서비스 카탈로그 API

Service Catalog API는 에서 서비스 포털구성 및 작업에 액세스하는 서비스 카탈로그 엔드포인트를 제공합니다.

서비스 카탈로그 - 삭제 /sn_sc/servicecatalog/cart/{cart_item_id}

현재 카트에서 지정된 항목을 삭제합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}

기본 URL: /api/sn_sc/servicecatalog/cart/{cart_item_id}

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 1. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
cart_item_id 현재 카트에서 삭제할 항목의 Sys_id입니다.

데이터 유형: 문자열
표 2. 쿼리 매개변수
이름 설명
안 함
표 3. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 4. 요청 헤더
헤더 설명
안 함
표 5. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 6. 상태 코드
상태 코드 설명
204 요청이 성공적으로 완료되었고 지정된 항목이 카트에서 삭제되었음을 나타냅니다.
400 지정된 cart_item_id 항목이 잘못되었거나 사용자가 카트 항목에 접근할 수 없음을 나타냅니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
안 함

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/1f4cc597db21120064301150f0b8f5fc" \
--request DELETE \
--user "username":"password"
None

서비스 카탈로그 - 삭제 /sn_sc/servicecatalog/cart/{sys_id}/empty

지정된 카트와 카트의 컨텐츠를 삭제합니다.

사용자가 삭제할 수 있는 항목(항목 및/또는 카트)의 기능은 사용자가 인증에 사용하는 역할에 따라 다릅니다.

카트 및 카트 컨텐츠를 삭제하는 데 필요한 사용자 역할:
  • admin/catalog_admin: 모든 사용자 카트를 비울 수 있습니다.
  • admin: 카트의 모든 컨텐츠가 삭제된 후 카트를 삭제할 수 있습니다.
  • catalog_admin: 카트에 있는 모든 항목을 삭제할 수 있습니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/cart/{sys_id}/empty

기본 URL: /api/sn_sc/servicecatalog/cart/{sys_id}/empty

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 7. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 카트에서 비우고 삭제할 Sys_id입니다.

데이터 유형: 문자열
표 8. 쿼리 매개변수
이름 설명
안 함
표 9. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 10. 요청 헤더
헤더 설명
안 함
표 11. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 12. 상태 코드
상태 코드 설명
204 요청이 성공적으로 완료되었으며 카트를 비우고 삭제합니다.
400 다음 이유 중 하나로 인한 오류를 나타냅니다.
  • 잘못된 cartId입니다.
  • 사용자에게 관리자/catalog_admin 역할이 없거나 다른 사용자 카트를 비우려고 합니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
안 함

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/dde34ad713426300027879d96144b072/empty" \
--request DELETE \
--user 'username':'password'
None

서비스 카탈로그 - GET /sn_sc/servicecatalog/cart

로그인한 사용자의 카트에 있는 항목의 상세 정보를 조회합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/cart

기본 URL: /api/sn_sc/servicecatalog/cart

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 13. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
표 14. 쿼리 매개변수
이름 설명
안 함
표 15. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 16. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 17. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 18. 상태 코드
상태 코드 설명
200 요청이 성공적으로 완료되었음을 나타냅니다. 카트에 항목이 없으면 사용자에게 기본 카트 정보와 가격을 반환합니다. 카트에 항목이 들어 있으면 항목에 대한 정보와 개별 가격 책정도 포함됩니다.
400 카트가 비어 있으며 체크 아웃할 수 없음을 나타냅니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

매개변수 설명
cart_id 카트의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency> 특정 반복 빈도가 있는 카트 항목 목록입니다. 가능한 값은 다음과 같습니다.
  • 매일
  • 월별
  • 매년
  • 없음(반복 수수료 없음)

데이터 유형: 객체

"<recurring_frequency>": {
  "frequency_label": "String",
  "items": [Array],
  "show_subtotal_price": "String",
  "subtotal_price": "String",
  "subtotal_recurring_frequency": "String",
  "subtotal_recurring_price": "String",
  "subtotal_title": "String",
  "total_title": "String"
<recurring_frequency>.frequency_label 연결된 반복 수수료의 빈도입니다.

데이터 유형: 문자열

기본값: null
<recurring_frequency>.항목 지정된 반복 빈도 범주와 연결된 각 항목의 상세 정보를 포함하는 객체의 목록입니다.

데이터 유형: 배열

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created.by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_description": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
<recurring_frequency>.items.cart_item_id 이 카트에 있는 항목의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.catalog_item_id 항목과 연결된 카탈로그의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.created.by 처음에 카트에 항목을 넣은 사용자입니다.

데이터 유형: 문자열
<recurring_frequency>.items.created_on 항목이 처음 카트에 담겨진 날짜입니다.

데이터 유형: 문자열
<recurring_frequency>.items.delivery_time 지정된 항목을 배달하는 데 걸리는 시간입니다.

데이터 유형: 문자열
<recurring_frequency>.items.item_id 항목의 카탈로그 sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.item_name 지정된 항목의 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.localized_price 현지 통화로 표기한 항목의 가격입니다.

데이터 유형: 문자열
<recurring_frequency>.items.localized_recurring_price 지정된 항목에 대해 현지 통화로 나타낸 반복 수수료입니다.

데이터 유형: 문자열
<recurring_frequency>.items.name 항목 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.order_guide 이 항목이 연결된 주문 가이드의 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.picture 항목 그림의 파일 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.품목.가격 항목의 가격입니다.

데이터 유형: 문자열
<recurring_frequency>.items.quantity 카트에 있는 지정된 항목의 번호입니다.

데이터 유형: 문자열
<recurring_frequency>.items.recurring_frequency 지정된 항목에 대해 반복 수수료가 청구되는 빈도입니다.

데이터 유형: 문자열

기본값: null
<recurring_frequency>.items.recurring_price 지정된 항목에 대한 반복 수수료입니다.

데이터 유형: 문자열
<recurring_frequency>.items.recurring_subtotal 항목에 대한 반복 수수료의 소계입니다(recurring_price x quantity).

데이터 유형: 숫자
<recurring_frequency>.items.recurring_subtotal_price 항목에 대한 반복 수수료의 소계입니다.

데이터 유형: 문자열
<recurring_frequency>.items.short_description 항목에 대한 간단한 설명입니다.

데이터 유형: 문자열
<recurring_frequency>.items.show_price 항목의 가격이 카트에 표시되는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 장바구니에 있는 항목의 가격을 표시합니다.
  • false: 장바구니에 있는 항목의 가격을 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.items.show_quantity 카트에 항목 수량을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 항목 수량을 표시합니다.
  • false: 카트에 항목 수량을 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.items.show_recurring_price 반복 수수료를 카트에 표시해야 하는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 반복 수수료를 표시합니다.
  • false: 카트에 반복 수수료를 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.items.subtotal 항목의 소계 수입니다.

데이터 유형: 숫자
<recurring_frequency>.items.subtotal_price 항목의 소계(price x quantity).

데이터 유형: 문자열
<recurring_frequency>.items.sys_클래스_이름 항목의 시스템 분류 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.sys_id 항목 기록의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.updated_by 항목을 처음 카트에 넣은 후 업데이트한 사용자입니다.

데이터 유형: 문자열
<recurring_frequency>.items.updated_on 항목을 처음 카트에 넣거나 업데이트한 마지막 날짜/시간입니다.

데이터 유형: 문자열
<recurring_frequency>.items.variables 항목 변수의 이름/값 쌍 목록입니다.

데이터 유형: 객체
<recurring_frequency>.show_subtotal_price 연결된 반복 수수료 범주에 대한 소계를 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 부분합을 표시합니다.
  • false: 카트에 부분합을 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.subtotal_price 연결된 반복 빈도 범주에 대한 모든 항목의 비용 소계입니다.

데이터 유형: 문자열
<recurring_frequency>.subtotal_recurring_frequency 반복되는 빈도의 소계 유형(예: 매일, 매월 등) 와 subtotal_recurring_frequency같습니다.

데이터 유형: 문자열
<recurring_frequency>.subtotal_recurring_price 연결된 반복 빈도 범주 내 항목의 반복 수수료 소계입니다.

데이터 유형: 문자열
<recurring_frequency>.subtotal_title the show_subtotal_price 가 true로 설정된 경우 연결된 자막의 카트에 표시할 텍스트입니다.

데이터 유형: 문자열
<recurring_frequency>.total_title 연결된 반복 빈도 범주의 총 제목에 대해 표시할 텍스트입니다.

데이터 유형: 문자열
show_subtotal_price 카트에 소계 가격을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 부분합을 표시합니다.
  • false: 카트에 부분합을 표시하지 않습니다.

데이터 유형: 문자열
subtotal_price 카트에 있는 모든 항목의 소계(전체 달러)입니다.

데이터 유형: 문자열
subtotal_recurring_frequency 반복되는 빈도의 소계 유형(예: 매일, 매월 등) 와 <recurring_frequency>.subtotal_recurring_frequency같습니다.

데이터 유형: 문자열
subtotal_recurring_price 카트에 있는 모든 항목에 대한 반복 빈도 수수료의 소계입니다.

데이터 유형: 문자열
subtotal_title 소계 필드 제목에 대해 카트에 표시할 텍스트입니다.

데이터 유형: 문자열
total_title 총계 필드 제목에 대해 카트에 표시할 텍스트입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "cart_id": "6d88bc29137d2300027879d96144b04b",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
      {
        "updated_on": "2018-11-15 14:24:00",
        "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "short_description": "Apple iPhone 7 ",
        "recurring_subtotal_price": "$0.00",
        "delivery_time": "2 Days",
        "sys_class_name": "sc_cat_item",
        "sys_id": "1f88bc29137d2300027879d96144b056",
        "price": "$799.00",
        "recurring_frequency": null,
        "subtotal_price": "$799.00",
        "variables": {},
        "quantity": "1",
        "item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "recurring_price": "$0.00",
        "show_price": true,
        "item_name": "Apple iPhone7",
        "cart_item_id": "1f88bc29137d2300027879d96144b056",
        "recurring_subtotal": 0,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
        "created_on": "2018-11-15 14:24:00",
        "localized_price": "$799.00",
        "subtotal": 799,
        "show_recurring_price": false,
        "name": "Apple iPhone7",
        "updated_by": "admin",
        "localized_recurring_price": "$0.00",
        "order_guide": ""
      },
    ],
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
   },
   "show_subtotal_price": "true",
   "subtotal_title": "Subtotal"
 }
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/cart/delivery_address/{user_id}

속성 및 에 구성된 glide.sc.req_for.roles.defaultproperty기본 동작을 기반으로 glide.sc.req_for.roles 지정된 사용자의 배송 주소를 조회합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/cart/delivery_address/{user_id}

기본 URL: /api/sn_sc/servicecatalog/cart/delivery_address/{user_id}

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 19. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
user_id 배송 주소를 검색할 사용자의 Sys_id입니다.

데이터 유형: 문자열

테이블: 사용자 [sys_user]
표 20. 쿼리 매개변수
이름 설명
안 함
표 21. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 22. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 23. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 24. 상태 코드
상태 코드 설명
200 요청이 성공적으로 완료되었습니다. 지정된 사용자의 배송 주소를 반환합니다.
400 사용자 sys_id 잘못되었습니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
결과 지정된 사용자의 주소입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/delivery_address/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
'result': '25 New Chardon Street, Boston\nBoston, MA, 02114-1801\nUSA'
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/catalog

전달된 매개변수를 기반으로 사용자가 접근할 수 있는 카탈로그 목록을 검색합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/catalogs

기본 URL: /api/sn_sc/servicecatalog/catalogs

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 25. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
표 26. 쿼리 매개변수
이름 설명
sysparm_limit 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다.

이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다.

주:
이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다.

데이터 유형: 숫자

기본값: 20

최대: 100
sysparm_text 사용 가능한 서비스 카탈로그의 "제목" 필드에서 검색할 키워드입니다.

데이터 유형: 문자열
sysparm_view 항목이 표시될 수 있는 장치:
  • desktop: 바탕 화면에서.
  • mobile: 휴대기기에서.
  • both: 데스크톱과 모바일 장치 모두에서 사용할 수 있습니다.

데이터 유형: 문자열
표 27. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 28. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 29. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 30. 상태 코드
상태 코드 설명
200 요청이 성공적으로 완료되었음을 나타냅니다. 유효한 쿼리가 결과를 반환하지 않으면 응답 본문에는 빈 결과 배열만 포함됩니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
설명 카탈로그에 대한 설명입니다.

데이터 유형: 문자열
desktop_image 이 카탈로그의 바탕 화면에 나타나는 이미지입니다.

데이터 유형: 문자열
has_categories 카탈로그에 범주가 포함되어 있는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카탈로그에 범주가 포함되어 있습니다.
  • False: 카탈로그에 범주가 없습니다.

데이터 유형: 부울
has_items 카탈로그에 항목이 포함되어 있는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카탈로그에 항목이 포함되어 있습니다.
  • false: 카탈로그에 항목이 없습니다.

데이터 유형: 부울
sys_id 카탈로그의 Sys_id입니다.

데이터 유형: 문자열
제목 카탈로그 제목입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs?sysparm_limit=10" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "title": "Technical Catalog",
      "sys_id": "742ce428d7211100f2d224837e61036d",
      "has_categories": true,
      "has_items": true,
      "description": "Products and services for the IT department",
      "desktop_image": "7a7c8271475211002ee987e8dee4906d.iix"
    },
    {
      "title": "Service Catalog",
      "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
      "has_categories": true,
      "has_items": true,
      "description": "Service Catalog - IT Now",
      "desktop_image": "adbcc271475211002ee987e8dee49001.iix"
    }
  ]
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/catalogs/{sys_id}/categories

지정된 카탈로그에 사용할 수 있는 범주 목록을 검색합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}/categories

기본 URL: /api/sn_sc/servicecatalog/catalogs/{sys_id}/categories

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 31. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 범주가 요청된 카탈로그의 Sys_id입니다.

데이터 유형: 문자열
표 32. 쿼리 매개변수
이름 설명
sysparm_limit 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다.

이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다.

주:
이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다.

데이터 유형: 숫자

기본값: 20

최대: 100
sysparm_offset 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다.

예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 sysparm_offset=sysparm_offset+sysparm_limit를 사용합니다.

매개변수에 sysparm_offset 음수를 전달하지 마십시오.

데이터 유형: 숫자

기본값: 0
sysparm_top_level_only 상위 항목이 카탈로그인 범주만 반환합니다.
유효한 값은 다음과 같습니다.
  • True: 상위 항목이 카탈로그인 범주만 반환합니다.
  • false: 모든 범주를 반환합니다.

데이터 유형: 부울
sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

유효한 값은 다음과 같습니다.

  • 데스크톱
  • 모바일
  • 모두

sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

데이터 유형: 문자열
표 33. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 34. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 35. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 36. 상태 코드
상태 코드 설명
200 카탈로그의 범주 목록을 반환합니다. 쿼리 결과가 없으면 빈 배열이 반환됩니다.
400 요청 또는 카탈로그 sys_id 잘못되었음을 나타냅니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
카운트 범주 내 항목 수입니다.

데이터 유형: 숫자
설명 간략한 범주 설명입니다.

데이터 유형: 문자열
전체 _description 자세한 범주 설명입니다.

데이터 유형: 문자열
header_icon 범주 헤더에 사용되는 아이콘입니다.

데이터 유형: 문자열
homepage_image 범주의 홈페이지에서 이 범주에 대해 표시되는 이미지입니다.

데이터 유형: 문자열
아이콘 이 범주를 나타내는 데 사용할 아이콘입니다.

데이터 유형: 문자열
하위 범주 범주 내의 하위 범주 목록입니다.

데이터 유형: 배열

"subcategories": [
  "sys_id": "String",
  "title": "String
]
subcategories.sys_id 하위 범주의 Sys_id입니다.

데이터 유형: 문자열
하위 범주.제목 하위 범주의 제목입니다.

데이터 유형: 문자열
sys_id 범주의 Sys_id입니다.

데이터 유형: 문자열
제목 범주 제목입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs/e0d08b13c3330100c8b837659bba8fb4/categories?sysparm_limit=2 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": [
    {
      "title": "Can We Help You?",
      "description": "Your IT gateway. Report issues and submit requests.\n\t\t",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "29f8ffa9471211002ee987e8dee4905e.iix",
      "count": 14,
      "subcategories": [],
      "sys_id": "e15706fc0a0a0aa7007fc21e1ab70c2f"
    },
    {
      "title": "Departmental Services",
      "description": "Services offered by different departments in the organization",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "6fb4a1d95f2211001c9b2572f2b47748.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "95fc11615f1211001c9b2572f2b477c6"
    },
    {
      "title": "Desktops",
      "description": "Desktop computers for your work area.",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "1bface31475211002ee987e8dee49095.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "900682363731300054b6a3549dbe5d5f"
    }
  ]
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/catalogs/{sys_id}

지정된 카탈로그에 사용할 수 있는 정보를 조회합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}

기본 URL: /api/sn_sc/servicecatalog/catalogs/{sys_id}

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 37. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 검색할 카탈로그의 Sys_id입니다.

데이터 유형: 문자열
표 38. 쿼리 매개변수
이름 설명
sysparm_view 항목이 표시될 수 있는 장치:
  • desktop: 바탕 화면에서.
  • mobile: 휴대기기에서.
  • both: 데스크톱과 모바일 장치 모두에서 사용할 수 있습니다.

데이터 유형: 문자열
표 39. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 40. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 41. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 42. 상태 코드
상태 코드 설명
200 요청이 성공적으로 완료되었음을 나타내며 지정된 카탈로그에 사용 가능한 정보를 반환합니다.
400 다음 이유 중 하나로 요청이 잘못되었음을 나타냅니다.
  • 사용자에게 카탈로그에 접근할 수 있는 권한이 없습니다.
  • 잘못된 sys_id.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
범주 카탈로그 내의 범주를 설명하는 객체의 목록입니다.

데이터 유형: 배열

"categories": [
  "description": "String",
  "header_image": "String",
  "sys_id": "String",
  "title": "String
]
범주.설명 범주에 대한 설명입니다.

데이터 유형: 문자열
categories.header_image 범주 헤더 이미지입니다.

데이터 유형: 문자열
categories.sys_id 고유 범주 식별자(sys_id)입니다.

데이터 유형: 문자열
범주.제목 범주 제목입니다.

데이터 유형: 문자열
설명 카탈로그 설명입니다.

데이터 유형: 문자열
desktop_image 데스크톱 뷰에서 카탈로그와 함께 표시되는 이미지의 소스입니다.

데이터 유형: 문자열
has_categories 카탈로그에 범주가 있는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카탈로그에 범주가 있습니다.
  • false: 카탈로그에 범주가 없습니다.

데이터 유형: 부울
has_items 범주 내에 항목이 있는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카탈로그에 연결된 항목이 있습니다.
  • False: 카탈로그에 연결된 항목이 없습니다.

데이터 유형: 부울
sys_id 고유한 카탈로그 sys_id.

데이터 유형: 문자열
제목 카탈로그 제목입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.comaqsw" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "title": "Customer Service",
    "sys_id": "65bcd377c3011200b12d9f2974d3aea0",
    "has_categories": true,
    "categories": [
      {
        "header_image": "",
        "sys_id": "4cb69d19c3921200b0449f2974d3ae69",
        "description": null,
        "title": "Services"
      },
      {
        "header_image": "",
        "sys_id": "1b8611d5c3921200b0449f2974d3ae12",
        "description": null,
        "title": "Support"
      }
    ],
    "has_items": true,
    "description": "Customer Service",
    "desktop_image": ""
  }
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/categories/{sys_id}

지정된 범주에 대해 사용 가능한 정보를 검색합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/categories/{sys_id}

기본 URL: /api/sn_sc/servicecatalog/categories/{sys_id}

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 43. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 정보를 반환할 범주의 Sys_id입니다.

데이터 유형: 문자열
표 44. 쿼리 매개변수
이름 설명
sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

유효한 값은 다음과 같습니다.

  • 데스크톱
  • 모바일
  • 모두

sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

데이터 유형: 문자열
표 45. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 46. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 47. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 48. 상태 코드
상태 코드 설명
200 성공입니다. 요청이 성공적으로 처리되었습니다.
400 다음 이유 중 하나로 요청이 잘못되었음을 나타냅니다.
  • 사용자에게 범주에 대한 액세스 권한이 없습니다.
  • 잘못된 sys_id.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
child_categories 이 범주에 속하는 하위 범주를 설명하는 객체의 목록입니다.

데이터 유형: 배열

"child_categories": [
  "count": Number,
  "isParentCategory": "String",
  "parent": "String",
  "subcategories": [Array],
  "sys_id": "String",
  "title": "String"
]
child_categories.카운트 하위 범주의 항목 수입니다.

데이터 유형: 숫자
child_categories.isParentCategory 상위 범주인지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 상위 범주입니다.
  • false: 상위 범주가 아님

데이터 유형: 부울
child_categories.parent 하위 범주의 상위 항목 Sys_id.

데이터 유형: 문자열
child_categories.하위 범주 이 하위 범주의 하위 범주를 설명하는 객체의 목록입니다.

데이터 유형: 배열

"subcategories": [
  "sys_id": "String",
  "title": "String"
]
child_categories.subcategories.sys_id 하위 하위 범주의 Sys_id입니다.

데이터 유형: 문자열
child_categories.subcategories.title 하위 하위 범주 제목입니다.

데이터 유형: 문자열
child_categories.sys_id 하위 범주의 Sys_id입니다.

데이터 유형: 문자열
child_categories.title 하위 범주 제목입니다.

데이터 유형: 문자열
설명 짧은 범주 설명입니다.

데이터 유형: 문자열
full_description 자세한 범주 설명입니다.

데이터 유형: 문자열
header_icon 범주가 최상위 범주에 나열될 때 범주 헤더 옆에 표시되는 아이콘의 소스입니다.

데이터 유형: 문자열
homepage_image 범주에 대한 홈페이지 이미지의 소스입니다.

데이터 유형: 문자열
아이콘 범주가 하위 범주로 나열될 때 범주 이름 옆에 표시되는 작은 아이콘의 소스입니다.

데이터 유형: 문자열
sys_id 범주의 Sys_id입니다.

데이터 유형: 문자열
제목 범주 제목입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/categories/b0fdfb01932002009ca87a75e57ffbe9" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "title": "Office",
    "description": "Office services such as printing, supplies requisition\n\t\t\tand document shipping and delivery.\n\t\t",
    "full_description": null,
    "icon": "",
    "header_icon": "",
    "homepage_image": "498b0271475211002ee987e8dee490ea.iix",
    "sys_id": "109cdff8c6112276003b17991a09ad65",
    "child_categories": [
      {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services",
        "count": 16,
        "parent": "109cdff8c6112276003b17991a09ad65",
        "subcategories": [],
        "isParentCategory": false
      }
    ]
  }
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/items

지정된 매개변수를 기반으로 카탈로그 항목의 목록을 조회합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items

기본 URL: /api/sn_sc/servicecatalog/items

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 49. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
표 50. 쿼리 매개변수
이름 설명
sysparm_catalog 항목의 카탈로그 sys_id입니다. 이 매개변수를 사용하여 특정 카탈로그에서 항목을 찾을 수 있습니다.

데이터 유형: 문자열
sysparm_category 항목의 범주 sys_id입니다. 이 매개변수를 사용하여 특정 범주에서 카탈로그 항목을 찾을 수 있습니다.

데이터 유형: 문자열
sysparm_limit 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다.

이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다.

주:
이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다.

데이터 유형: 숫자

기본값: 20

최대: 100
sysparm_offset 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다.

예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 sysparm_offset=sysparm_offset+sysparm_limit를 사용합니다.

매개변수에 sysparm_offset 음수를 전달하지 마십시오.

데이터 유형: 숫자

기본값: 0
sysparm_text 범주 항목에서 검색할 특정 텍스트입니다. 예를 들어 , sysparm_text="iPhone" 또는 sysparm_text="Mobile devices"입니다.

데이터 유형: 문자열
sysparm_type 항목의 유형입니다.

유효한 검색 값:

  • 기록 생성자
  • 주문 가이드
다른 값이 전달되면 정보가 무시됩니다.

데이터 유형: 문자열
sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

유효한 값은 다음과 같습니다.

  • 데스크톱
  • 모바일
  • 모두

sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

데이터 유형: 문자열
표 51. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 52. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 53. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 54. 상태 코드
상태 코드 설명
200 지정된 매개변수를 기반으로 카탈로그 및 항목의 목록을 반환합니다. 유효한 쿼리 결과에서 항목이 없으면 응답 본문에 빈 결과 배열만 포함됩니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

매개변수 설명
catalogs 이 항목을 포함하는 카탈로그를 설명하는 객체의 목록입니다.

데이터 유형: 배열

"catalogs": [{
  "sys_id": "String",
  "title": "String"
}]
catalogs.sys_id 카탈로그의 Sys_id입니다.

데이터 유형: 문자열
카탈로그.제목 카탈로그 제목입니다.

데이터 유형: 문자열
범주 이 항목이 포함된 범주에 대해 설명합니다.

데이터 유형: 객체

"catalogs": {
  "sys_id": "String",
  "title": "String"
}
category.sys_id 범주의 Sys_id입니다.

데이터 유형: 문자열
범주.제목 범주 제목

데이터 유형: 문자열
content_type 컨텐츠의 유형입니다.

데이터 유형: 문자열
설명 항목에 대한 자세한 설명입니다.

데이터 유형: 문자열
아이콘 항목 이름 옆에 표시되는 작은 아이콘의 소스입니다.

데이터 유형: 문자열
kb_article 항목과 연결된 지식 기반 문서입니다.

데이터 유형: 문자열
local_currency 현지 통화의 국가 통화 코드입니다.

데이터 유형: 문자열
localized_price 로 local_currency정의된 통화로 표시되는 항목의 가격입니다.

데이터 유형: 문자열
localized_recurring_price 로 정의된 local_currency통화로 표시되는 반복 수수료의 가격입니다.

데이터 유형: 문자열
이름 항목의 이름입니다.

데이터 유형: 문자열
순서 항목이 속한 미리 정의된 순서입니다.

데이터 유형: 숫자
picture 항목에 대해 표시할 이미지의 경로입니다.

데이터 유형: 문자열
가격 로 price_currency정의된 통화로 표시되는 항목의 가격입니다.

데이터 유형: 문자열
price_currency 항목 가격이 표시되는 국가 통화 코드입니다.

데이터 유형: 문자열
recurring_frequency 반복되는 수수료가 적용되는 빈도(예: 매일, 매월 또는 매년) 항목에 대한 수수료가 없는 경우 null입니다.

데이터 유형: 문자열
recurring_price 항목과 연결된 반복 수수료의 금액입니다.

데이터 유형: 문자열
recurring_price_currency 반복 수수료를 표시하는 국가 통화 코드입니다.

데이터 유형: 문자열
short_description 항목에 대한 간략한 설명입니다.

데이터 유형: 문자열
show_price 카트에 항목 가격 책정을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 응답 파라미터에 이름-값 쌍이 반환됩니다.
  • false: 응답 파라미터에 이름-값 쌍이 반환되지 않습니다.

데이터 유형: 부울
show_quantity 카트에 항목 수량을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 항목 수량을 표시합니다.
  • false: 카트에 항목 수량을 표시하지 않습니다.

데이터 유형: 부울
sys_class_name sc_cat_item_producer와 같이 기록이 속한 테이블입니다.

데이터 유형: 문자열
sys_id 항목의 Sys_id입니다.

데이터 유형: 문자열
유형 항목의 유형입니다.

데이터 유형: 문자열
URL 항목의 URL입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items?sysparm_catalog=e0d08b13c3330100c8b837659bba8fb4&sysparm_limit=2" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": [
    {
      "short_description": null,
      "kb_article": "",
      "icon": "images/icons/catalog_item.gifx",
      "description": "<p class=\"p1\"><font size=\"2\"><span class=\"s1\">Request an existing Standard Change Template is made unavailable when it is no longer required or no longer acceptable as a Standard Change.  This will be confirmed by your Change Management team.</span></font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "",
      "url": "",
      "sys_id": "011f117a9f3002002920bde8132e7020",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Retire a Standard Change Template",
      "category": {
        "sys_id": "00728916937002002dcef157b67ffb6d",
        "title": "Template Management"
      },
      "order": 30
    },
    {
      "short_description": null,
      "kb_article": "",
      "icon": "4cc3ec3d471211002ee987e8dee490d0.iix",
      "description": "<p><font size=\"3\" color=\"#808080\" face=\"arial,helvetica,sans-serif\">A role delegator may delegate any role they have to any member of the specified group</font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "ed44b5804f889200086eeed18110c7ca.iix",
      "url": "",
      "sys_id": "01205b180a0a0b3000b6efd641d24b75",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Grant role delegation rights within a group",
      "category": {
        "sys_id": "496a3a7e0a0a0bc00089b39df14eb56e",
        "title": "Role Delegation"
      },
      "order": 100
    }
  ]
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

지정된 위임된 사용자에게 지정된 서비스 카탈로그 항목에 대한 취득 권한이 있는지 확인합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

기본 URL: /api/sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 55. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
item_sys_id 지정된 사용자에게 취득 권한이 있는지 확인하기 위한 서비스 카탈로그 항목의 Sys_id입니다.

데이터 유형: 문자열

테이블: Service Catalog [sc_catalog]
user_sys_id 지정된 Service Catalog 항목에 대한 취득 권한이 있는지 여부를 확인하는 사용자의 Sys_id입니다.

데이터 유형: 문자열

테이블: 사용자 [sys_users]
표 56. 쿼리 매개변수
이름 설명
안 함
표 57. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 58. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 59. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 60. 상태 코드
상태 코드 설명
200 성공입니다. 요청이 성공적으로 처리되었습니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
결과 지정된 사용자에게 지정된 서비스 카탈로그 항목에 대한 취득 권한이 있는지 여부를 나타내는 플래그입니다.
유효한 값은 다음과 같습니다.
  • true: 사용자에게 취득 권한이 있습니다.
  • false: 사용자에게 취득 권한이 없습니다.

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/5c7e9fd20f1010108af26b198b767eb8/delegation/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "result": true
  }
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/items/{sys_id}

지정된 카탈로그 항목을 조회합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}

기본 URL: /api/sn_sc/servicecatalog/items/{sys_id}

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 61. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 반환할 카탈로그 항목의 Sys_id입니다.

데이터 유형: 문자열
표 62. 쿼리 매개변수
이름 설명
sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

유효한 값은 다음과 같습니다.

  • 데스크톱
  • 모바일
  • 모두

sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

데이터 유형: 문자열
표 63. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 64. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 65. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 66. 상태 코드
상태 코드 설명
200 요청이 성공적으로 완료되었음을 나타내며 카탈로그 항목의 상세 정보를 반환합니다.
400 다음 이유 중 하나로 요청이 잘못되었음을 나타냅니다.
  • 사용자에게 카탈로그 항목에 대한 액세스 권한이 없습니다.
  • 잘못된 sys_id.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
catalogs 이 항목을 포함하는 카탈로그를 설명하는 객체의 목록입니다.

데이터 유형: 배열

"catalogs": [{
  "sys_id": "String",
  "title": "String"
}]
catalogs.sys_id 카탈로그의 Sys_id입니다.

데이터 유형: 문자열
카탈로그.제목 카탈로그 제목입니다.

데이터 유형: 문자열
범주 이 항목을 포함하는 범주를 설명하는 객체의 목록입니다.

데이터 유형: 배열

"categories": [{
  "active": Boolean,
  "category": {Object},
  "sys_id": "String",
  "title": "String"
}]
범주.활성 범주가 활성 상태인지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 범주가 활성 상태입니다.
  • false: 범주가 비활성 상태입니다.

데이터 유형: 부울
범주.범주 관련 범주에 대해 설명합니다.

데이터 유형: 객체

"category": {
  "active": Boolean,
  "sys_id": "String",
  "title": "String"
}
categories.category.active 범주가 활성 상태인지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 범주가 활성 상태입니다.
  • false: 범주가 비활성 상태입니다.

데이터 유형: 부울
categories.category.sys_id 범주의 Sys_id입니다.

데이터 유형: 문자열
범주.범주.제목 범주 제목입니다.

데이터 유형: 문자열
categories.sys_id 에 지정된 범주의 상위 범주입니다.categories.category

데이터 유형: 문자열
범주 항목이 속한 기본 범주입니다.

데이터 유형: 객체

"category": {
  "sys_id": "String",
  "title": "String"
}
category.sys_id 기본 범주의 Sys_id입니다.

데이터 유형: 문자열
범주.제목 기본 범주의 제목입니다.

데이터 유형: 문자열
client_script 카탈로그 항목에 정의된 모든 카탈로그 클라이언트 스크립트의 목록입니다.

데이터 유형: 객체

"client_script": {
  "onChange": [Array],
  "onLoad": [Array],
  "onSubmit": [Array]
}
client_script.변경 시 항목과 연결된 onChange 클라이언트 스크립트의 목록입니다.

데이터 유형: 배열
client_script.onSubmit 항목과 연결된 onSubmit 클라이언트 스크립트의 목록입니다.

데이터 유형: 배열
client_script.온로드 항목과 연결된 onLoad 클라이언트 스크립트의 목록입니다.

데이터 유형: 배열
content_type 컨텐츠의 유형입니다.

데이터 유형: 문자열
data_lookup 카탈로그 항목에 정의된 데이터 조회 목록입니다.

데이터 유형: 배열
설명 항목에 대한 자세한 설명입니다.

데이터 유형: 문자열
아이콘 항목 이름 옆에 표시되는 작은 아이콘의 소스입니다.

데이터 유형: 문자열
kb_article 항목과 연결된 지식 기반 문서입니다.

데이터 유형: 문자열
local_currency 현지 통화의 국가 통화 코드입니다.

데이터 유형: 문자열
localized_price 로 local_currency정의된 통화로 표시되는 항목의 가격입니다.

데이터 유형: 문자열
localized_recurring_price 로 정의된 local_currency통화로 표시되는 반복 수수료의 가격입니다.

데이터 유형: 문자열
이름 항목의 이름입니다.

데이터 유형: 문자열
순서 항목의 주문 수입니다.

데이터 유형: 숫자
picture 항목에 대해 표시할 이미지의 파일 이름입니다.

데이터 유형: 문자열
가격 로 price_currency정의된 통화로 표시되는 항목의 가격입니다.

데이터 유형: 문자열
price_currency 항목 가격이 표시되는 국가 통화 코드입니다.

데이터 유형: 문자열
recurring_frequency 반복되는 수수료가 적용되는 빈도입니다(예: 매일, 매월 또는 매년).

데이터 유형: 문자열
recurring_price 항목과 관련된 반복 수수료 금액

데이터 유형: 문자열
recurring_price_currency 반복 수수료를 표시하는 국가 통화 코드입니다.

데이터 유형: 문자열
short_description 항목에 대한 간략한 설명입니다.

데이터 유형: 문자열
show_price 카트에 항목 가격 책정을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 가격 책정 이름/값 쌍이 응답 매개변수에 반환됩니다.
  • false: 가격 책정 이름/값 쌍이 응답 매개변수에 반환되지 않습니다.

데이터 유형: 부울
show_quantity 카트에 항목 수량을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 항목 수량을 표시합니다.
  • false: 카트에 항목 수량을 표시하지 않습니다.

데이터 유형: 부울
sys_class_name 이 기록이 속한 테이블의 이름입니다.

데이터 유형: 문자열
sys_id 항목의 Sys_id입니다.

데이터 유형: 문자열
유형 항목의 유형입니다.

데이터 유형: 문자열
ui_policy 항목과 연결된 UI 정책의 목록입니다.

데이터 유형: 배열
URL 항목 이미지의 URL입니다.

데이터 유형: 문자열
variables 항목과 연결된 사용 가능한 변수 목록입니다.

데이터 유형: 배열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0cf7477237153000158bbfc8bcbe5dec" \
  --request GET \
  --header "Accept:application/json" \
  --user "username":"password"
{
  "result": {
    "short_description": "Apple iPad 3",
    "kb_article": "",
    "icon": "e6b3bc0647311200e0ef563dbb9a71fc.iix",
    "description": "\n\t\t\t<p>\n\t\t\t\t<font size=\"3\">\n\t\t\t\t\t<span style=\"color: gray;\">\n\t\t\t\t\t\tiPad with Retina display Wi-Fi 16GB - Black </span>\n\t\t\t\t</font>\n\t\t\t</p>\n\t\t\t<p>\n\t\t\t\t<span style=\"color: gray;\">Key Features:</span>\n\t\t\t</p>\n\t\t\t<ul><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Retina display (2048x1536 resolution)</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">16GB storage</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Wi-Fi enabled</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Built-in speaker, microphone and camera</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Up to 10 hours battery life</span>\n\t\t\t\t</li></ul>",
    "show_price": true,
    "recurring_price": "$0.00",
    "type": "catalog_item",
    "show_quantity": true,
    "local_currency": "USD",
    "sys_class_name": "pc_hardware_cat_item",
    "picture": "5b977690cb921200f2de77a4634c9c6a.iix",
    "url": "",
    "sys_id": "060f3afa3731300054b6a3549dbe5d3e",
    "recurring_price_currency": "USD",
    "content_type": "",
    "localized_price": "$600.00",
    "price": "$600.00",
    "catalogs": [
      {
        "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
      }
    ],
    "recurring_frequency": null,
    "name": "Apple iPad 3",
    "localized_recurring_price": "$0.00",
    "category": {
      "sys_id": "b06546f23731300054b6a3549dbe5dd8",
      "title": "Tablets"
    },
    "price_currency": "USD",
    "order": 0,
    "categories": [
      {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "active": true,
        "category": {
          "sys_id": "b06546f23731300054b6a3549dbe5dd8",
          "active": true,
          "title": "Tablets"
        },
        "title": "Hardware"
      }
    ],
    "variables": [],
    "ui_policy": [],
    "client_script": {
      "onChange": [],
      "onSubmit": [],
      "onLoad": []
    },
    "data_lookup": []
  }
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/wishlist

로그인한 사용자의 희망 목록에 있는 항목 목록을 검색합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/wishlist

기본 URL: /api/sn_sc/servicecatalog/wishlist

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 67. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
표 68. 쿼리 매개변수
이름 설명
안 함
표 69. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 70. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 71. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 72. 상태 코드
상태 코드 설명
200 성공입니다. 요청이 성공적으로 처리되었습니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
cart_id 희망 목록 카트의 Sys_id입니다.

데이터 유형: 문자열
항목 희망 목록 카트에 있는 항목을 설명하는 객체의 목록입니다.

데이터 유형: 배열

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created_by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_descriptions": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
items.cart_item_id 항목의 Sys_id입니다. 와 items.sys_id같습니다.

데이터 유형: 문자열
items.catalog_item_id 희망 목록 카트에 있는 이 항목의 카탈로그 식별자 Sys_id입니다. 와 items.item_id같습니다.

데이터 유형: 문자열
items.created_by 처음에 희망 목록 카트에 항목을 넣은 사용자입니다.

데이터 유형: 문자열
items.created_on 항목을 처음 카트에 넣은 날짜와 시간입니다.

데이터 유형: 문자열
items.delivery_time 항목 제공에 소요되는 시간입니다.

데이터 유형: 문자열
items.item_id 희망 목록 카트(sys_id)에 있는 이 항목의 고유 카탈로그 식별자입니다. items.catalog_item_id와 동일합니다.

데이터 유형: 문자열
items.item_name 항목의 이름입니다.

데이터 유형: 문자열
items.localized_price 현지 통화로 표시되는 항목의 가격입니다.

데이터 유형: 문자열
items.localized_recurring_price 현지 통화로 표현된 반복 수수료의 가격입니다.

데이터 유형: 문자열
items.name 항목의 이름입니다.

데이터 유형: 문자열
items.order_guide 항목이 연결된 주문 가이드입니다.

데이터 유형: 문자열
항목.그림 항목에 대해 표시할 이미지의 경로입니다.

데이터 유형: 문자열
항목.가격 항목의 가격입니다.

데이터 유형: 문자열
항목.수량 희망 목록 카트에 있는 이 항목의 번호입니다.

데이터 유형: 문자열
items.recurring_frequency 반복되는 수수료가 적용되는 빈도입니다(예: 매일, 매월 또는 매년). 이 항목에 대한 반복 수수료가 없는 경우 Null입니다.

데이터 유형: 문자열
items.recurring_price 항목과 연결된 반복 수수료의 금액입니다.

데이터 유형: 문자열
items.recurring_subtotal 이 항목의 반복 수수료에 대한 소계(recurring_price x 수량)입니다.

데이터 유형: 숫자
items.recurring_subtotal_price 이 항목의 반복 수수료에 대한 소계(recurring_price x 수량)입니다.

데이터 유형: 문자열
items.short_description 항목에 대한 간략한 설명입니다.

데이터 유형: 문자열
items.show_price 카트에 항목 가격 책정을 표시할지 여부를 나타내는 플래그입니다. 이 매개 변수를 "false"로 설정하면 가격 책정 이름/값 쌍이 응답 매개 변수에 반환되지 않습니다.

데이터 유형: 부울
items.show_quantity 카트에 항목 수량을 표시할지 여부를 나타내는 플래그입니다.

데이터 유형: 부울
items.show_recurring_price 카트에 반복 수수료를 표시할지 여부를 나타내는 플래그입니다.

데이터 유형: 부울
항목.소계 이 항목의 소계 - 센트(가격 x 수량)는 포함하지 않습니다.

데이터 유형: 숫자
items.subtotal_price 센트(가격 x 수량) 포함 이 항목의 소계입니다.

데이터 유형: 문자열
items.sys_클래스_이름 연결된 항목 기록이 속한 하위 클래스입니다.

데이터 유형: 문자열
items.sys_id 항목의 고유 식별자(sys_id)입니다. items.cart_item_id와 동일합니다.

데이터 유형: 문자열
items.updated_by 희망 목록 카트에서 이 항목을 업데이트한 사용자입니다.

데이터 유형: 문자열
items.updated_on 항목을 희망 목록에 추가한 날짜 및 시간입니다.

데이터 유형: 문자열
항목.변수 항목과 연결된 변수의 이름-값 쌍입니다.

데이터 유형: 객체

cURL 요청

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
{
  "result": {
    "cart_id": "3a68c46013f12300027879d96144b0ce",
    "items": [
      {
        "updated_on": "2018-11-16 05:54:41",
        "catalog_item_id": "774906834fbb4200086eeed18110c737",
        "short_description": "Macbook Pro",
        "recurring_subtotal_price": "$100.00",
        "delivery_time": "5 Days 0 seconds",
        "sys_class_name": "sc_cat_item",
        "sys_id": "3b8d887113b5a300027879d96144b0c2",
        "price": "$1,499.00",
        "recurring_frequency": "Annually",
        "subtotal_price": "$1,499.00",
        "variables": {
          "Adobe Photoshop": "false",
          "Adobe Acrobat": "false",
          "Optional Software": "true",
          "Additional software requirements": "",
          "Eclipse IDE": "true"
        },
        "quantity": "1",
        "item_id": "774906834fbb4200086eeed18110c737",
        "recurring_price": "$100.00",
        "show_price": true,
        "item_name": "Developer Laptop (Mac)",
        "cart_item_id": "3b8d887113b5a300027879d96144b0c2",
        "recurring_subtotal": 100,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "4e4efd444f889200086eeed18110c7e6.iix",
        "created_on": "2018-11-16 05:54:41",
        "localized_price": "$1,499.00",
        "subtotal": 1499,
        "show_recurring_price": true,
        "name": "Developer Laptop (Mac)",
        "updated_by": "admin",
        "localized_recurring_price": "$100.00",
        "order_guide": ""
      }
    ]
  }
}

서비스 카탈로그 - GET /sn_sc/servicecatalog/wishlist/{cart_item_id}

희망 목록 카트에 저장된 지정된 항목의 상세 정보를 검색합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/v1/servicecatalog/wishlist/{cart_item_id}

기본 URL: /api/sn_sc/servicecatalog/wishlist/{cart_item_id}

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 73. 경로 매개변수
이름 설명
cart_item_id 검색할 희망 목록 카트 항목의 Sys_id입니다.

데이터 유형: 문자열
표 74. 쿼리 매개변수
이름 설명
안 함
표 75. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 76. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 77. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 78. 상태 코드
상태 코드 설명
200 성공입니다. 요청이 성공적으로 처리되었습니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404 실패한 요청을 나타냅니다. 카트 항목 ID가 잘못되었거나 항목이 희망 목록 카트에 없습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
cart_item_id 항목의 Sys_id입니다.

데이터 유형: 문자열
catalog_item_id 희망 목록 카트에 있는 이 항목의 카탈로그 식별자 Sys_id입니다.

데이터 유형: 문자열
delivery_time 항목 제공에 소요되는 시간입니다.

데이터 유형: 문자열
item_name 항목의 이름입니다.

데이터 유형: 문자열
localized_price 현지 통화로 표시되는 항목의 가격입니다.

데이터 유형: 문자열
localized_recurring_price 현지 통화로 표현된 반복 수수료의 가격입니다.

데이터 유형: 문자열
가격 항목의 가격입니다.

데이터 유형: 문자열
수량 희망 목록 카트에 있는 이 항목의 번호입니다.

데이터 유형: 문자열
recurring_frequency 반복되는 수수료가 적용되는 빈도입니다(예: 매일, 매월 또는 매년). 이 항목에 대한 반복 수수료가 없는 경우 Null입니다.

데이터 유형: 문자열
recurring_price 항목과 연결된 반복 수수료의 금액입니다.

데이터 유형: 문자열
variables 항목과 연결된 변수의 이름-값 쌍입니다.

데이터 유형: 객체

cURL 요청

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist/774906834fbb4200086eeed18110c737" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
    "variables": {
      "Adobe Photoshop": "",
      "Adobe Acrobat": "",
      "Optional Software": "",
      "Additional software requirements": ""
    },
    "quantity": "1",
    "localized_price": "$1,100.00",
    "price": "$1,100.00",
    "recurring_frequency": "Annually",
    "localized_recurring_price": "$100.00",
    "recurring_price": "$100.00",
    "item_name": "Standard Laptop &",
    "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
    "delivery_time": "5 Days"
  }
}

서비스 카탈로그 - POST /sn_sc/servicecatalog/cart/checkout

2단계 체크아웃 프로세스를 사용할 수 있는지 여부에 따라 현재 카트에 대한 체크아웃을 조회하고 처리합니다.

한 단계 체크 아웃인 경우 메서드는 카트를 체크 아웃(저장)하고 요청 번호와 요청 주문 ID를 반환합니다. 2단계 체크아웃인 경우 메서드는 카트 주문 상태와 2단계 체크아웃에 필요한 모든 정보를 반환합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/cart/checkout

기본 URL: /api/sn_sc/servicecatalog/cart/checkout

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 79. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
표 80. 쿼리 매개변수
이름 설명
안 함
표 81. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 82. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 83. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 84. 상태 코드
상태 코드 설명
200 요청이 성공적으로 완료되었음을 나타냅니다. 카트에 있는 항목에 대한 전체 및 소계 정보와 정보를 반환합니다.

한 단계 체크 아웃인 경우 메서드는 카트를 체크 아웃(저장)하고 요청 번호와 요청 주문 ID를 반환합니다. 2단계 체크아웃인 경우 메서드는 카트 주문 상태와 2단계 체크아웃에 필요한 모든 정보를 반환합니다.
400 카트가 비어 있으며 체크 아웃할 수 없음을 나타냅니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

매개변수 설명
cart_id 카트의 Sys_id입니다.

데이터 유형: 문자열
delivery_address 카트 항목을 배달할 주소입니다.

데이터 유형: 문자열
<recurring_frequency> 특정 반복 빈도가 있는 카트 항목 목록입니다. 가능한 값은 다음과 같습니다.
  • 매일
  • 월별
  • 매년
  • 없음(반복 수수료 없음)

데이터 유형: 객체

"<recurring_frequency>": {
  "frequency_label": "String",
  "items": [Array],
  "show_subtotal_price": "String",
  "subtotal_price": "String",
  "subtotal_recurring_frequency": "String",
  "subtotal_recurring_price": "String",
  "subtotal_title": "String",
  "total_title": "String"
}
<recurring_frequency>.frequency_label 연결된 반복 수수료의 빈도입니다. 항목에 대한 반복되는 수수료가 없는 경우 이 매개변수에는 "null"이 포함됩니다.

데이터 유형: 문자열
<recurring_frequency>.항목 지정된 반복 빈도 범주와 연결된 각 항목의 상세 정보를 포함하는 객체의 배열입니다.

데이터 유형: 배열

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created.by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_description": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
<recurring_frequency>.items.cart_item_id 이 카트에 있는 항목의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.catalog_item_id 항목의 카탈로그 sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.created.by 처음에 카트에 항목을 넣은 사용자입니다.

데이터 유형: 문자열
<recurring_frequency>.items.created_on 항목이 처음 카트에 담겨진 날짜입니다.

데이터 유형: 문자열
<recurring_frequency>.items.delivery_time 지정된 항목을 배달하는 데 걸리는 시간입니다.

데이터 유형: 문자열
<recurring_frequency>.items.item_id 항목의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.item_name 지정된 항목의 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.localized_price 현지 통화로 표기한 항목의 가격입니다.

데이터 유형: 문자열
<recurring_frequency>.items.localized_recurring_price 지정된 항목에 대해 현지 통화로 나타낸 반복 수수료입니다.

데이터 유형: 문자열
<recurring_frequency>.items.name 항목 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.order_guide 이 항목이 연결된 주문 가이드의 이름입니다. 이 항목이 주문 가이드와 연결되어 있지 않으면 이 매개변수에 빈 문자열이 포함됩니다.

데이터 유형: 문자열
<recurring_frequency>.items.picture 항목 그림의 파일 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.품목.가격 항목의 가격입니다.

데이터 유형: 문자열
<recurring_frequency>.items.quantity 카트에 있는 지정된 항목의 번호입니다.

데이터 유형: 문자열
<recurring_frequency>.items.recurring_frequency 지정된 항목에 대해 반복 수수료가 청구되는 빈도입니다. 항목에 대한 반복되는 수수료가 없는 경우 이 매개변수에는 "null"이 포함됩니다.

데이터 유형: 문자열
<recurring_frequency>.items.recurring_price 지정된 항목에 대한 반복 수수료입니다.

데이터 유형: 문자열
<recurring_frequency>.items.recurring_subtotal 항목에 대한 반복 수수료의 소계입니다(recurring_price x quantity).

데이터 유형: 숫자
<recurring_frequency>.items.recurring_subtotal_price 항목에 대한 반복 수수료의 소계입니다.

데이터 유형: 문자열
<recurring_frequency>.items.short_description 항목에 대한 간단한 설명입니다.

데이터 유형: 문자열
<recurring_frequency>.items.show_price 항목의 가격이 카트에 표시되는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 장바구니에 있는 항목의 가격을 표시합니다.
  • false: 장바구니에 있는 항목의 가격을 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.items.show_quantity 카트에 항목 수량을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 항목 수량을 표시합니다.
  • false: 카트에 항목 수량을 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.items.show_recurring_price 반복 수수료를 카트에 표시해야 하는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 반복 수수료를 표시합니다.
  • false: 카트에 반복 수수료를 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.items.subtotal 항목의 소계 수입니다.

데이터 유형: 숫자
<recurring_frequency>.items.subtotal_price 항목의 소계(price x quantity).

데이터 유형: 문자열
<recurring_frequency>.items.sys_클래스_이름 항목의 시스템 분류 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.sys_id 항목 기록의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.updated_by 항목을 처음 카트에 넣은 후 업데이트한 사용자입니다.

데이터 유형: 문자열
<recurring_frequency>.items.updated_on 항목을 처음 카트에 넣거나 업데이트한 마지막 날짜/시간입니다.

데이터 유형: 문자열
<recurring_frequency>.items.variables 항목 변수의 이름-값 쌍 목록입니다.

데이터 유형: 객체
<recurring_frequency>.show_subtotal_price 연결된 반복 수수료 범주에 대한 소계를 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 부분합을 표시합니다.
  • false: 카트에 부분합을 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.subtotal_price 연결된 반복 빈도 범주에 대한 모든 항목의 비용 소계입니다.

데이터 유형: 문자열
<recurring_frequency>.subtotal_recurring_frequency 반복되는 빈도의 소계 유형(예: 매일, 매월 등) 와 subtotal_recurring_frequency같습니다.

데이터 유형: 문자열
<recurring_frequency>.subtotal_recurring_price 연결된 반복 빈도 범주 내 항목의 반복 수수료 소계입니다.

데이터 유형: 문자열
<recurring_frequency>.subtotal_title the show_subtotal_price 가 true로 설정된 경우 연결된 자막의 카트에 표시할 텍스트입니다.

데이터 유형: 문자열
<recurring_frequency>.total_title 연결된 반복 빈도 범주의 총 제목에 대해 표시할 텍스트입니다.

데이터 유형: 문자열
requested_for 항목을 주문한 사용자의 Sys_id입니다.

데이터 유형: 문자열
requested_for_user 다른 사람을 대신하여 항목을 요청한 사용자입니다.

데이터 유형: 문자열
show_subtotal_price 카트에 소계 가격을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 부분합을 표시합니다.
  • false: 카트에 부분합을 표시하지 않습니다.

데이터 유형: 문자열
special_instructions 항목에 대해 고객이 제공한 모든 지침입니다.

데이터 유형: 문자열
subtotal_price 카트에 있는 모든 항목의 소계(전체 달러)입니다.

데이터 유형: 문자열
subtotal_recurring_frequency 반복되는 빈도의 소계 유형(예: 매일, 매월 등) 와 <recurring_frequency>.subtotal_recurring_frequency같습니다.

데이터 유형: 문자열
subtotal_recurring_price 카트에 있는 모든 항목에 대한 반복 빈도 수수료의 소계입니다.

데이터 유형: 문자열
subtotal_title 소계 필드 제목에 대해 카트에 표시할 텍스트입니다.

데이터 유형: 문자열
total_title 총계 필드 제목에 대해 카트에 표시할 텍스트입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/checkout" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "delivery_address": "",
    "special_instructions": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "requested_for_user": "System Administrator",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:34:15",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "requested_for": "6816f79cc0a8016401c5a33be04be441",
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

서비스 카탈로그 - POST /sn_sc/servicecatalog/cart/submit_order

현재 체크아웃 유형(1단계 또는 2단계)을 기준으로 사용자 카트를 체크아웃합니다.

한 단계 체크 아웃인 경우 메서드는 카트를 체크 아웃(저장)하고 요청 번호와 요청 주문 ID를 반환합니다. 2단계 체크아웃인 경우 메서드는 카트 주문 상태와 2단계 체크아웃에 필요한 모든 정보를 반환합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/cart/submit_order

기본 URL: /api/sn_sc/servicecatalog/cart/submit_order

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 85. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
표 86. 쿼리 매개변수
이름 설명
안 함
표 87. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 88. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 89. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 90. 상태 코드
상태 코드 설명
200 요청이 성공적으로 완료되었고 카트에 있는 항목이 성공적으로 체크아웃되었음을 나타냅니다.

한 단계 체크 아웃인 경우 메서드는 카트를 체크 아웃(저장)하고 요청 번호와 요청 주문 ID를 반환합니다. 2단계 체크아웃인 경우 메서드는 카트 주문 상태와 2단계 체크아웃에 필요한 모든 정보를 반환합니다.
400 사용자 카트가 비어 있음을 나타냅니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
parent_id 사용 가능한 경우 요청이 생성된 상위 기록의 sys_id입니다. 자세한 내용은 요청에 대한 상위 매핑 구성을 참조하세요.

데이터 유형: 문자열
parent_table 상위 테이블의 이름입니다.

데이터 유형: 문자열
request_id 생성된 주문 요청의 Sys_id입니다.

데이터 유형: 문자열
request_number 생성된 요청의 수입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com /api/sn_sc/v1/servicecatalog/cart/submit_order " \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "request_number": "REQ0010010",
    "request_id": "f89ed597db21120064301150f0b8f5ff"
  }
}

서비스 카탈로그 - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart

지정된 항목을 현재 사용자의 카트에 추가합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_cart

기본 URL: /api/sn_sc/servicecatalog/items/{sys_id}/add_to_cart

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 91. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 현재 카트에 추가할 항목의 Sys_id입니다.

데이터 유형: 문자열
표 92. 쿼리 매개변수
이름 설명
안 함
표 93. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
sysparm_also_request_for 지정된 항목을 주문할 다른 사용자의 쉼표로 구분된 사용자 sys_ids 문자열입니다.
  • 항목을 받을 추가 사용자를 50명 이상 지정할 수 없습니다.
  • 목록에 있는 사람이 해당 항목에 적합하지 않은 경우 전체 요청이 거부됩니다.
  • 연결된 항목에 변수 세트가 없는 requested_for 경우 요청이 거부됩니다.
  • 연결된 항목에 requested_for 변수 세트가 있지만 변수에 대한 요청 또한 사용이 구성되지 않았거나 호출하는 사용자에게 적절한 역할이 없는 경우 요청이 거부됩니다.

테이블: 사용자 [sys_user]
sysparm_quantity 필수 항목의 수량입니다. 음수일 수 없습니다.

데이터 유형: 숫자
sysparm_requested_for 지정된 항목을 주문할 사용자의 Sys_id입니다.

데이터 유형: 문자열

테이블: 사용자 [sys_user]
variables 모든 필수 카트 항목 변수의 이름-값 쌍입니다. 필수 변수는 연결된 양식에 정의되어 있습니다.

데이터 유형: 문자열

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 94. 요청 헤더
헤더 설명
안 함
표 95. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 96. 상태 코드
상태 코드 설명
200 성공입니다. 요청이 성공적으로 처리되었습니다.
400 다음과 같은 오류가 발생할 수 있습니다.
  • 잘못된 수량 값: 매개변수가 sysparm_quantity 제공되지 않았거나 잘못된 값을 포함했음을 나타냅니다.
  • 보안 제약 조건으로 인해 항목을 주문할 수 없음: 경로 매개변수에 지정된 카트 항목 sys_id 잘못되었거나 사용자에게 항목에 대한 액세스 권한이 없음을 나타냅니다.
  • 필수 변수는 필수입니다: 하나 이상의 필수 변수가 요청에 제공되지 않았음을 나타냅니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
cart_id 카트 sys_id

데이터 유형: 문자열
항목 카트에 있는 모든 항목에 대한 상세 정보입니다.

데이터 유형: 배열

"items":[
  {
    "cart_item_id":"String",
    "catalog_item_id":"String",
    "item_name":"String",
    "localized_recurring_price":"String",
    "localized_price":"String",
    "price":"String",
    "quantity":"String",
    "recurring_frequency":"String",
    "recurring_price":"String"
  }
]
items.cart_item_id 항목의 Sys_id입니다.

데이터 유형: 문자열
items.catalog_item_id 항목의 카탈로그 sys_id입니다.

데이터 유형: 문자열
items.item_name 항목의 이름입니다.

데이터 유형: 문자열
items.localized_price 항목의 가격(사용자의 현지 통화)입니다.

데이터 유형: 문자열
items.localized_recurring_price 항목의 반복되는 가격(사용자의 현지 통화)입니다.

데이터 유형: 문자열
항목.가격 기본 가격입니다.

데이터 유형: 문자열
항목.수량 카트에 있는 항목의 수량입니다.

데이터 유형: 문자열
items.recurring_frequency 반복되는 가격이 적용되는 빈도입니다.

데이터 유형: 문자열
items.recurring_price 반복되는 가격입니다.

데이터 유형: 문자열
소계 카트에 있는 항목의 소계입니다.

데이터 유형: 문자열

샘플 cURL 요청 및 응답

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0d08837237153000158bbfc8bcbe5d02/add_to_cart" \
--request POST \
--header "Accept:application/json" \
--data "{ 'sysparm_quantity' : '1',
  'variables' : {
    'acrobat' : 'true'
  }
}" \
--user "username":"password"
{
  "result": {
    "cart_id": "0951c597db21120064301150f0b8f5cf",
    "subtotal": "$1,599.98",
    "items": [
      {
        "catalog_item_id": "0d08837237153000158bbfc8bcbe5d02",
        "quantity": "1",
        "localized_price": "$799.99",
        "price": "$799.99",
        "recurring_frequency": "Monthly",
        "localized_recurring_price": "$30.00",
        "recurring_price": "$29.00",
        "item_name": "Apple iPhone 5",
        "cart_item_id": "ac61c597db21120064301150f0b8f5f9"
      }
    ]
  }
}

서비스 카탈로그 - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_wishlist

지정된 항목을 희망 목록 카트에 추가합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_wishlist

기본 URL: /api/sn_sc/ servicecatalog/items/{sys_id}/add_to_wishlist

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 97. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 희망 목록에 추가할 항목의 Sys_id입니다.

데이터 유형: 문자열
표 98. 쿼리 매개변수
이름 설명
안 함
표 99. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 100. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 101. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 102. 상태 코드
상태 코드 설명
200 성공입니다. 요청이 성공적으로 처리되었습니다.
400 실패한 요청을 나타냅니다. 잘못된 요청 데이터이거나 사용자가 희망 목록에 항목을 추가할 수 없습니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
안 함

cURL 요청

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/add_to_wishlist" \
 --request POST \
 --header "Accept:application/json" \
 --header "Content-Type:application/json" \
 --data "{\"sysparm_quantity\":\"1\"}" \
 --user "username":"password"
{
  "result": {
    "cart_id": "02a559a7c3b02200d68d3b0ac3d3ae5d",
    "items": [
      {
        "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
        "variables": {
          "Adobe Photoshop": "",
          "Adobe Acrobat": "",
          "Optional Software": "",
          "Additional software requirements": ""
        },
        "quantity": "1",
        "localized_price": "$1,100.00",
        "price": "$1,100.00",
        "recurring_frequency": "Annually",
        "localized_recurring_price": "$100.00",
        "recurring_price": "$100.00",
        "item_name": "Standard Laptop &",
        "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
        "delivery_time": "5 Days"
      }
    ]
  }
}

서비스 카탈로그 - POST /sn_sc/servicecatalog/items/{sys_id}/checkout_guide

체크 아웃을 위해 요청된 컨텐츠의 배열을 검색합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/checkout_guide

기본 URL: /api/sn_sc/servicecatalog/items/{sys_id}/checkout_guide

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 103. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 정보를 반환할 체크 아웃 가이드의 Sys_id입니다.

데이터 유형: 문자열
표 104. 쿼리 매개변수
이름 설명
안 함
표 105. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
항목 체크 아웃을 위해 요청된 항목을 설명하는 객체의 목록입니다.
데이터 유형: 배열
"items": [{
  "sys_id": "String",
  "sysparm_quantity": "String",
  "variables": {Object}
}]
items.sys_id 필수 카탈로그 항목의 Sys_id입니다.

데이터 유형: 문자열
items.sysparm_quantity 항목 수입니다.

데이터 유형: 문자열

기본값: 1
항목.변수 항목과 연결된 변수의 이름-값 쌍입니다.

데이터 유형: 객체

기본값: 변수 없음

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 106. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 107. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 108. 상태 코드
상태 코드 설명
200 요청이 성공적으로 완료되었음을 나타냅니다.
  • 2단계가 아님: 항목이 카트에 추가되고 카트 내용이 반환됩니다.
  • 2단계: 체크아웃 후 요청 번호와 요청 sys_id 반환합니다.
400 요청이 잘못되었음을 나타냅니다. 다음 이유 중 하나가 원인일 수 있습니다.
  • 보낸 항목이 하나 이상 없습니다.
  • 사용자는 하나 이상의 항목에 접근할 수 없습니다.
  • 하나 이상의 필수 변수에 답변되지 않았습니다. (필수로 정의된 변수만 적용됩니다.)
  • 수량 값이 전송되었으며 양의 정수가 아닙니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

표 109. 2단계 체크아웃이 아니오일 때 응답 본문에 반환되는 요소
이름 설명
cart_id 카트의 Sys_id입니다.

데이터 유형: 문자열
항목 카트에 있는 모든 항목의 상세 정보를 포함하는 객체의 목록입니다.

데이터 유형: 배열

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "delivery_time": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "variables": {Object}
}]
items.cart_item_id 카트에 있는 항목의 Sys_id입니다.

데이터 유형: 문자열
items.catalog_item_id 카트에 있는 카탈로그 항목의 Sys_id입니다.

데이터 유형: 문자열
items.delivery_time 항목을 제공하는 데 걸리는 시간입니다.

데이터 유형: 문자열
items.item_name 카트에 있는 항목의 이름입니다.

데이터 유형: 문자열
items.localized_price 현지 통화로 표기한 항목의 가격입니다.

데이터 유형: 문자열
items.localized_recurring_price 현지 통화로 표기된 항목의 반복되는 가격입니다.

데이터 유형: 문자열
항목.가격 항목의 가격입니다.

데이터 유형: 문자열
항목.수량 카트에 있는 항목의 번호입니다.

데이터 유형: 문자열
items.recurring_frequency 항목의 되풀이 빈도입니다.

데이터 유형: 문자열
items.recurring_price 항목의 반복되는 가격입니다.

데이터 유형: 문자열
항목.변수 카트에 있는 항목과 연결된 이름-값 쌍입니다.

데이터 유형: 객체
parent_id 사용 가능한 경우 요청이 생성된 상위 기록의 sys_id입니다. 자세한 내용은 요청에 대한 상위 매핑 구성을 참조하세요.

데이터 유형: 문자열
parent_table 상위 테이블의 이름입니다(대/소문자 구분).

데이터 유형: 문자열
request_number 요청 기록 번호입니다.

데이터 유형: 문자열
request_id 요청의 Sys_id입니다.

데이터 유형: 문자열
subtotal_price 카트 소계입니다.

데이터 유형: 문자열
subtotal_price 현재 주파수 블록의 소계입니다.

데이터 유형: 문자열
subtotal_recurring_frequency 카트의 되풀이 빈도 소계입니다.

데이터 유형: 문자열
subtotal_recurring_frequency 현재 주파수 블록의 반복 빈도 소계입니다.

데이터 유형: 문자열
subtotal_recurring_price 카트의 반복되는 가격 소계입니다.

데이터 유형: 문자열
subtotal_recurring_price 현재 빈도 블록의 반복되는 가격 소계

데이터 유형: 문자열
total_title 페이지의 총 필드에 대한 제목입니다.

데이터 유형: 문자열
total_title 현재 주파수 블록의 총계 필드에 대한 제목입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/checkout_guide" \
--request POST \
--header "Accept:application/json"  \
--header "Content-Type:application/json" \
--data "{\"items\":[{
  \"sys_id\":\"04b7e94b4f7b4200086eeed18110c7fd\",
  \"variables\":{
    \"acrobat\":\"true\",
    \"Additional_software_requirements\":\"MS Office 2007\"
  },
  \"sysparm_quantity\":\"3\"
},
{
  \"sys_id\":\"e1be6dcb4f7b4200086eeed18110c74c\"
},
{
  \"sys_id\":\"186d917a6fab7980575967ddbb3ee4f2\",
  \"variables\":{
    \"new_email\":\"abel.tuter@example.com\"
  }
},
{
  \"sys_id\":\"8b3ae7fedc1be1004ece5c08239e522b\"
},
{
  \"sys_id\":\"962967674ff38200086eeed18110c7e7\",
  \"variables\":{
    \"ergonomic_office\":\"Office chair should have lumbar support\"
  }
}]}" \
--user "username":"password"
<!--Case-1: if two-step is false:-->
{
  "result": {
    "cart_id": "0d8c7a32c3211200d68d3b0ac3d3aeba",
    "subtotal_price": "$3,350.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$300.00",
    "total_title": "Total",
    "monthly": {
      "subtotal_price": "$50.00",
      "subtotal_recurring_frequency": "Monthly",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "90af095bcd38798071a208d710d1b64f",
          "variables": {},
          "quantity": "1",
          "localized_price": "$50.00",
          "price": "$50.00",
          "recurring_frequency": "Monthly",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Belkin iPad Mini Case",
          "cart_item_id": "cb6e485fc3211200d68d3b0ac3d3ae35",
          "delivery_time": "2 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "none": {
      "subtotal_price": "-",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "186d917a6fab7980575967ddbb3ee4f2",
          "variables": {
            "Preferred Email address": "abel.tuter@example.com"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "New Email Account",
          "cart_item_id": "17c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "global.Workflow"
        },
        {
          "catalog_item_id": "8b3ae7fedc1be1004ece5c08239e522b",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Corp VPN",
          "cart_item_id": "97c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "e1be6dcb4f7b4200086eeed18110c74c",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "External Monitor",
          "cart_item_id": "d3c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "962967674ff38200086eeed18110c7e7",
          "variables": {
            "Please describe any ergonomic requirements\n\t\t": "Office chair should have lumbar support"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Desk Set Up",
          "cart_item_id": "d7c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "false",
      "subtotal_title": "Subtotal"
    },
    "yearly": {
      "subtotal_price": "$3,300.00",
      "subtotal_recurring_frequency": "Annually",
      "subtotal_recurring_price": "$300.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
          "variables": {
            "Adobe Photoshop": "",
            "Adobe Acrobat": "true",
            "Optional Software": "",
            "Additional software requirements": "MS Office 2007"
          },
          "quantity": "3",
          "localized_price": "$1,100.00",
          "price": "$1,100.00",
          "recurring_frequency": "Annually",
          "localized_recurring_price": "$100.00",
          "recurring_price": "$100.00",
          "item_name": "Standard Laptop",
          "cart_item_id": "9fc5241fc3211200d68d3b0ac3d3ae7e",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Case-2: if two-step is true:
{
  "result": {
    "request_number": "REQ0010001",
    "request_id": "82a7e89fc3211200d68d3b0ac3d3ae0a"
  }
}

서비스 카탈로그 - POST /sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

지정된 항목에 대한 요청을 위임할 수 없는 사용자 목록을 반환합니다(다른 사용자가 요청).

다른 사람을 대신하여 서비스 카탈로그 항목을 요청할 수 있는 서비스 카탈로그 API - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart 또는 서비스 카탈로그 API - POST /sn_sc/servicecatalog/items/{sys_id}/order_now 와 같은 엔드포인트를 호출하기 전에 이 엔드포인트를 호출할 수 있습니다. 연결된 항목에 대한 권한이 부여되지 않은 사용자를 전달하면 이러한 호출이 실패합니다. 이 엔드포인트를 사용하면 항목을 주문하거나 카트에 항목을 추가하려고 하는 엔드포인트를 호출하기 전에 사용자 목록을 확인할 수 있습니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

기본 URL: /api/sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 110. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
item_sys_id 지정된 사용자에게 취득 권한이 있는지 확인하기 위한 서비스 카탈로그 항목의 Sys_id입니다.

데이터 유형: 문자열

테이블: Service Catalog [sc_catalog]
표 111. 쿼리 매개변수
이름 설명
안 함
표 112. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
sysparm_also_request_for 유효한 사용자 sys_ids의 쉼표로 구분된 문자열입니다. 엔드포인트는 이러한 사용자에게 지정된 서비스 카탈로그 항목에 대한 취득 권한이 있는지 확인합니다.

데이터 유형: 문자열

테이블: 사용자 [sys_users]

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 113. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 114. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 115. 상태 코드
상태 코드 설명
200 성공입니다. 요청이 성공적으로 처리되었습니다.
400 요청에 실패했습니다. 처리를 위해 잘못된 요청이 제공되었습니다. 오류에 대한 자세한 내용은 반환 결과의 메시지를 참조하십시오.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
errCode 오류와 관련된 번호입니다. 엔드포인트가 실패한 경우에만 반환됩니다.

데이터 유형: 문자열
errMsg 엔드포인트가 실패했을 때 발생한 오류에 대한 설명입니다.
잘못된 사용자 지정된 카탈로그 항목을 요청할 수 없는 사용자의 이름입니다.

데이터 유형: 배열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"

{
  "result": {
    "invalidUsers": [
      "Abel Tuter"
    ]
  }
}

cURL 요청

curl "https://instance.servicenow.com /api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"
{
  "result": {
    "errCode": "42202",
    "errMsg": "This item cannot be submitted for multiple people as it is not configured with Requested For"
  }
}

서비스 카탈로그 - POST /sn_sc/servicecatalog/items/{sys_id}/order_now

지정된 카탈로그 항목을 주문합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/order_now

기본 URL: /api/sn_sc/servicecatalog/items/{sys_id}/order_now

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 116. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 서비스 카탈로그 항목의 Sys_id입니다.

데이터 유형: 문자열

테이블: 카탈로그 항목 [sc_cat_item]
표 117. 쿼리 매개변수
이름 설명
안 함
표 118. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
sysparm_also_request_for 지정된 항목을 주문할 다른 사용자의 쉼표로 구분된 사용자 sys_ids 문자열입니다.
  • 항목을 받을 추가 사용자를 50명 이상 지정할 수 없습니다.
  • 목록에 있는 사람이 해당 항목에 적합하지 않은 경우 전체 요청이 거부됩니다.
  • 연결된 항목에 변수 세트가 없는 requested_for 경우 요청이 거부됩니다.
  • 연결된 항목에 requested_for 변수 세트가 있지만 변수에 대한 요청 또한 사용이 구성되지 않았거나 호출하는 사용자에게 적절한 역할이 없는 경우 요청이 거부됩니다.

테이블: 사용자 [sys_user]
sysparm_quantity 필수 항목의 수량입니다. 음수일 수 없습니다.

데이터 유형: 숫자
sysparm_requested_for 지정된 항목을 주문할 사용자의 Sys_id입니다.
and glide.sc.req_for.roles.default 속성의 설정에 glide.sc.req_for.roles 따라 사용자가 항목을 요청할 수 있는 수준이 결정됩니다.
  • 속성에 값이 지정된 glide.sc.req_for.roles 경우 시스템은 사용자에게 다른 사용자의 정보를 요청할 수 있는 지정된 역할이 있는지 확인합니다.
  • glide.sc.req_for.roles 속성 값이 비어 있고 glide.sc.req_for.roles.default 속성 값이 거부인 경우 사용자가 다른 사용자에 대한 항목을 요청할 수 없습니다.
  • glide.sc.req_for.roles 속성 값이 비어 있고 glide.sc.req_for.roles.default 속성 값이 허용인 경우 모든 사용자가 다른 사용자에 대한 항목을 요청할 수 있습니다.

데이터 유형: 문자열
variables 모든 필수 카트 항목 변수의 이름-값 쌍입니다. 필수 변수는 연결된 양식에 정의되어 있습니다.

데이터 유형: 문자열

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 119. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 120. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 121. 상태 코드
상태 코드 설명
200 성공입니다. 요청이 성공적으로 처리되었습니다.
400 수량 값이 잘못되어 요청이 접수되지 않았음을 나타냅니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
번호 생성된 요청의 번호입니다.

데이터 유형: 문자열
parent_id 사용 가능한 경우 요청이 생성된 상위 기록의 sys_id입니다. 자세한 내용은 요청에 대한 상위 매핑 구성을 참조하세요.

데이터 유형: 문자열
parent_table 사용 가능한 경우, 요청이 생성된 상위 테이블의 이름입니다.

데이터 유형: 문자열
request_id 주문 요청의 Sys_id입니다.

데이터 유형: 문자열
request_number 요청 번호입니다.

데이터 유형: 문자열
sys_id 주문의 Sys_id입니다.

데이터 유형: 문자열
테이블 요청의 테이블 이름입니다.

데이터 유형: 문자열

샘플 cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/d82ea08510247200964f77ffeec6c4ee/order_now" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  sysparm_quantity: 1,
  variables: {
    replacement: 'Yes',
    originalnumber: '1640000',
    data_plan: '500MB'
  }
}" \
--user "username":"password"
{
  "result": {
    "sys_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "number": "REQ0010012",
    "request_number": "REQ0010012",
    "request_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "table": "sc_request"
  }
}

서비스 카탈로그 - POST /sn_sc/servicecatalog/items/{sys_id}/submit_producer

기록을 생성하고 테이블 API 상대 경로를 반환하고 생성된 기록에 액세스하기 위한 리디렉션 URL을 반환합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_producer

기본 URL: /api/sn_sc/servicecatalog/items/{sys_id}/submit_producer

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 122. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 기록 생성자를 만들 테이블의 Sys_id입니다.

데이터 유형: 문자열
표 123. 쿼리 매개변수
이름 설명
sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

유효한 값은 다음과 같습니다.

  • 데스크톱
  • 모바일
  • 모두

sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

데이터 유형: 문자열
표 124. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
variables 정의할 생산자 기록의 변수 이름-값 쌍입니다.

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 125. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 126. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 127. 상태 코드
상태 코드 설명
200 성공적인 요청으로 나타내며 테이블 API와 생성된 기록에 액세스하기 위한 URL로 구성된 응답 객체를 반환합니다.
400 잘못된 요청 메시지로 인해 요청이 처리되지 않았습니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404 요청한 자원을 찾을 수 없습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
번호 기록 생성자와 연결된 티켓의 번호입니다.

데이터 유형: 문자열
parent_id 사용 가능한 경우 요청이 생성된 상위 기록의 sys_id입니다. 자세한 내용은 요청에 대한 상위 매핑 구성을 참조하세요.

데이터 유형: 문자열
parent_table 상위 테이블의 이름입니다.

데이터 유형: 문자열
기록 테이블 API 새로 만든 기록 생성자의 상대 경로입니다.

데이터 유형: 문자열
redirect_portal_url Service Portal을 리디렉션할 URL입니다.

데이터 유형: 문자열
redirect_to 리디렉션 값입니다.

데이터 유형: 문자열
redirect_url 생성된 기록 생성자에 접근하기 위한 리디렉션 URL입니다.

데이터 유형: 문자열
sys_id 생성된 기록의 Sys_id입니다.

데이터 유형: 문자열
테이블 요청이 이루어진 테이블의 이름입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/3f1dd0320a0a0b99000a53f7604a2ef9/submit_producer" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'variables':{'urgency':'2','comments':'This is sample incident'}}" \
--user "username":"password"
{
  "result": {
    "sys_id": "6baf4e1ddbba2300e890f71fbf961963",
    "number": "INC0010006",
    "parent_id": null,
    "record": "api/now/table/incident/6baf4e1ddbba2300e890f71fbf961963",
    "redirect_portal_url": "",
    "parent_table": "task",
    "redirect_url": "incident.do?sys_id=6baf4e1ddbba2300e890f71fbf961963&sysparm_view=ess",
    "table": "incident",
    "redirect_to": ""
  }
}

서비스 카탈로그 - POST /sn/sc/servicecatalog/variables/{sys_id}/display_value

지정된 변수의 표시 값을 반환합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/variables/{sys_id}/display_value

기본 URL: /api/sn_sc/servicecatalog/variables/{sys_id}/display_value

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 128. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 표시 값을 반환할 변수의 Sys_id입니다.

데이터 유형: 문자열
표 129. 쿼리 매개변수
이름 설명
안 함
표 130. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
sysparm_value 반환할 표시 값을 포함하는 기록의 Sys_id입니다.

데이터 유형: 문자열

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 131. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 132. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 133. 상태 코드
상태 코드 설명
200 성공입니다. 요청이 성공적으로 처리되었습니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
결과 변수의 표시 값입니다.

데이터 유형: 문자열

cURL 요청


 curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/variables/2a3947a10a0a020e007f12648f8790c0/display_value" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"sysparm_value\":\"62826bf03710200044e0bfc8bcbe5df1\"}" \ 
--user "username":"password" 
{
  "result": "Abel Tuter (Architect)"
}

서비스 카탈로그 - PUT /sn_sc/servicecatalog/cart/{cart_item_id}

로그인한 사용자의 카트에서 지정된 항목을 업데이트합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}

기본 URL: /api/sn_sc/servicecatalog/cart/{cart_item_id}

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 134. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
cart_item_id 업데이트할 카트 항목의 Sys_id입니다.

데이터 유형: 문자열
표 135. 쿼리 매개변수
이름 설명
안 함
표 136. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
sysparm_quantity 필수 카트를 업데이트할 항목의 수량입니다.

데이터 유형: 문자열
variables 항목에 지정된 필수 변수가 있는 경우 필요합니다. 모든 필수 변수 이름-값 쌍으로 구성된 객체입니다.

데이터 유형: 객체

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 137. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 138. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 139. 상태 코드
상태 코드 설명
201 요청이 성공적으로 완료되었으며 항목이 카트에 추가되었음을 나타냅니다.
400 다음 세 가지 오류가 발생할 수 있습니다.
  • 잘못된 수량 값:sysparm_quantity 매개변수가 제공되지 않았거나 잘못된 값을 포함했음을 나타냅니다.
  • 보안 제약 조건으로 인해 항목을 주문할 수 없음:경로 매개 변수에 지정된 항목 ID가 잘못되었거나 사용자가 항목에 액세스할 수 없음을 나타냅니다.
  • 필수 변수는 필수입니다:하나 이상의 필수 변수 값이 요청에 제공되지 않았음을 나타냅니다.
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
cart_id 카트의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency> 특정한 반복 빈도를 갖는 카트의 항목을 설명합니다.
가능한 값은 다음과 같습니다.
  • 매일
  • 월별
  • 매년
  • 없음(반복 수수료 없음)

데이터 유형: 객체

"<recurring_frequency>": {
  "frequency_label": "String",
  "items": [Array],
  "show_subtotal_price": "String",
  "subtotal_price": "String",
  "subtotal_recurring_frequency": "String",
  "subtotal_recurring_price": "String",
  "subtotal_title": "String",
  "total_title": "String"
}
<recurring_frequency>.frequency_label 연결된 반복 수수료의 빈도입니다. 항목에 대한 반복되는 수수료가 없는 경우 이 매개변수에는 "null"이 포함됩니다.

데이터 유형: 문자열
<recurring_frequency>.항목 지정된 반복 빈도 범주와 연결된 각 항목을 설명하는 객체의 목록입니다.

데이터 유형: 배열

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created.by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_description": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
<recurring_frequency>.items.cart_item_id 이 카트에 있는 항목의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.catalog_item_id 항목의 카탈로그 sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.created.by 처음에 카트에 항목을 넣은 사용자입니다.

데이터 유형: 문자열
<recurring_frequency>.items.created_on 항목이 처음 카트에 담겨진 날짜입니다.

데이터 유형: 문자열
<recurring_frequency>.items.delivery_time 지정된 항목을 배달하는 데 걸리는 시간입니다.

데이터 유형: 문자열
<recurring_frequency>.items.item_id 항목 sys_id.

데이터 유형: 문자열
<recurring_frequency>.items.item_name 지정된 항목의 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.localized_price 항목의 가격(현지 통화)입니다.

데이터 유형: 문자열
<recurring_frequency>.items.localized_recurring_price 지정된 항목에 대한 반복 수수료(현지 통화)입니다.

데이터 유형: 문자열
<recurring_frequency>.items.name 항목 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.order_guide 이 항목이 연결된 주문 가이드의 이름입니다. 이 항목이 주문 가이드와 연결되어 있지 않으면 이 매개변수에 빈 문자열이 포함됩니다.

데이터 유형: 문자열
<recurring_frequency>.items.picture 항목 그림의 파일 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.품목.가격 항목의 가격입니다.

데이터 유형: 문자열
<recurring_frequency>.items.quantity 카트에 있는 지정된 항목의 번호입니다.

데이터 유형: 문자열
<recurring_frequency>.items.recurring_frequency 지정된 항목에 대해 반복 수수료가 청구되는 빈도입니다.

데이터 유형: 문자열

기본값: null
<recurring_frequency>.items.recurring_price 지정된 항목에 대한 반복 수수료입니다.

데이터 유형: 문자열
<recurring_frequency>.items.recurring_subtotal 항목에 대한 반복 수수료의 소계입니다(recurring_price x quantity).

데이터 유형: 숫자
<recurring_frequency>.items.recurring_subtotal_price 항목에 대한 반복 수수료의 소계입니다.

데이터 유형: 문자열
<recurring_frequency>.items.short_description 항목에 대한 간단한 설명입니다.

데이터 유형: 문자열
<recurring_frequency>.items.show_price 항목의 가격이 카트에 표시되는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 장바구니에 있는 항목의 가격을 표시합니다.
  • false: 장바구니에 있는 항목의 가격을 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.items.show.quantity 카트에 항목 수량을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 항목 수량을 표시합니다.
  • false: 카트에 항목 수량을 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.items.show_recurring_price 반복 수수료를 카트에 표시해야 하는지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 반복 수수료를 표시합니다.
  • false: 카트에 반복 수수료를 표시하지 않습니다.

데이터 유형: 부울
<recurring_frequency>.items.subtotal 항목 수의 소계입니다.

데이터 유형: 숫자
<recurring_frequency>.items.subtotal_price 항목의 소계(price x quantity).

데이터 유형: 문자열
<recurring_frequency>.items.sys_클래스_이름 항목의 시스템 분류 이름입니다.

데이터 유형: 문자열
<recurring_frequency>.items.sys_id 항목의 Sys_id입니다.

데이터 유형: 문자열
<recurring_frequency>.items.updated_by 항목을 처음 카트에 넣은 후 업데이트한 사용자입니다.

데이터 유형: 문자열
<recurring_frequency>.items.updated_on 항목을 처음 카트에 넣거나 업데이트한 마지막 날짜/시간입니다.

데이터 유형: 문자열
<recurring_frequency>.items.variables 항목 변수의 이름-값 쌍입니다.

데이터 유형: 객체
<recurring_frequency>.show_subtotal_price 연결된 반복 수수료 범주에 대한 소계를 표시할지 여부를 나타내는 플래그입니다.

데이터 유형: 문자열
<recurring_frequency>.subtotal_price 연결된 반복 빈도 범주에 대한 모든 항목의 비용 소계입니다.

데이터 유형: 문자열
<recurring_frequency>.subtotal_recurring_frequency 반복되는 빈도의 소계 유형(예: 매일, 매월 등)

데이터 유형: 문자열
<recurring_frequency>.subtotal_recurring_price 연결된 반복 빈도 범주 내 항목의 반복 수수료 소계입니다.

데이터 유형: 문자열
<recurring_frequency>.subtotal_title the show_subtotal_price 가 true로 설정된 경우 연결된 자막의 카트에 표시할 텍스트입니다.

데이터 유형: 문자열
<recurring_frequency>.total_title 연결된 반복 빈도 범주의 총 제목에 대해 표시할 텍스트입니다.

데이터 유형: 문자열
show_subtotal_price 카트에 소계 가격을 표시할지 여부를 나타내는 플래그입니다.
가능한 값:
  • true: 카트에 부분합을 표시합니다.
  • false: 카트에 부분합을 표시하지 않습니다.

데이터 유형: 문자열
subtotal_price 카트에 있는 모든 항목의 소계입니다.

데이터 유형: 문자열
subtotal_recurring_frequency 반복되는 빈도의 소계 유형(예: 매일, 매월 등) 와 <recurring_frequency>.subtotal_recurring_frequency같습니다.

데이터 유형: 문자열
subtotal_recurring_price 카트에 있는 모든 항목에 대한 반복 빈도 수수료의 소계입니다.

데이터 유형: 문자열
subtotal_title 소계 필드 제목에 대해 카트에 표시할 텍스트입니다.

데이터 유형: 문자열
total_title 총계 필드 제목에 대해 카트에 표시할 텍스트입니다.

데이터 유형: 문자열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/7d138fa21329e300027879d96144b065" \
--request PUT \
--header "Accept:application/json" \
--data "{\"sysparm_quantity\": \"2\" }" \
--user "username":"password"
{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$2,397.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$2,397.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:21:08",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$1,598.00",
          "variables": {},
          "quantity": "2",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 1598,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

서비스 카탈로그 - PUT /sn_sc/servicecatalog/items/{sys_id}/submit_guide

주문 가이드에 대해 설명된 요구 사항에 따라 항목 목록을 검색합니다.

URL 형식

버전이 지정된 URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_guide

기본 URL: /api/sn_sc/servicecatalog/items/{sys_id}/submit_guide

주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 140. 경로 매개변수
이름 설명
api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

데이터 유형: 문자열
sys_id 항목을 검색할 주문 가이드의 Sys_id.

데이터 유형: 문자열

표: 주문 가이드 [sc_cat_item_guide]
표 141. 쿼리 매개변수
이름 설명
안 함
표 142. 요청 본문 매개변수(XML 또는 JSON)
이름 설명
variables 항목에 대해 요청된 변수입니다. 각 변수는 이름-값 쌍으로 구성된 JSON 객체입니다.

데이터 유형: 배열

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 143. 요청 헤더
헤더 설명
수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

기본값: application/json
표 144. 응답 헤더
헤더 설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 145. 상태 코드
상태 코드 설명
200 요청이 성공적으로 완료되었음을 나타냅니다. 전달된 변수 목록을 기준으로 항목 목록을 반환합니다. 결과 집합에 항목이 포함되어 있지 않으면 빈 배열이 반환됩니다.
400 요청이 잘못되었음을 나타냅니다. 다음 이유 중 하나가 원인일 수 있습니다.
  • 사용자에게 항목에 대한 액세스 권한이 없습니다.
  • 하나 이상의 필수 변수에 답변되지 않았습니다. (필수로 정의된 변수만 적용됩니다.)
401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500 선택한 옵션에 따라 항목을 계산하는 동안 내부 오류가 발생했습니다.

응답 본문 매개변수(JSON 또는 XML)

이름 설명
catalogs 항목이 속한 객체의 목록과 카탈로그의 각 카탈로그 제목 및 sys_id입니다.

데이터 유형: 객체 배열

"catalogs": [
  {
    "sys_id": "String",
    "title": "String"  
  }
]
catalogs.sys_id 카탈로그의 Sys_id입니다.

데이터 유형: 문자열
카탈로그.제목 카탈로그 제목입니다.

데이터 유형: 문자열
범주 이 항목이 포함된 범주입니다.

데이터 유형: 객체

"catalogs": {
  "sys_id": "String",
  "title": "String"
}
category.sys_id 범주의 Sys_id입니다.

데이터 유형: 문자열
범주.제목 범주 제목

데이터 유형: 문자열
client_script 카탈로그 항목에 정의된 모든 카탈로그 클라이언트 스크립트의 목록입니다.

데이터 유형: 객체

"client_script": {
  "onChange": [Array],
  "onLoad": [Array],
  "onSubmit": [Array]
}
client_script.변경 시 항목과 연결된 onChange 클라이언트 스크립트의 목록입니다.

데이터 유형: 배열
client_script.온로드 항목과 연결된 onLoad 클라이언트 스크립트의 목록입니다.

데이터 유형: 배열
client_script.onSubmit 항목과 연결된 onSubmit 클라이언트 스크립트의 목록입니다.

데이터 유형: 배열
data_lookup 카탈로그 항목에 정의된 데이터 조회입니다.

데이터 유형: 배열
설명 카탈로그 항목에 대한 전체 설명입니다.

데이터 유형: 문자열
아이콘 카탈로그 항목 옆에 아이콘으로 표시되는 이미지의 경로입니다.

데이터 유형: 문자열
이름 카탈로그 항목의 이름입니다.

데이터 유형: 문자열
short_description 서비스 카탈로그 홈페이지 또는 검색 결과 페이지의 텍스트 또는 카탈로그 항목의 주문 양식에 있는 제목

데이터 유형: 문자열
show_price 가격 상세 정보를 표시할지 여부를 나타내는 플래그입니다. true인 경우 다음 상세 정보를 반환합니다.
  • local_currency
  • localized_price
  • localized_recurring_price
  • 가격
  • price_currency
  • recurring_frequency
  • recurring_price
  • recurring_price_currency

데이터 유형: 부울
sys_id 카탈로그 항목의 Sys_id입니다.

데이터 유형: 문자열
유형 항목 유형입니다.
가능한 값:
  • 카탈로그 항목
  • 주문 가이드
  • 기록 생성자 항목

데이터 유형: 문자열
variables 카탈로그 항목과 연결된 모든 변수의 이름-값 쌍입니다.

데이터 유형: 배열
ui_policy 카탈로그 항목에 정의된 모든 카탈로그 UI 정책의 목록입니다.

데이터 유형: 배열

cURL 요청

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/submit_guide" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"variables\":{
    \"hiring_manager\":\"6816f79cc0a8016401c5a33be04be441\",
    \"hiring_group\":\"221f3db5c6112284009f4becd3039cc9\",
    \"remote\":\"No\",
    \"standard_package\":\"No\",
    \"laptop_type\":\"developer\"
  }
}" \
--user "username":"password"
{
  "result": [
    {
      "short_description": "Lenovo - Carbon x1",
      "icon": "1195c2084f889200086eeed18110c74a.iix",
      "description": "<p class=\"p1\"><font size=\"3\" color=\"#808080\"><span class=\"s1\">x1 Carbon</span></font></p>\n<p class=\"p1\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">The x1 Carbon is Lenovo's lightest ThinkPad yet. It provides a QHD display that fights glare and weighs less than three pounds. Ideal for most computing tasks, and highly mobile. </span></font></p>\n<p class=\"p2\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">Technical Specs:</span></font></p>\n<ul class=\"ul1\"><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Intel core i5 processor</span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">512GB solid state drive (SSD) </span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Backlit keyboard</span></font></li></ul>",
      "show_price": true,
      "recurring_price": "$100.00",
      "type": "catalog_item",
      "local_currency": "USD",
      "sys_id": "04b7e94b4f7b4200086eeed18110c7fd",
      "recurring_price_currency": "USD",
      "localized_price": "$1,100.00",
      "price": "$1,100.00",
      "catalogs": [
       {
         "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
       }
      ],
      "recurring_frequency": "Annually",
      "name": "Standard Laptop",
      "localized_recurring_price": "$100.00",
      "category": {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "title": "Hardware"
      },
      "price_currency": "USD",
      "show_quantity": false,
      "quantity": "1",
      "order": "100",
      "variables": [
        {
          "label": "Optional Software",
          "type": 0,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "container_start",
          "render_label": true,
          "read_only": false,
          "children": [
            {
              "label": "Adobe Acrobat",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "acrobat",
              "attributes": "edge_encryption_enabled=true",
              "id": "90b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            },
            {
              "label": "Adobe Photoshop",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "photoshop",
              "attributes": "edge_encryption_enabled=true",
              "id": "a8b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            }
          ],
          "name": "optional_label",
          "attributes": "edge_encryption_enabled=true",
          "id": "10b72d4b4f7b4200086eeed18110c700",
          "value": "",
          "help_text": "",
          "max_length": 0
        },
        {
          "label": "Additional software requirements",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "Additional_software_requirements",
          "attributes": "edge_encryption_enabled=true",
          "id": "a8b72d4b4f7b4200086eeed18110c702",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "e1be6dcb4f7b4200086eeed18110c74c",
      "short_description": "LG IPS 27\" Monitor",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "External Monitor",
      "icon": "08569a4c4f889200086eeed18110c77b.iix",
      "description": "<p><font size=\"2\"><span style=\"color: #485563;\"><br /> <font size=\"3\" color=\"#808080\">The striking design of the LG Cinema Screen incorporates an ultra-narrow bezel, so virtually all you see is picture. The viewing experience is more immersive for your favorite movies and games. Make the most of your time, with an LG Full HD LED monitor. </font></span></font></p>\n<p><font size=\"2\" color=\"#808080\">Item Specs:</font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Screen Size: 27"</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Resolution: 1920 x 1080</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Aspect Ratio: 16:9</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Brightness: 250 cd/m2</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Supports Split Screen</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "2c0b59874f7b4200086eeed18110c71f",
        "title": "Peripherals"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "200",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "186d917a6fab7980575967ddbb3ee4f2",
      "short_description": "New Email Creation",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "New Email Account",
      "icon": "b630e97e6fab7980575967ddbb3ee4d2.iix",
      "description": "<p style=\"font-size: 13px;\"><font size=\"4\"><span style=\"color: #485563;\">Service Overview:</span></font></p>\n\t<p style=\"font-size: 13px;\"><font size=\"3\">Creation of a new email account within our Microsoft Exchange environment.  Creation of your email address will also create your Active Directory account. </font></p>\n\t<p> </p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "300",
      "variables": [
        {
          "label": "Preferred Email address",
          "type": 6,
          "mandatory": true,
          "displayvalue": "",
          "friendly_type": "single_line_text",
          "display_type": "Single Line Text",
          "render_label": true,
          "read_only": false,
          "name": "new_email",
          "attributes": "edge_encryption_enabled=true",
          "id": "65865e474fbb4200086eeed18110c7dd",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "8b3ae7fedc1be1004ece5c08239e522b",
      "short_description": "Remote access to Internal Corporate Systems\n\t\t",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Corp VPN",
      "icon": "11dc8df74f778200086eeed18110c78e.iix",
      "description": "<p><font size=\"3\"><span style=\"color: #485563;\">Corp VPN Account</span></font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\">Corp VPN provides VPN (Virtual Private Network) access to all Internal Corporate Systems and to IP Restricted Customer Instances</font></li><li style=\"color: #485563;\"><font size=\"2\">By utilizing Corp VPN, users will be provided a similar experience to being within one of the Corporate office locations, while offsite</font></li></ul>\n<p><font size=\"2\"><span style=\"color: #485563;\"> </span></font></p>\n<p><font size=\"2\"><span style=\"color: #485563;\">Please reference the <span style=\"color: #485563;\">CORP VPN </span><span style=\"color: #485563;\">Installation</span><span style=\"color: #485563;\"> and Support Documentation</span> for instructions on installation, usage and FAQ’s. For all other questions, please contact <span style=\"color: #485563;\">IT Support.</span></span></font></p>\n<p> </p>\n<p><span style=\"font-size: 10pt; font-family: tahoma, arial, helvetica, sans-serif;\"><br /><br /></span></p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "d2f7cae4c611227a018ddc481b34e099",
        "title": "Security and Access"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "600",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "962967674ff38200086eeed18110c7e7",
      "short_description": "Desk Set Up for New Hires or Employee Moves\n\t\t",
      "catalogs": [
        {
          "sys_id": "",
          "title": "Service Catalog"
        }
      ],
      "name": "Desk Set Up",
      "icon": "aa6b08ff4ff38200086eeed18110c7ed.iix",
      "description": "<p><font size=\"3\" face=\"arial, helvetica, sans-serif\">The facilities organization will set up your new desk with the following configuration:</font></p>\n<ul><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Docking Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Power Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Phone</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Office Chair</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "",
        "title": null
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "900",
      "variables": [
        {
          "label": "Please describe any ergonomic requirements\n\t\t",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "ergonomic_office",
          "attributes": "edge_encryption_enabled=true",
          "id": "b0b9ab674ff38200086eeed18110c755",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    }
  ]
}