サービス契約 API

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間:306分
  • サービス契約 API は、サービス契約レコードを作成および取得するためのエンドポイントを提供します。

    注:
    この API は、 カスタマー契約とエンタイトルメント アプリケーションのテーブルにデータを作成するためのものです。これは汎用 API ではありません。
    この API にアクセスするには、関連するインスタンスで次のプラグインをアクティブ化する必要があります。
    • カスタマー契約とエンタイトルメント (com.sn_pss_core)
    • カスタマーサービスインストールベース管理 (com.snc.install)
    • 製品カタログ管理コア (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_specification]
    • 製品オファリング [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/{api_version}/servicecontract/{id}

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

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

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

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

    データタイプ:文字列

    ID 取得するサービス契約のSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    表 : 2. クエリパラメーター
    名前 説明
    display_value 返されるデータのタイプ。
    有効な値:
    • false:すべてのフィールド の値 を返します。例: "state":"draft"
    • true:すべてのフィールドの display_value を返します。例: "state":"Draft"
    • all:すべてのフィールドのすべての情報を返します。

    データタイプ:文字列

    デフォルト値: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]

    終了
    サービス契約が終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    世帯
    サービス契約に関連付けられている世帯の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。追加
    関連するサービス契約がインストールベースアイテムをカバーし始める日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    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。削除
    関連付けられたサービス契約がインストールベースアイテムの対象範囲を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    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": [
      {
        "child_contract_lines": [Array],
        "contract": "String",
        "ends": "String",
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "number": "String",
        "parent_contract_line": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "String",
        "sold_product": "String",
        "sold_products_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。child_contract_lines サービス契約品目に関連付けられている子サービス契約品目のリスト。

    データタイプ:オブジェクトのアレイ

    "child_contract_lines": [
      {
        "child_contract_lines": [Array],
        "contract": "String",
        "ends": "String",
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "number": "String",
        "parent_contract_line": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "String",
        "sold_product": "String",
        "sold_products_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。child_contract_lines。child_contract_lines 子サービス契約品目に関連付けられた子サービス契約品目のリスト。child_contract_lines と同じパラメーター。

    データタイプ:アレイ

    service_contract_lines。child_contract_lines。契約 子サービス契約品目に関連付けられたサービス契約のSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    service_contract_lines。child_contract_lines。終了 子サービス契約品目が終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    service_contract_lines。child_contract_lines。エンタイトルメント 子サービス契約品目に関連付けられたエンタイトルメントのリスト。

    データタイプ:オブジェクトのアレイ

    "entitlements": [
      {
        "account": "String",
        "consumer": "String",
        "contract": "String",
        "end_date": "String",
        "entitlement_characteristics": [Array],
        "entitlement_name": "String",
        "household": "String",
        "install_base_items_covered": [Array],
        "product": "String",
        "product_offering": "String",
        "product_specification": "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。child_contract_lines。エンタイトルメント。アカウント
    エンタイトルメントが属するアカウントレコードのSys_id。

    データタイプ:文字列

    テーブル:アカウント [customer_account]

    service_contract_lines。child_contract_lines。エンタイトルメント。消費者
    エンタイトルメントが属するコンシューマーレコードのSys_id。

    データタイプ:文字列

    テーブル:コンシューマー [csm_consumer]

    service_contract_lines。child_contract_lines。エンタイトルメント。契約 エンタイトルメントが属する契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    service_contract_lines。child_contract_lines。エンタイトルメント。end_date エンタイトルメントの終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "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。child_contract_lines。エンタイトルメント。entitlement_characteristics。特性
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。資格 エンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage 関連製品の使用状況値のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_usage": [
      {
        "entitlement": "String",
        "entitlement_characteristic": "String",
        "period_end": "String",
        "period_start": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_update_on": "String",
        "total_units": "String",
        "used_units": "String"
      }
    ]
    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。資格 エンタイトルメントの使用状況に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。entitlement_characteristic エンタイトルメントの使用状況に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。period_end エンタイトルメントの使用状況が追跡されなくなる終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。period_start エンタイトルメントの使用状況を追跡する開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。service_contract_line 現在のエンタイトルメントの使用状況が属するサービス契約品目のSys_id。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_created_by エンタイトルメント使用状況レコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_created_on エンタイトルメント使用状況レコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_id エンタイトルメント使用状況レコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_updated_by エンタイトルメント使用状況レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_updated_on エンタイトルメント使用状況レコードが最後に更新された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。total_units 関連付けられたエンタイトルメント特性の総合補償額。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。used_units period_startperiod_end の間でアカウントまたはコンシューマーによって使用されたユニット数。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。service_contract_line 現在のエンタイトルメント特性が属する子契約品目。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。sys_created_by エンタイトルメント特性を作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。sys_created_on エンタイトルメント特性が作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。sys_id エンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。sys_updated_by エンタイトルメント特性を最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。sys_updated_on エンタイトルメント特性が最後に更新された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。種類 エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。価値
    特性の値。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_name
    エンタイトルメントの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。世帯
    エンタイトルメントに関連付けられた世帯レコードのSys_id。

    データタイプ:文字列

    テーブル:世帯 [csm_household]

    service_contract_lines。child_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"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。追加
    関連付けられたインストールベースアイテムがサービス契約品目に追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。契約 インストールベースアイテムに関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。資格 インストールベースアイテムに関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。install_base 関連付けられたインストールベースアイテムレコードのSys_id。

    データタイプ:文字列

    テーブル:インストールベースアイテム [sn_install_base_item]

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。削除
    関連付けられたサービス契約品目がインストールベースアイテムのカバレッジを終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。service_contract_line 関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。sys_created_by インストールベースアイテムレコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。sys_created_on インストールベースアイテムレコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。sys_id 対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。sys_updated_by インストールベースアイテムレコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。sys_updated_on インストールベースアイテムレコードが最後に更新された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。積 エンタイトルメントに関連付けられた製品モデルレコードのSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    service_contract_lines。child_contract_lines。エンタイトルメント。product_offering エンタイトルメントに関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    service_contract_lines。child_contract_lines。エンタイトルメント。product_specification エンタイトルメントに関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    service_contract_lines。child_contract_lines。エンタイトルメント。service_contract_line エンタイトルメントに関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_entitlement エンタイトルメントに関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered 対象製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sold_product": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。追加
    関連するサービス契約が製品を対象として開始する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。契約 対象の販売済み製品に関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。資格 対象の販売済み製品に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。削除
    関連付けられたサービス契約が関連付けられた製品の補償を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。service_contract_line 対象の販売済み製品に関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。sold_product サービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。sys_created_by 販売済み製品対象レコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。sold_products_covered。sys_created_on 販売済み製品対象レコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。sys_id このサービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。sys_updated_by 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。sys_updated_on 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。start_date
    エンタイトルメントの開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。エンタイトルメント。状態
    エンタイトルメントの現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。sys_created_by エンタイトルメントレコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。sys_created_on エンタイトルメントレコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。sys_id 関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    service_contract_lines。child_contract_lines。エンタイトルメント。sys_updated_by エンタイトルメントレコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。sys_updated_on エンタイトルメントレコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
        "type": "String",
        "value": "String"
      }
    ]
    service_contract_lines。child_contract_lines。entitlement_characteristics。特性
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    service_contract_lines。child_contract_lines。entitlement_characteristics。characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    service_contract_lines。child_contract_lines。entitlement_characteristics。資格 エンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    service_contract_lines。child_contract_lines。entitlement_characteristics。service_contract_line エンタイトルメント特性に関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。child_contract_lines。entitlement_characteristics。sys_created_by エンタイトルメント特性レコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics。sys_created_on エンタイトルメント特性レコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics。sys_id エンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics。sys_updated_by エンタイトルメント特性レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics。sys_updated_on エンタイトルメント特性レコードが最後に更新された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics。種類 エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics。価値
    特性の値。

    データタイプ:文字列

    service_contract_lines。child_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"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。install_base_items_covered。追加
    関連付けられたインストールベースアイテムがサービス契約品目に追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。install_base_items_covered。契約 インストールベースアイテムに関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    service_contract_lines。child_contract_lines。install_base_items_covered。資格 インストールベースアイテムに関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    service_contract_lines。child_contract_lines。install_base_items_covered。install_base 関連付けられたインストールベースアイテムレコードのSys_id。

    データタイプ:文字列

    テーブル:インストールベースアイテム [sn_install_base_item]

    service_contract_lines。child_contract_lines。install_base_items_covered。削除
    関連付けられたサービス契約品目がインストールベースアイテムのカバレッジを終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。install_base_items_covered。service_contract_line 関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。child_contract_lines。install_base_items_covered。sys_created_by インストールベースアイテムレコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。install_base_items_covered。sys_created_on インストールベースアイテムレコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。install_base_items_covered。sys_id 対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。install_base_items_covered。sys_updated_by インストールベースアイテムレコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。install_base_items_covered。sys_updated_on インストールベースアイテムレコードが最後に更新された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。名前 子サービス契約品目の名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。parent_contract_line 子サービス契約品目に関連付けられた親契約品目レコードのSys_id。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。product_model 子サービス契約品目に関連付けられている製品のSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    service_contract_lines。child_contract_lines。product_offering 子サービス契約品目に関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    service_contract_lines。child_contract_lines。sold_product 子サービス契約品目に関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    service_contract_lines。child_contract_lines。sold_products_covered 対象製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sold_product": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。sold_products_covered。追加
    関連するサービス契約が製品を対象として開始する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    service_contract_lines。child_contract_lines。sold_products_covered。契約 対象の販売済み製品に関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    service_contract_lines。child_contract_lines。sold_products_covered。資格 対象の販売済み製品に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    service_contract_lines。child_contract_lines。sold_products_covered。削除
    関連付けられたサービス契約が関連付けられた製品の補償を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    service_contract_lines。child_contract_lines。sold_products_covered。service_contract_line 対象の販売済み製品に関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。child_contract_lines。sold_products_covered。sold_product サービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    service_contract_lines。child_contract_lines。sold_products_covered。sys_created_by 販売済み製品対象レコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。sold_products_covered。sys_created_on 販売済み製品対象レコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。sold_products_covered。sys_id このサービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。sold_products_covered。sys_updated_by 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。sold_products_covered。sys_updated_on 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。開始 子サービス契約品目の開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。sys_created_by 子サービス契約品目レコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。sys_created_on 子サービス契約品目レコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。sys_id 子サービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。child_contract_lines。sys_updated_by 子サービス契約品目レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。sys_updated_on 子サービス契約品目レコードが最後に更新された日時。

    データタイプ:文字列

    service_contract_lines。契約
    サービス契約品目に関連付けられたサービス契約のSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    service_contract_lines。終了 サービス契約品目が終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    service_contract_lines。エンタイトルメント サービス契約に関連付けられたエンタイトルメントのリスト。

    データタイプ:オブジェクトのアレイ

    "entitlements": [
      {
        "account": "String",
        "consumer": "String",
        "contract": "String",
        "end_date": "String",
        "entitlement_characteristics": [Array],
        "entitlement_name": "String",
        "household": "String",
        "install_base_items_covered": [Array],
        "product": "String",
        "product_offering": "String",
        "product_specification": "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_entitlement]

    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 エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array]
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String",
        "type": "String",
        "value": "String"
      }
    ]

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。エンタイトルメント。entitlement_characteristics.characteristic
    エンタイトルメントに関連付けられた特性レコードの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。entitlement_usage 関連製品の使用状況値のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_usage": [
      {
        "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_characteristics。entitlement_usage。資格 エンタイトルメントの使用状況に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。entitlement_characteristic エンタイトルメントの使用状況に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。period_end エンタイトルメントの使用状況が追跡されなくなる終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。period_start エンタイトルメントの使用状況を追跡する開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_created_by エンタイトルメント使用状況レコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_created_on エンタイトルメント使用状況レコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_id エンタイトルメント使用状況レコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_updated_by エンタイトルメント使用状況レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_updated_on エンタイトルメント使用状況レコードが最後に更新された日時。

    データタイプ:文字列

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。total_units 関連付けられたエンタイトルメント特性の総合補償額。

    データタイプ:文字列

    service_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。used_units period_startperiod_end の間でアカウントまたはコンシューマーによって使用されたユニット数。

    データタイプ:文字列

    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 エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    service_contract_lines。エンタイトルメント。entitlement_characteristics。価値
    特性の値。

    データタイプ:文字列

    service_contract_lines。エンタイトルメント。entitlement_name
    エンタイトルメントの名前。

    データタイプ:文字列

    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。エンタイトルメント。product_specification エンタイトルメントに関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    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 対象製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sold_product": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    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.removed 関連付けられた販売済み製品がエンタイトルメントから削除された日付。

    データタイプ:文字列

    形式: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。エンタイトルメント。状態
    エンタイトルメントの現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    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 サービス契約品目に関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String",
        "type": "String",
        "value": "String"
      }
    ]

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。entitlement_characteristics.characteristic
    エンタイトルメントに関連付けられた特性レコードの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。entitlement_usage 関連製品の使用状況値のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_usage": [
      {
        "entitlement": "String",
        "entitlement_characteristic": "String",
        "period_end": "String",
        "period_start": "String",
        "service_contract_line": "String", 
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_update_on": "String",
        "total_units": "String",
        "used_units": "String"
      }
    ]
    service_contract_lines。entitlement_characteristics。entitlement_usage。資格 エンタイトルメントの使用状況に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    service_contract_lines。entitlement_characteristics。entitlement_usage。entitlement_characteristic エンタイトルメントの使用状況に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。entitlement_characteristics。entitlement_usage。period_end エンタイトルメントの使用状況が追跡されなくなる終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。entitlement_characteristics。entitlement_usage。period_start エンタイトルメントの使用状況を追跡する開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。entitlement_characteristics。entitlement_usage。sys_created_by エンタイトルメント使用状況レコードを作成したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。entitlement_characteristics。entitlement_usage。sys_created_on エンタイトルメント使用状況レコードが作成された日時。

    データタイプ:文字列

    service_contract_lines。entitlement_characteristics。entitlement_usage。sys_id エンタイトルメント使用状況レコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    service_contract_lines。entitlement_characteristics。entitlement_usage。sys_updated_by エンタイトルメント使用状況レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    service_contract_lines。entitlement_characteristics。entitlement_usage。sys_updated_on エンタイトルメント使用状況レコードが最後に更新された日時。

    データタイプ:文字列

    service_contract_lines。entitlement_characteristics。entitlement_usage。total_units 購入されたユニットの合計数。

    データタイプ:文字列

    service_contract_lines。entitlement_characteristics。entitlement_usage。used_units 使用された単位数。

    データタイプ:文字列

    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 エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    service_contract_lines。entitlement_characteristics.value
    特性の値。

    データタイプ:文字列

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

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    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。数 サービス契約品目の一意の番号。エンドポイントによって自動的に生成されます。例:CTRL9812347。

    データタイプ:文字列

    service_contract_lines。parent_contract_line 現在のサービス契約品目が子であるサービス契約品目のSys_id。

    契約に基づいて作成された契約品目の場合は Null。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。product_model サービス契約品目に関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    service_contract_lines。product_offering サービス契約品目に関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    service_contract_lines。product_specification サービス契約品目に関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    service_contract_lines。sold_product サービス契約品目に関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    service_contract_lines。sold_products_covered 対象製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sold_product": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    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.removed 関連付けられた販売済み製品がサービス契約品目から削除された日付。

    データタイプ:文字列

    形式: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。状態
    契約品目の現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    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 対象製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sold_product": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    sold_products_covered。追加 関連する販売済み製品が契約に追加された日付。

    データタイプ:文字列

    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

    デフォルト:承認されるとすぐに開始します。

    state
    サービス契約の現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ

    データタイプ:文字列

    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",
            "number": "CNTRL0000001",
            "contract": "d8641151d1f53110f8776589fa411fde",
            "parent_contract_line": null,
            "sold_product": null,
            "starts": "2022-12-03",
            "ends": "",
            "product_offering": null,
            "product_specification": null,
            "product_model": null,
            "child_contract_lines": [
              {
                "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
                "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": "Child CLI",
                "number": "CNTRL0000002",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "parent_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_specification": null,
                "product_model": null,
                "child_contract_lines": [],
                "entitlements": [
                  {
                    "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
                    "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": "Child CLI - ENTL",
                    "account": "4c325111d1f53110f8776589fa411f3d",
                    "consumer": null,
                    "household": null,
                    "contract": "d8641151d1f53110f8776589fa411fde",
                    "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
                    "state": "active",
                    "product_offering": null,
                    "product_specification": null,
                    "sold_entitlement": null,
                    "product": null,
                    "start_date": "2022-12-03",
                    "end_date": "",
                    "entitlement_characteristics": [],
                    "sold_products_covered": [],
                    "install_base_items_covered": []
                  }
                ],
                "sold_products_covered": [
                  {
                    "sys_id": "dfb62e9c4c6843009be02a68f65b9118",
                    "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": "2583912e81964501b52a2e44d4797a28",
                    "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": "3a00c975bb49412cae169200c7f6236e",
                    "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"
                  }
                ]
              }
            ],
            "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,
                "product_specification": null,
                "sold_entitlement": null,
                "product": null,
                "start_date": "2022-12-03",
                "end_date": "",
                "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"
                  }
                ],
                "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_usage": [
                      {
                        "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",
                        "service_contract_line": null,
                        "entitlement_characteristic": "a8641d91d1f53110f8776589fa411fd0",
                        "period_start": "2022-12-03",
                        "period_end": "",
                        "total_units": "5",
                        "used_units": "3"
                      }
                    ]
                  }
                ]
              }
            ],
            "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",
            "number": "CNTRL0000003”,
            "contract": "d8641151d1f53110f8776589fa411fde",
            "parent_contract_line": null,
            "sold_product": null,
            "starts": "2022-12-03",
            "ends": "",
            "product_offering": null,
            "product_specification": null,
            "product_model": null,
            "child_contract_lines": [],
            "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/{api_version}/servicecontract/contractline/{id}

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

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

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

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

    データタイプ:文字列

    ID 取得するサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    表 : 8. クエリパラメーター
    名前 説明
    display_value 返されるデータのタイプ。
    有効な値:
    • false:すべてのフィールド の値 を返します。例: "state":"draft"
    • true:すべてのフィールドの display_value を返します。例: "state":"Draft"
    • all:すべてのフィールドのすべての情報を返します。

    データタイプ:文字列

    デフォルト値:false

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

    ヘッダー

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

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

    デフォルト: application/json

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

    ステータスコード

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

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

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

    名前 説明
    child_contract_lines サービス契約品目に関連付けられている子サービス契約品目のリスト。

    データタイプ:オブジェクトのアレイ

    "child_contract_lines": [
      {
        "child_contract_lines": [Array],
        "contract": "String",
        "ends": "String",
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "number": "String",
        "parent_contract_line": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "String",
        "sold_product": "String",
        "sold_products_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"
      }
    ]
    child_contract_lines。child_contract_lines 子サービス契約品目の下に作成された子サービス契約品目オブジェクトのリスト。この配列のオブジェクトには、 child_contract_lines パラメーターのオブジェクトと同じ要素があります。

    データタイプ:オブジェクトのアレイ

    child_contract_lines。契約 子サービス契約品目に関連付けられたサービス契約のSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。終了 子サービス契約品目が終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    child_contract_lines。エンタイトルメント 子サービス契約品目に関連付けられたエンタイトルメントのリスト。

    データタイプ:オブジェクトのアレイ

    "entitlements": [
      {
        "account": "String",
        "consumer": "String",
        "contract": "String",
        "end_date": "String",
        "entitlement_characteristics": [Array],
        "entitlement_name": "String",
        "household": "String",
        "install_base_items_covered": [Array],
        "product": "String",
        "product_offering": "String",
        "product_specification": "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"
      }
    ]
    child_contract_lines。エンタイトルメント。アカウント
    エンタイトルメントが属するアカウントレコードのSys_id。

    データタイプ:文字列

    テーブル:アカウント [customer_account]

    child_contract_lines。エンタイトルメント。消費者
    エンタイトルメントが属するコンシューマーレコードのSys_id。

    データタイプ:文字列

    テーブル:コンシューマー [csm_consumer]

    child_contract_lines。エンタイトルメント。契約 エンタイトルメントが属する契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。エンタイトルメント。end_date エンタイトルメントの終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    child_contract_lines。エンタイトルメント。entitlement_characteristics エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
        "type": "String",
        "value": "String"
      }
    ]
    child_contract_lines。エンタイトルメント。entitlement_characteristics。特性
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    child_contract_lines。エンタイトルメント。entitlement_characteristics。characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    child_contract_lines。エンタイトルメント。entitlement_characteristics。資格 エンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage エンタイトルメント特性に関連付けられたエンタイトルメント使用状況のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_usage": [
      {
        "entitlement": "String",
        "entitlement_characteristic": "String",
        "period_end": "String",
        "period_start": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String",
        "total_units": "String",
        "used_units": "String"
      }
    ]
    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。資格 エンタイトルメントの使用状況に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。entitlement_characteristic エンタイトルメントの使用状況に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    cchild_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。period_end エンタイトルメントの使用状況が追跡されなくなる終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。period_start エンタイトルメントの使用状況を追跡する開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。service_contract_line 現在のエンタイトルメントの使用状況が属するサービス契約品目のSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_created_by エンタイトルメント使用状況レコードを作成したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_created_on エンタイトルメント使用状況レコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_id エンタイトルメント使用状況レコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_updated_by エンタイトルメント使用状況レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_updated_on エンタイトルメント使用状況レコードが最後に更新された日時。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。total_units 関連付けられたエンタイトルメント特性の総合補償額。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics。entitlement_usage。used_units period_startperiod_end の間でアカウントまたはコンシューマーによって使用されたユニット数。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics。種類 エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics。価値
    特性の値。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_name
    エンタイトルメントの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。世帯
    エンタイトルメントに関連付けられた世帯レコードのSys_id。

    データタイプ:文字列

    テーブル:世帯 [csm_household]

    child_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"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。エンタイトルメント。install_base_items_covered。追加
    関連付けられたインストールベースアイテムがサービス契約品目に追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。エンタイトルメント。install_base_items_covered。契約 インストールベースアイテムに関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。エンタイトルメント。install_base_items_covered。資格 インストールベースアイテムに関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。エンタイトルメント。install_base_items_covered。install_base 関連付けられたインストールベースアイテムレコードのSys_id。

    データタイプ:文字列

    テーブル:インストールベースアイテム [sn_install_base_item]

    child_contract_lines。エンタイトルメント。install_base_items_covered。削除
    関連付けられたサービス契約品目がインストールベースアイテムのカバレッジを終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。エンタイトルメント。install_base_items_covered。service_contract_line 関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    child_contract_lines。エンタイトルメント。install_base_items_covered。sys_created_by インストールベースアイテムレコードを作成したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。install_base_items_covered。sys_created_on インストールベースアイテムレコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。install_base_items_covered。sys_id 対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。エンタイトルメント。install_base_items_covered。sys_updated_by インストールベースアイテムレコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。install_base_items_covered。sys_updated_on インストールベースアイテムレコードが最後に更新された日時。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。積 エンタイトルメントに関連付けられた製品モデルレコードのSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    child_contract_lines。エンタイトルメント。product_offering エンタイトルメントに関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    child_contract_lines。エンタイトルメント。product_specification エンタイトルメントに関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    child_contract_lines。エンタイトルメント。service_contract_line エンタイトルメントに関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    child_contract_lines。エンタイトルメント。sold_entitlement エンタイトルメントに関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    child_contract_lines。エンタイトルメント。sold_products_covered 対象製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sold_product": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。エンタイトルメント。sold_products_covered。追加
    関連するサービス契約が製品を対象として開始する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    child_contract_lines。エンタイトルメント。sold_products_covered。契約 対象の販売済み製品に関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。エンタイトルメント。sold_products_covered。資格 対象の販売済み製品に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    child_contract_lines。エンタイトルメント。sold_products_covered。削除
    関連付けられたサービス契約が関連付けられた製品の補償を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    child_contract_lines。エンタイトルメント。sold_products_covered。service_contract_line 対象の販売済み製品に関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    child_contract_lines。エンタイトルメント。sold_products_covered。sold_product サービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    child_contract_lines。エンタイトルメント。sold_products_coveredsys_created_by 販売済み製品対象レコードを作成したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。sold_products_covered。sys_created_on 販売済み製品対象レコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。sold_products_covered。sys_id このサービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。エンタイトルメント。sold_products_covered。sys_updated_by 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。sold_products_covered。sys_updated_on 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。start_date
    エンタイトルメントの開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。エンタイトルメント。状態
    エンタイトルメントの現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。sys_created_by エンタイトルメントレコードを作成したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。sys_created_on エンタイトルメントレコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。sys_id 関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    child_contract_lines。エンタイトルメント。sys_updated_by エンタイトルメントレコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。sys_updated_on エンタイトルメントレコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
        "type": "String",
        "value": "String"
      }
    ]
    child_contract_lines。entitlement_characteristics。特性
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    child_contract_lines。entitlement_characteristics。characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    child_contract_lines。entitlement_characteristics。資格 エンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    child_contract_lines。entitlement_characteristics。entitlement_usage エンタイトルメント特性に関連付けられたエンタイトルメント使用状況のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_usage": [
      {
        "entitlement": "String",
        "entitlement_characteristic": "String",
        "period_end": "String",
        "period_start": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String",
        "total_units": "String",
        "used_units": "String"
      }
    ]
    child_contract_lines。entitlement_characteristics。entitlement_usage。資格 エンタイトルメントの使用状況に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    child_contract_lines。entitlement_characteristics。entitlement_usage。entitlement_characteristic エンタイトルメントの使用状況に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    child_contract_lines。entitlement_characteristics。entitlement_usage。period_end エンタイトルメントの使用状況が追跡されなくなる終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。entitlement_characteristics。entitlement_usage。period_start エンタイトルメントの使用状況を追跡する開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。entitlement_characteristics。entitlement_usage。service_contract_line 現在のエンタイトルメントの使用状況が属するサービス契約品目のSys_id。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。entitlement_usage。sys_created_by エンタイトルメント使用状況レコードを作成したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。entitlement_usage。sys_created_on エンタイトルメント使用状況レコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。entitlement_usage。sys_id エンタイトルメント使用状況レコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    child_contract_lines。entitlement_characteristics。entitlement_usage。sys_updated_by エンタイトルメント使用状況レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。entitlement_usage。sys_updated_on エンタイトルメント使用状況レコードが最後に更新された日時。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。entitlement_usage。total_units 関連付けられたエンタイトルメント特性の総合補償額。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。entitlement_usage。used_units period_startperiod_end の間でアカウントまたはコンシューマーによって使用されたユニット数。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。service_contract_line エンタイトルメント特性に関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    child_contract_lines。entitlement_characteristics。sys_created_by エンタイトルメント特性レコードを作成したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。sys_created_on エンタイトルメント特性レコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。sys_id エンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。sys_updated_by エンタイトルメント特性レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。sys_updated_on エンタイトルメント特性レコードが最後に更新された日時。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。種類 エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。価値
    特性の値。

    データタイプ:文字列

    child_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"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。install_base_items_covered。追加
    関連付けられたインストールベースアイテムがサービス契約品目に追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。install_base_items_covered。契約 インストールベースアイテムに関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。install_base_items_covered。資格 インストールベースアイテムに関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。install_base_items_covered。install_base 関連付けられたインストールベースアイテムレコードのSys_id。

    データタイプ:文字列

    テーブル:インストールベースアイテム [sn_install_base_item]

    child_contract_lines。install_base_items_covered。削除
    関連付けられたサービス契約品目がインストールベースアイテムのカバレッジを終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。install_base_items_covered。service_contract_line 関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    child_contract_lines。install_base_items_covered。sys_created_by インストールベースアイテムレコードを作成したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。install_base_items_covered。sys_created_on インストールベースアイテムレコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。install_base_items_covered。sys_id 対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。install_base_items_covered。sys_updated_by インストールベースアイテムレコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。install_base_items_covered。sys_updated_on インストールベースアイテムレコードが最後に更新された日時。

    データタイプ:文字列

    child_contract_lines。名前 子サービス契約品目の名前。

    データタイプ:文字列

    child_contract_lines。数 サービス契約品目の一意の番号。エンドポイントによって自動的に生成されます。例:CTRL000001。

    データタイプ:文字列

    child_contract_lines。parent_contract_line 子サービス契約品目に関連付けられた親契約品目レコードのSys_id。

    データタイプ:文字列

    child_contract_lines。product_model 子サービス契約品目に関連付けられている製品のSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    child_contract_lines。product_offering 子サービス契約品目に関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    child_contract_lines。product_specification 子サービス契約品目に関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    child_contract_lines。sold_product 子サービス契約品目に関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    child_contract_lines。sold_products_covered 対象製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sold_product": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。sold_products_covered。追加
    関連するサービス契約が製品を対象として開始する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    child_contract_lines。sold_products_covered。契約 対象の販売済み製品に関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。sold_products_covered。資格 対象の販売済み製品に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    child_contract_lines。sold_products_covered。削除
    関連付けられたサービス契約が関連付けられた製品の補償を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    child_contract_lines。sold_products_covered。service_contract_line 対象の販売済み製品に関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    child_contract_lines。sold_products_covered。sold_product サービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    child_contract_lines。sold_products_covered。sys_created_by 販売済み製品対象レコードを作成したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。sold_products_covered。sys_created_on 販売済み製品対象レコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。sold_products_covered。sys_id このサービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。sold_products_covered。sys_updated_by 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。sold_products_covered。sys_updated_on 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。開始 子サービス契約品目の開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。状態
    契約品目の現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    child_contract_lines。sys_created_by 子サービス契約品目レコードを作成したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。sys_created_on 子サービス契約品目レコードが作成された日時。

    データタイプ:文字列

    child_contract_lines。sys_id 子サービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    child_contract_lines。sys_updated_by 子サービス契約品目レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    child_contract_lines。sys_updated_on 子サービス契約品目レコードが最後に更新された日時。

    データタイプ:文字列

    contract
    サービス契約品目に関連付けられたサービス契約のSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    終了 サービス契約品目が終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    エンタイトルメント サービス契約品目に関連付けられたエンタイトルメントのリスト。

    データタイプ:オブジェクトのアレイ

    "entitlements": [
      {
        "account": "String",
        "consumer": "String",
        "contract": "String",
        "end_date": "String",
        "entitlement_characteristics": [Array],
        "entitlement_name": "String",
        "household": "String",
        "install_base_items_covered": [Array],
        "product": "String",
        "product_offering": "String",
        "product_specification": "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_entitlement]

    エンタイトルメント。アカウント
    エンタイトルメントが属するアカウントレコードのSys_id。

    データタイプ:文字列

    テーブル:アカウント [customer_account]

    エンタイトルメント。消費者
    エンタイトルメントが属するコンシューマーレコードのSys_id。

    データタイプ:文字列

    テーブル:コンシューマー [csm_consumer]

    エンタイトルメント。契約 エンタイトルメントが属する契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    エンタイトルメント。end_date エンタイトルメントの終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    エンタイトルメント。entitlement_characteristics エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String",
        "type": "String",
        "value": "String"
      }
    ]

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    エンタイトルメント。entitlement_characteristics.characteristic
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    エンタイトルメント。entitlement_characteristics.characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    エンタイトルメント。entitlement_characteristics。資格 関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    エンタイトルメント。entitlement_characteristics。entitlement_usage エンタイトルメントの使用状況の詳細。

    データタイプ:オブジェクトのアレイ

    "entitlement_usage": [
      {
        "entitlement": "String",
        "entitlement_characteristic": [Array],
        "period_end": "String",
        "period_start": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String",
        "total_units": "String",
        "used_units": "String"
      }
    ]
    エンタイトルメント。entitlement_characteristics。entitlement_usage。資格 エンタイトルメントの使用状況に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    エンタイトルメント。entitlement_characteristics。entitlement_usage。entitlement_characteristic エンタイトルメントの使用状況に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    エンタイトルメント。entitlement_characteristics。entitlement_usage。period_end エンタイトルメントの使用状況が追跡されなくなる終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    エンタイトルメント。entitlement_characteristics。entitlement_usage。period_start エンタイトルメントの使用状況を追跡する開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    エンタイトルメント。entitlement_characteristics。entitlement_usage。service_contract_line 現在のエンタイトルメント使用状況が属するサービス契約品目。

    データタイプ:文字列

    エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_created_by エンタイトルメント使用状況レコードを作成したユーザーの名前。

    データタイプ:文字列

    エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_created_on エンタイトルメント使用状況レコードが作成された日時。

    データタイプ:文字列

    エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_id エンタイトルメント使用状況レコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_updated_by エンタイトルメント使用状況レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    エンタイトルメント。entitlement_characteristics。entitlement_usage。sys_updated_on エンタイトルメント使用状況レコードが最後に更新された日時。

    データタイプ:文字列

    エンタイトルメント。entitlement_characteristics。entitlement_usage。total_units 関連付けられたエンタイトルメント特性の総合補償額。

    データタイプ:文字列

    エンタイトルメント。entitlement_characteristics。entitlement_usage。used_units period_startperiod_end の間でアカウントまたはコンシューマーによって使用されたユニット数。

    データタイプ:文字列

    エンタイトルメント。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 エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    エンタイトルメント。entitlement_characteristics.value
    特性の値。

    データタイプ:文字列

    エンタイトルメント。entitlement_name
    エンタイトルメントの名前。

    データタイプ:文字列

    エンタイトルメント。世帯
    エンタイトルメントに関連付けられた世帯レコードのSys_id。

    データタイプ:文字列

    テーブル:世帯 [csm_household]

    エンタイトルメント。install_base_items_covered サービス契約品目の対象となるインストールベースアイテムのリスト。

    データタイプ:オブジェクトのアレイ

    "install_base_items_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "install_base": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]
    エンタイトルメント。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]

    エンタイトルメント。product_specification エンタイトルメントに関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    エンタイトルメント。service_contract_line エンタイトルメントに関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    エンタイトルメント。sold_entitlement エンタイトルメントに関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    エンタイトルメント。sold_products_covered 対象製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sold_product": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    エンタイトルメント。sold_products_covered。追加 関連付けられた販売済み製品がエンタイトルメントに追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    エンタイトルメント。sold_products_covered。契約 対象の販売済み製品に関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    エンタイトルメント。sold_products_covered。資格 対象の販売済み製品に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    エンタイトルメント。sold_products_covered.removed 関連付けられた販売済み製品がエンタイトルメントから削除された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    エンタイトルメント。sold_products_covered。service_contract_line 対象の販売済み製品に関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    エンタイトルメント。sold_products_covered。sold_product エンタイトルメントの対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    エンタイトルメント。sold_products_covered。sys_created_by 販売済み製品対象レコードを作成したユーザーの名前。

    データタイプ:文字列

    エンタイトルメント。sold_products_covered。sys_created_on 販売済み製品対象レコードが作成された日時。

    データタイプ:文字列

    エンタイトルメント。sold_products_covered。sys_id このサービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    エンタイトルメント。sold_products_covered。sys_updated_by 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    エンタイトルメント。sold_products_covered。sys_updated_on 販売済み製品対象レコードが最後に更新された日時。

    データタイプ:文字列

    エンタイトルメント。start_date
    エンタイトルメントの開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    エンタイトルメント。状態
    エンタイトルメントの現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    エンタイトルメント。sys_created_by エンタイトルメントレコードを作成したユーザーの名前。

    データタイプ:文字列

    エンタイトルメント。sys_created_on エンタイトルメントレコードが作成された日時。

    データタイプ:文字列

    エンタイトルメント。sys_id 関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    エンタイトルメント。sys_updated_by エンタイトルメントレコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    エンタイトルメント。sys_updated_on エンタイトルメントレコードが作成された日時。

    データタイプ:文字列

    entitlement_characteristics サービス契約品目に関連付けられたエンタイトルメント特性のリスト。

    データタイプ:オブジェクトのアレイ

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

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    entitlement_characteristics。特性
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    entitlement_characteristics。characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    entitlement_characteristics。資格 エンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    entitlement_characteristics。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。種類 エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    entitlement_characteristics。価値
    特性の値。

    データタイプ:文字列

    install_base_items_covered サービス契約品目の対象となるインストールベースアイテムのリスト。

    データタイプ:オブジェクトのアレイ

     "install_base_items_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "install_base": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    install_base_items_covered。追加
    関連付けられたインストールベースアイテムがサービス契約品目に追加された日付。

    データタイプ:文字列

    install_base_items_covered。契約 インストールベースアイテムに関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    install_base_items_covered。資格 インストールベースアイテムに関連付けられたエンタイトルメントレコードの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 インストールベースアイテムレコードが最後に更新された日時。

    データタイプ:文字列

    名前
    サービス契約品目の名前。

    データタイプ:文字列

    番号 サービス契約品目の一意の番号。エンドポイントによって自動的に生成されます。例:CTRL9812347。

    データタイプ:文字列

    parent_contract_line 現在のサービス契約品目が子であるサービス契約品目のSys_id。

    契約に基づいて作成された契約品目の場合は Null。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    product_model サービス契約品目に関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    product_offering サービス契約品目に関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    product_specification サービス契約品目に関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    sold_product サービス契約品目に関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    sold_products_covered 対象製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sold_product": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    sold_products_covered。追加 関連付けられた販売済み製品がサービス契約品目に追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    sold_products_covered。契約 対象の販売済み製品に関連付けられたサービス契約レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    sold_products_covered。資格 対象の販売済み製品に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    sold_products_covered.removed 関連付けられた販売済み製品がサービス契約品目から削除された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    sold_products_covered。service_contract_line 対象の販売済み製品に関連付けられたサービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    sold_products_covered。sold_product エンタイトルメントの対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    sold_products_covered。sys_created_by 販売済み製品対象レコードを作成したユーザーの名前。

    データタイプ:文字列

    sold_products_covered。sys_created_on 販売済み製品対象レコードが作成された日時。

    データタイプ:文字列

    sold_products_covered。sys_id このサービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    sold_products_covered。sys_updated_by 販売済み製品対象レコードを最後に更新したユーザーの名前。

    データタイプ:文字列

    sold_products_covered。sys_updated_on 販売済み製品対象レコードが最後に更新された日時。

    データタイプ:文字列

    開始
    サービス契約品目の開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    state
    契約品目の現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    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",
        "number": "CTRL0000001",
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "parent_contract_line": null,
        "sold_product": null,
        "starts": "2022-12-03",
        "ends": "",
        "product_offering": null,
        "product_specification": null,
        "product_model": null,
        "child_contract_lines": [
          {
            "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
            "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": "Child CLI",
            "number": "CTRL0000002",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "parent_contract_line": "16e451d1d1f53110f8776589fa411f80",
            "sold_product": null,
            "starts": "2022-12-03",
            "ends": "",
            "product_offering": null,
            "product_model": null,
            "product_specification": null,
            "child_contract_lines": [],
            "entitlements": [
              {
                "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
                "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": "Child CLI - ENTL",
                "account": "4c325111d1f53110f8776589fa411f3d",
                "consumer": null,
                "household": null,
                "contract": "a4b415d1d1f53110f8776589fa411f20",
                "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
                "state": "active",
                "product_offering": null,
                "product_specification": null,
                "sold_entitlement": null,
                "product": null,
                "start_date": "2022-12-03",
                "end_date": "",
                "entitlement_characteristics": [],
                "sold_products_covered": [],
                "install_base_items_covered": []
              }
            ],
            "sold_products_covered": [
              {
                "sys_id": "dfb62e9c4c6843009be02a68f65b9118",
                "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": "a4b415d1d1f53110f8776589fa411f20",
                "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
                "entitlement": null,
                "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
                "added": "2023-12-03",
                "removed": "2023-12-03"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "2583912e81964501b52a2e44d4797a28",
                "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": "a4b415d1d1f53110f8776589fa411f20",
                "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
                "entitlement": null,
                "install_base": "a1731551d1f53110f8776589fa411f8d",
                "added": "2023-12-03",
                "removed": "2023-12-03"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "3a00c975bb49412cae169200c7f6236e",
                "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": "3a39ecdc01154f4ab782da0169c9c922",
                "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,
            "product_specification": null,
            "sold_entitlement": null,
            "product": null,
            "start_date": "2022-12-03",
            "end_date": "",
            "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": [],
            "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_usage": [
                  {
                    "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",
                    "service_contract_line": null,
                    "entitlement_characteristic": "1ae419d1d1f53110f8776589fa411f3e",
                    "period_start": "2022-12-03",
                    "period_end": "",
                    "total_units": "5",
                    "used_units": "2"
                  }
                ]
              }
            ]
          }
        ],
        "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"
          }
        ]
      }
    }

    サービス契約: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/{api_version}/servicecontract

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

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

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

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

    データタイプ:文字列

    表 : 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 サービス契約の対象となるインストールベースアイテムのリスト。

    インストールベースアイテムの詳細については、 Configure Install baseを参照してください。

    データタイプ:オブジェクトのアレイ

    "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]

    保存場所:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product] テーブル。

    install_base_items_covered.added
    関連するサービス契約がインストールベースアイテムをカバーし始める日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    install_base_items_covered。install_base 関連付けられたインストールベースアイテムレコードのSys_id。

    データタイプ:文字列

    テーブル:インストールベースアイテム [sn_install_base_item]

    install_base_items_covered。削除
    関連付けられたサービス契約がインストールベースアイテムの対象範囲を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    service_contract_lines サービス契約に関連付けられているサービス契約品目のリスト。

    データタイプ:オブジェクトのアレイ

    "service_contract_lines": [
      {
        "child_contract_lines": [Array],
        "ends": "String",
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "number": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "String",
        "sold_product": "String",
        "sold_products_covered": [Array],
        "starts": "String",
        "state": "String"
      }
    ]

    保存場所: サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。child_contract_lines サービス契約品目の下にある子サービス契約品目のリスト。

    データタイプ:オブジェクトのアレイ

    "child_contract_lines": [
      {
        "child_contract_lines": [Array],
        "ends": "String",
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "String",
        "sold_product": "String",
        "sold_products_covered": [Array],
        "starts": "String",
        "state": "String"
      }
    ]

    保存場所: サービス契約品目 [sn_pss_core_service_contract_line]

    service_contract_lines。child_contract_lines。child_contract_lines 子サービス契約品目の下に作成する子サービス契約品目オブジェクトのリスト。この配列のオブジェクトには、 service_contract_lines.child_contract_lines パラメーターのオブジェクトと同じ要素があります。

    データタイプ:オブジェクトのアレイ

    service_contract_lines。child_contract_lines。終了 サービス契約品目が終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    service_contract_lines。child_contract_lines。エンタイトルメント 子サービス契約品目に関連付けるエンタイトルメントのリスト。

    データタイプ:オブジェクトのアレイ

    "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",
        "product_specification": "String",
        "sold_entitlement": "String",
        "sold_products_covered": [Array],
        "start_date": "String",
        "state": "String"
      }
    ]

    保存場所: エンタイトルメント [service_entitlement]

    service_contract_lines。child_contract_lines。エンタイトルメント。アカウント
    エンタイトルメントが属するアカウントレコードのSys_id。

    データタイプ:文字列

    テーブル:アカウント [customer_account]

    service_contract_lines。child_contract_lines。エンタイトルメント。消費者
    エンタイトルメントが属するコンシューマーレコードのSys_id。

    データタイプ:文字列

    テーブル:コンシューマー [csm_consumer]

    service_contract_lines。child_contract_lines。エンタイトルメント。end_date エンタイトルメントの終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement_usage": {Object},
        "type": "String",
        "value": "String"
      }
    ]

    保存場所:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics.characteristic 必須。
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics.characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics.entitlement_usage 関連付けられたエンタイトルメント特性の使用単位値。

    entitlement_characteristicsがエンタイトルメントの下にある場合にのみ、このパラメーターを渡します。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "used_units": "String"
    }

    保存場所: エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics.entitlement_usage。used_units 関連付けられたエンタイトルメント特性の使用法。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics.type エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics.value entitlement_characteristics.characteristicパラメーターで指定されたレコードに含まれるinput_typeパラメーターが選択されていない場合は必須です。
    特性の値。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_name 必須。
    エンタイトルメントの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。世帯 世帯プラグインがアクティブで、 consumer パラメーターが渡された場合にのみ渡されます。
    エンタイトルメントに関連付けられた世帯レコードのSys_id。

    データタイプ:文字列

    テーブル:世帯 [csm_household]

    service_contract_lines。child_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。child_contract_lines。エンタイトルメント。install_base_items_covered。追加 関連付けられたインストールベースアイテムがエンタイトルメントに追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。install_base エンタイトルメントの対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:インストールベースアイテム [sn_install_base_item]

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。削除 関連付けられたインストールベースアイテムがエンタイトルメントから削除された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    service_contract_lines。child_contract_lines。エンタイトルメント。積 エンタイトルメントに関連付けられた製品モデルレコードのSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    service_contract_lines。child_contract_lines。エンタイトルメント。product_offering エンタイトルメントに関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    service_contract_lines。child_contract_lines。エンタイトルメント。product_specification エンタイトルメントに関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_entitlement エンタイトルメントに関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered エンタイトルメントの対象となる販売済み製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。追加 関連付けられた販売済み製品がエンタイトルメントに追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。削除 関連付けられた販売済み製品がエンタイトルメントから削除された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    service_contract_lines。child_contract_lines。エンタイトルメント。start_date 必須。
    エンタイトルメントの開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。エンタイトルメント。状態 必須。
    エンタイトルメントの現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics サービス契約品目に関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics" [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement_usage": {Object},
        "type": "String",
        "value": "String"
      }
    ]

    保存場所:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。child_contract_lines。entitlement_characteristics.characteristic 必須。
    サービス契約品目に関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    service_contract_lines。child_contract_lines。entitlement_characteristics.characteristic_option
    サービス契約品目に関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    service_contract_lines。child_contract_lines。entitlement_characteristics.entitlement_usage 関連付けられたサービス契約品目の特性の使用単位値。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "used_units": "String"
    }

    保存場所: エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    service_contract_lines。child_contract_lines。entitlement_characteristics.entitlement_usage。usage_units 関連付けられたエンタイトルメント特性の使用法。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics.type サービス契約品目の特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • 補償_and_usage

    データタイプ:文字列

    service_contract_lines。child_contract_lines。entitlement_characteristics.value entitlement_characteristics.typeパラメーターが渡されない場合は必須です。
    特性の値。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。install_base_items_covered
    サービス契約品目の対象となるインストールベースアイテムのリスト。

    データタイプ:オブジェクトのアレイ

     "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]

    保管場所: 対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。install_base_items_covered。追加
    関連付けられたインストールベースアイテムがサービス契約品目に追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    service_contract_lines。child_contract_lines。install_base_items_covered。install_base サービス契約品目の対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:インストールベースアイテム [sn_install_base_item]

    service_contract_lines。child_contract_lines。install_base_items_covered。削除
    関連付けられたサービス契約品目がインストールベースアイテムのカバレッジを終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    service_contract_lines。child_contract_lines。名前
    サービス契約品目の名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。product_model サービス契約品目に関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    service_contract_lines。child_contract_lines。product_offering サービス契約品目に関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    service_contract_lines。child_contract_lines。product_specification サービス契約品目に関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    service_contract_lines。child_contract_lines。sold_product サービス契約品目に関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    service_contract_lines。child_contract_lines。sold_products_covered
    サービス契約品目の対象となる製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    service_contract_lines。child_contract_lines。.sold_products_covered。追加 関連する製品をカバーするために関連するサービス契約品目が開始される日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    service_contract_lines。child_contract_lines。sold_products_covered。削除 関連付けられたサービス契約品目が関連製品の補償を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    service_contract_lines。child_contract_lines。sold_products_covered。sold_product
    サービス契約品目に関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。開始 必須。
    サービス契約品目の開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。child_contract_lines。状態 必須。
    契約品目の現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    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",
        "product_specification": "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 エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement_usage": {Object},
        "type": "String",
        "value": "String"
      }
    ]

    保存場所:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。エンタイトルメント。entitlement_characteristics.characteristic 必須。
    エンタイトルメントに関連付けられた特性レコードの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 関連付けられたエンタイトルメント特性の使用単位値。

    entitlement_characteristicsがエンタイトルメントの下にある場合にのみ、このパラメーターを渡します。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "used_units": "String"
    }

    保存場所: エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    service_contract_lines。エンタイトルメント。entitlement_characteristics.entitlement_usage。usage_units 関連付けられたエンタイトルメント特性の使用法。

    データタイプ:文字列

    service_contract_lines。エンタイトルメント。entitlement_characteristics.type エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    service_contract_lines。エンタイトルメント。entitlement_characteristics.value entitlement_characteristics.characteristicパラメーターで指定されたレコードに含まれるinput_typeパラメーターが選択されていない場合は必須です。
    特性の値。

    データタイプ:文字列

    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",
        "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。エンタイトルメント。積 エンタイトルメントに関連付けられた製品モデルレコードのSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    service_contract_lines。エンタイトルメント。product_offering エンタイトルメントに関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    service_contract_lines。エンタイトルメント。product_specification エンタイトルメントに関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    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",
        "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。エンタイトルメント。start_date 必須。
    エンタイトルメントの開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    service_contract_lines。エンタイトルメント。状態 必須。
    エンタイトルメントの現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    service_contract_lines。entitlement_characteristics サービス契約品目に関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics" [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement_usage": {Object},
        "type": "String",
        "value": "String"
      }
    ]

    保存場所:特性 [sn_pss_core_entitlement_characteristic]

    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 関連付けられたサービス契約品目の特性の使用単位値。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "used_units": "String"
    }

    保存場所: エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    service_contract_lines。entitlement_characteristics。entitlement_usage。usage_units 関連付けられたエンタイトルメント特性の使用法。

    データタイプ:文字列

    service_contract_lines。entitlement_characteristics。種類 サービス契約品目の特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • 補償_and_usage

    データタイプ:文字列

    service_contract_lines。entitlement_characteristics。価値 entitlement_characteristics.typeパラメーターが渡されない場合は必須です。
    特性の値。

    データタイプ:文字列

    service_contract_lines。install_base_items_covered
    サービス契約品目の対象となるインストールベースアイテムのリスト。

    データタイプ:オブジェクトのアレイ

     "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]

    保管場所: 対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    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。product_specification サービス契約品目に関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    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。状態 必須。
    契約品目の現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    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.added
    関連するサービス契約が製品を対象として開始する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    sold_products_covered.removed
    関連付けられたサービス契約が関連付けられた製品の補償を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    sold_products_covered.sold_product サービス契約の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    開始 必須。
    サービス契約が開始される日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    state 必須。
    サービス契約の現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ

    データタイプ:文字列

    vendor_contract 必須。
    関連付けられた外部契約の一意の識別子。

    データタイプ:文字列

    ヘッダー

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

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

    デフォルト: application/json

    Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

    デフォルト: application/json

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

    ステータスコード

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

    表 : 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": [
      {
        "child_contract_lines": [Array],
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "number": "String",
        "sold_products_covered": [Array],
        "sys_id": "String"
      }
    ]
    service_contract_lines。child_contract_lines サービス契約品目の下に作成された子サービス契約品目オブジェクトのリスト。

    データタイプ:オブジェクトのアレイ

    "child_contract_lines": [
      {
        "child_contract_lines": [Array],
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "number": "String",
        "sold_products_covered": [Array],
        "sys_id" "String"
      }
    ]
    service_contract_lines。child_contract_lines。child_contract_lines 子サービス契約品目の下に作成された子サービス契約品目オブジェクトのリスト。この配列のオブジェクトには、 service_contract_lines.child_contract_lines パラメーターと同じ要素があります。

    データタイプ:オブジェクトのアレイ

    service_contract_lines。child_contract_lines。エンタイトルメント 子サービス契約品目に関連付けられたエンタイトルメントのリスト。

    データタイプ:オブジェクトのアレイ

    "entitlements": [
      {
        "entitlement_name": "String",
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "sold_products_covered": [Array],
        "sys_id": "String"
      }
    ]
    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_name
    エンタイトルメントの名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics エンタイトルメントの下に作成されたエンタイトルメント特性オブジェクトのリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines。child_contract_lines。エンタイトルメント。entitlement_characteristics。sys_id 子サービス契約品目に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered エンタイトルメントの対象となるインストールベースアイテムのsys_idsのリスト。

    データタイプ:オブジェクトのアレイ

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines。child_contract_lines。エンタイトルメント。install_base_items_covered。sys_id エンタイトルメントの対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered エンタイトルメントの対象となるsys_ids製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines。child_contract_lines。エンタイトルメント。sold_products_covered。sys_id エンタイトルメントに関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。エンタイトルメント。sys_id 子サービス契約品目に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    service_contract_lines。child_contract_lines。entitlement_characteristics チリの契約品目に関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "entitlement_usage": {Object},
        "sys_id": "String"
      }
    ]
    service_contract_lines。child_contract_lines。entitlement_characteristics。entitlement_usage entitlement_characteristicの下に挿入されたエンタイトルメント使用オブジェクト。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "sys_id": "String"
    }
    service_contract_lines。child_contract_lines。entitlement_characteristics。entitlement_usage。sys_id エンタイトルメント使用状況レコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    service_contract_lines。child_contract_lines。entitlement_characteristics。sys_id 子サービス契約品目に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    service_contract_lines。child_contract_lines。install_base_items_covered 子契約品目の対象となるインストールベースアイテムのsys_idsのリスト。

    データタイプ:オブジェクトのアレイ

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines。child_contract_lines。install_base_items_covered。sys_id 対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。名前 子サービス契約品目の名前。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。数 サービス契約品目の一意の番号。エンドポイントによって自動的に生成されます。例:CTRL000001。

    データタイプ:文字列

    service_contract_lines。child_contract_lines。sold_products_covered 子サービス契約品目の対象となる製品のsys_idsのリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines。child_contract_lines。sold_products_covered。sys_id 子サービス契約品目の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    service_contract_lines。child_contract_lines。sys_id 子サービス契約品目レコードのSys_id。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    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]

    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。名前 子サービス契約品目の名前。

    データタイプ:文字列

    service_contract_lines。数 サービス契約品目の一意の番号。エンドポイントによって自動的に生成されます。例:CTRL000001。

    データタイプ:文字列

    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。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    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",
      "service_contract_lines": [
        {
          "state": "active",
          "name": "CLI",
          "starts": "2022-12-03",
          "child_contract_lines": [
            {
              "state": "active",
              "name": "Child CLI",
              "starts": "2022-12-03",
              "entitlements": [
                {
                  "state": "active",
                  "entitlement_name": "Child CLI - ENTL",
                  "start_date": "2022-12-03"
                }
              ],
              "sold_products_covered": [
                {
                  "sold_product": "8db4258949f14ef7b90d90822dfc5800",
                  "added": "2023-12-03",
                  "removed": "2023-12-03"
                }
              ],
              "install_base_items_covered": [
                {
                  "install_base": "2f270832699b46e78aa899a5a5dc6682",
                  "added": "2023-12-03",
                  "removed": "2023-12-03"
                }
              ],
              "entitlement_characteristics": [
                {
                  "characteristic": "63418db7539e61106bfcddeeff7b1238",
                  "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                  "value": "20",
                  "type": "coverage"
                }
              ]
            }
          ],
          "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"
                  }
                }
              ]
            }
          ],
          "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"
            }
          ],
          "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"
            }
          ]
        }
      ],
      "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"
        }
      ]
    } 
    --user "username":"password"

    応答:

    {
      "result": {
        "sys_id": "d8641151d1f53110f8776589fa411fde",
        "number": "CNTR0010004",
        "short_description": null,
        "service_contract_lines": [
          {
            "sys_id": "d4641d91d1f53110f8776589fa411fbb",
            "name": "CLI",
            "number": "CTRL0000001,                                                                                                 
            "child_contract_lines": [
              {
                "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
                "name": "Child CLI",
                "number": "CTRL0000002",
                "child_contract_lines": [],
                "entitlements": [
                  {
                    "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
                    "entitlement_name": "Child CLI - ENTL",
                    "sold_products_covered": [],
                    "install_base_items_covered": [],
                    "entitlement_characteristics": []
                  }
                ],
                "sold_products_covered": [
                  {
                    "sys_id": "dfb62e9c4c6843009be02a68f65b9118"
                  }
                ],
                "install_base_items_covered": [
                  {
                    "sys_id": "2583912e81964501b52a2e44d4797a28"
                  }
                ],
                "entitlement_characteristics": [
                  {
                    "sys_id": "3a00c975bb49412cae169200c7f6236e",
                    "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"
                    }
                  }
                ]
              }
            ],
            "sold_products_covered": [
              {
                "sys_id": "98641d91d1f53110f8776589fa411fbc"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "58641d91d1f53110f8776589fa411fbd"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "e0641d91d1f53110f8776589fa411fbf",
                "entitlement_usage": {}
              }
            ]
          },
          {
            "sys_id": "e4641d91d1f53110f8776589fa411fd2",
            "name": "CLI 2",
            "number": "CTRL0000003",
            "child_contract_lines": [],
            "entitlements": [],
            "sold_products_covered": [
              {
                "sys_id": "e8641d91d1f53110f8776589fa411fd3"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "a8641d91d1f53110f8776589fa411fd4"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "a8641d91d1f53110f8776589fa411fd5",
                "entitlement_usage": {}
              }
            ]
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "9c641d91d1f53110f8776589fa411fb9"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "d8641d91d1f53110f8776589fa411fba"
          }
        ]
      }
    }

    サービス契約: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/{api_version}/servicecontract/contractline

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

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

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

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

    データタイプ:文字列

    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    child_contract_lines サービス契約品目の下に作成された子サービス契約品目オブジェクトのリスト。

    データタイプ:オブジェクトのアレイ

    "child_contract_lines": [
      {
        "child_contract_lines": [Array],
        "contract": "String",
        "ends": "String",
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "parent_contract_line": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "String",
        "sold_product": "String",
        "sold_products_covered": [Array],
        "starts": "String",
        "state": "String"
      }
    ]

    保存場所: サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。child_contract_lines 子サービス契約品目の下に作成する子サービス契約品目オブジェクトのリスト。この配列のオブジェクトには、 child_contract_lines パラメーターのオブジェクトと同じ要素があります。

    データタイプ:オブジェクトのアレイ

    child_contract_lines。契約 子サービス契約品目に関連付けられたサービス契約のSys_id。

    データタイプ:文字列

    テーブル:サービス契約 [sn_pss_core_service_contract]

    child_contract_lines。終了 子サービス契約品目が終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    child_contract_lines。エンタイトルメント 子サービス契約品目に関連付けられたエンタイトルメントのリスト。

    データタイプ:オブジェクトのアレイ

    "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",
        "product_specification": "String",
        "sold_entitlement": "String",
        "sold_products_covered": [Array],
        "start_date": "String",
        "state": "String"
      }
    ]

    保存場所: エンタイトルメント [service_entitlement]

    child_contract_lines。エンタイトルメント。アカウント consumerパラメーターが渡されない場合は必須です。
    エンタイトルメントが属するアカウントレコードのSys_id。

    データタイプ:文字列

    テーブル:アカウント [customer_account]

    child_contract_lines。エンタイトルメント。消費者 accountパラメーターが渡されない場合は必須です。
    エンタイトルメントが属するコンシューマーレコードのSys_id。

    データタイプ:文字列

    テーブル:コンシューマー [csm_consumer]

    child_contract_lines。エンタイトルメント。end_date エンタイトルメントの終了日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:手動で削除するまで終了しません。

    child_contract_lines。エンタイトルメント。entitlement_characteristics エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement_usage": {Object},
        "type": "String",
        "value": "String"
      }
    ]

    保存場所:特性 [sn_pss_core_entitlement_characteristic]

    child_contract_lines。エンタイトルメント。entitlement_characteristics.characteristic 必須。
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    child_contract_lines。エンタイトルメント。entitlement_characteristics.characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    child_contract_lines。エンタイトルメント。entitlement_characteristics.entitlement_usage 関連付けられたエンタイトルメント特性の使用単位値。

    entitlement_characteristicsがエンタイトルメントの下にある場合にのみ、このパラメーターを渡します。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "used_units": "String"
    }

    保存場所: エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    child_contract_lines。エンタイトルメント。entitlement_characteristics.entitlement_usage。used_units 関連付けられたエンタイトルメント特性の使用法。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics.type エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics.value entitlement_characteristics.characteristicパラメーターで指定されたレコードに含まれるinput_typeパラメーターが選択されていない場合は必須です。
    特性の値。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_name 必須。
    エンタイトルメントの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。世帯 世帯プラグインがアクティブで、 consumer パラメーターが渡された場合にのみ渡されます。
    エンタイトルメントに関連付けられた世帯レコードのSys_id。

    データタイプ:文字列

    テーブル:世帯 [csm_household]

    child_contract_lines。エンタイトルメント。install_base_items_covered
    エンタイトルメントの対象となるインストールベースアイテムのリスト。このアレイの情報は、対象の販売済み製品 [sn_install_base_m2m_contract_sold_product] テーブルに挿入されます。

    データタイプ:オブジェクトのアレイ

    "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]
    child_contract_lines。エンタイトルメント。install_base_items_covered。追加 関連付けられたインストールベースアイテムがエンタイトルメントに追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    child_contract_lines。エンタイトルメント。install_base_items_covered。install_base エンタイトルメントの対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:インストールベースアイテム [sn_install_base_item]

    child_contract_lines。エンタイトルメント。install_base_items_covered。削除 関連付けられたインストールベースアイテムがエンタイトルメントから削除された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    child_contract_lines。エンタイトルメント。積 エンタイトルメントに関連付けられた製品モデルレコードのSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    child_contract_lines。エンタイトルメント。product_offering エンタイトルメントに関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    child_contract_lines。エンタイトルメント。product_specification エンタイトルメントに関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    child_contract_lines。エンタイトルメント。sold_entitlement エンタイトルメントに関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    child_contract_lines。エンタイトルメント。sold_products_covered エンタイトルメントの対象となる販売済み製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    child_contract_lines。エンタイトルメント。sold_products_covered。追加 関連付けられた販売済み製品がエンタイトルメントに追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    child_contract_lines。エンタイトルメント。sold_products_covered。削除 関連付けられた販売済み製品がエンタイトルメントから削除された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    child_contract_lines。エンタイトルメント。sold_products_covered。sold_product エンタイトルメントに関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。エンタイトルメント。start_date 必須。
    エンタイトルメントの開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。エンタイトルメント。状態 必須。
    エンタイトルメントの現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement_usage": {Object},
        "type": "String",
        "value": "String"
      }
    ]

    保存場所:特性 [sn_pss_core_entitlement_characteristic]

    child_contract_lines。entitlement_characteristics。特性
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    child_contract_lines。entitlement_characteristics。characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    child_contract_lines。entitlement_characteristics。entitlement_usage 関連付けられたエンタイトルメント特性の使用単位値。

    entitlement_characteristicsがエンタイトルメントの下にある場合にのみ、このパラメーターを渡します。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "used_units": "String"
    }

    保存場所: エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    child_contract_lines。entitlement_characteristics。entitlement_usage。used_units 関連付けられたエンタイトルメント特性の使用法。

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。種類 エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    child_contract_lines。entitlement_characteristics。価値
    特性の値。

    データタイプ:文字列

    child_contract_lines。install_base_items_covered
    エンタイトルメントの対象となるインストールベースアイテムのリスト。このアレイの情報は、対象の販売済み製品 [sn_install_base_m2m_contract_sold_product] テーブルに挿入されます。

    データタイプ:オブジェクトのアレイ

    "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]
    child_contract_lines。install_base_items_covered。追加 関連付けられたインストールベースアイテムが子サービス契約品目に追加された日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    child_contract_lines。install_base_items_covered。install_base 子サービス契約品目の対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:インストールベースアイテム [sn_install_base_item]

    child_contract_lines。install_base_items_covered。削除 関連付けられた子サービス契約品目がインストールベースアイテムの補償を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    child_contract_lines。名前 子サービス契約品目の名前。

    データタイプ:文字列

    child_contract_lines。parent_contract_line 子サービス契約品目に関連付けられた親契約品目レコードのSys_id。

    データタイプ:文字列

    child_contract_lines。product_model 子サービス契約品目に関連付けられている製品のSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    child_contract_lines。product_offering 子サービス契約品目に関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    child_contract_lines。product_specification 子サービス契約品目に関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    child_contract_lines。sold_product 子サービス契約品目に関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    child_contract_lines。sold_products_covered 子サービス契約品目の対象となる製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    child_contract_lines。sold_products_covered。追加 関連付けられた子サービス契約品目が、関連付けられた製品をカバーし始める日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    child_contract_lines。sold_products_covered。削除 関連付けられた子サービス契約品目が、関連付けられた製品の補償を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    child_contract_lines。sold_products_covered。sold_product 子サービス契約品目に関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。開始 子サービス契約品目の開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    child_contract_lines。状態
    契約品目の現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    contract
    サービス契約品目に関連付けられたサービス契約の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",
        "product_specification": "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 エンタイトルメントに関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement_usage": {Object},
        "type": "String",
        "value": "String"
      }
    ]

    保存場所:特性 [sn_pss_core_entitlement_characteristic]

    エンタイトルメント。entitlement_characteristics.characteristic 必須。
    エンタイトルメントに関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    エンタイトルメント。entitlement_characteristics.characteristic_option エンタイトルメントに関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    エンタイトルメント。entitlement_characteristics.entitlement_usage 関連付けられたエンタイトルメント特性の使用単位値。

    entitlement_characteristicsがエンタイトルメントの下にある場合にのみ、このパラメーターを渡します。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "used_units": "String"
    }

    保存場所: エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    エンタイトルメント。entitlement_characteristics.entitlement_usage。used_units 関連付けられたエンタイトルメント特性の使用法。

    データタイプ:文字列

    エンタイトルメント。entitlement_characteristics.type エンタイトルメント特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • coverage_and_usage

    データタイプ:文字列

    エンタイトルメント。entitlement_characteristics.value entitlement_characteristics.characteristicパラメーターで指定されたレコードに含まれるinput_typeパラメーターが選択されていない場合は必須です。
    特性の値。

    データタイプ:文字列

    エンタイトルメント。entitlement_name 必須。
    エンタイトルメントの名前。

    データタイプ:文字列

    エンタイトルメント。世帯 世帯プラグインがアクティブで、 consumer パラメーターが渡された場合にのみ渡されます。
    エンタイトルメントに関連付けられた世帯レコードのSys_id。

    データタイプ:文字列

    テーブル:世帯 [csm_household]

    エンタイトルメント。install_base_items_covered
    エンタイトルメントの対象となるインストールベースアイテムのリスト。このアレイの情報は、対象の販売済み製品 [sn_install_base_m2m_contract_sold_product] テーブルに挿入されます。

    データタイプ:オブジェクトのアレイ

    "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]
    エンタイトルメント。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]

    エンタイトルメント。product_specification エンタイトルメントに関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    エンタイトルメント。sold_entitlement エンタイトルメントに関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    エンタイトルメント。sold_products_covered エンタイトルメントの対象となる販売済み製品のリスト。

    データタイプ:オブジェクトのアレイ

    "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_m2m_contract_sold_product]

    エンタイトルメント。start_date 必須。
    エンタイトルメントの開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    エンタイトルメント。状態 必須。
    エンタイトルメントの現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    entitlement_characteristics サービス契約品目に関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics" [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement_usage": {Object},
        "type": "String",
        "value": "String"
      }
    ]

    保存場所:特性 [sn_pss_core_entitlement_characteristic]

    entitlement_characteristics。特性 必須。
    サービス契約品目に関連付けられた特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_prd_pm_characteristic]

    entitlement_characteristics。characteristic_option entitlement_characteristics.characteristicパラメーターで指定されたレコードに含まれるinput_typeパラメーターが選択に設定されている場合は必須です。
    サービス契約品目に関連付けられた特性オプションレコードのSys_id。

    データタイプ:文字列

    テーブル:特性オプション [sn_prd_pm_characteristic_option]

    entitlement_characteristics。entitlement_usage 関連付けられたサービス契約品目の特性の使用単位値。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "used_units": "String"
    }

    保存場所: エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    entitlement_characteristics。entitlement_usage。used_units 関連付けられたエンタイトルメント特性の使用法。

    データタイプ:文字列

    entitlement_characteristics。種類 サービス契約品目の特性のタイプ。
    有効な値:
    • 対象範囲の拡大
    • 補償_and_usage

    データタイプ:文字列

    entitlement_characteristics。価値 entitlement_characteristics.typeパラメーターが渡されない場合は必須です。
    特性の値。

    データタイプ:文字列

    install_base_items_covered sold_products_coveredパラメーターが渡されない場合は必須です。
    サービス契約品目の対象となるインストールベースアイテムのリスト。

    データタイプ:オブジェクトのアレイ

     "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]

    保管場所: 対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    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

    デフォルト:終了日なし

    名前 必須。
    サービス契約品目の名前。

    データタイプ:文字列

    parent_contract_line 現在のサービス契約品目が子であるサービス契約品目のSys_id。

    契約に基づいて作成された契約品目の場合は Null。

    データタイプ:文字列

    テーブル:サービス契約品目 [sn_pss_core_service_contract_line]

    product_model サービス契約品目に関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:製品モデル [cmdb_model]

    product_offering サービス契約品目に関連付けられた製品オファリングレコードのSys_id。

    データタイプ:文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]

    product_specification サービス契約品目に関連付けられた製品仕様レコードのSys_id。

    データタイプ:文字列

    表:製品仕様 [sn_prd_pm_product_specification]

    sold_product サービス契約品目に関連付けられた販売済み製品レコードのSys_id。

    データタイプ:文字列

    テーブル:販売済み製品 [sn_install_base_sold_product]

    sold_products_covered install_base_items_coveredパラメーターが渡されない場合は必須です。
    サービス契約品目の対象となる製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]

    データは、対象の販売済み製品 [sn_install_base_m2m_contract_sold_product] テーブルに保存されます。

    sold_products_covered。追加 関連する製品をカバーするために関連するサービス契約品目が開始される日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:現在の日付

    sold_products_covered。削除 関連付けられたサービス契約品目が関連製品の補償を終了する日付。

    データタイプ:文字列

    形式:yyyy-mm-dd

    デフォルト:終了日なし

    sold_products_covered。sold_product
    サービス契約品目に関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    開始 必須。
    サービス契約品目の開始日。

    データタイプ:文字列

    形式:yyyy-mm-dd

    state 必須。
    契約品目の現在のステータス。
    有効な値: (大文字と小文字を区別)
    • アクティブ
    • キャンセル
    • draft
    • 期限 切れ
    • 中断

    データタイプ:文字列

    ヘッダー

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

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

    デフォルト: application/json

    Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

    デフォルト: application/json

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

    ステータスコード

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

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

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

    名前 説明
    child_contract_lines サービス契約品目の下に作成された子サービス契約品目オブジェクトのリスト。

    データタイプ:オブジェクトのアレイ

    "child_contract_lines": [
      {
        "child_contract_lines": [Array],
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "number": "String",
        "sold_products_covered": [Array],
        "sys_id" "String"
      }
    ]
    child_contract_lines。child_contract_lines 子サービス契約品目の下に作成された子サービス契約品目オブジェクトのリスト。この配列のオブジェクトには、 child_contract_lines パラメーターと同じ要素があります。

    データタイプ:オブジェクトのアレイ

    child_contract_lines。エンタイトルメント 子サービス契約品目に関連付けられたエンタイトルメントのリスト。

    データタイプ:オブジェクトのアレイ

    "entitlements": [
      {
        "entitlement_name": "String",
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "sold_products_covered": [Array],
        "sys_id": "String"
      }
    ]
    child_contract_lines。エンタイトルメント。entitlement_name
    エンタイトルメントの名前。

    データタイプ:文字列

    child_contract_lines。エンタイトルメント。entitlement_characteristics エンタイトルメントの下に作成されたエンタイトルメント特性オブジェクトのリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines。エンタイトルメント。entitlement_characteristics。sys_id 子サービス契約品目に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    child_contract_lines。エンタイトルメント。install_base_items_covered エンタイトルメントの対象となるインストールベースアイテムのsys_idsのリスト。

    データタイプ:オブジェクトのアレイ

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines。エンタイトルメント。install_base_items_covered。sys_id エンタイトルメントの対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。エンタイトルメント。sold_products_covered エンタイトルメントの対象となるsys_ids製品のリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines。エンタイトルメント。sold_products_covered。sys_id エンタイトルメントに関連付けられた製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。エンタイトルメント。sys_id 子サービス契約品目に関連付けられたエンタイトルメントレコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメント [service_entitlement]

    child_contract_lines。entitlement_characteristics チリの契約品目に関連付けられた特性のリスト。

    データタイプ:オブジェクトのアレイ

    "entitlement_characteristics": [
      {
        "entitlement_usage": {Object},
        "sys_id": "String"
      }
    ]
    child_contract_lines。entitlement_characteristics。entitlement_usage entitlement_characteristicの下に挿入されたエンタイトルメント使用オブジェクト。

    データタイプ: オブジェクト

    "entitlement_usage": {
        "sys_id": "String"
    }
    child_contract_lines。entitlement_characteristics。entitlement_usage。sys_id エンタイトルメント使用状況レコードのSys_id。

    データタイプ:文字列

    テーブル:エンタイトルメントの使用状況 [sn_pss_core_entitlement_usage]

    child_contract_lines。entitlement_characteristics。sys_id 子サービス契約品目に関連付けられたエンタイトルメント特性レコードのSys_id。

    データタイプ:文字列

    テーブル:特性 [sn_pss_core_entitlement_characteristic]

    child_contract_lines。install_base_items_covered 子サービス契約品目の対象となるインストールベースアイテムのsys_idsのリスト。

    データタイプ:オブジェクトのアレイ

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines。install_base_items_covered。sys_id 対象となるインストールベースアイテムのSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。名前 子サービス契約品目の名前。

    データタイプ:文字列

    child_contract_lines。数 サービス契約品目の一意の番号。エンドポイントによって自動的に生成されます。例:CTRL9812347。

    データタイプ:文字列

    child_contract_lines。sold_products_covered 子サービス契約品目の対象となる製品のsys_idsのリスト。

    データタイプ:オブジェクトのアレイ

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines。sold_products_covered。sys_id 子サービス契約品目の対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    child_contract_lines。sys_id 子契約アイテムの対象となる製品のSys_id。

    データタイプ:文字列

    テーブル:対象の販売済み製品 [sn_install_base_m2m_contract_sold_product]

    エンタイトルメント サービス契約品目に関連付けられたエンタイトルメントのリスト。

    データタイプ:オブジェクトのアレイ

    "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]

    名前
    サービス契約品目の名前。

    データタイプ:文字列

    番号 サービス契約品目の一意の番号。エンドポイントによって自動的に生成されます。例:CTRL9812347。

    データタイプ:文字列

    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",
      "parent_contract_line": null,
      "name": "CLI",
      "starts": "2022-12-03",
      "child_contract_lines": [
        {
          "state": "active",
          "name": "Child CLI",
          "starts": "2022-12-03",
          "entitlements": [
            {
              "state": "active",
              "entitlement_name": "Child CLI - ENTL",
              "start_date": "2022-12-03"
            }
          ],
          "sold_products_covered": [
            {
              "sold_product": "8db4258949f14ef7b90d90822dfc5800",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "install_base_items_covered": [
            {
              "install_base": "2f270832699b46e78aa899a5a5dc6682",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "entitlement_characteristics": [
            {
              "characteristic": "63418db7539e61106bfcddeeff7b1238",
              "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
              "value": "20",
              "type": "coverage"
            }
          ]
        }
      ],
      "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"
              }
            }
          ]
        }
      ],
      "sold_products_covered": [
        {
          "sold_product": "0df21151d1f53110f8776589fa411f1b",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "tyfy6h",
          "type": "coverage"
        }
      ]
    }

    応答:

    {
      "result": {
        "sys_id": "16e451d1d1f53110f8776589fa411f80",
        "name": "CLI",
        "number": "CTRL00000001",
        "child_contract_lines": [
          {
            "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
            "name": "Child CLI",
            "number": "CTRL00000001",
            "child_contract_lines": [],
            "entitlements": [
              {
                "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
                "entitlement_name": "Child CLI - ENTL",
                "sold_products_covered": [],
                "install_base_items_covered": [],
                "entitlement_characteristics": []
              }
            ],
            "sold_products_covered": [
              {
                "sys_id": "dfb62e9c4c6843009be02a68f65b9118"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "2583912e81964501b52a2e44d4797a28"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "3a00c975bb49412cae169200c7f6236e",
                "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"
                }
              }
            ]
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "5ae451d1d1f53110f8776589fa411f81"
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "dae451d1d1f53110f8776589fa411f82",
            "entitlement_usage": {}
          }
        ]
      }
    }