エンタイトルメント API

ワシントンDC API リファレンス

Release

washingtondc

ft:locale

ja-JP

ft:publication_title

ワシントンDC API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

エンタイトルメント API

リリースバージョン: Washingtondc

更新日 2024年02月01日

読む34読むのに数分

エンタイトルメント 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)
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":"Draft"` 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] テーブルにあります。データタイプ：文字列
consumer	資格付与が属するコンシューマーレコードの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	エンタイトルメントの名前。データタイプ：文字列
世帯	エンタイトルメントに関連付けられた世帯レコード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/エンタイトルメント

資格付与レコードとそれに関連するすべての詳細レコードを作成します。

資格付与データが保存されるテーブルのリストは次のとおりです。

特性[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] テーブルにあります。データタイプ：文字列
consumer	パラメーターが渡されない場合は 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。値	input_typeパラメーターで指定されたentitlement_characteristics.characteristicレコードに含まれるパラメーターが`選択肢`でない場合は必須です。特性の値。データタイプ：文字列
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.追加	関連するインストールベースアイテムがエンタイトルメントに追加された日付。データタイプ：文字列形式：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
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"
        }
      }
    ]
  }
}