---
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日
*
*  所要時間：35分
エンタイトルメント 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)
* カスタマーサービスインストールベース管理 (com.snc.install_base)
* 製品カタログ管理コア (com.sn_prd_pm)
さらに、この API を正常に呼び出すには、sn_pss_core.pss_integrator ロールが必要です。この API は `sn_pss_core` 名前空間で実行されます。
## エンタイトルメント:GET /sn_pss_core/entitlement/{id} {#ariaid-title2}
指定されたエンタイトルメントレコード、それに関連する範囲、および最新の使用状況の詳細を返します。
エンタイトルメントデータが保存されるテーブルのリストは次のとおりです。
* 特性 \[sn_pss_core_entitlement_characteristic\]
* エンタイトルメント \[service_entitlement\]
* エンタイトルメントの使用状況 \[sn_pss_core_entitlement_usage\]
* 対象の販売済み製品 \[sn_install_base_m2m_contract_sold_product\]:このテーブルには、対象の販売済み製品と対象のインストールベースアイテムの両方に関する情報が含まれています。
{#entitlement-GET-entitlement__ul_hcl_vlb_tzb}
### URL 形式 {#entitlement-GET-entitlement__section_jby_sbk_3xb}
バージョニングされた URL: /api/sn_pss_core/{api_version}/entitlement/{id}
デフォルト URL: /api/sn_pss_core/entitlement/{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 をビルドできます。")に追加のバージョン情報があります。
### サポートされている要求パラメーター
{#entitlement-GET-entitlement__entry__2}{#entitlement-GET-entitlement__version-not_optional-RESTAPI}
| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| ID | 取得するエンタイトルメントレコードのSys_id。 データタイプ：文字列 テーブル:エンタイトルメント \[service_entitlement\] |
[表 : 1. パスパラメーター]
{#entitlement-GET-entitlement__entry__8}
| 名前 | 説明 |
|-|-|
| display_value | 返されるデータのタイプ。 有効な値： * false:すべてのフィールドの `値を` 返します。たとえば、「 `state":"draft」`などです。 * true:すべてのフィールドの `display_value` を返します。例:" `state":"Draft"` * all:すべてのフィールドのすべての情報を返します。 {#entitlement-GET-entitlement__ul_ohj_gjv_szb} データタイプ：文字列 デフォルト値：false |
[表 : 2. クエリパラメーター]
{#entitlement-GET-entitlement__entry__12}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 3. 要求本文パラメーター (JSON)]
### ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#entitlement-GET-entitlement__entry__16}{#entitlement-GET-entitlement__accept-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 4. 要求ヘッダー]
{#entitlement-GET-entitlement__entry__20}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 5. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#entitlement-GET-entitlement__entry__24}{#entitlement-GET-entitlement__entry-200-status-code}{#entitlement-GET-entitlement__entry-400-status-code}{#entitlement-GET-entitlement__entry-403-status-code}{#entitlement-GET-entitlement__entry-404-status-code}{#entitlement-GET-entitlement__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
[表 : 6. ステータスコード]
### 応答本文のパラメーター
{#entitlement-GET-entitlement__entry__36}
| 名前 | 説明 |
|-|-|
| アカウント | エンタイトルメントが属するアカウントレコードのSys_id。 データタイプ：文字列 テーブル:アカウント \[customer_account\] |
| consumer | エンタイトルメントが属するコンシューマーレコードのSys_id。 データタイプ：文字列 テーブル:コンシューマー \[csm_consumer\] |
| contract | エンタイトルメントが属する契約レコードのSys_id。 データタイプ：文字列 テーブル:サービス契約 \[sn_pss_core_service_contract\] |
| end_date | エンタイトルメントの終了日。 データタイプ：文字列 形式:yyyy-mm-dd デフォルト:手動で削除するまで終了しません。 |
| entitlement_characteristics | エンタイトルメントに関連付けられた特性のリスト。 データタイプ：オブジェクトのアレイ "entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": [Array], "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" } ] 格納場所:特性 \[sn_pss_core_entitlement_characteristic\] |
| 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 | エンタイトルメント特性に関連付けられたエンタイトルメント使用状況のリスト。 データタイプ：オブジェクトのアレイ "entitlement_usage": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "total_units": "String", "used_units": "String" } ] |
| entitlement_characteristics。entitlement_usage。資格 | エンタイトルメントの使用状況に関連付けられたエンタイトルメントレコードのSys_id。 データタイプ：文字列 テーブル:エンタイトルメント \[service_entitlement\] |
| entitlement_characteristics。entitlement_usage。entitlement_characteristic | エンタイトルメントの使用状況に関連付けられたエンタイトルメント特性レコードのSys_id。 データタイプ：文字列 テーブル:特性 \[sn_pss_core_entitlement_characteristic\] |
| entitlement_characteristics。entitlement_usage。period_end | エンタイトルメントの使用状況が追跡されなくなる終了日。 データタイプ：文字列 形式:yyyy-mm-dd |
| entitlement_characteristics。entitlement_usage。period_start | エンタイトルメントの使用状況を追跡する開始日。 データタイプ：文字列 形式:yyyy-mm-dd |
| entitlement_characteristics。entitlement_usage。service_contract_line | 現在のエンタイトルメントの使用状況が属するサービス契約品目のSys_id。 データタイプ：文字列 |
| entitlement_characteristics。entitlement_usage。sys_created_by | エンタイトルメント使用レコードを作成したユーザーの名前。 データタイプ：文字列 |
| entitlement_characteristics。entitlement_usage。sys_created_on | エンタイトルメント使用レコードが作成された日時。 データタイプ：文字列 |
| entitlement_characteristics。entitlement_usage。sys_id | エンタイトルメント使用レコードのSys_id。 データタイプ：文字列 テーブル:エンタイトルメントの使用状況 \[sn_pss_core_entitlement_usage\] |
| entitlement_characteristics。entitlement_usage。sys_updated_by | エンタイトルメント使用レコードを最後に更新したユーザーの名前。 データタイプ：文字列 |
| entitlement_characteristics。entitlement_usage。sys_updated_on | エンタイトルメント使用レコードが最後に更新された日時。 データタイプ：文字列 |
| entitlement_characteristics。entitlement_usage。total_units | 関連付けられたエンタイトルメント特性の合計範囲値。 データタイプ：文字列 |
| entitlement_characteristics。entitlement_usage。used_units | アカウントまたはコンシューマーが period_start と period_endの間で使用するユニットの数。 データタイプ：文字列 |
| entitlement_characteristics。種類 | エンタイトルメント特性のタイプ。 有効な値： * 範囲 * coverage_and_usage データタイプ：文字列 |
| entitlement_characteristics。価値 | 特性の値。 データタイプ：文字列 |
| entitlement_name | エンタイトルメントの名前。 データタイプ：文字列 |
| 世帯 | エンタイトルメントに関連付けられた世帯レコードのSys_id。 データタイプ：文字列 テーブル:世帯 \[csm_household\] |
| install_base_items_covered | エンタイトルメントの対象となるインストールベースアイテムのリスト。 データタイプ：オブジェクトのアレイ "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" } ] テーブル:対象の販売済み製品 \[sn_install_base_m2m_contract_sold_product\] |
| 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 | インストールベースアイテムレコードが最後に更新された日時。 データタイプ：文字列 |
| product | エンタイトルメントに関連付けられた製品モデルレコードの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 | 対象製品のリスト。 データタイプ：オブジェクトのアレイ "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" } ] テーブル:対象の販売済み製品 \[sn_install_base_m2m_contract_sold_product\] |
| 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.removed | 関連する販売済み製品がエンタイトルメントから削除された日付。 データタイプ：文字列 形式: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",
"service_contract_line": null,
"entitlement_characteristic": "12651515d1f53110f8776589fa411f7e",
"period_start": "2023-10-03",
"period_end": "2024-12-03",
"total_units": "5",
"used_units": "25"
}
]
}
]
}
}
## エンタイトルメント:POST /sn_pss_core/entitlement {#ariaid-title3}
エンタイトルメントレコードとそれに関連するすべての詳細レコードを作成します。
エンタイトルメントデータが保存されるテーブルのリストは次のとおりです。
* 特性 \[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/{api_version}/entitlement
デフォルト URL: /api/sn_pss_core/entitlement
注:
使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。
### サポートされている要求パラメーター
{#entitlement-POST-entitlement__entry__2}{#entitlement-POST-entitlement__version-not_optional-RESTAPI}
| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 7. パスパラメーター]
{#entitlement-POST-entitlement__entry__6}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 8. クエリパラメーター]
{#entitlement-POST-entitlement__entry__10}
| 名前 | 説明 |
|-|-|
| アカウント | consumerパラメーターが渡されない場合は必須です。 エンタイトルメントが属するアカウントレコードのSys_id。 データタイプ：文字列 テーブル:アカウント \[customer_account\] |
| consumer | accountパラメーターが渡されない場合は必須です。 エンタイトルメントが属するコンシューマーレコードのSys_id。 データタイプ：文字列 テーブル:コンシューマー \[csm_consumer\] |
| end_date | エンタイトルメントの終了日。 データタイプ：文字列 形式:yyyy-mm-dd デフォルト:手動で削除するまで終了しません。 |
| entitlement_characteristics | エンタイトルメントに関連付けられた特性のリスト。 データタイプ：オブジェクトのアレイ "entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ] 格納場所:特性 \[sn_pss_core_entitlement_characteristic\] |
| entitlement_characteristics。特性 | 必須です。 エンタイトルメントに関連付けられた特性レコードのSys_id。 データタイプ：文字列 テーブル:特性 \[sn_prd_pm_characteristic\] |
| entitlement_characteristics。characteristic_option | エンタイトルメントに関連付けられた特性オプションレコードのSys_id。 データタイプ：文字列 テーブル:特性オプション \[sn_prd_pm_characteristic_option\] |
| entitlement_characteristics。entitlement_usage | 関連付けられたエンタイトルメント特性に使用される単位値。 entitlement_characteristicsがエンタイトルメントの下にある場合にのみ、このパラメーターを渡します。 データタイプ: オブジェクト "entitlement_usage": { "used_units": "String" } 保存場所:エンタイトルメントの使用状況 \[sn_pss_core_entitlement_usage\] |
| entitlement_characteristics。entitlement_usage。usage_units | 関連付けられたエンタイトルメント特性の使用法。 データタイプ：文字列 |
| entitlement_characteristics。種類 | エンタイトルメント特性のタイプ。 有効な値： * 範囲 * coverage_and_usage データタイプ：文字列 |
| entitlement_characteristics。価値 | entitlement_characteristics.characteristicパラメーターで指定されたレコードに含まれるinput_typeパラメーターが`選択`されない場合は必須です。 特性の値。 データタイプ：文字列 |
| entitlement_name | 必須です。 エンタイトルメントの名前。 データタイプ：文字列 |
| 世帯 | 世帯プラグインがアクティブで、 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](https://www.servicenow.com/docs/access?context=configure-install-base&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。 |
| install_base_items_covered.added | 関連付けられたインストールベースアイテムがエンタイトルメントに追加された日付。 データタイプ：文字列 形式:yyyy-mm-dd デフォルト:現在の日付 |
| install_base_items_covered。install_base | 関連付けられたインストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] |
| install_base_items_covered。削除 | 関連付けられたインストールベースアイテムがエンタイトルメントから削除された日付。 データタイプ：文字列 形式:yyyy-mm-dd デフォルト:終了日なし |
| product | エンタイトルメントに関連付けられた製品モデルレコードの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 | エンタイトルメントの対象となる製品のリスト。 データタイプ：オブジェクトのアレイ "sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ] 保存場所:対象の製品の販売 \[sn_install_base_m2m_contract_sold_product\] |
| sold_products_covered.added | 関連する販売済み製品がエンタイトルメントに追加された日付。 データタイプ：文字列 形式:yyyy-mm-dd デフォルト:現在の日付 |
| sold_products_covered.removed | 関連する販売済み製品がエンタイトルメントから削除された日付。 データタイプ：文字列 形式:yyyy-mm-dd デフォルト:終了日なし |
| sold_products_covered.sold_product | エンタイトルメントの対象となる製品のSys_id。 データタイプ：文字列 テーブル:販売済み製品 \[sn_install_base_sold_product\] |
| start_date | 必須です。 エンタイトルメントの開始日。 データタイプ：文字列 形式:yyyy-mm-dd |
| 状況 | 必須です。 エンタイトルメントの現在のステータス。 有効な値:(大文字と小文字を区別) * アクティブ * キャンセル * ドラフト * 期限切れ * 一時停止 データタイプ：文字列 |
[表 : 9. 要求本文パラメーター (JSON)]
### ヘッダー {#entitlement-POST-entitlement__section_bdz_2rp_4xb}
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#entitlement-POST-entitlement__table_cdz_2rp_4xb__entry__2}{#entitlement-POST-entitlement__accept-RESTAPI}{#entitlement-POST-entitlement__content_type-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 10. 要求ヘッダー]
{#entitlement-POST-entitlement__table_cdz_2rp_4xb} {#entitlement-POST-entitlement__table_ddz_2rp_4xb__entry__2}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 11. 応答ヘッダー]
{#entitlement-POST-entitlement__table_ddz_2rp_4xb}
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#entitlement-POST-entitlement__entry__72}{#entitlement-POST-entitlement__entry-400-status-code}{#entitlement-POST-entitlement__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 201 | 成功。要求が正常に処理され、レコードが作成されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 403 | 禁止されました。ユーザーには API にアクセスする権限がありません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
[表 : 12. ステータスコード]
### 応答本文のパラメーター (JSON)
{#entitlement-POST-entitlement__entry__82}
| 名前 | 説明 |
|-|-|
| 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"
}
}
]
}
}