エンタイトルメント API

Zurich API リファレンス

Release

zurich

ft:locale

ja-JP

ft:publication_title

Zurich API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

エンタイトルメント API

リリースバージョン: Zurich

更新日 2025年07月31日

所要時間：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)
Customer Service インストールベース管理 (com.snc.install_base)
製品カタログ管理コア (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/{api_version}/entitlement/{id}

デフォルト URL: /api/sn_pss_core/entitlement/{id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
ID	取得するエンタイトルメントレコードのSys_id。データタイプ：文字列テーブル:エンタイトルメント [service_entitlement]

表 : 2. クエリパラメーター
名前	説明
display_value	返されるデータのタイプ。有効な値： false:すべてのフィールド `の値` を返します。例: `"state":"draft"`。 true:すべてのフィールドの `display_value` を返します。例: `"state":"Draft"` all:すべてのフィールドのすべての情報を返します。データタイプ：文字列デフォルト値：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]
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	インストールベースアイテムレコードが最後に更新された日時。データタイプ：文字列
製品	エンタイトルメントに関連付けられた製品モデルレコードの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
state	エンタイトルメントの現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセル draft 期限切れ中断データタイプ：文字列
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/エンタイトルメント

エンタイトルメントレコードとそれに関連するすべての詳細レコードを作成します。

エンタイトルメントデータが保存されるテーブルのリストは次のとおりです。

特性 [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

注:

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 8. クエリパラメーター
名前	説明
なし

表 : 9. 要求本文パラメーター (JSON)
名前	説明
アカウント	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を参照してください。
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 デフォルト:終了日なし
製品	エンタイトルメントに関連付けられた製品モデルレコードの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
state	必須。エンタイトルメントの現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセル draft 期限切れ中断データタイプ：文字列

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json
Content-Type	要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 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"
        }
      }
    ]
  }
}