---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference
Release :
- australia
ft:locale :
- ja-JP
ft:publication_title :
- オーストラリア API リファレンス
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# エンタイトルメント API の検証
# エンタイトルメント API の検証 {#ariaid-title1}
* リリースバージョン: Australia
*
* 更新日 2026年03月12日
*
*  所要時間：30分
Verify Entitlements 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/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス 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 または consumer パラメーターのいずれかを渡す必要があります。これらは相互に排他的です。エンタイトルメントレコードを返すアカウントレコードのSys_id。 データタイプ：文字列 デフォルト：なし テーブル:アカウント \[customer_account\] |
| consumer | account または consumer パラメーターのいずれかを渡す必要があります。これらは相互に排他的です。エンタイトルメントレコードを返すコンシューマーレコードのSys_id。 データタイプ：文字列 デフォルト：なし テーブル:コンシューマー \[csm_consumer\] |
| contract | エンタイトルメントレコードを返す契約レコードの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\] |
| product | エンタイトルメントレコードを返す製品レコードの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/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#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/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#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" } ] |
| entitlements.account | このエンタイトルメントに関連付けられたアカウントレコードのSys_id。 データタイプ：文字列 テーブル:アカウント \[customer_account\] |
| entitlements.consumer | このエンタイトルメントに関連付けられたコンシューマーレコードのSys_id。 データタイプ：文字列 テーブル:コンシューマー \[csm_consumer\] |
| entitlements.contract | このエンタイトルメントに関連付けられた契約レコードのSys_id。 データタイプ：文字列 テーブル:契約 \[sn_pss_core_service_contract\] |
| entitlements.end_date | 関連付けられたエンタイトルメントレコードの \[終了日\] フィールドの値。 データタイプ：文字列 |
| entitlements.entitlement_name | エンタイトルメントの名前。 データタイプ：文字列 |
| entitlements.household | このエンタイトルメントに関連付けられた世帯レコードの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.state | エンタイトルメントレコードのステータス。 可能な値： * アクティブ * キャンセル * ドラフト * 期限切れ * 一時停止 データタイプ：文字列 |
| 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」が渡されました。パラメーター値は「draft」である必要があります。 |
| error.detail | エンドポイント呼び出しが失敗した理由に関する詳細情報。 データタイプ：文字列 |
| error.message | エラーの概要を説明するメッセージ。 データタイプ：文字列 |
| hasMore | 返すエンタイトルメントレコードが他にあるかどうかを示すフラグ。 可能な値： * true:返されるエンタイトルメントレコードが増えます。 * false:エンタイトルメントレコードはありません。 データタイプ：ブーリアン |
| status | エンドポイント呼び出しのステータス。 可能な値： * failure:要求の処理中にエラーが発生しました。 * 成功:コールは正常に処理されました。 データタイプ：文字列 |
| 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/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス 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/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#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/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#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\] |
| type | エンタイトルメント特性レコードのタイプフィールドの値。 可能な値： * 範囲 * coverage_and_usage データタイプ：文字列 |
| value | 特性を指定する範囲。 一部の特性では、補償は特性オプションテーブルで定義されます。ただし、\[特性オプション\] テーブルに補償が定義されていない場合は、 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"
}
}
]
}
}