RESTAPIRequest - 범위 지정, 전역

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기4분
  • RESTAPIRequest API를 사용하면 스크립트에서 스크립팅된 REST API 요청 세부 정보에 액세스할 수 있습니다.

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

    RESTAPIRequest - 본문

    요청의 본문입니다.

    표 1. 필드
    이름 유형 설명
    본문 RESTAPIRequest본문 요청의 본문입니다. RESTAPIRequestBody API를 사용하여 body 객체의 데이터에 액세스할 수 있습니다.
    var requestBody = request.body // Returns instance of RESTAPIRequestBody

    RESTAPIRequest - getHeader(헤더 문자열)

    웹 서비스 요청에서 특정 헤더의 값을 반환합니다.

    표 2. 매개변수
    이름 유형 설명
    헤더 문자열 헤더의 이름(예: accept 또는 content-type.
    표 3. 반환
    유형 설명
    문자열 지정된 헤더의 값입니다.
    var acceptHeader = request.getHeader('accept');

    RESTAPIRequest - getSupportedResponseContentTypes()

    요청 수락 헤더에 지정된 컨텐츠 유형을 가져옵니다.

    표 4. 매개변수
    이름 유형 설명
    없음
    표 5. 반환
    유형 설명
    배열 각 문자열이 컨텐츠 유형인 문자열 값의 배열(예시: application/json)입니다.

    RESTAPIRequest - 헤더

    요청의 모든 헤더입니다.

    표 6. 필드
    이름 유형 설명
    헤더 객체 요청의 모든 헤더와 해당 값입니다.
    var headers = request.headers; 
    var acceptHeader = headers.Accept;
    var myCustomHeader = headers.myCustom; 
    var specialHeader = headers['special - header'];

    RESTAPIRequest - pathParams

    요청 URI에 전달된 경로 매개변수입니다.

    표 7. 필드
    이름 유형 설명
    pathParams 객체 스크립트 객체로서의 경로 매개변수입니다. 사용 가능한 경로 매개변수는 웹 서비스 구성에 따라 다릅니다.

    이 예제에서 스크립팅된 REST API 엔드포인트는 https://instance.service-now.com/api/now/myservice/{tableName}/{id} 형식을 따릅니다. 처리 중인 요청은 https://instance.service-now.com/api/now/myservice/myApp_table/1234 URL을 사용합니다.

    var pathParams = request.pathParams; 
    var tableName = pathParams.tableName; //'myApp_table' 
    var id = pathParams.id; //'1234'

    RESTAPIRequest - queryParams

    웹 서비스 요청의 쿼리 매개변수입니다.

    표 8. 필드
    이름 유형 설명
    queryParams 배열 웹 서비스 요청의 쿼리 매개변수입니다.

    이 예에서 처리 중인 요청은 https://<instance_rest_endpoint>?active=false&name=now URL을 사용합니다. 및 name 매개 변수를 기록해 active 둡니다.

    var queryParams = request.queryParams; 
    var isActiveQuery = queryParams.active; // [false] 
    var nameQueryVal = queryParams.name; // ['now']

    RESTAPIRequest - queryString

    엔드포인트 URI에 추가된 전체 쿼리입니다.

    표 9. 필드
    이름 유형 설명
    Querystring 문자열 요청에 대한 전체 쿼리입니다.

    이 예에서 처리 중인 요청은 https://<instance_rest_endpoint>?active=false&name=now URL을 사용합니다. active=false&name=now 쿼리를 확인합니다.

    var query = request.queryString; //"active=false&name=now"

    RESTAPIRequest - uri

    도메인 정보를 제외한 요청 URI입니다.

    표 10. 필드
    이름 유형 설명
    uri 문자열 도메인 정보를 제외한 요청 URI입니다.

    이 예에서 처리 중인 요청은 https://instance.service-now.com/api/now/table/myTable?active=false&name=now URL을 사용합니다.

    var query = request.uri; //"api/now/table/myTable"

    RESTAPIRequest - url

    전체 요청 URL입니다.

    표 11. 필드
    이름 유형 설명
    URL 문자열 전체 요청 URL입니다.

    이 예에서 처리 중인 요청은 https://instance.service-now.com/api/now/table/myTable?active=false&name=now URL을 사용합니다.

    var query = request.url; //"https://instance.service-now.com/api/now/table/myTable?active=false&name=now"