RESTAPIResponse - 범위, 전역

RESTAPIResponse API는 스크립팅된 REST API 요청에 대한 RESTful 응답을 빌드할 수 있는 메서드를 제공합니다.

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

주:

이 형식의 개체는 인스턴스화할 수 없습니다. 이 유형의 개체는 자동으로 만들어지며 스크립팅된 REST API 리소스 스크립트에서만 액세스할 수 있습니다.

RESTAPIResponse - getStreamWriter()

응답 스트림에 직접 쓸 수 있도록 이 응답에 대한 ResponseStreamWriter를 반환합니다.

getStreamWriter 함수를 호출하기 전에 setHeaders 및 setStatus 함수를 사용하여 컨텐츠 유형 및 상태 코드를 설정합니다.

표 1. 매개변수

이름	유형	설명
없음

표 2. 반환

유형	설명
RESTAPIResponseStream - 범위가 지정됨, 전역	이 응답에 대한 ResponseStreamWriter입니다. 이 개체를 사용하여 응답 스트림에 직접 쓸 수 있습니다.

response.setContentType('application/json');
response.setStatus(200);
var writer = response.getStreamWriter();

RESTAPIResponse - setBody(객체 본문)

웹 서비스 응답에서 보낼 본문 콘텐츠를 설정합니다.

표 3. 매개변수

이름	유형	설명
본문	객체	응답 본문(JavaScript 객체)입니다. 본문 콘텐츠는 요청에 전달된 헤더 값에 따라 JSON 또는 XML Accept 로 자동으로 직렬화됩니다.

표 4. 반환

유형	설명
void

var body = {};
body.name = "incident";
body.number = "1234";
body.caller = {"id": "user1"};
response.setBody(body);

var bodyArray = [];
var body = {};
body.name = "incident";
body.number = "1234";
body.caller = {"id":"user1"};
bodyArray.push(body);
response.setBody(bodyArray);

RESTAPIResponse - setContentType(문자열 contentType)

웹 서비스 응답의 Content-Type 헤더에 값을 할당합니다.

응답을 작성하기 전에 응답 콘텐츠 형식을 설정해야 합니다. 콘텐츠 유형은 요청 수락 헤더 값에 따라 문자열 응답에 대해 자동으로 설정됩니다.

잘못된 콘텐츠 유형을 설정하면 응답이 기본적으로 JSON으로 설정됩니다. 콘텐츠 형식을 설정하지 못하면 이진 응답을 보낼 때 상태 코드 500 오류가 발생합니다.

이 헤더에 대한 자세한 내용은 W3 Content-Type 헤더 설명서를 참조하세요.

표 5. 매개변수

이름	유형	설명
콘텐츠 유형	문자열	응답 본문의 콘텐츠 유형(예: application/json)입니다.

표 6. 반환

유형	설명
void

response.setContentType('application/json');

RESTAPIResponse - setError(객체 오류)

오류를 반환하도록 REST 응답을 구성합니다.

표 7. 매개변수

이름	유형	설명
오류	객체	Error 객체입니다. 사용할 수 있는 오류 개체의 유형에 대한 자세한 내용은 을 참조하십시오 스크립팅된 REST API 예제 - 스크립트 샘플.

표 8. 반환

유형	설명
void

다음 예제에서는 스크립트된 REST 리소스 내에서 오류를 반환하는 방법을 보여 줍니다.

var queryParams = request.queryParams;
var userId = String(queryParams.user_id || '');
var fileId = String(queryParams.file_id || '');
if (!userId || !fileId){
  response.setError(new sn_ws_err.BadRequestError('Missing required parameters.'));
  return;
}

RESTAPIResponse - setHeader(문자열 헤더, 문자열 값)

REST 서비스 응답 헤더에 값을 할당합니다.

표 9. 매개변수

이름	유형	설명
헤더	문자열	설정할 헤더입니다.
값	문자열	지정된 헤더를 할당할 값입니다.

표 10. 반환

유형	설명
void

response.setHeader("Location","<URI>");

RESTAPIResponse - setHeaders(객체 헤더)

웹 서비스 응답의 헤더를 설정합니다.

표 11. 매개변수

이름	유형	설명
헤더	객체	각 헤더와 해당 헤더를 할당할 값을 나열하는 JavaScript 객체입니다.

표 12. 반환

유형	설명
void

var headers = {};
headers.X-Total-Count=100;
headers.Location='https://instance.service-now.com/<endpoint_to_resource>';
response.setHeaders(headers);

RESTAPIResponse - setLocation(문자열 위치)

웹 서비스 응답의 위치 헤더에 값을 할당합니다.

이 헤더에 대한 자세한 내용은 W3 위치 헤더 설명서를 참조하세요.

표 13. 매개변수

이름	유형	설명
없음	문자열	응답 수신자를 리디렉션할 절대 URI입니다.

표 14. 반환

유형	설명
void

RESTAPIResponse - setStatus(번호 상태)

웹 서비스 응답의 상태 코드 번호를 설정합니다.

표 15. 매개변수

이름	유형	설명
상태	번호	응답으로 보낼 상태 코드(예: 성공을 나타내는 200)입니다. 문자열과 같이 숫자가 아닌 값을 전달하면 상태 코드가 기본적으로 0으로 설정됩니다.

표 16. 반환

유형	설명
void

response.setStatus(200);