RESTAPIResponseStream - 범위가 지정됨, 전역

  • 릴리스 버전: Zurich
  • 업데이트 날짜 2025년 07월 31일
  • 소요 시간: 3분
  • RESTAPIResponseStream API는 스크립트된 REST API 응답 스트림에 직접 쓸 수 있는 메서드를 제공합니다.

    RESTAPIResponseStream 메서드를 사용하여 스크립트 기반 REST API 기능에서 웹 서비스 API를 빌드합니다.

    이 API는 sn_ws 네임스페이스에서 실행됩니다.

    주:
    이 형식의 개체는 인스턴스화할 수 없습니다. 이 유형의 객체는 자동으로 생성되며 스크립트된 REST API 자원 스크립트에서만 액세스할 수 있습니다.

    RESTAPIResponseStream - writeStream(객체 스트림)

    응답 스트림에 입력 스트림을 씁니다.

    writeStream() 메서드를 호출하기 전에 내용 유형과 상태 코드를 설정해야 합니다. 그렇지 않으면 응답이 실패합니다. writeStream() 메서드를 호출한 후에는 이러한 값을 수정할 수 없습니다.

    주:

    외부 공급업체 서비스에서 스트림을 가져오는 것은 스크립트 작성자의 책임입니다.

    표 1. 매개변수
    이름 유형 설명
    시내 객체 외부 공급업체 서비스의 첨부 파일 또는 응답 스트림입니다.
    표 2. 반환
    유형 설명
    void

    다음은 범위가 지정된 애플리케이션에 대한 예시입니다.

    (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
    
        response.setContentType('application/json');
        response.setStatus(200);
    
        var gsa = new GlideSysAttachment();
        var attachmentStream = new gsa.getContentStream(<sys_id of attachment>); 
        var writer = response.getStreamWriter();
        writer.writeStream(attachmentStream);
    
    })(request, response);

    다음은 전역 애플리케이션에 대한 예시입니다.

    (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
    
        response.setContentType('application/json');
        response.setStatus(200);
    
        var attachmentStream = new GlideSysAttachmentInputStream(<sys_id of attachment>);
        var writer = response.getStreamWriter();
        writer.writeStream(attachmentStream);
    
    })(request, response);

    RESTAPIResponseStream - writeString(문자열 데이터)

    응답 스트림에 문자열 데이터를 씁니다.

    writeString() 메서드를 호출하기 전에 내용 유형과 상태 코드를 설정해야 합니다. 그렇지 않으면 응답이 실패합니다. writeString() 메서드를 호출한 후에는 이러한 값을 수정할 수 없습니다.

    표 3. 매개변수
    이름 유형 설명
    데이터 문자열 응답 데이터에 추가할 문자열입니다.
    표 4. 반환
    유형 설명
    void
    response.setContentType('application/json');
    response.setStatus(200);
    var writer = response.getStreamWriter();
    var body ={
      name:user1,
      id: 1234,
      roles: [
        {
          name: admin
        },
        {
          name: itil
        }
      ]
    }
    writer.writeString("{'name':'user','id':'1234'}");
    writer.writeString(JSON.stringify(body));