サービス契約 API

リリースバージョン: Washingtondc

更新日 2024年02月01日

読む154読むのに数分

サービス契約 API を使用すると、サービス契約レコードを作成および取得できます。

注:

この API は、カスタマー契約とエンタイトルメントアプリケーションのテーブルにデータを作成するためのものです。汎用 API ではありません。

この API にアクセスするには、関連するインスタンスで次のプラグインを有効にする必要があります。

顧客契約とエンタイトルメント (com.sn_pss_core)
Customer Service インストールベース管理 (com.snc.install)
Product Catalog 管理コア (com.sn_prd)

また、この API を正常に呼び出すには、sn_pss_core.pss_integrator ロールが必要です。この API は sn_pss_core 名前空間で実行されます。

この API を使用する前に、次のテーブルにデータが関連付けられている必要があります。詳細については、「Create service contracts」を参照してください。

アカウント (customer_account)
コンシューマー (csm_consumer)
世帯 [csm_household]
インストールベース [sn_install_base_item]
製品オファリング [sn_prd_pm_product_offering]
製品モデル [cmdb_model]
販売済み製品 [sn_install_base_sold_product]

サービス契約 - GET /sn_pss_core/servicecontract/{id}

指定されたサービス契約レコードを取得します。

このエンドポイントは、要求を処理するときに次のテーブルのデータを取得します。

特性[sn_pss_core_entitlement_characteristic]
エンタイトルメント [service_entitlement]
エンタイトルメント使用 [sn_pss_core_entitlement_usage]
対象製品の販売 [sn_install_base_m2m_contract_sold_product]:このテーブルには、対象の販売済み製品と対象インストールベースアイテムの両方の情報が含まれています。
サービス契約 [sn_pss_core_service_contract]
サービス契約品目 [sn_pss_core_service_contract_line]

URL 形式

バージョニングされた URL:/ api/sn_pss_core/v1/servicecontract/{id}

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

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

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

表 : 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. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

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

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

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
403	禁止されました。ユーザーには API にアクセスする権限がありません。
404	見つかりません。要求アイテムが見つかりませんでした。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)


名前	説明
アカウント	サービス契約が属するアカウントレコードSys_id。アカウント [customer_account] テーブルにあります。データタイプ：文字列
consumer	サービス契約が属するコンシューマーレコードSys_id。コンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
終了	サービス契約が終了する日付。データタイプ：文字列
世帯	サービス契約に関連付けられている世帯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" } ]`
install_base_items_covered。追加	関連付けられたサービス契約がインストールベースアイテムの適用を開始する日付。データタイプ：文字列
install_base_items_covered。契約	インストールベースアイテムに関連付けられたサービス契約レコードSys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
install_base_items_covered。資格	インストールベースアイテムに関連付けられたエンタイトルメントレコードのSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
install_base_items_covered。install_base	関連付けられたインストールベースアイテムレコードのSys_id。インストールベースアイテム [sn_install_base_item] テーブルにあります。データタイプ：文字列
install_base_items_covered。削除	関連付けられたサービス契約がインストールベースアイテムの提供を終了する日付。データタイプ：文字列
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	インストールベースアイテムレコードが最後に更新された日時。データタイプ：文字列
番号	自動生成されたサービス契約番号。データタイプ：文字列
service_contract_lines	サービス契約に関連付けられているサービス契約品目 (サービス) のリスト。データタイプ：オブジェクトのアレイ `"service_contract_lines": [ { "contract": "String", "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "product_model": "String", "product_offering": "String", "sold_product": "String", "sold_product_covered": [Array], "starts": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String" } ]`
service_contract_lines。契約	サービス契約品目に関連付けられたサービス契約Sys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
service_contract_lines。終了	サービス契約品目が終了する日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト: 手動で削除するまで終了しません。
service_contract_lines。資格	サービス契約に関連付けられたエンタイトルメントのリスト。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：オブジェクトのアレイ "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "entitlement_usages": [Array], "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]
service_contract_lines。資格。アカウント	エンタイトルメントが属するアカウントレコードSys_id。アカウント [customer_account] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。消費者	資格付与が属するコンシューマーレコードのSys_id。コンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。契約	エンタイトルメントが属する契約レコードのSys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。end_date	エンタイトルメントの終了日。データタイプ：文字列形式：yyyy-mm-dd デフォルト: 手動で削除するまで終了しません。
service_contract_lines。資格。entitlement_characteristics	資格付与に関連付けられた特性のリスト。特性 [sn_pss_core_entitlement_characteristic] テーブルにあります。データタイプ：オブジェクトのアレイ `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "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" } ]`
service_contract_lines。資格。entitlement_characteristics.特性	エンタイトルメントに関連付けられた特性レコードSys_id。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics.characteristic_option	エンタイトルメントに関連付けられた特性オプションレコードのSys_id。特性オプション [sn_prd_pm_characteristic_option] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics。資格	関連するエンタイトルメントレコードのSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics。service_contract_line	エンタイトルメント特性に関連付けられたサービス契約品目レコードSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics。sys_created_by	エンタイトルメント特性レコードを作成したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics。sys_created_on	エンタイトルメント特性レコードが作成された日時。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics。sys_id	エンタイトルメント特性レコードのSys_id。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics。sys_updated_by	エンタイトルメント特性レコードを最後に更新したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics。sys_updated_on	エンタイトルメント特性レコードが最後に更新された日時。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics.type	エンタイトルメント特性のタイプ。有効な値：範囲カバー範囲と使用状況データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics.value	特性の値。データタイプ：文字列
service_contract_lines。資格。entitlement_name	エンタイトルメントの名前。データタイプ：文字列
service_contract_lines。資格。entitlement_usages	関連付けられた製品の使用状況の値のリスト。データタイプ：オブジェクトのアレイ `"entitlement_usages": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String", "total_units": "String", "used_units": "String" } ]`
service_contract_lines。資格。entitlement_usages。資格	エンタイトルメント使用に関連付けられたエンタイトルメントレコードSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_usages。entitlement_characteristic	エンタイトルメント使用に関連付けられたエンタイトルメント特性レコードのSys_id。特性 [sn_pss_core_entitlement_characteristic] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_usages。period_end	エンタイトルメントの使用が追跡されなくなる終了日。データタイプ：文字列形式：yyyy-mm-dd
service_contract_lines。資格。entitlement_usages。period_start	エンタイトルメントの使用を追跡する開始日。データタイプ：文字列形式：yyyy-mm-dd
service_contract_lines。資格。entitlement_usages。sys_created_by	エンタイトルメント使用レコードを作成したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。entitlement_usages。sys_created_on	エンタイトルメント使用レコードが作成された日時。データタイプ：文字列
service_contract_lines。資格。entitlement_usages。sys_id	エンタイトルメント使用レコードのSys_id。エンタイトルメント使用 [sn_pss_core_entitlement_usage] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_usages。sys_updated_by	エンタイトルメント使用レコードを最後に更新したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。entitlement_usages。sys_updated_on	エンタイトルメント使用レコードが最後に更新された日時。データタイプ：文字列
service_contract_lines。資格。entitlement_usages。total_units	購入したユニットの合計数。データタイプ：文字列
service_contract_lines。資格。entitlement_usages。used_units	使用されたユニットの数。データタイプ：文字列
service_contract_lines。資格。世帯	エンタイトルメントに関連付けられた世帯レコードSys_id。世帯 [csm_household] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。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" } ]`
service_contract_lines。資格。install_base_items_covered。追加	関連するインストールベースアイテムがエンタイトルメントに追加された日付。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。契約	インストールベースアイテムに関連付けられたサービス契約レコードSys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。資格	インストールベースアイテムに関連付けられたエンタイトルメントレコードのSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。install_base	関連付けられたインストールベースアイテムレコードのSys_id。インストールベースアイテム [sn_install_base_item] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。削除	関連付けられたインストールベースアイテムがエンタイトルメントから削除された日付。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。service_contract_line	関連付けられたサービス契約品目レコードのSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。sys_created_by	インストールベースアイテムレコードを作成したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。sys_created_on	インストールベースアイテムレコードが作成された日時。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。sys_id	対象のインストールベースアイテムのSys_id。対象となる販売済み製品の [sn_install_base_m2m_contract_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。sys_updated_by	インストールベースアイテムレコードを最後に更新したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered。sys_updated_on	インストールベースアイテムレコードが最後に更新された日時。データタイプ：文字列
service_contract_lines。資格。製品	エンタイトルメントに関連付けられた製品モデルレコードのSys_id。製品モデル [cmdb_model] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。product_offering	資格付与に関連付けられた製品オファリングレコードSys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。service_contract_line	エンタイトルメントに関連付けられたサービス契約品目レコードSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sold_entitlement	エンタイトルメントに関連付けられた販売済み製品レコードSys_id。販売済み製品テーブル [sn_install_base_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。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" } ]`
service_contract_lines。資格。sold_products_covered。追加	関連付けられた販売済み製品がエンタイトルメントに追加された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:現在の日付
service_contract_lines。資格。sold_products_covered。契約	対象の販売済み製品に関連付けられたサービス契約レコードのSys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
資格。sold_products_covered。資格	販売対象製品に関連付けられたエンタイトルメントレコードSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sold_products_covered.削除済み	関連付けられた販売済み製品がエンタイトルメントから削除された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:終了日なし
service_contract_lines。資格。sold_products_covered。service_contract_line	対象の販売済み製品に関連付けられているサービス契約品目レコードのSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sold_products_covered。sold_product	エンタイトルメントの対象となる製品のSys_id。販売済み製品テーブル [sn_install_base_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sold_products_covered。sys_created_by	販売対象製品レコードを作成したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。sold_products_covered。sys_created_on	対象の製品の販売レコードが作成された日時。データタイプ：文字列
service_contract_lines。資格。sold_products_covered。sys_id	本サービス契約の対象となる製品のSys_id。対象となる販売済み製品の [sn_install_base_m2m_contract_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sold_products_covered。sys_updated_by	販売対象製品レコードを最後に更新したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。sold_products_covered。sys_updated_on	対象の製品の販売レコードが最後に更新された日時。データタイプ：文字列
service_contract_lines。資格。start_date	エンタイトルメントの開始日。データタイプ：文字列形式：yyyy-mm-dd
service_contract_lines。資格。状態	エンタイトルメントの現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセルドラフト期限切れ中断データタイプ：文字列
service_contract_lines。資格。sys_created_by	エンタイトルメントレコードを作成したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。sys_created_on	エンタイトルメントレコードが作成された日時。データタイプ：文字列
service_contract_lines。資格。sys_id	関連するエンタイトルメントレコードのSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sys_updated_by	エンタイトルメントレコードを最後に更新したユーザーの名前。データタイプ：文字列
service_contract_lines。資格。sys_updated_on	エンタイトルメントレコードが作成された日時。データタイプ：文字列
service_contract_lines。entitlement_characteristics	サービス契約品目に関連付けられた特性のリスト。特性 [sn_pss_core_entitlement_characteristic] テーブルにあります。データタイプ：オブジェクトのアレイ `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "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" } ]`
service_contract_lines。entitlement_characteristics.特性	エンタイトルメントに関連付けられた特性レコードSys_id。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
service_contract_lines。entitlement_characteristics.characteristic_option	エンタイトルメントに関連付けられた特性オプションレコードのSys_id。特性オプション [sn_prd_pm_characteristic_option] テーブルにあります。データタイプ：文字列
service_contract_lines。entitlement_characteristics。資格	関連するエンタイトルメントレコードのSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
service_contract_lines。entitlement_characteristics。service_contract_line	エンタイトルメント特性に関連付けられたサービス契約品目レコードSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
service_contract_lines。entitlement_characteristics。sys_created_by	エンタイトルメント特性レコードを作成したユーザーの名前。データタイプ：文字列
service_contract_lines。entitlement_characteristics。sys_created_on	エンタイトルメント特性レコードが作成された日時。データタイプ：文字列
service_contract_lines。entitlement_characteristics。sys_id	エンタイトルメント特性レコードのSys_id。データタイプ：文字列
service_contract_lines。entitlement_characteristics。sys_updated_by	エンタイトルメント特性レコードを最後に更新したユーザーの名前。データタイプ：文字列
service_contract_lines。entitlement_characteristics。sys_updated_on	エンタイトルメント特性レコードが最後に更新された日時。データタイプ：文字列
service_contract_lines。entitlement_characteristics.type	エンタイトルメント特性のタイプ。有効な値：範囲カバー範囲と使用状況データタイプ：文字列
service_contract_lines。entitlement_characteristics.value	特性の値。データタイプ：文字列
service_contract_lines。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" } ]`
service_contract_lines。install_base_items_covered。追加	関連するインストールベースアイテムがサービス契約品目に追加された日付。データタイプ：文字列
service_contract_lines。install_base_items_covered。契約	インストールベースアイテムに関連付けられたサービス契約レコードSys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
service_contract_lines。install_base_items_covered。資格	インストールベースアイテムに関連付けられたエンタイトルメントレコードのSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
service_contract_lines。install_base_items_covered。install_base	サービス契約品目の対象となるインストールベースアイテムのSys_id。インストールベースアイテム [sn_install_base_item] テーブルにあります。データタイプ：文字列
service_contract_lines。install_base_items_covered。削除	関連付けられたサービス契約品目がインストールベースアイテムの提供範囲を終了する日付。データタイプ：文字列
service_contract_lines。install_base_items_covered。service_contract_line	関連付けられたサービス契約品目レコードのSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
service_contract_lines。install_base_items_covered。sys_created_by	インストールベースアイテムレコードを作成したユーザーの名前。データタイプ：文字列
service_contract_lines。install_base_items_covered。sys_created_on	インストールベースアイテムレコードが作成された日時。データタイプ：文字列
service_contract_lines。install_base_items_covered。sys_id	対象のインストールベースアイテムのSys_id。対象となる販売済み製品の [sn_install_base_m2m_contract_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。install_base_items_covered。sys_updated_by	インストールベースアイテムレコードを最後に更新したユーザーの名前。データタイプ：文字列
service_contract_lines。install_base_items_covered。sys_updated_on	インストールベースアイテムレコードが最後に更新された日時。データタイプ：文字列
service_contract_lines。名前	サービス契約品目の名前。データタイプ：文字列
service_contract_lines。product_model	サービス契約品目に関連付けられた製品のSys_id。製品モデル [cmdb_model] テーブルにあります。データタイプ：文字列
service_contract_lines。product_offering	サービス契約品目に関連付けられた製品オファリングレコードSys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
service_contract_lines。sold_product	サービス契約品目に関連付けられた販売済み製品レコードSys_id。販売済み製品テーブル [sn_install_base_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。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" } ]`
service_contract_lines。sold_products_covered。追加	関連付けられた販売済み製品がサービス契約品目に追加された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:現在の日付
service_contract_lines。sold_products_covered。契約	対象の販売済み製品に関連付けられたサービス契約レコードのSys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
service_contract_lines。sold_products_covered。資格	販売対象製品に関連付けられたエンタイトルメントレコードSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
service_contract_lines。sold_products_covered.削除済み	関連する販売済み製品がサービス契約品目から削除された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:終了日なし
service_contract_lines。sold_products_covered。service_contract_line	対象の販売済み製品に関連付けられているサービス契約品目レコードのSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
service_contract_lines。sold_products_covered。sold_product	エンタイトルメントの対象となる製品のSys_id。販売済み製品テーブル [sn_install_base_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。sold_products_covered。sys_created_by	販売対象製品レコードを作成したユーザーの名前。データタイプ：文字列
service_contract_lines。sold_products_covered。sys_created_on	対象の製品の販売レコードが作成された日時。データタイプ：文字列
service_contract_lines。sold_products_covered。sys_id	本サービス契約の対象となる製品のSys_id。対象となる販売済み製品の [sn_install_base_m2m_contract_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。sold_products_covered。sys_updated_by	販売対象製品レコードを最後に更新したユーザーの名前。データタイプ：文字列
service_contract_lines。sold_products_covered。sys_updated_on	対象の製品の販売レコードが最後に更新された日時。データタイプ：文字列
service_contract_lines。開始	サービス契約品目の開始日。データタイプ：文字列形式：yyyy-mm-dd
service_contract_lines。状態	サービス契約品目の現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセルドラフト期限切れ中断データタイプ：文字列
service_contract_lines。sys_created_by	サービス契約品目レコードを作成したユーザーの名前。データタイプ：文字列
service_contract_lines。sys_created_on	サービス契約品目レコードが作成された日時。データタイプ：文字列
service_contract_lines。sys_id	サービス契約品目レコードSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
service_contract_lines。sys_updated_by	サービス契約品目レコードを最後に更新したユーザーの名前。データタイプ：文字列
service_contract_lines。sys_updated_on	サービス契約品目レコードが最後に更新された日時。データタイプ：文字列
short_description	サービス契約の簡単な説明または名前。データタイプ：文字列
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。追加	関連付けられた販売済み製品が契約に追加された日付。データタイプ：文字列
sold_products_covered。契約	対象の販売済み製品に関連付けられたサービス契約レコードのSys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
sold_products_covered。資格	販売対象製品に関連付けられたエンタイトルメントレコードSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
sold_products_covered。削除	関連付けられた販売済み製品が契約から除外された日付。データタイプ：文字列
sold_products_covered。service_line_contract	対象の販売済み製品に関連付けられているサービス契約品目レコードの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	対象の製品の販売レコードが最後に更新された日時。データタイプ：文字列
開始	サービス契約が開始される日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:承認されるとすぐに開始します。
ステータス	サービス契約の現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセルドラフト期限切れ中断データタイプ：文字列
sys_created_by	サービス契約レコードを作成したユーザーの名前。データタイプ：文字列
sys_created_on	サービス契約が作成された日時レコード。データタイプ：文字列
sys_id	サービス契約レコードのSys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
sys_updated_by	サービス契約レコードを最後に更新したユーザーの名前。データタイプ：文字列
sys_updated_on	サービス契約レコードが最後に更新された日時。データタイプ：文字列
vendor_contract	関連付けられた外部契約の一意の識別子。データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを呼び出す方法を示しています。

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/fc73d2de89226110f877430a4e008add" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

応答：

{
    "result": {
        "sys_id": "d8641151d1f53110f8776589fa411fde",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:27:29",
        "sys_updated_on": "2023-10-09 11:27:29",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "number": "CNTR0010004",
        "state": "active",
        "starts": "2022-12-03",
        "ends": "",
        "short_description": null,
        "vendor_contract": "External Reference",
        "service_contract_lines": [
            {
                "sys_id": "d4641d91d1f53110f8776589fa411fbb",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "name": "CLI",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_model": null,
                "entitlements": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fc0",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "entitlement_name": "ENTL",
                        "account": "4c325111d1f53110f8776589fa411f3d",
                        "consumer": null,
                        "household": null,
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "state": "active",
                        "product_offering": null,
                        "sold_entitlement": null,
                        "product": null,
                        "start_date": "2022-12-03",
                        "end_date": "",
                        "entitlement_characteristics": [
                            {
                                "sys_id": "a8641d91d1f53110f8776589fa411fd0",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "service_contract_line": null,
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                                "value": "5",
                                "characteristic": "63418db7539e61106bfcddeeff7b1238",
                                "type": "coverage_and_usage"
                            }
                        ],
                        "entitlement_usages": [
                            {
                                "sys_id": "a8641d91d1f53110f8776589fa411fd1",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "entitlement_characteristic": "a8641d91d1f53110f8776589fa411fd0",
                                "period_start": "2022-12-03",
                                "period_end": "",
                                "total_units": "5",
                                "used_units": "3"
                            }
                        ],
                        "sold_products_covered": [
                            {
                                "sys_id": "a0641d91d1f53110f8776589fa411fc2",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "contract": "d8641151d1f53110f8776589fa411fde",
                                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "sold_product": "da23d151d1f53110f8776589fa411f27",
                                "added": "",
                                "removed": ""
                            }
                        ],
                        "install_base_items_covered": [
                            {
                                "sys_id": "e0641d91d1f53110f8776589fa411fc3",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "contract": "d8641151d1f53110f8776589fa411fde",
                                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "install_base": "43739151d1f53110f8776589fa411fc1",
                                "added": "2023-12-03",
                                "removed": "2023-12-03"
                            }
                        ]
                    }
                ],
                "sold_products_covered": [
                    {
                        "sys_id": "98641d91d1f53110f8776589fa411fbc",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "install_base_items_covered": [
                    {
                        "sys_id": "58641d91d1f53110f8776589fa411fbd",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "install_base": "a1731551d1f53110f8776589fa411f8d",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "entitlement_characteristics": [
                    {
                        "sys_id": "e0641d91d1f53110f8776589fa411fbf",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                        "value": "5",
                        "characteristic": "63418db7539e61106bfcddeeff7b1238",
                        "type": "coverage"
                    }
                ]
            },
            {
                "sys_id": "e4641d91d1f53110f8776589fa411fd2",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "name": "CLI 2",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_model": null,
                "entitlements": [],
                "sold_products_covered": [
                    {
                        "sys_id": "e8641d91d1f53110f8776589fa411fd3",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
                        "entitlement": null,
                        "sold_product": "7f23995dd1b53110f8776589fa411f66",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "install_base_items_covered": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fd4",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
                        "entitlement": null,
                        "install_base": "a483d951d1f53110f8776589fa411fad",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "entitlement_characteristics": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fd5",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
                        "entitlement": null,
                        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                        "value": "5",
                        "characteristic": "63418db7539e61106bfcddeeff7b1238",
                        "type": "coverage"
                    }
                ]
            }
        ],
        "sold_products_covered": [
            {
                "sys_id": "9c641d91d1f53110f8776589fa411fb9",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": null,
                "entitlement": null,
                "sold_product": "0df21151d1f53110f8776589fa411f1b",
                "added": "2023-12-03",
                "removed": "2023-12-03"
            }
        ],
        "install_base_items_covered": [
            {
                "sys_id": "d8641d91d1f53110f8776589fa411fba",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": null,
                "entitlement": null,
                "install_base": "e2639951d1f53110f8776589fa411f2b",
                "added": "2023-12-03",
                "removed": "2023-12-03"
            }
        ]
    }
}

サービス契約 - GET /sn_pss_core/servicecontract/contractline/{id}

指定されたサービス契約品目レコードを取得します。

このエンドポイントは、要求を処理するときに次のテーブルのデータを取得します。

特性[sn_pss_core_entitlement_characteristic]
エンタイトルメント [service_entitlement]
エンタイトルメント使用 [sn_pss_core_entitlement_usage]
対象製品の販売 [sn_install_base_m2m_contract_sold_product]:このテーブルには、対象の販売済み製品と対象インストールベースアイテムの両方の情報が含まれています。
サービス契約品目 [sn_pss_core_service_contract_line]

URL 形式

バージョニングされた URL:/ api/sn_pss_core/v1/servicecontract/contractline/{id}

デフォルトの URL:/ api/sn_pss_core/servicecontract/contractline/{id}

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

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

表 : 8. クエリパラメーター
名前	説明
display_value	返されるデータのタイプ。有効な値： false:すべてのフィールド `の値` を返します。例:" `state":"draft"`。 true:すべてのフィールドの `display_value` を返します。例:" `state":"Draft"` all:すべてのフィールドのすべての情報を返します。 `"state": { "name": "state", "label": "State", "value": "draft", "display_value": "Draft", "type": "string" }` データタイプ：文字列デフォルト：false

表 : 9. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

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

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
403	禁止されました。ユーザーには API にアクセスする権限がありません。
404	見つかりません。要求アイテムが見つかりませんでした。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)


名前	説明
契約	サービス契約品目に関連付けられたサービス契約Sys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
終了	サービス契約品目が終了する日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト: 手動で削除するまで終了しません。
資格	サービス契約品目に関連付けられたエンタイトルメントのリスト。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：オブジェクトのアレイ "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "entitlement_usages": [Array], "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]
資格。アカウント	エンタイトルメントが属するアカウントレコードSys_id。アカウント [customer_account] テーブルにあります。データタイプ：文字列
資格。消費者	資格付与が属するコンシューマーレコードの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", "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。service_contract_line	エンタイトルメント特性に関連付けられたサービス契約品目レコードSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
資格。entitlement_characteristics。sys_created_by	エンタイトルメント特性レコードを作成したユーザーの名前。データタイプ：文字列
資格。entitlement_characteristics。sys_created_on	エンタイトルメント特性レコードが作成された日時。データタイプ：文字列
資格。entitlement_characteristics。sys_id	エンタイトルメント特性レコードのSys_id。データタイプ：文字列
資格。entitlement_characteristics。sys_updated_by	エンタイトルメント特性レコードを最後に更新したユーザーの名前。データタイプ：文字列
資格。entitlement_characteristics。sys_updated_on	エンタイトルメント特性レコードが最後に更新された日時。データタイプ：文字列
資格。entitlement_characteristics.type	エンタイトルメント特性のタイプ。有効な値：範囲カバー範囲と使用状況データタイプ：文字列
資格。entitlement_characteristics.value	特性の値。データタイプ：文字列
資格。entitlement_name	エンタイトルメントの名前。データタイプ：文字列
資格。entitlement_usages	関連付けられた製品の使用状況の値のリスト。データタイプ：オブジェクトのアレイ `"entitlement_usages": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String", "total_units": "String", "used_units": "String" } ]`
資格。entitlement_usages。資格	エンタイトルメント使用に関連付けられたエンタイトルメントレコードSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
資格。entitlement_usages。entitlement_characteristic	エンタイトルメント使用に関連付けられたエンタイトルメント特性レコードのSys_id。特性 [sn_pss_core_entitlement_characteristic] テーブルにあります。データタイプ：文字列
資格。entitlement_usages。period_end	エンタイトルメントの使用が追跡されなくなる終了日。データタイプ：文字列形式：yyyy-mm-dd
資格。entitlement_usages。period_start	エンタイトルメントの使用を追跡する開始日。データタイプ：文字列形式：yyyy-mm-dd
資格。entitlement_usages。sys_created_by	エンタイトルメント使用レコードを作成したユーザーの名前。データタイプ：文字列
資格。entitlement_usages。sys_created_on	エンタイトルメント使用レコードが作成された日時。データタイプ：文字列
資格。entitlement_usages。sys_id	エンタイトルメント使用レコードのSys_id。エンタイトルメント使用 [sn_pss_core_entitlement_usage] テーブルにあります。データタイプ：文字列
資格。entitlement_usages。sys_updated_by	エンタイトルメント使用レコードを最後に更新したユーザーの名前。データタイプ：文字列
資格。entitlement_usages。sys_updated_on	エンタイトルメント使用レコードが最後に更新された日時。データタイプ：文字列
資格。entitlement_usages。total_units	購入したユニットの合計数。データタイプ：文字列
資格。entitlement_usages。used_units	使用されたユニットの数。データタイプ：文字列
資格。世帯	エンタイトルメントに関連付けられた世帯レコード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" } ]`
資格。install_base_items_covered。追加	関連するインストールベースアイテムがエンタイトルメントに追加された日付。データタイプ：文字列
資格。install_base_items_covered。契約	インストールベースアイテムに関連付けられたサービス契約レコードSys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
資格。install_base_items_covered。資格	インストールベースアイテムに関連付けられたエンタイトルメントレコードのSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
資格。install_base_items_covered。install_base	関連付けられたインストールベースアイテムレコードのSys_id。インストールベースアイテム [sn_install_base_item] テーブルにあります。データタイプ：文字列
資格。install_base_items_covered。削除	関連付けられたインストールベースアイテムがエンタイトルメントから削除された日付。データタイプ：文字列
資格。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] テーブルにあります。データタイプ：文字列
資格。service_contract_line	エンタイトルメントに関連付けられたサービス契約品目レコードSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
資格。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	エンタイトルメントレコードが作成された日時。データタイプ：文字列
entitlement_characteristics	サービス契約品目に関連付けられたエンタイトルメント特性のリスト。特性 [sn_pss_core_entitlement_characteristic] テーブルにあります。データタイプ：オブジェクトのアレイ `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "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。service_contract_line	エンタイトルメント特性に関連付けられたサービス契約品目レコードSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
entitlement_characteristics。sys_created_by	エンタイトルメント特性レコードを作成したユーザーの名前。データタイプ：文字列
entitlement_characteristics。sys_created_on	エンタイトルメント特性レコードが作成された日時。データタイプ：文字列
entitlement_characteristics。sys_id	エンタイトルメント特性レコードのSys_id。データタイプ：文字列
entitlement_characteristics。sys_updated_by	エンタイトルメント特性レコードを最後に更新したユーザーの名前。データタイプ：文字列
entitlement_characteristics。sys_updated_on	エンタイトルメント特性レコードが最後に更新された日時。データタイプ：文字列
entitlement_characteristics。型	エンタイトルメント特性のタイプ。有効な値：範囲カバー範囲と使用状況データタイプ：文字列
entitlement_characteristics。値	特性の値。データタイプ：文字列
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。資格	インストールベースアイテムに関連付けられたエンタイトルメントレコードのSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
install_base_items_covered。install_base	サービス契約品目の対象となるインストールベースアイテムのSys_id。インストールベースアイテム [sn_install_base_item] テーブルにあります。データタイプ：文字列
install_base_items_covered。削除	関連付けられたサービス契約品目がインストールベースアイテムの提供範囲を終了する日付。データタイプ：文字列
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_model	サービス契約品目に関連付けられた製品のSys_id。製品モデル [cmdb_model] テーブルにあります。データタイプ：文字列
product_offering	サービス契約品目に関連付けられた製品オファリングレコードSys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
sold_product	サービス契約品目に関連付けられた販売済み製品レコード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	対象の製品の販売レコードが最後に更新された日時。データタイプ：文字列
開始	サービス契約品目の開始日。データタイプ：文字列形式：yyyy-mm-dd
ステータス	サービス契約品目の現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセルドラフト期限切れ中断データタイプ：文字列
sys_created_by	サービス契約品目レコードを作成したユーザーの名前。データタイプ：文字列
sys_created_on	サービス契約品目レコードが作成された日時。データタイプ：文字列
sys_id	サービス契約品目レコードSys_id。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列
sys_updated_by	サービス契約品目レコードを最後に更新したユーザーの名前。データタイプ：文字列
sys_updated_on	サービス契約品目レコードが最後に更新された日時。データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを呼び出す方法を示しています。

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/contractline/fc73d2de89226110f877430a4e008add" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

応答：

{
  "result": {
    "sys_id": "16e451d1d1f53110f8776589fa411f80",
    "sys_created_by": "admin",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-10-09 11:29:47",
    "sys_updated_on": "2023-10-09 11:29:47",
    "name": "CLI",
    "contract": "a4b415d1d1f53110f8776589fa411f20",
    "sold_product": null,
    "starts": "2022-12-03",
    "ends": "",
    "product_offering": null,
    "product_model": null,
    "sold_products_covered": [
      {
        "sys_id": "5ae451d1d1f53110f8776589fa411f81",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:47",
        "sys_updated_on": "2023-10-09 11:29:47",
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "entitlement": null,
        "sold_product": "0df21151d1f53110f8776589fa411f1b",
        "added": "2023-12-03",
        "removed": "2023-12-03"
      }
    ],
    "install_base_items_covered": [],
    "entitlement_characteristics": [
      {
        "sys_id": "dae451d1d1f53110f8776589fa411f82",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:47",
        "sys_updated_on": "2023-10-09 11:29:47",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "entitlement": null,
        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
        "value": "5",
        "characteristic": "63418db7539e61106bfcddeeff7b1238",
        "type": "coverage"
      }
    ],
    "entitlements": [
      {
        "sys_id": "16e419d1d1f53110f8776589fa411f3c",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:48",
        "sys_updated_on": "2023-10-09 11:29:48",
        "entitlement_name": "ENTL 2",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "state": "active",
        "product_offering": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2022-12-03",
        "end_date": "",
        "entitlement_characteristics": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "service_contract_line": null,
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage_and_usage"
          }
        ],
        "entitlement_usages": [
          {
            "sys_id": "56e419d1d1f53110f8776589fa411f3f",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "entitlement_characteristic": "1ae419d1d1f53110f8776589fa411f3e",
            "period_start": "2022-12-03",
            "period_end": "",
            "total_units": "5",
            "used_units": "2"
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3d",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "sold_product": "da23d151d1f53110f8776589fa411f27",
            "added": "",
            "removed": ""
          }
        ],
        "install_base_items_covered": []
      },
      {
        "sys_id": "9ee451d1d1f53110f8776589fa411f83",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:48",
        "sys_updated_on": "2023-10-09 11:29:48",
        "entitlement_name": "ENTL 1",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "state": "active",
        "product_offering": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2022-12-03",
        "end_date": "",
        "entitlement_characteristics": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f86",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "service_contract_line": null,
            "entitlement": "9ee451d1d1f53110f8776589fa411f83",
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage_and_usage"
          }
        ],
        "entitlement_usages": [
          {
            "sys_id": "dee451d1d1f53110f8776589fa411f86",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "entitlement": "9ee451d1d1f53110f8776589fa411f83",
            "entitlement_characteristic": "92e451d1d1f53110f8776589fa411f86",
            "period_start": "2022-12-03",
            "period_end": "",
            "total_units": "5",
            "used_units": "3"
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f85",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
            "entitlement": "9ee451d1d1f53110f8776589fa411f83",
            "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
            "added": "",
            "removed": ""
          }
        ],
        "install_base_items_covered": []
      }
    ]
  } 
}

サービス契約 - POST /sn_pss_core/servicecontract

指定されたペイロードからサービス契約レコードを作成します。

サービスコントラクト API は、さまざまなテーブルにデータを格納します。サービス契約の作成時にこのエンドポイントによってレコードが作成されるテーブルのリストは次のとおりです。

特性[sn_pss_core_entitlement_characteristic]
エンタイトルメント [service_entitlement]
エンタイトルメント使用 [sn_pss_core_entitlement_usage]
対象製品の販売 [sn_install_base_m2m_contract_sold_product]:このテーブルには、対象の販売済み製品と対象インストールベースアイテムの両方の情報が含まれています。
サービス契約 [sn_pss_core_service_contract]
サービス契約品目 [sn_pss_core_service_contract_line]

このエンドポイントの要求本文は、次のテーブルのフィールドを参照します。この API を利用する前に、この情報をインスタンスに追加する必要があります。詳細については、「Create service contracts」を参照してください。

アカウント (customer_account)
特性オプション [sn_prd_pm_characteristic_option]
コンシューマー (csm_consumer)
世帯 [csm_household]

URL 形式

バージョニングされた URL:/ api/sn_pss_core/v1/servicecontract

デフォルトの URL:/ api/sn_pss_core/servicecontract

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

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

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

表 : 15. 要求本文パラメーター (XML または JSON)
名前	説明
アカウント	パラメーターが指定されていない場合は必須です consumer 。サービス契約が属するアカウントレコードSys_id。アカウント [customer_account] テーブルにあります。データタイプ：文字列
consumer	パラメーターが指定されていない場合は必須です account 。サービス契約が属するコンシューマーレコードSys_id。コンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
終了	サービス契約が終了する日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト: 手動で削除するまで終了しません。
世帯	コンシューマーサービス契約でのみ有効です。サービス契約に関連付けられている世帯Sys_id。世帯 [csm_household] にあります。データタイプ：文字列デフォルト:null (世帯なし)
install_base_items_covered	サービス契約の対象となるインストールベースアイテムのリスト。このパラメーターのデータは、対象の製品の販売 [sn_install_base_m2m_contract_sold_product] テーブルに挿入されます。インストールベースアイテム Configure install baseの詳細については、を参照してください。データタイプ：オブジェクトのアレイ `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
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 デフォルト:終了日なし
service_contract_lines	サービス契約に関連付けられているサービス契約品目のリスト。このデータは、サービス契約品目 [sn_pss_core_service_contract_line] テーブルに挿入されます。データタイプ：オブジェクトのアレイ `"service_contract_lines": [ { "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "product_model": "String", "product_offering": "String", "sold_product": "String", "sold_products_covered": [Array], "starts": "String", "state": "String" } ]`
service_contract_lines.ends	サービス契約品目が終了する日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト: 手動で削除するまで終了しません。
service_contract_lines.entitlements	サービス契約に関連付けるエンタイトルメントのリスト。これらの資格付与は資格付与 [service_entitlement] テーブルに挿入されます。データタイプ：オブジェクトのアレイ `"entitlements" [ { "account": "String", "consumer": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String" } ]`
service_contract_lines。資格。アカウント	エンタイトルメントが属するアカウントレコードSys_id。アカウント [customer_account] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。消費者	資格付与が属するコンシューマーレコードのSys_id。コンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。end_date	エンタイトルメントの終了日。データタイプ：文字列形式：yyyy-mm-dd デフォルト: 手動で削除するまで終了しません。
service_contract_lines。資格。entitlement_characteristics	資格付与に関連付けられた特性のリスト。このアレイのデータは特性 [sn_pss_core_entitlement_characteristic] テーブルに挿入されます。データタイプ：オブジェクトのアレイ `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
service_contract_lines。資格。entitlement_characteristics.特性	必須です。エンタイトルメントに関連付けられた特性レコードSys_id。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics.characteristic_option	エンタイトルメントに関連付けられた特性オプションレコードのSys_id。特性オプション [sn_prd_pm_characteristic_option] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics.entitlement_usage	関連付けられたエンタイトルメント特性に使用される単位値。このデータは、エンタイトルメント使用 [sn_pss_core_entitlement_usage] テーブルに挿入されます。このパラメーターを渡すのは、entitlement_characteristicsがエンタイトルメント下にある場合のみです。データタイプ: オブジェクト `"entitlement_usage": { "usage_units": "String" }`
service_contract_lines。資格。entitlement_characteristics.entitlement_usage。usage_units	関連付けられたエンタイトルメント特性の使用。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics.type	エンタイトルメント特性のタイプ。有効な値：範囲カバー範囲と使用状況データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics.value	input_typeパラメーターで指定されたentitlement_characteristics.characteristicレコードに含まれるパラメーターが`選択肢`でない場合は必須です。特性の値。データタイプ：文字列
service_contract_lines。資格。entitlement_name	必須です。エンタイトルメントの名前。データタイプ：文字列
service_contract_lines。資格。世帯	世帯プラグインがアクティブで、パラメーターが consumer 渡されている場合にのみ渡されます。エンタイトルメントに関連付けられた世帯レコードSys_id。世帯 [csm_household] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered	エンタイトルメントの対象となるインストールベースアイテムのリスト。このアレイの情報は、対象の製品の販売 [sn_install_base_m2m_contract_sold_product] テーブルに挿入されます。データタイプ：オブジェクトのアレイ `"install_base_items_covered": [ { "added": "String", "removed": "String" } ]`
service_contract_lines。資格。install_base_items_covered。追加	関連するインストールベースアイテムがエンタイトルメントに追加された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:現在の日付
service_contract_lines。資格。install_base_items_covered。削除	関連付けられたインストールベースアイテムがエンタイトルメントから削除された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:終了日なし
service_contract_lines。資格。製品	エンタイトルメントに関連付けられた製品モデルレコードのSys_id。製品モデル [cmdb_model] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。product_offering	資格付与に関連付けられた製品オファリングレコードSys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sold_entitlement	エンタイトルメントに関連付けられた販売済み製品レコードSys_id。販売済み製品テーブル [sn_install_base_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sold_products_covered	エンタイトルメントの対象となる販売済み製品のリスト。データタイプ：オブジェクトのアレイ `"sold_products_covered": [ { "added": "String", "removed": "String" } ]`
service_contract_lines。資格。sold_products_covered。追加	関連付けられた販売済み製品がエンタイトルメントに追加された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:現在の日付
service_contract_lines。資格。sold_products_covered。削除	関連付けられた販売済み製品がエンタイトルメントから削除された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:終了日なし
service_contract_lines。資格。start_date	必須です。エンタイトルメントの開始日。データタイプ：文字列形式：yyyy-mm-dd
service_contract_lines。資格。状態	必須です。エンタイトルメントの現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセルドラフト期限切れ中断データタイプ：文字列
service_contract_lines。entitlement_characteristics	サービス契約品目に関連付けられた特性のリスト。このアレイのデータは特性 [sn_pss_core_entitlement_characteristic] テーブルに挿入されます。データタイプ：オブジェクトのアレイ `"entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
service_contract_lines。entitlement_characteristics.特性	必須です。サービス契約品目に関連付けられた特性レコードSys_id。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
service_contract_lines。entitlement_characteristics.characteristic_option	サービス契約品目に関連付けられた特性オプションレコードSys_id。特性オプション [sn_prd_pm_characteristic_option] テーブルにあります。データタイプ：文字列
service_contract_lines。entitlement_characteristics.entitlement_usage	関連するサービス契約品目特性の使用済み単位値。このデータは、エンタイトルメント使用 [sn_pss_core_entitlement_usage] テーブルに挿入されます。データタイプ: オブジェクト `"entitlement_usage": { "usage_units": "String" }`
service_contract_lines。entitlement_characteristics.entitlement_usage。usage_units	関連付けられたエンタイトルメント特性の使用。データタイプ：文字列
service_contract_lines。entitlement_characteristics.type	サービス契約品目特性のタイプ。有効な値：範囲カバー範囲と使用状況データタイプ：文字列
service_contract_lines。entitlement_characteristics.value	パラメーターが渡されない場合は entitlement_characteristics.type 必須です。特性の値。データタイプ：文字列
service_contract_lines。install_base_items_covered	サービス契約品目の対象となるインストールベースアイテムのリスト。このパラメーターのデータは、対象の製品の販売 [sn_install_base_m2m_contract_sold_product] テーブルに挿入されます。データタイプ：オブジェクトのアレイ `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
service_contract_lines。install_base_items_covered。追加	関連するインストールベースアイテムがサービス契約品目に追加された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:現在の日付
service_contract_lines。install_base_items_covered。install_base	サービス契約品目の対象となるインストールベースアイテムのSys_id。インストールベースアイテム [sn_install_base_item] テーブルにあります。データタイプ：文字列
service_contract_lines。install_base_items_covered。削除	関連付けられたサービス契約品目がインストールベースアイテムの提供範囲を終了する日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:終了日なし
service_contract_lines。名前	サービス契約品目の名前。データタイプ：文字列
service_contract_lines。product_model	サービス契約品目に関連付けられた製品のSys_id。製品モデル [cmdb_model] テーブルにあります。データタイプ：文字列
service_contract_lines。product_offering	サービス契約品目に関連付けられた製品オファリングレコードSys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
service_contract_lines。sold_product	サービス契約品目に関連付けられた販売済み製品レコードSys_id。販売済み製品テーブル [sn_install_base_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。.sold_products_covered	サービス契約品目の対象となる製品のリスト。データタイプ：オブジェクトのアレイ `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
service_contract_lines。.sold_products_covered。追加	関連付けられたサービス契約品目が関連製品をカバーし始める日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:現在の日付
service_contract_lines。.sold_products_covered。削除	関連付けられたサービス契約品目が関連製品の補償を終了する日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:終了日なし
service_contract_lines。.sold_products_covered。sold_product	サービス契約品目に関連付けられた製品のSys_id。対象となる販売済み製品の [sn_install_base_m2m_contract_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。。開始	必須です。サービス契約品目の開始日。データタイプ：文字列形式：yyyy-mm-dd
service_contract_lines。。状態	必須です。サービス契約品目の現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセルドラフト期限切れ中断データタイプ：文字列
short_description	サービス契約の簡単な説明または名前。データタイプ：文字列デフォルト:null (空の文字列)
sold_products_covered	パラメーターが指定されていない場合は必須です install_base_items_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] テーブルにあります。データタイプ：文字列
開始	必須です。サービス契約が開始される日付。データタイプ：文字列形式：yyyy-mm-dd
ステータス	必須です。サービス契約の現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセルドラフト期限切れ中断データタイプ：文字列
vendor_contract	必須です。関連付けられた外部契約の一意の識別子。データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
201	成功。要求が正常に処理され、レコードが作成されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
403	禁止されました。ユーザーには API にアクセスする権限がありません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)


名前	説明
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] テーブルにあります。データタイプ：文字列
番号	自動生成されたサービス契約番号。データタイプ：文字列
service_contract_lines	サービス契約に関連付けられているサービス契約品目のリスト。データタイプ：オブジェクトのアレイ `"service_contract_lines": [ { "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "sold_products_covered": [Array], "sys_id": "String" } ]`
service_contract_lines。資格	サービス契約に関連付けられたエンタイトルメントのリスト。データタイプ：オブジェクトのアレイ `"entitlements" [ { "entitlement_name": "String", "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "sold_products_covered": [Array], "sys_id": "String" } ]`
service_contract_lines。資格。entitlement_name	エンタイトルメントの名前。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics	資格付与に基づいて作成された資格付与特性オブジェクトのリスト。データタイプ：オブジェクトのアレイ `"entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
service_contract_lines。資格。entitlement_characteristics。entitlement_usage	entitlement_characteristicの下に挿入されたエンタイトルメント使用オブジェクト。データタイプ: オブジェクト `"entitlement_usage": { "sys_id": "String" }`
service_contract_lines。資格。entitlement_characteristics。entitlement_usage。sys_id	エンタイトルメント使用レコードのSys_id。エンタイトルメント使用 [sn_pss_core_entitlement_usage] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。entitlement_characteristics。sys_id	サービス契約品目に関連付けられたエンタイトルメント特性レコードSys_id。特性 [sn_pss_core_entitlement_characteristic] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。install_base_items_covered	エンタイトルメントの対象となるインストールベースアイテムsys_idsのリスト。データタイプ：オブジェクトのアレイ `"install_base_items_covered": [ { "sys_id": "String" } ]`
service_contract_lines。資格。install_base_items_covered。sys_id	エンタイトルメントの対象となるインストールベースアイテムのSys_id。対象となる販売済み製品の [sn_install_base_m2m_contract_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sold_products_covered	エンタイトルメントの対象となる製品のsys_idsのリスト。データタイプ：オブジェクトのアレイ `"sold_products_covered": [ { "sys_id": "String" } ]`
service_contract_lines。資格。sold_products_covered。sys_id	エンタイトルメントの対象となる製品のSys_id。対象となる販売済み製品の [sn_install_base_m2m_contract_sold_product] テーブルにあります。データタイプ：文字列
service_contract_lines。資格。sys_id	サービス契約品目に関連付けられたエンタイトルメントレコードSys_id。エンタイトルメント [service_entitlement] テーブルにあります。データタイプ：文字列
short_description	サービス契約の簡単な説明または名前。データタイプ：文字列
sold_products_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。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを呼び出して、1 つの販売済み製品対象レコード、1 つのインストールベースアイテム対象レコード、および 2 つのサービス契約明細を含むサービス契約を作成する方法を示しています。

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "account": "4c325111d1f53110f8776589fa411f3d",
  "vendor_contract": "External Reference",
  "starts": "2022-12-03",
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "install_base_items_covered": [
    {
      "install_base": "e2639951d1f53110f8776589fa411f2b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "service_contract_lines": [
    {
      "state": "active",
      "name": "CLI",
      "starts": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "a1731551d1f53110f8776589fa411f8d",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlements": [
        {
          "state": "active",
          "entitlement_name": "ENTL",
          "start_date": "2022-12-03",
          "sold_products_covered": [
            {
              "sold_product": "da23d151d1f53110f8776589fa411f27"
            }
          ],
          "install_base_items_covered": [
            {
              "install_base": "43739151d1f53110f8776589fa411fc1",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "entitlement_characteristics": [
            {
              "characteristic": "63418db7539e61106bfcddeeff7b1238",
              "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
              "value": "20",
              "type": "coverage_and_usage",
              "entitlement_usage": {
                "used_units": "3"
              }
            }
          ]
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    },
    {
      "state": "active",
      "name": "CLI 2",
      "starts": "2022-12-03",
      "sold_products_covered": [
        { 
          "sold_product": "7f23995dd1b53110f8776589fa411f66",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "a483d951d1f53110f8776589fa411fad",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    }
  ]
} 
--user "username":"password"

応答：

{ 
  "result": {
    "sys_id": "d8641151d1f53110f8776589fa411fde",
    "number": "CNTR0010004",
    "short_description": null,
    "sold_products_covered": [
      {
        "sys_id": "9c641d91d1f53110f8776589fa411fb9"
      }
    ], 
    "install_base_items_covered": [
      {
        "sys_id": "d8641d91d1f53110f8776589fa411fba"
      }
    ],
    "service_contract_lines": [
      {
        "sys_id": "d4641d91d1f53110f8776589fa411fbb",
        "name": "CLI",
        "sold_products_covered": [
          {
            "sys_id": "98641d91d1f53110f8776589fa411fbc"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "58641d91d1f53110f8776589fa411fbd"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "e0641d91d1f53110f8776589fa411fbf",
            "entitlement_usage": {}
          }
        ],
        "entitlements": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fc0",
            "entitlement_name": "ENTL",
            "sold_products_covered": [
              {
                "sys_id": "a0641d91d1f53110f8776589fa411fc2"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "e0641d91d1f53110f8776589fa411fc3"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "a8641d91d1f53110f8776589fa411fd0",
                "entitlement_usage": {
                  "sys_id": "a8641d91d1f53110f8776589fa411fd1"
                }
              }
            ]
          }
        ]
      },
      {
        "sys_id": "e4641d91d1f53110f8776589fa411fd2",
        "name": "CLI 2",
        "sold_products_covered": [
          {
            "sys_id": "e8641d91d1f53110f8776589fa411fd3"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd4"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd5",
            "entitlement_usage": {}
          }
        ],
        "entitlements": []
      }
    ]
  }
}

サービス契約 - POST /sn_pss_core/servicecontract/contractline

契約品目レコードとそのすべての関連エンティティを作成します。

このエンドポイントは、要求を処理するときに次のテーブルにデータを格納します。

特性[sn_pss_core_entitlement_characteristic]
エンタイトルメント [service_entitlement]
エンタイトルメント使用 [sn_pss_core_entitlement_usage]
対象製品の販売 [sn_install_base_m2m_contract_sold_product]:このテーブルには、対象の販売済み製品と対象インストールベースアイテムの両方の情報が含まれています。
サービス契約品目 [sn_pss_core_service_contract_line]

URL 形式

バージョニングされた URL:/ api/sn_pss_core/v1/servicecontract/contractline

デフォルトの URL:/ api/sn_pss_core/servicecontract/contractline

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

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

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

表 : 21. 要求本文パラメーター (XML または JSON)
名前	説明
契約	必須です。サービス契約品目に関連付けられたサービス契約Sys_id。サービス契約 [sn_pss_core_service_contract] テーブルにあります。データタイプ：文字列
終了	サービス契約品目が終了する日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト: 手動で削除するまで終了しません。
資格	サービス契約に関連付けるエンタイトルメントのリスト。これらの資格付与は資格付与 [service_entitlement] テーブルに挿入されます。データタイプ：オブジェクトのアレイ `"entitlements" [ { "account": "String", "consumer": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String" } ]`
資格。アカウント	パラメーターが渡されない場合は consumer 必須です。エンタイトルメントが属するアカウントレコードSys_id。アカウント [customer_account] テーブルにあります。データタイプ：文字列
資格。消費者	パラメーターが渡されない場合は 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.type	エンタイトルメント特性のタイプ。有効な値：範囲カバー範囲と使用状況データタイプ：文字列
資格。entitlement_characteristics.value	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", "removed": "String" } ]`
資格。install_base_items_covered。追加	関連するインストールベースアイテムがエンタイトルメントに追加された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:現在の日付
資格。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_products_covered。追加	関連付けられた販売済み製品がエンタイトルメントに追加された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:現在の日付
資格。sold_products_covered。削除	関連付けられた販売済み製品がエンタイトルメントから削除された日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:終了日なし
資格。start_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	input_typeパラメーターで指定されたentitlement_characteristics.characteristicレコードに含まれるパラメーターが`選択肢`に設定されている場合は必須です。サービス契約品目に関連付けられた特性オプションレコードSys_id。特性オプション [sn_prd_pm_characteristic_option] テーブルにあります。データタイプ：文字列
entitlement_characteristics。entitlement_usage	関連するサービス契約品目特性の使用済み単位値。このデータは、エンタイトルメント使用 [sn_pss_core_entitlement_usage] テーブルに挿入されます。データタイプ: オブジェクト `"entitlement_usage": { "usage_units": "String" }`
entitlement_characteristics。entitlement_usage。used_units	関連付けられたエンタイトルメント特性の使用。データタイプ：文字列
entitlement_characteristics。型	サービス契約品目特性のタイプ。有効な値：範囲カバー範囲と使用状況データタイプ：文字列
entitlement_characteristics。値	パラメーターが渡されない場合は entitlement_characteristics.type 必須です。特性の値。データタイプ：文字列
install_base_items_covered	パラメーターが渡されない場合は sold_products_covered 必須です。サービス契約品目の対象となるインストールベースアイテムのリスト。このパラメーターのデータは、対象の製品の販売 [sn_install_base_m2m_contract_sold_product] テーブルに挿入されます。データタイプ：オブジェクトのアレイ `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
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 デフォルト:終了日なし
名前	必須です。サービス契約品目の名前。データタイプ：文字列
product_model	サービス契約品目に関連付けられた製品のSys_id。製品モデル [cmdb_model] テーブルにあります。データタイプ：文字列
product_offering	サービス契約品目に関連付けられた製品オファリングレコードSys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
sold_product	サービス契約品目に関連付けられた販売済み製品レコードSys_id。販売済み製品テーブル [sn_install_base_sold_product] テーブルにあります。データタイプ：文字列
sold_product_covered	パラメーターが渡されない場合は install_base_items_covered 必須です。サービス契約品目の対象となる製品のリスト。データタイプ：オブジェクトのアレイ `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]` データは、対象の製品の販売 [sn_install_base_m2m_contract_sold_product] テーブルに保存されます。
sold_product_covered。追加	関連付けられたサービス契約品目が関連製品をカバーし始める日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:現在の日付
sold_product_covered。削除	関連付けられたサービス契約品目が関連製品の補償を終了する日付。データタイプ：文字列形式：yyyy-mm-dd デフォルト:終了日なし
sold_product_covered。sold_product	サービス契約品目に関連付けられた製品のSys_id。対象となる販売済み製品の [sn_install_base_m2m_contract_sold_product] テーブルにあります。データタイプ：文字列
開始	必須です。サービス契約品目の開始日。データタイプ：文字列形式：yyyy-mm-dd
ステータス	必須です。サービス契約品目の現在のステータス。有効な値： (大文字と小文字を区別) アクティブキャンセルドラフト期限切れ中断データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 24. ステータスコード
ステータスコード	説明
201	成功。要求が正常に処理され、レコードが作成されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
403	禁止されました。ユーザーには API にアクセスする権限がありません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)


名前	説明
資格	サービス契約品目に関連付けられたエンタイトルメントのリスト。データタイプ：オブジェクトのアレイ `"entitlements": [ { "entitlement_characteristics": [Array], "entitlement_name": "String", "install_base_items_covered": [Array], "sold_products_covered": [Array], "sys_id": "String" } ]`
資格。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。データタイプ：文字列
資格。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_products_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] テーブルにあります。データタイプ：文字列
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。データタイプ：文字列
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_products_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。サービス契約品目 [sn_pss_core_service_contract_line] テーブルにあります。データタイプ：文字列

cURL 要求

このエンドポイントを呼び出してサービス契約品目レコードを作成する方法を示すコード例を次に示します。

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/contractline" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "contract": "a4b415d1d1f53110f8776589fa411f20",
  "name": "CLI",
  "starts": "2022-12-03",
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "entitlements": [
    {
      "state": "active",
      "entitlement_name": "ENTL 1",
      "start_date": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "ec235d9dd1b53110f8776589fa411fe2"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage_and_usage",
          "entitlement_usage": {
            "used_units": "3"
          }
        }
      ]
    },
    {
      "state": "active",
      "entitlement_name": "ENTL 2",
      "start_date": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "da23d151d1f53110f8776589fa411f27"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage_and_usage",
          "entitlement_usage": {
            "used_units": "2"
          }
        }
      ]
    }
  ],
  "entitlement_characteristics": [
    {
      "characteristic": "63418db7539e61106bfcddeeff7b1238",
      "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
      "value": "tyfy6h",
      "type": "coverage"
    }
  ]
}

応答：

{
  "result": {
    "sys_id": "16e451d1d1f53110f8776589fa411f80",
    "name": "CLI",
    "sold_products_covered": [
      {
        "sys_id": "5ae451d1d1f53110f8776589fa411f81"
      }
    ],
    "install_base_items_covered": [],
    "entitlement_characteristics": [
      {
        "sys_id": "dae451d1d1f53110f8776589fa411f82",
        "entitlement_usage": {}
      }
    ],
    "entitlements": [
      {
        "sys_id": "9ee451d1d1f53110f8776589fa411f83",
        "entitlement_name": "ENTL 1",
        "sold_products_covered": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f85"
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f86",
            "entitlement_usage": {
              "sys_id": "dee451d1d1f53110f8776589fa411f86" 
            }
          }
        ]
      },
      {
        "sys_id": "16e419d1d1f53110f8776589fa411f3c",
        "entitlement_name": "ENTL 2",
        "sold_products_covered": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3d"
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3e", 
            "entitlement_usage": {
              "sys_id": "56e419d1d1f53110f8776589fa411f3f"
            }
          }
        ]
      }
    ]
  } 
}