권리 API

워싱턴 DC API 참조

Release

washingtondc

ft:locale

ko-KR

ft:publication_title

워싱턴 DC API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

권리 API

릴리스 버전: Washingtondc

업데이트 날짜 2024년 02월 01일

읽기30분

권리 API를 사용하면 인스턴스에서 권리 기록을 만들고 검색할 수 있습니다.

권리 확인은 어플라이언스 또는 컴퓨터와 같은 제품을 구매하는 고객에 대한 사후 판매 지원 서비스의 일부로 발생합니다. 고객이 구매한 제품에 대해 어떤 서비스를 받을 수 있는지 결정하기 위해 에이전트가 자격 확인을 수행합니다. 권리 API를 사용하여 권리를 정의하고 검색합니다.

이 API는 다음 테이블에 데이터를 액세스하고 저장합니다.

계정 [customer_account]
소비자 [csm_consumer]
세대 [csm_household]
설치 기반 [sn_install_base_item]
제품 모델 [cmdb_model]
제품 오퍼링 [sn_prd_pm_product_offering]
판매된 제품 [sn_install_base_sold_product]

이 API에 액세스하려면 연결된 인스턴스에서 다음 플러그인을 활성화해야 합니다.

고객 계약 및 권리(com.sn_pss_core)
Customer Service Install Base Management (com.snc.install_base)
Product Catalog 관리 코어(com.sn_prd_pm)

또한 이 API를 성공적으로 호출하려면 sn_pss_core.pss_integrator 역할이 있어야 합니다. 이 API는 sn_pss_core 네임스페이스에서 실행됩니다.

권리 - GET /sn_pss_core/entitlement/{id}

지정된 권리 기록, 연관된 범위 및 최신 사용 상세 정보를 반환합니다.

다음은 권리 데이터가 저장되는 테이블 목록입니다.

특성 [sn_pss_core_entitlement_characteristic]
권리 [service_entitlement]
권리 사용 [sn_pss_core_entitlement_usage]
판매된 제품 포함[sn_install_base_m2m_contract_sold_product] - 이 테이블에는 포함된 판매된 제품과 포함된 설치 기반 항목 모두에 대한 정보가 포함되어 있습니다.

URL 형식

버전이 지정된 URL: / api/sn_pss_core/v1/entitlement/{id}

기본 URL: / api/sn_pss_core/entitlement/{id}

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
ID	검색할 권리 기록의 Sys_id입니다. 권리 [service_entitlement] 테이블에 있습니다. 데이터 유형: 문자열

표 2. 쿼리 매개변수
이름	설명
display_value	반환할 데이터의 형식입니다. 유효한 값은 다음과 같습니다. false: 모든 필드에 대한 `값을` 반환합니다. 예를 들어 " `state":"draft"입니다`. true: 모든 필드에 대한 `display_value` 반환합니다. 예: " `state":"초안"` all: 모든 필드에 대한 모든 정보를 반환합니다. `"state": { "name": "state", "label": "State", "value": "draft", "display_value": "Draft", "type": "string" }` 데이터 유형: 문자열 기본값: false

표 3. 요청 본문 매개변수(JSON)
이름	설명
없음

헤더

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

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

표 5. 응답 헤더
헤더	설명
없음

상태 코드

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

표 6. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
403	금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수


이름	설명
계정	권리가 속한 계정 기록의 Sys_id입니다. 계정 [customer_account] 테이블에 있습니다. 데이터 유형: 문자열
소비자	권리가 속한 소비자 기록의 Sys_id입니다. 소비자 [csm_consumer] 테이블에 있습니다. 데이터 유형: 문자열
계약	권리가 속한 계약 기록의 Sys_id입니다. 서비스 계약 [sn_pss_core_service_contract] 테이블에 있습니다. 데이터 유형: 문자열
end_date	권리의 종료 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd 기본값: 수동으로 제거할 때까지 종료되지 않습니다.
entitlement_characteristics	권리와 연결된 특성의 목록입니다. 이 배열의 데이터는 특성 [sn_pss_core_entitlement_characteristic] 테이블에 삽입됩니다. 데이터 유형: 객체 배열 `"entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": {Object}, "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]`
entitlement_characteristics.특성	권리와 연결된 특성 기록의 Sys_id입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
entitlement_characteristics.characteristic_option	권리와 연결된 특성 옵션 기록의 Sys_id입니다. 특성 옵션 [sn_prd_pm_characteristic_option] 테이블에 있습니다. 데이터 유형: 문자열
entitlement_characteristics.자격	연결된 권리 기록의 Sys_id입니다. 권리 [service_entitlement] 테이블에 있습니다. 데이터 유형: 문자열
entitlement_characteristics.entitlement_usage	연결된 권리 특성에 사용된 단위 값입니다. 이 데이터는 권리 사용 현황 [sn_pss_core_entitlement_usage] 테이블에 삽입됩니다. entitlement_characteristics 권리 아래에 있는 경우에만 이 매개변수를 전달합니다. 데이터 유형: 객체 `"entitlement_usage": { "usage_units": "String" }`
entitlement_characteristics.entitlement_usage.usage_units	연결된 권리 특성의 사용량입니다. 데이터 유형: 문자열
entitlement_characteristics.entitlement_usage.service_contract_line	권리 특성과 연결된 서비스 계약 라인 기록의 Sys_id입니다. 서비스 계약 라인 [sn_pss_core_service_contract_line] 테이블에 있습니다. 데이터 유형: 문자열
entitlement_characteristics.entitlement_usage.sys_created_by	권리 특성 기록을 생성한 사용자의 이름입니다. 데이터 유형: 문자열
entitlement_characteristics.entitlement_usage.sys_created_on	권리 특성 기록이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열
entitlement_characteristics.entitlement_usage.sys_id	권리 특성 기록의 Sys_id입니다. 데이터 유형: 문자열
entitlement_characteristics.entitlement_usage.sys_updated_by	권리 특성 기록을 마지막으로 업데이트한 사용자의 이름입니다. 데이터 유형: 문자열
entitlement_characteristics.entitlement_usage.sys_updated_on	권리 특성 기록이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열
entitlement_characteristics.형식	권리 특성의 유형입니다. 유효한 값은 다음과 같습니다. 보장 범위 범위 및 사용 데이터 유형: 문자열
entitlement_characteristics.값	특성의 값입니다. 데이터 유형: 문자열
entitlement_name	권리의 이름입니다. 데이터 유형: 문자열
household	권리와 연결된 세대 기록의 Sys_id입니다. 세대 [csm_household] 테이블에 있습니다. 데이터 유형: 문자열
install_base_items_covered	권리에 포함된 설치 기반 항목의 목록입니다. 판매된 제품 포함[sn_install_base_m2m_contract_sold_product] 테이블에 있습니다. 데이터 유형: 객체 배열 `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
install_base_items_covered.추가	연결된 설치 기반 항목이 권리에 추가된 날짜입니다. 데이터 유형: 문자열
install_base_items_covered.계약	설치 기반 항목과 연결된 서비스 계약 기록의 Sys_id입니다. 서비스 계약 [sn_pss_core_service_contract] 테이블에 있습니다. 데이터 유형: 문자열
install_base_items_covered.install_base	서비스 계약 라인에서 다루는 설치 기반 항목의 Sys_id입니다. 설치 기반 항목 [sn_install_base_item] 테이블에 있습니다. 데이터 유형: 문자열
install_base_items_covered.제거	연결된 설치 기반 항목이 권리에서 제거된 날짜입니다. 데이터 유형: 문자열
install_base_items_covered.자격	설치 기반 항목과 연결된 권리 기록의 Sys_id입니다. 권리 [service_entitlement] 테이블에 있습니다. 데이터 유형: 문자열
install_base_items_covered.service_contract_line	연결된 서비스 계약 라인 기록의 Sys_id입니다. 서비스 계약 라인 [sn_pss_core_service_contract_line] 테이블에 있습니다. 데이터 유형: 문자열
install_base_items_covered.sys_created_by	설치 기반 항목 기록을 생성한 사용자의 이름입니다. 데이터 유형: 문자열
install_base_items_covered.sys_created_on	설치 기반 항목 기록이 만들어진 날짜 및 시간입니다. 데이터 유형: 문자열
install_base_items_covered.sys_id	포함된 설치 기반 항목의 Sys_id입니다. 판매된 제품 포함[sn_install_base_m2m_contract_sold_product] 테이블에 있습니다. 데이터 유형: 문자열
install_base_items_covered.sys_updated_by	설치 기반 항목 기록을 마지막으로 업데이트한 사용자의 이름입니다. 데이터 유형: 문자열
install_base_items_covered.sys_updated_on	설치 기반 항목 기록이 마지막으로 업데이트된 날짜와 시간입니다. 데이터 유형: 문자열
제품	권리와 연결된 제품 모델 기록의 Sys_id입니다. 제품 모델 [cmdb_model] 테이블에 있습니다. 데이터 유형: 문자열
product_offering	권리와 연결된 제품 오퍼링 기록의 Sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
sold_entitlement	권리와 연결된 판매된 제품 기록의 Sys_id입니다. 판매된 제품 [sn_install_base_sold_product] 테이블에 있습니다. 데이터 유형: 문자열
sold_products_covered	적용되는 제품 목록입니다. 판매된 제품 포함[sn_install_base_m2m_contract_sold_product] 테이블에 있습니다. 데이터 유형: 객체 배열 `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
sold_products_covered.추가	판매된 관련 제품이 권리에 추가된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd 기본값: 현재 날짜
sold_products_covered.계약	판매된 제품과 연결된 서비스 계약 기록의 Sys_id입니다. 서비스 계약 [sn_pss_core_service_contract] 테이블에 있습니다. 데이터 유형: 문자열
sold_products_covered.자격	판매된 제품과 연결된 권리 기록의 Sys_id입니다. 권리 [service_entitlement] 테이블에 있습니다. 데이터 유형: 문자열
sold_products_covered.제거됨	판매된 관련 제품이 권리에서 제거된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd 기본값: 종료 날짜 없음
sold_products_covered.service_contract_line	판매된 제품과 연결된 서비스 계약 라인 기록의 Sys_id입니다. 서비스 계약 라인 [sn_pss_core_service_contract_line] 테이블에 있습니다. 데이터 유형: 문자열
sold_products_covered.sold_product	권리가 적용되는 제품의 Sys_id입니다. 판매된 제품 [sn_install_base_sold_product] 테이블에 있습니다. 데이터 유형: 문자열
sold_products_covered.sys_created_by	판매된 제품 포함 기록을 생성한 사용자의 이름입니다. 데이터 유형: 문자열
sold_products_covered.sys_created_on	판매된 제품 포함 기록이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열
sold_products_covered.sys_id	이 서비스 계약이 적용되는 제품의 Sys_id입니다. 판매된 제품 포함[sn_install_base_m2m_contract_sold_product] 테이블에 있습니다. 데이터 유형: 문자열
sold_products_covered.sys_updated_by	판매된 제품 포함 기록을 마지막으로 업데이트한 사용자의 이름입니다. 데이터 유형: 문자열
sold_products_covered.sys_updated_on	판매된 제품 포함 기록이 마지막으로 업데이트된 날짜와 시간입니다. 데이터 유형: 문자열
start_date	권리의 시작 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd
상태	권리의 현재 상태입니다. 유효한 값은 다음과 같습니다. (대/소문자 구분) 활성 취소됨 초안 만료 일시 중단 데이터 유형: 문자열
sys_created_by	권리 기록을 생성한 사용자의 이름입니다. 데이터 유형: 문자열
sys_created_on	권리 기록이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열
sys_id	연결된 권리 기록의 Sys_id입니다. 권리 [service_entitlement] 테이블에 있습니다. 데이터 유형: 문자열
sys_updated_by	권리 기록을 마지막으로 업데이트한 사용자의 이름입니다. 데이터 유형: 문자열
sys_updated_on	권리 기록이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열

cURL 요청

다음 예제에서는 이 엔드포인트를 호출하여 권리 템플릿을 검색하는 방법을 보여 줍니다.

curl "https://instance.servicenow.com/api/sn_pss_core/entitlement/fc73d2de89226110f877430a4e008" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

응답:

{
  "result": {
    "sys_id": "5a651515d1f53110f8776589fa411f7b",
    "sys_created_by": "admin",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-10-09 11:31:59",
    "sys_updated_on": "2023-10-09 11:31:59",
    "entitlement_name": "indep entl",
    "account": "4c325111d1f53110f8776589fa411f3d",
    "consumer": null,
    "household": null,
    "contract": null,
    "service_contract_line": null,
    "state": "active",
    "product_offering": null,
    "sold_entitlement": null,
    "product": null,
    "start_date": "2023-10-03",
    "end_date": "2024-12-03",
    "sold_products_covered": [
      {
        "sys_id": "d6651515d1f53110f8776589fa411f7c",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "contract": null,
        "service_contract_line": null,
        "entitlement": "5a651515d1f53110f8776589fa411f7b",
        "sold_product": "0df21151d1f53110f8776589fa411f1b",
        "added": "",
        "removed": ""
      }
    ],
    "install_base_items_covered": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7d",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "contract": null,
        "service_contract_line": null,
        "entitlement": "5a651515d1f53110f8776589fa411f7b",
        "install_base": "e2639951d1f53110f8776589fa411f2b",
        "added": "",
        "removed": ""
      }
    ],
    "entitlement_characteristics": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7e",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "service_contract_line": null,
        "entitlement": "5a651515d1f53110f8776589fa411f7b",
        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
        "value": "5",
        "characteristic": "63418db7539e61106bfcddeeff7b1238",
        "type": "coverage_and_usage",
        "entitlement_usage": [
          {
            "sys_id": "de651515d1f53110f8776589fa411f7e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:31:59",
            "sys_updated_on": "2023-10-09 11:31:59",
            "entitlement": "5a651515d1f53110f8776589fa411f7b",
            "entitlement_characteristic": "12651515d1f53110f8776589fa411f7e",
            "period_start": "2023-10-03",
            "period_end": "2024-12-03",
            "total_units": "5",
            "used_units": "25"
          }
        ]
      }
    ]
  } 
}

권리 - POST /sn_pss_core/entitlement

권리 기록과 모든 관련 상세 기록을 생성합니다.

다음은 권리 데이터가 저장되는 테이블 목록입니다.

특성 [sn_pss_core_entitlement_characteristic]
권리 [service_entitlement]
권리 사용 [sn_pss_core_entitlement_usage]
판매된 제품 [sn_install_base_m2m_contract_sold_product] - 이 테이블에는 포함된 판매된 제품과 포함된 설치 기반 항목 모두에 대한 정보가 포함되어 있습니다.

URL 형식

버전이 지정된 URL: / api/sn_pss_core/v1/entitlement

기본 URL: / api/sn_pss_core/entitlement

지원되는 요청 매개변수

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

표 8. 쿼리 매개변수
이름	설명
없음

표 9. 요청 본문 매개변수(JSON)
이름	설명
계정	매개변수가 consumer 전달되지 않은 경우 필수입니다. 권리가 속한 계정 기록의 Sys_id입니다. 계정 [customer_account] 테이블에 있습니다. 데이터 유형: 문자열
소비자	매개변수가 account 전달되지 않은 경우 필수입니다. 권리가 속한 소비자 기록의 Sys_id입니다. 소비자 [csm_consumer] 테이블에 있습니다. 데이터 유형: 문자열
end_date	권리의 종료 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd 기본값: 수동으로 제거할 때까지 종료되지 않습니다.
entitlement_characteristics	권리와 연결된 특성의 목록입니다. 이 배열의 데이터는 특성 [sn_pss_core_entitlement_characteristic] 테이블에 삽입됩니다. 데이터 유형: 객체 배열 `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
entitlement_characteristics.특성	필수 권리와 연결된 특성 기록의 Sys_id입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
entitlement_characteristics.characteristic_option	권리와 연결된 특성 옵션 기록의 Sys_id입니다. 특성 옵션 [sn_prd_pm_characteristic_option] 테이블에 있습니다. 데이터 유형: 문자열
entitlement_characteristics.entitlement_usage	연결된 권리 특성에 사용된 단위 값입니다. 이 데이터는 권리 사용 현황 [sn_pss_core_entitlement_usage] 테이블에 삽입됩니다. entitlement_characteristics 권리 아래에 있는 경우에만 이 매개변수를 전달합니다. 데이터 유형: 객체 `"entitlement_usage": { "usage_units": "String" }`
entitlement_characteristics.entitlement_usage.usage_units	연결된 권리 특성의 사용량입니다. 데이터 유형: 문자열
entitlement_characteristics.형식	권리 특성의 유형입니다. 유효한 값은 다음과 같습니다. 보장 범위 범위 및 사용 데이터 유형: 문자열
entitlement_characteristics.값	매개변수에 지정된 entitlement_characteristics.characteristic 기록에 포함된 매개변수가 input_type`choice` 아닌 경우 필수입니다. 특성의 값입니다. 데이터 유형: 문자열
entitlement_name	필수 권리의 이름입니다. 데이터 유형: 문자열
household	세대 플러그인이 활성 상태이고 매개변수가 consumer 전달된 경우에만 전달됩니다. 권리와 연결된 세대 기록의 Sys_id입니다. 세대 [csm_household] 테이블에 있습니다. 데이터 유형: 문자열
install_base_items_covered	권리에 포함된 설치 기반 항목의 목록입니다. 이 배열의 정보는 판매된 제품 포함[sn_install_base_m2m_contract_sold_product] 테이블에 삽입됩니다. 데이터 유형: 객체 배열 `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]` 설치 기반 항목에 Configure install base대한 자세한 내용은 다음을 참조하십시오.
install_base_items_covered. 추가	연결된 설치 기반 항목이 권리에 추가된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd 기본값: 현재 날짜
install_base_items_covered.install_base	연결된 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 [sn_install_base_item] 테이블에 있습니다. 데이터 유형: 문자열
install_base_items_covered.제거	연결된 설치 기반 항목이 권리에서 제거된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd 기본값: 종료 날짜 없음
제품	권리와 연결된 제품 모델 기록의 Sys_id입니다. 제품 모델 [cmdb_model] 테이블에 있습니다. 데이터 유형: 문자열
product_offering	권리와 연결된 제품 오퍼링 기록의 Sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
sold_entitlement	권리와 연결된 판매된 제품 기록의 Sys_id입니다. 판매된 제품 [sn_install_base_sold_product] 테이블에 있습니다. 데이터 유형: 문자열
sold_products_covered	권리에 포함되는 제품 목록입니다. 이 매개변수의 데이터는 판매된 제품 포함[sn_install_base_m2m_contract_sold_product] 테이블에 삽입됩니다. 데이터 유형: 객체 배열 `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
sold_products_covered. 추가	판매된 관련 제품이 권리에 추가된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd 기본값: 현재 날짜
sold_products_covered.제거됨	판매된 관련 제품이 권리에서 제거된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd 기본값: 종료 날짜 없음
sold_products_covered.sold_product	권리가 적용되는 제품의 Sys_id입니다. 판매된 제품 [sn_install_base_sold_product] 테이블에 있습니다. 데이터 유형: 문자열
start_date	필수 권리의 시작 날짜입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd
상태	필수 권리의 현재 상태입니다. 유효한 값은 다음과 같습니다. (대/소문자 구분) 활성 취소됨 초안 만료 일시 중단 데이터 유형: 문자열

헤더

표 10. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json
컨텐츠-형식	요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 11. 응답 헤더
헤더	설명
없음

상태 코드

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

표 12. 상태 코드
상태 코드	설명
201	성공입니다. 요청이 성공적으로 처리되고 기록이 작성되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
403	금지되었습니다. 사용자에게 API에 액세스할 수 있는 권한이 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON)


이름	설명
entitlement_characteristics	권리 아래에 생성된 권리 특성 객체의 목록입니다. 데이터 유형: 객체 배열 `"entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
entitlement_characteristics.entitlement_usage	entitlement_characteristic 아래에 삽입된 권리 사용 현황 객체입니다. 데이터 유형: 객체 `"entitlement_usage": { "sys_id": "String" }`
entitlement_characteristics.entitlement_usage.sys_id	권리 사용 기록의 Sys_id입니다. 권리 사용 현황 [sn_pss_core_entitlement_usage] 테이블에 있습니다. 데이터 유형: 문자열
entitlement_characteristics.sys_id	권리와 연결된 권리 특성 기록의 Sys_id입니다. 특성 [sn_pss_core_entitlement_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
entitlement_name	권리의 이름입니다. 데이터 유형: 문자열
install_base_items_covered	권리에 포함된 설치 기반 항목의 sys_ids 목록입니다. 데이터 유형: 객체 배열 `"install_base_items_covered": [ { "sys_id": "String" } ]`
install_base_items_covered.sys_id	권리에 포함되는 설치 기반 항목의 Sys_id입니다. 판매된 제품 포함[sn_install_base_m2m_contract_sold_product] 테이블에 있습니다. 데이터 유형: 문자열
sold_prodocts_covered	권리에 포함된 sys_ids 제품 목록입니다. 데이터 유형: 객체 배열 `"sold_products_covered": [ { "sys_id": "String" } ]`
sold_products_covered.sys_id	권리가 적용되는 제품의 Sys_id입니다. 판매된 제품 포함[sn_install_base_m2m_contract_sold_product] 테이블에 있습니다. 데이터 유형: 문자열
sys_id	연결된 권리 기록의 Sys_id입니다. 권리 [service_entitlement] 테이블에 있습니다. 데이터 유형: 문자열

cURL 요청

다음 예제에서는 권리 템플릿을 만드는 방법을 보여 줍니다.

curl "https://instance.servicenow.com/api/sn_pss_core/entitlement" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "entitlement_name": "indep entl",
  "account": "4c325111d1f53110f8776589fa411f3d",
  "start_date": "2023-10-03",
  "end_date": "2024-12-03",
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b"
    }
  ], 
  "install_base_items_covered": [
    {
      "install_base": "e2639951d1f53110f8776589fa411f2b"
    }
  ],
  "entitlement_characteristics": [
    {
      "characteristic": "63418db7539e61106bfcddeeff7b1238",
      "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
      "value": "20",
      "type": "coverage_and_usage",
      "entitlement_usage": {
        "used_units": "25"
      } 
    }
  ]
}

응답:

{
  "result": {
    "sys_id": "5a651515d1f53110f8776589fa411f7b",
    "entitlement_name": "indep entl",
    "sold_products_covered": [
      {
        "sys_id": "d6651515d1f53110f8776589fa411f7c"
      }
    ],
    "install_base_items_covered": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7d"
      }
    ],
    "entitlement_characteristics": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7e",
        "entitlement_usage": {
          "sys_id": "de651515d1f53110f8776589fa411f7e"
        }
      }
    ]
  }
}