---
sourceDocument: 호주 API 참조
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ko-KR/api-reference
Release :
- australia
ft:locale :
- ko-KR
ft:publication_title :
- 호주 API 참조
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# 권리 검증 API
# 권리 검증 API {#ariaid-title1}
* 릴리스 버전: Australia
*
* 업데이트 날짜 2026년 03월 12일
*
*  소요 시간: 27분
권리 검증 API는 유효한 권리 목록, 권리 특성에 대한 상세 정보 및 권리의 최신 사용량 정보를 얻을 수 있는 엔드포인트를 제공합니다.
이 API에 액세스하려면 com.sn_ent_verify(권리 검증) 플러그인을 활성화해야 합니다.
이 API는 `sn_ent_verify` 네임스페이스 내에서 제공됩니다.
호출 사용자에게 sn_pss_core.pss_integrator 역할이 있어야 합니다.
이 API의 REST 엔드포인트는 다음 테이블의 데이터를 쿼리합니다.
* 계정 \[customer_account\]
* 소비자 \[csm_consumer\]
* 권리 \[service_entitlement\]
* 권리 특성 \[sn_pss_core_entitlement_characteristic\]
* 권리 사용량 \[sn_pss_core_entitlement_usage\]
* 세대 \[csm_household\]
* 설치 기반 \[sn_install_base_item\]
* 제품 모델 \[cmdb_model\]
* 제품 오퍼링 \[sn_prd_pm_product_offering\]
* 제품 사양 \[sn_prd_pm_product_specification\]
* 서비스 계약 \[sn_pss_core_service_contract\]
* 서비스 계약 라인 \[sn_pss_core_service_contract_line\]
* 판매된 제품 \[sn_install_base_sold_product\]
## 권리 검증 - GET /sn_ent_verify/verifyentitlements {#ariaid-title2}
제공된 필터에 따라 유효한 권리 기록을 반환합니다.
다음을 기준으로 권리를 필터링할 수 있습니다.
* 계정
* 소비자
* 계약
* 세대
* 설치 기반
* 제품 모델
* 제품 오퍼링
* 제품 사양
* 서비스 계약 라인
* 판매된 권리
* 판매된 제품
* 상태
{#ver_entitle-GET-verify__ul_zgk_xd2_pzb}최소한 권리를 필터링할 계정 또는 소비자를 지정해야 합니다.
여러 필터 매개변수가 전달되면 엔드포인트는 매개변수에 `AND` 연산자를 적용합니다. 예를 들어 `"account = boxeo"` 및 `"state = draft"`와 같은 필터 매개변수를 전달하면 엔드포인트는 Account = boxeo `AND` state = draft가 있는 모든 권리를 반환합니다.
시스템 페이지 매김 매개변수 sysparm_offset 및 sysparm_limit. 기본적으로 sysparm_offset 0으로 설정되고 sysparm_limit 10으로 설정됩니다. 따라서 필터를 적용한 후 100개의 권리가 기준을 충족하면 응답에는 처음 10개의 권리가 포함됩니다. 이러한 값은 엔드포인트 호출에 전달하여 수정할 수 있습니다.
### URL 형식
버전이 지정된 URL: /api/sn_ent_verify/{api_version}/verifyentitlements
기본 URL: /api/sn_ent_verify/verifyentitlements
주:
사용 가능한 버전은 [REST API 탐색기에](https://servicenow-prod.fluidtopics.net/arCv9b3UPYvLylUnDh9RpQ "이 튜토리얼에서는 REST API 탐색기를 사용하여 REST API를 테스트합니다 ServiceNow .") 지정됩니다. 스크립트 기반 REST API의 경우 [스크립트 기반 REST 서비스 양식](https://servicenow-prod.fluidtopics.net/vfCIdYdXpX8Ltk8_R7WfkA "스크립팅된 REST API 기능을 사용하면 애플리케이션 개발자가 사용자 지정 웹 서비스 API를 빌드할 수 있습니다.")에 추가 버전 정보가 있습니다.
### 지원되는 요청 매개변수
{#ver_entitle-GET-verify__entry__2}{#ver_entitle-GET-verify__version-not_optional-RESTAPI}
| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오. 데이터 유형: 문자열 |
| sysparm_limit | 옵션입니다. 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 sysparm_offset 사용하여 기록 검색을 페이지 매김합니다. 응답에서 부울 매개변수 hasMore 가 반환됩니다. 필터 기준을 충족하는 반환할 기록이 더 있는지 여부를 나타냅니다. 데이터 유형: 숫자 기본값: 10 최대: 100 |
| sysparm_offset | 옵션입니다. 기록 검색을 시작할 기록 인덱스를 시작하는 중입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수에 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트 sysparm_offset 를 처음 호출할 때 '0'으로 설정됩니다. 사용 가능한 모든 기록을 간단히 페이지화하려면 모든 기록의 끝에 도달할 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다. 매개변수에 sysparm_offset 음수를 전달하지 마십시오. 데이터 유형: 숫자 기본값: 0 |
[표 1. 경로 매개변수]
{#ver_entitle-GET-verify__entry__10}{#ver_entitle-GET-verify__csm-display_value-entry}
| 이름 | 설명 |
|-|-|
| 계정 | account or consumer 매개변수를 전달해야 합니다. 이 둘은 상호 배타적입니다. 권리 기록을 반환할 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 기본값: 없음 테이블: 계정 \[customer_account\] |
| 소비자 | account or consumer 매개변수를 전달해야 합니다. 이 둘은 상호 배타적입니다. 권리 기록을 반환할 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 기본값: 없음 테이블: 소비자 \[csm_consumer\] |
| 계약 | 권리 기록을 반환할 계약 기록의 Sys_id입니다. 데이터 유형: 문자열 기본값: 없음 테이블: 계약 \[sn_pss_core_service_contract\] |
| display_value | 연결된 필드 값, 표시 값 또는 둘 다를 반환할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 응답에 필드의 표시 값만 포함됩니다. 예: `"state": "Draft"`. * false: 응답에 필드 값만 포함됩니다. 예:` "state": "draft"`. * all: 응답에 필드에 대한 모든 정보가 포함되어 있습니다. 예: "state": { "name": "state", "label": "State", "value": "draft", "display_value": "true", "type": "string" } 데이터 유형: 문자열 기본값: false |
| 세대 | 권리 기록을 반환할 세대 기록의 Sys_id입니다. 데이터 유형: 문자열 기본값: 없음 테이블: 세대 \[csm_household\] |
| install_base | 권리 기록을 반환할 설치 기반 기록의 Sys_id입니다. 엔드포인트는 설치 기반 기록의 sys_id를 사용하여 판매된 제품 대상 \[sn_install_base_m2m_contract_sold_product\] 테이블을 검색하여 연결된 설치 기반에 포함된 모든 권리를 반환합니다. 데이터 유형: 문자열 기본값: 없음 테이블: 설치 기반 \[sn_install_base_item\] |
| 제품 | 권리 기록을 반환할 제품 기록의 Sys_id입니다. 데이터 유형: 문자열 기본값: 없음 테이블: 제품 모델 \[cmdb_model\] |
| product_offering | 권리 기록을 반환할 제품 오퍼링 기록의 Sys_id입니다. 데이터 유형: 문자열 기본값: 없음 테이블: 제품 오퍼링\[sn_prd_pm_product_offering\] |
| product_specification | 권리 기록을 반환할 제품 사양 기록의 Sys_id입니다. 데이터 유형: 문자열 기본값: 없음 테이블: 제품 사양 \[sn_prd_pm_product_specification\] |
| service_contract_line | 권리 기록을 반환할 서비스 계약 라인 기록의 Sys_id입니다. 데이터 유형: 문자열 기본값: 없음 테이블: 서비스 계약 라인 \[sn_pss_core_service_contract_line\] |
| sold_entitlement | 권리 기록을 반환할 판매된 권리 기록의 Sys_id입니다. 데이터 유형: 문자열 기본값: 없음 테이블: 판매된 제품 \[sn_install_base_sold_product\] |
| sold_product | 권리 기록을 반환할 판매된 제품 기록의 Sys_id입니다. 엔드포인트는 판매된 제품 기록의 sys_id을 사용하여 판매된 제품 \[sn_install_base_m2m_contract_sold_product\] 테이블을 검색하여 판매된 관련 제품에 포함된 모든 권리를 반환합니다. 데이터 유형: 문자열 기본값: 없음 테이블: 판매된 제품 \[sn_install_base_sold_product\] |
| 상태 | 반환할 권리의 상태입니다. 유효한 값은 다음과 같습니다. * 활성 * 취소됨 * 초안 * 만료됨 * 일시 중단됨 {#ver_entitle-GET-verify__ul_vch_twr_pzb} 데이터 유형: 문자열 기본값: 모두 |
[표 2. 쿼리 매개변수]
{#ver_entitle-GET-verify__entry__38}
| 이름 | 설명 |
|-|-|
| 안 함 | |
[표 3. 요청 본문 매개변수(XML 또는 JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#ver_entitle-GET-verify__entry__42}{#ver_entitle-GET-verify__accept-RESTAPI}
| 머리글 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
[표 4. 요청 헤더]
{#ver_entitle-GET-verify__entry__46}
| 머리글 | 설명 |
|-|-|
| 안 함 | |
[표 5. 응답 헤더]
### 상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 [REST API HTTP 응답 코드를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#ver_entitle-GET-verify__entry__50}{#ver_entitle-GET-verify__entry-200-status-code}{#ver_entitle-GET-verify__entry-403-status-code}{#ver_entitle-GET-verify__entry-404-status-code}{#ver_entitle-GET-verify__entry-500-status-code}
| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
[표 6. 상태 코드]
### 응답 본문 매개변수(JSON 또는 XML)
{#ver_entitle-GET-verify__entry__60}
| 이름 | 설명 |
|-|-|
| 권리 | 통과된 필터 기준과 일치하는 권리 목록입니다. 데이터 유형: 객체 배열 "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_name": "String", "household": "String", "product": "String", "product_offering": "String", "product_specification": "String", "service_contract_line": "String", "sold_entitlement": "String", "start_date": "String", "state": "String", "sys_id": "String" } ] |
| 권리.계정 | 이 권리와 연결된 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 계정 \[customer_account\] |
| 권리.소비자 | 이 권리와 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 소비자 \[csm_consumer\] |
| 권리.계약 | 이 권리와 연결된 계약 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 계약 \[sn_pss_core_service_contract\] |
| entitlements.end_date | 연결된 권리 기록의 종료 날짜 필드 값입니다. 데이터 유형: 문자열 |
| entitlements.entitlement_name | 권리의 이름입니다. 데이터 유형: 문자열 |
| 권리.세대 | 이 권리와 연결된 세대 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 세대 \[csm_household\] |
| entitlements.product | 이 권리와 연결된 제품 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 모델 \[cmdb_model\] |
| entitlements.product_offering | 이 권리와 연결된 제품 오퍼 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 \[sn_prd_pm_product_offering\] |
| entitlements.product_specification | 이 권리와 연결된 제품 사양 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 사양 \[sn_prd_pm_product_specification\] |
| entitlements.service_contract_line | 이 권리와 연결된 서비스 계약 라인 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 서비스 계약 라인 \[sn_pss_core_service_contract_line\] |
| entitlements.sold_entitlement | 이 권리와 연결된 판매된 권리 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 판매된 제품 \[sn_install_base_sold_product\] |
| entitlements.start_date | 연결된 권리 기록의 시작 날짜 필드 값입니다. 데이터 유형: 문자열 |
| 권리.상태 | 권리 기록의 상태입니다. 가능한 값: * 활성 * 취소됨 * 초안 * 만료됨 * 일시 중단됨 데이터 유형: 문자열 |
| entitlements.sys_id | 권리 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 권리 \[service_entitlement\] |
| 오류 | 발생한 오류에 대해 설명합니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } 오류 응답의 예: * 오류 메시지: 페이지 크기 -20이 잘못되었습니다. 페이지 크기는 1에서 100 사이의 정수여야 합니다.오류 조건: 잘못된 sysparm_limit 매개변수가 전달되었습니다. 매개변수는 sysparm_limit 1에서 100 사이여야 합니다. * 오류 메시지: 페이지 오프셋 -23이 잘못되었습니다. 오프셋은 0보다 크거나 같은 정수여야 합니다.오류 조건: 잘못된 sysparm_offset 매개변수가 전달되었습니다. 매개변수는 sysparm_offset 정수여야 합니다. * 오류 메시지: 잘못된 쿼리 매개변수 - accnt오류 조건: 잘못된 쿼리 매개변수 "accnt"가 전달되었습니다. 매개변수는 "account"여야 합니다. * 오류 메시지: 잘못된 선택 값: 상태 = drft오류 조건: 잘못된 값 "drft"가 전달되었습니다. 매개변수 값은 "초안"이어야 합니다. |
| 오류.상세 정보 | 엔드포인트 호출이 실패한 원인에 대한 자세한 정보입니다. 데이터 유형: 문자열 |
| 오류.메시지 | 상위 수준에서 오류를 설명하는 메시지입니다. 데이터 유형: 문자열 |
| hasMore | 반환할 권리 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 권리 기록이 더 있습니다. * false: 더 이상 권리 기록이 없습니다. 데이터 유형: 부울 |
| 상태 | 엔드포인트 호출의 상태입니다. 가능한 값: * 실패: 요청을 처리할 때 오류가 발생했습니다. * 성공: 호출이 성공적으로 처리되었습니다. 데이터 유형: 문자열 |
| sysparm_limit | 엔드포인트 호출에서 매개변수가 sysparm_limit 전달된 경우 전달된 값이 포함되고, 그렇지 않으면 기본값이 포함됩니다. 데이터 유형: 숫자 |
| sysparm_offset | 엔드포인트 호출에서 매개변수가 sysparm_offset 전달된 경우 전달된 값이 포함되고, 그렇지 않으면 기본값이 포함됩니다. 데이터 유형: 숫자 |
[ ]
### cURL 요청
다음 코드 예제는 특정 계정에 대한 권리를 반환하는 방법을 보여줍니다.
curl "https://instance.service-now.com/api/sn_ent_verify/verifyentitlements?account=9e2fd2ee11b43110f877366201dea674" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
반환 결과:
{
"result": {
"sysparm_offset": "0",
"sysparm_limit": "10",
"has_more": "false",
"entitlements": [
{
"sys_id": "38374bf251e27110f877bf82d3ddf30a",
"entitlement_name": "test ent",
"account": "9e2fd2ee11b43110f877366201dea674",
"consumer": null,
"household": null,
"contract": "0e1747f251e27110f877bf82d3ddf31c",
"service_contract_line": "da278fb251e27110f877bf82d3ddf3b7",
"state": "active",
"product_offering": null,
"product_specification": null,
"sold_entitlement": null,
"product": null,
"start_date": "2023-11-21",
"end_date": ""
},
{
"sys_id": "e6ad4e4151723d10f877bf82d3ddf3fb",
"entitlement_name": "tets entitlement",
"account": "9e2fd2ee11b43110f877366201dea674",
"consumer": null,
"household": null,
"contract": "0e1747f251e27110f877bf82d3ddf31c",
"service_contract_line": "e79dce4151723d10f877bf82d3ddf31d",
"state": "active",
"product_offering": null,
"product_specification": null,
"sold_entitlement": null,
"product": null,
"start_date": "2023-11-21",
"end_date": ""
}
],
"status": "success"
}
}
### cURL 요청
다음 코드 예제는 특정 계정 및 서비스 계약 라인에 대한 권리를 반환하는 방법을 보여줍니다.
curl "https://instance.service-now.com/api/sn_ent_verify/verifyentitlements?service_contract_line=e79dce4151723d10f877bf82d3ddf31d&account=9e2fd2ee11b43110f877366201dea674" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
반환 결과:
{
"result": {
"sysparm_offset": "0",
"sysparm_limit": "10",
"has_more": "false",
"entitlements": [
{
"sys_id": "e6ad4e4151723d10f877bf82d3ddf3fb",
"entitlement_name": "test entitlement",
"account": "9e2fd2ee11b43110f877366201dea674",
"consumer": null,
"household": null,
"contract": "0e1747f251e27110f877bf82d3ddf31c",
"service_contract_line": "e79dce4151723d10f877bf82d3ddf31d",
"state": "active",
"product_offering": null,
"product_specification": null,
"sold_entitlement": null,
"product": null,
"start_date": "2023-11-21",
"end_date": ""
}
],
"status": "success"
}
}
### cURL 요청
다음 코드 예제에서는 오류 응답을 보여 줍니다.
curl "https://instance.service-now.com/api/sn_ent_verify/verifyentitlements?service_contract_line=e79dce4151723d10f877bf82d3ddf31d" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
반환 결과:
{
"error": {
"detail": "At least one of Account or Consumer parameter is mandatory.",
"message": "At least one of Account or Consumer parameter is mandatory."
},
"status": "failure"
}
## 권리 확인 - GET /sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/{id} {#ariaid-title3}
지정된 권리 특성 기록과 최신 사용 기록의 상세 정보를 반환합니다.
특성의 최신 사용 기록은 기간 시작 날짜가 현재 날짜보다 작거나 같고 기간 종료 날짜가 현재 날짜보다 크거나 같은 기록으로 정의됩니다.
### URL 형식 {#ver_entitle-GET-getEntitleChar__section_wzv_ksv_qzb}
버전이 지정된 URL: /api/sn_ent_verify/{api_version}/verifyentitlements/getEntitlementCharacteristic/{id}
기본 URL: /api/sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/{id}
주:
사용 가능한 버전은 [REST API 탐색기에](https://servicenow-prod.fluidtopics.net/arCv9b3UPYvLylUnDh9RpQ "이 튜토리얼에서는 REST API 탐색기를 사용하여 REST API를 테스트합니다 ServiceNow .") 지정됩니다. 스크립트 기반 REST API의 경우 [스크립트 기반 REST 서비스 양식](https://servicenow-prod.fluidtopics.net/vfCIdYdXpX8Ltk8_R7WfkA "스크립팅된 REST API 기능을 사용하면 애플리케이션 개발자가 사용자 지정 웹 서비스 API를 빌드할 수 있습니다.")에 추가 버전 정보가 있습니다.
### 지원되는 요청 매개변수
{#ver_entitle-GET-getEntitleChar__entry__2}{#ver_entitle-GET-getEntitleChar__version-not_optional-RESTAPI}
| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오. 데이터 유형: 문자열 |
| ID | 반환할 권리 특성 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 권리 특성 \[sn_pss_core_entitlement_characteristic\] |
[표 7. 경로 매개변수]
{#ver_entitle-GET-getEntitleChar__entry__8}{#ver_entitle-GET-getEntitleChar__csm-display_value-entry}
| 이름 | 설명 |
|-|-|
| display_value | 연결된 필드 값, 표시 값 또는 둘 다를 반환할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 응답에 필드의 표시 값만 포함됩니다. 예: `"state": "Draft"`. * false: 응답에 필드 값만 포함됩니다. 예:` "state": "draft"`. * all: 응답에 필드에 대한 모든 정보가 포함되어 있습니다. 예: "state": { "name": "state", "label": "State", "value": "draft", "display_value": "true", "type": "string" } 데이터 유형: 문자열 기본값: false |
[표 8. 쿼리 매개변수]
{#ver_entitle-GET-getEntitleChar__entry__12}
| 이름 | 설명 |
|-|-|
| 안 함 | |
[표 9. 요청 본문 매개변수(XML 또는 JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#ver_entitle-GET-getEntitleChar__entry__16}{#ver_entitle-GET-getEntitleChar__accept-RESTAPI}
| 머리글 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
[표 10. 요청 헤더]
{#ver_entitle-GET-getEntitleChar__entry__20}
| 머리글 | 설명 |
|-|-|
| 안 함 | |
[표 11. 응답 헤더]
### 상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 [REST API HTTP 응답 코드를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#ver_entitle-GET-getEntitleChar__entry__24}{#ver_entitle-GET-getEntitleChar__entry-200-status-code}{#ver_entitle-GET-getEntitleChar__entry-403-status-code}{#ver_entitle-GET-getEntitleChar__entry-404-status-code}{#ver_entitle-GET-getEntitleChar__entry-500-status-code}
| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
[표 12. 상태 코드]
### 응답 본문 매개변수(JSON 또는 XML)
{#ver_entitle-GET-getEntitleChar__entry__34}
| 이름 | 설명 |
|-|-|
| 특성 | 연결된 권리 특성 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 특성 \[sn_prd_pm_characteristic\] |
| characteristic_option | 연결된 특성 옵션 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 특성 옵션 \[sn_prd_pm_characteristic_option\] |
| entitlement_usage | 지정된 권리 특성 기록과 연결된 권리 사용 기록에 대한 상세 정보입니다. 데이터 유형: 객체 배열 "entitlement_usage": [ { "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "sys_id": "String", "total_units": "String", "used_units": "String" } ] |
| entitlement_usage.entitlement_characteristic | 연결된 권리 특성 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 권리 특성 \[sn_pss_core_entitlement_characteristic\] |
| entitlement_usage.period_end | 권리 사용 기록의 기간 종료 필드 값입니다. 이 값은 이 권리에 대한 사용량 추적이 종료되는 날짜입니다. 데이터 유형: 문자열 |
| entitlement_usage.period_start | 권리 사용 기록의 기간 시작 필드 값입니다. 이 값은 이 권리에 대해 사용량 추적이 시작되는 날짜입니다. 데이터 유형: 문자열 |
| entitlement_usage.sys_id | 반환된 권리 사용 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 권리 사용량 \[sn_pss_core_entitlement_usage\] |
| entitlement_usage.total_units | 구매한 총 단위 수입니다. 데이터 유형: 문자열 테이블: 권리 사용량 \[sn_pss_core_entitlement_usage\] 테이블의 total_units 필드입니다. |
| entitlement_usage.used_units | 사용된 단위 수입니다. 데이터 유형: 문자열 테이블: 권리 사용량 \[sn_pss_core_entitlement_usage\] 테이블의 used_units 필드 |
| sys_id | 권리 특성 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 권리 특성 \[sn_pss_core_entitlement_characteristic\] |
| 유형 | 권리 특성 기록의 유형 필드 값입니다. 가능한 값: * 범위 * coverage_and_usage 데이터 유형: 문자열 |
| 값 | 특성을 제공하는 범위입니다. 일부 특성의 경우 적용 범위는 특성 옵션 테이블에 정의되어 있습니다. 그러나 특성 옵션 테이블에 정의된 범위가 없으면 매개변수에 value 범위 정보를 전달할 수 있습니다. 특성 옵션은 다음 특성 유형에 대해서만 정의됩니다. * 확인란 * 선택 * 예/아니요 다른 모든 유형의 특성의 경우 매개변수에 value 범위 값이 포함되어야 합니다. 예를 들어, 특성이 "교체 수"이고 해당 범위가 특성 옵션 테이블에 정의되어 있지 않은 경우 이 매개변수에 "10", "20"과 같은 범위를 지정할 수 있습니다. 주: 이 매개변수에는 특성의 최종 범위 값이 포함됩니다. 특성 옵션 테이블에 정보가 있으면 이 매개변수로 전파됩니다. 데이터 유형: 문자열 |
[ ]
### cURL 요청
다음 코드 예제에서는 모든 기본값을 사용하여 이 엔드포인트를 호출하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/3c817faa43823110341605ed0bb8f23a" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
반환 결과:
{
"result": {
"sys_id": "3c817faa43823110341605ed0bb8f23a",
"characteristic": "b73177aa43823110341605ed0bb8f246",
"type": "coverage",
"characteristic_option": "ff617baa43823110341605ed0bb8f266",
"value": "Minor parts",
"entitlement_usage": [
{
"sys_id": "03e3224d51b23d10f877bf82d3ddf310",
"period_start": "2022-12-12",
"period_end": "2025-12-12",
"entitlement_characteristic": "3c817faa43823110341605ed0bb8f23a",
"total_units": "10",
"used_units": "5"
}
]
}
}
### cURL 요청
다음 코드 예제에서는 이 엔드포인트를 호출하고 모든 표시 값을 반환하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/3c817faa43823110341605ed0bb8f23a?display_value=all" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
반환 결과:
{
"result": {
"sys_id": {
"label": "Sys ID",
"value": "3c817faa43823110341605ed0bb8f23a",
"displayValue": "3c817faa43823110341605ed0bb8f23a",
"type": "GUID"
},
"characteristic": {
"name": "characteristic",
"label": "Characteristic",
"value": "b73177aa43823110341605ed0bb8f246",
"display_value": "Repair parts covered",
"type": "reference"
},
"type": {
"name": "type",
"label": "Type",
"value": "coverage",
"display_value": "Coverage",
"type": "string"
},
"characteristic_option": {
"name": "characteristic_option",
"label": "Characteristic option",
"value": "ff617baa43823110341605ed0bb8f266",
"display_value": "Minor parts",
"type": "reference"
},
"value": {
"name": "value",
"label": "Value",
"value": "Minor parts",
"display_value": "Minor parts",
"type": "string"
},
"entitlement_usage": [
{
"sys_id": {
"label": "Sys ID",
"value": "03e3224d51b23d10f877bf82d3ddf310",
"displayValue": "03e3224d51b23d10f877bf82d3ddf310",
"type": "GUID"
},
"period_start": {
"name": "period_start",
"label": "Period start",
"value": "2022-12-12",
"display_value": "2022-12-12",
"type": "glide_date"
},
"period_end": {
"name": "period_end",
"label": "Period end",
"value": "2025-12-12",
"display_value": "2025-12-12",
"type": "glide_date"
},
"entitlement_characteristic": {
"name": "entitlement_characteristic",
"label": "Entitlement characteristic",
"value": "3c817faa43823110341605ed0bb8f23a",
"display_value": "Repair parts covered",
"type": "reference"
},
"total_units": {
"name": "total_units",
"label": "Total units",
"value": "10",
"display_value": "10",
"type": "string"
},
"used_units": {
"name": "used_units",
"label": "Used units",
"value": "5",
"display_value": "5",
"type": "string"
}
}
]
}
}