インストールベースアイテム API

リリースバージョン: Yokohama

更新日 2025年01月30日

所要時間：284分

インストールベースアイテム API は、ServiceNowインスタンス内のインストールベースアイテムレコードにアクセスして管理するためのエンドポイントを提供します。

インストールベースアイテムは、顧客用に構成された製品のインスタンスを表します。インストールベースアイテムを使用すると、顧客が行ったすべての購入を追跡できます。

この API を使用して、[インストールベース関連パーティ] 関連リストで CRUD 操作を実行することもできます。さらに、ケース、契約、エンタイトルメント、メンテナンス計画、販売済み製品、作業指示書など、他のインストールベースアイテム関連リストのレコードを読み取ることができます。

この API にアクセスするには、実行しようとしている CRUD アクションのタイプに応じて、sn_install_base.ib_api_write または sn_install_base.ib_api_read ロールのいずれかが必要です。

この API のさまざまなエンドポイントにアクセスするには、次のプラグインをインストールする必要があります。

Customer Service インストールベース管理 (com.snc.install_base)
メンテナンス計画と作業指示データを取得する場合の作業計画管理 (sn_fsm_planned_wm)。

この API は sn_install_base 名前空間で実行されます。

注:

この API は、エンドポイント応答で空でないフィールドのみを返します。また、システムレベルのフィールド (先頭に「sys_」が付いているもの) は、sys_id フィールドを除いて返されません。

インストールベースアイテムの詳細については、「 Create an install base item」を参照してください。

インストールベースアイテム:削除 /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

指定されたインストールベースアイテムレコードから、指定された関係者レコードの関連付けを解除します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

注:

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

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

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

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

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

ヘッダー

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

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

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

ステータスコード

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

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

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


[Name (名前)]	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
結果	エンドポイント結果の説明。データタイプ: オブジェクト
result.status	エンドポイント要求のステータス。可能な値： SUCCESS FAILURE データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/relatedparties/2a42dfae872521100b6afc86dabb356b" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "status": "SUCCESS"
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitems

すべてのインストールベースアイテムを返します。呼び出し内でパラメーターを渡して、返される結果をフィルター処理できます。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems

デフォルト URL: /api/sn_install_base/integrations/installbaseitems

注:

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

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

表 : 8. クエリパラメーター
名前	説明
フィールドの名前と値のペア	インストールベースアイテムレコードをフィルタリングするために使用するフィールドと値のペア。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。たとえば、ステータスフィールドが「in_use」に設定され、ステータスフィールドが「replacement」に設定されているレコードのみを返すには、 `&state=in_use&status=replacement` を渡します。データタイプ：文字列デフォルト：すべてのフィールドテーブル:インストールベースアイテム [sn_istall_base_item]
related_party	関係者レコードのSys_id。指定された関係者に基づいてインストールベースアイテムレコードをフィルタリングします。関係者は、インストールベースアイテムまたは販売済み製品にリンクできます。有効な値：アカウントsys_id:アカウント [customer_account] テーブルにあります。コンシューマー sys_id:コンシューマー [csm_consumer] テーブルにあります。連絡先 sys_id:連絡先 [customer-contact] テーブルにあります。サービス組織sys_id:サービス組織 [sn_customer_service_organization] テーブルにあります。ユーザー sys_id:ユーザー [sys-user] テーブルにあります。データタイプ：文字列テーブル:インストールベース関連パーティ [sn_install_base_related_party]
責任	関連付けられた責任レコードのSys_id。このレコードは、インストールベース情報のアクセスレベルを定義します。このパラメーターは、[ related_party ] フィールドも指定されている場合にのみ有効です。指定した場合、 related_party パラメーターと responsibility パラメーターの両方に一致するインストールベースアイテムのみを返します。詳細については、「Configure related parties for items received」を参照してください。データタイプ：文字列
sys_class_name	目的のレコードがインストールベースアイテム [sn_install_base_item] テーブルを拡張するテーブル内にある場合、クエリを実行する拡張テーブルの名前。データタイプ：文字列
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。データタイプ：数値デフォルト値：20 最大：100
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0

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

ヘッダー

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

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

ステータスコード

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

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

次の戻り値は、インストールベースアイテム [sn_install_base_items] テーブルから返されたレコードの戻り値のみを示しています。


名前	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
has_more	返すレコードが他にもテーブルにあるかどうかを示すフラグ。可能な値： true:返されるレコードが増えます。 false:返すレコードがこれ以上ありません。データタイプ:ブーリアン文字列
アイテム	指定されたフィルター結果に一致したインストールベースアイテムのリスト。データタイプ：オブジェクトのアレイ "items":[ { "account": {Object}, "active": "String", "asset": {Object}, "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": {Object}, "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "service_context": {Object}, "service_organization" {Object}, "sys_class_name": "String", "sys_id": "String", "sys_mod_count": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" } ]
items.account	インストールベースアイテムレコードに関連付けられた顧客アカウントの詳細。データタイプ: オブジェクト `"account": { "display_value": "String", "sys_id": "String" }`
items.account.display_value	インストールベースアイテムレコードに関連付けられた顧客アカウントのテキスト名。この値を使用して、UI に顧客アカウント名を表示します。データタイプ：文字列
items.account.sys_id	インストールベースアイテムレコードに関連付けられた顧客アカウントレコードのSys_id。データタイプ：文字列
items.active	インストールベースアイテムがアクティブかどうかを示すフラグ。可能な値： true:インストールベースアイテムはアクティブです。 false:インストールベースアイテムは非アクティブです。データタイプ:ブーリアン文字列
items.asset	インストールベースアイテムレコードに関連付けられた資産の詳細。データタイプ: オブジェクト `"asset": { "display_value": "String", "sys_id": "String" }`
items.asset.display_value	インストールベースアイテムレコードに関連付けられた資産のテキスト名。この値を使用して、UI に資産名を表示します。データタイプ：文字列
items.asset.sys_id	インストールベースアイテムレコードに関連付けられた資産レコードのSys_id。データタイプ：文字列
items.configuration_item	インストールベースアイテムレコードに関連付けられた構成アイテムの詳細。データタイプ: オブジェクト `"configuration_item": { "display_value": "String", "sys_id": "String" }`
items.configuration_item.display_value	インストールベースアイテムレコードに関連付けられた構成アイテムのテキスト名。この値を使用して、UI に構成アイテム名を表示します。データタイプ：文字列
items.configuration_item.sys_id	インストールベースアイテムレコードに関連付けられた構成アイテムレコードのSys_id。データタイプ：文字列
items.consumer	インストールベースアイテムレコードに関連付けられたコンシューマーの詳細。注: コンシューマーフィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer": { "display_value": "String", "sys_id": "String" }`
items.consumer.display_value	インストールベースアイテムレコードに関連付けられたコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。データタイプ：文字列
items.consumer.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列
items.consumer_profile	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルの詳細。注: [コンシューマープロファイル] フィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer_profile": { "display_value": "String", "sys_id": "String" }`
items.consumer_profile.display_value	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルのテキスト名。この値を使用して、UI にコンシューマープロファイル名を表示します。データタイプ：文字列
items.consumer_profile.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルレコードのSys_id。データタイプ：文字列
items.contact	インストールベースアイテムレコードを担当するアカウント連絡先の詳細。データタイプ: オブジェクト `"contact": { "display_value": "String", "sys_id": "String" }`
items.contact.display_value	インストールベースアイテムレコードに関連付けられたアカウント連絡先のテキスト名。この値を使用して、アカウントの連絡先名を UI に表示します。データタイプ：文字列
items.contact.sys_id	インストールベースアイテムレコードに関連付けられたアカウント連絡先レコードのSys_id。データタイプ：文字列
items.health_status	インストールベースアイテムの現在の健全性ステータスに関する詳細。プロアクティブカスタマーサービスオペレーション (com.snc.proactive_cs_itom) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"health_status": { "display_value": "String", "value": "String" }`
items.health_status.display_value	インストールベースアイテムの現在の健全性ステータスを示すテキスト文字列。この値を使用して、UI に健康状態を表示します。データタイプ：文字列
items.health_status.value	インストールベースアイテムの健全性ステータスの内部値。データタイプ：文字列
items.health_status_last_updated	インストールベースアイテムの健全性ステータスが最後に更新された日時。データタイプ：文字列
items.household	インストールベースアイテムレコードに関連付けられた世帯の詳細。カスタマーサービス世帯 (com.snc.household) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"household": { "display_value": "String", "sys_id": "String" }`
items.household.display_value	インストールベースアイテムレコードに関連付けられた世帯のテキスト名。この値を使用して、UI に世帯名を表示します。データタイプ：文字列
items.household.sys_id	インストールベースアイテムレコードに関連付けられた世帯のSys_id。データタイプ：文字列
items.install_date	インストールベースアイテムがアクティブになった日付に関する詳細。データタイプ: オブジェクト `"install_date": { "display_value": "String", "value": "String" }`
items.install_date.display_value	テキストインストール日。この値を使用して、インストール日を UI に表示します。データタイプ：文字列
items.install_date.value	インストール日の内部値。データタイプ：文字列
items.location	インストールベースアイテムの場所に関する詳細。データタイプ: オブジェクト `"location": { "display_value": "String", "sys_id": "String" }`
items.location.display_value	インストールベースアイテムの場所のテキスト名。この値を使用して、場所の名前を UI に表示します。データタイプ：文字列
items.location.sys_id	インストールベースアイテムレコードに関連付けられた場所レコードのSys_id。データタイプ：文字列
items.name	インストールベースアイテムの名前。データタイプ：文字列
items.number	インストールベースアイテムの一意の ID。データタイプ：文字列
items.parent	インストールベースアイテムレコードの親レコードに関する詳細。データタイプ: オブジェクト `"parent": { "display_value": "String", "sys_id": "String" }`
items.parent.display_value	インストールベースアイテムレコードに関連付けられた親レコードのテキスト名。この値を使用して、UI に親名を表示します。データタイプ：文字列
items.parent.sys_id	インストールベースアイテムレコードに関連付けられた親レコードのSys_id。データタイプ：文字列
items.product	インストールベースアイテムレコードに関連付けられた製品モデルの詳細。この情報を使用して、製品モデルに関連付けられたサービスを識別します。データタイプ: オブジェクト `"product": { "display_value": "String", "sys_id": "String" }`
items.product.display_value	インストールベースアイテムレコードに関連付けられた製品モデルのテキスト名。この値を使用して、UI に製品名を表示します。データタイプ：文字列
items.product.sys_id	インストールベースアイテムレコードに関連付けられた製品モデルレコードのSys_id。データタイプ：文字列
items.service_context	インストールベースアイテムレコードに関連付けられたサービスコンテキストの詳細。データタイプ: オブジェクト `"service_context": { "display_value": "String", "sys_id": "String" }`
items.service_context.display_value	インストールベースアイテムレコードに関連付けられたサービスコンテキストのテキスト名。この値を使用して、UI にサービスコンテキスト名を表示します。データタイプ：文字列
items.service_context.sys_id	インストールベースアイテムレコードに関連付けられたサービスコンテキストレコードのSys_id。データタイプ：文字列
items.service_organization	インストールベースアイテムレコードに関連付けられたサービス組織に関する詳細。Service Organization (com.snc.service_organization) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"service_organization": { "display_value": "String", "sys_id": "String" }`
items.service_organization.display_value	インストールベースアイテムレコードに関連付けられたサービス組織のテキスト名。この値を使用して、サービス組織名を UI に表示します。データタイプ：文字列
items.service_organization.sys_id	インストールベースアイテムレコードに関連付けられたサービス組織レコードのSys_id。データタイプ：文字列
items.sys_class_name	インストールベースアイテムレコードを含むテーブル。データタイプ：文字列
items.sys_id	インストールベースアイテムレコードのSys_id。sys_class_name パラメーターで指定されたテーブルにあります。データタイプ：文字列
items.sys_mod_count	関連付けられたインストールベースアイテムレコードが変更された回数。データタイプ：文字列
items.state	インストールベースアイテムの現在のステータスに関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
items.state.display_value	インストールベースアイテムの現在のステータスを示すテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
items.state.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
items.status	インストールベースアイテムのステータスに関する詳細。データタイプ: オブジェクト `"status": { "display_value": "String", "value": "String" }`
items.status.display_value	インストールベースアイテムのステータスのテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
items.status.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
items.uninstall_date	インストールベースアイテムが非アクティブになった日付に関する詳細。データタイプ: オブジェクト `"uninstall_date": { "display_value": "String", "value": "String" }`
items.uninstall_date.display_value	テキストのアンインストール日。この値を使用して、アンインストール日を UI に表示します。データタイプ：文字列
items.uninstall_date.value	アンインストール日の内部値。データタイプ：文字列
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_depth	階層内の、返される子インストールベースアイテムの深さのレベル数。データタイプ：整数
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列

cURL 要求

次のコード例は、オフセット 5 から始まる 1 つのレコードのみを返す単純な呼び出しを示しています。

curl "https://instance.servicenow.com/api/sn_install_base/v1/integrations/installbaseitems?sysparm_limit=1&sysparm_offset=5" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": "5",
    "sysparm_limit": 1,
    "has_more": true,
    "items": [
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001100",
        "sys_id": "181df7ff530a1110539dddeeff7b12f4",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "sys_mod_count": "2",
        "active": "true",
        "configuration_item": {
          "sys_id": "62446ae8535e5510539dddeeff7b12db",
          "display_value": "boxeoproderp"
        },
        "name": "boxeoproderp",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

cURL 要求

インストールベースアイテムテーブル内の state = "in_use" および status = "replacement" フィールドを検索する方法を示すコード例を次に示します。

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?state=in_use&status=replacement" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": false,
    "items": [
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001140",
        "sys_id": "a1a123745312d910539dddeeff7b127b",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "2dd1e7b753421110539dddeeff7b12d1",
          "display_value": "Stand"
        },
        "active": "true",
        "name": "Stand",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      },
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001139",
        "sys_id": "d0916bb05312d910539dddeeff7b1232",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "dfc127b753421110539dddeeff7b12ac",
          "display_value": "Register"
        },
        "active": "true",
        "name": "Register",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      },
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001141",
        "sys_id": "ffb123745312d910539dddeeff7b12cb",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "59e1e7b753421110539dddeeff7b12cc",
          "display_value": "Terminal"
        },
        "active": "true",
        "name": "Terminal",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

cURL 要求

次のコード例は、 related_party および responsibility クエリパラメーターを使用して返される結果をフィルター処理する方法を示しています。

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?related_party=dc0185d94f341200025ba3618110c77c&responsibility=c009bbedb3730010700b4d43c6a8dce" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": false,
    "items": [
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001004",
        "sys_id": "3ea014a778de1110f877d304c76fdd0d",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "consumer": {
          "sys_id": "feb5139ab3401010700b4d43c6a8dc43",
          "display_value": "Kenny Smith"
        },
        "product": {
          "sys_id": "63c8bc9778921110f877d304c76fdd34",
          "display_value": "X4 Sport Utility 4D"
        },
        "active": "true",
        "name": "X4 Sport Utility 4D",
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001003",
        "sys_id": "6e94e3c853500010df5dddeeff7b1234",
        "contact": {
          "sys_id": "4d147a386f0331003b3c498f5d3ee437",
          "display_value": "Julie Lewis"
        },
        "active": "true",
        "configuration_item": {
          "sys_id": "a96a570453500010df5dddeeff7b1206",
          "display_value": "boxeosandbox"
        },
        "name": "Boxeo - Sandbox",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001010",
        "sys_id": "83332fde87e5a1105d0055373cbb3567",
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2023-02-26 18:59:52",
          "display_value": "2023-02-26 10:59:52"
        },
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "product": {
          "sys_id": "a9a2d0c3c6112276010db16c5ddd3461",
          "display_value": "Lenovo ThinkStation S20"
        },
        "active": "true",
        "configuration_item": {
          "sys_id": "affd3c8437201000deeabfc8bcbe5dc3",
          "display_value": "*BETH-IBM"
        },
        "name": "IB B2B",
        "location": {
          "sys_id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "display_value": "100 South Charles Street, Baltimore,MD"
        },
        "asset": {
          "sys_id": "bfc1fa8837f3100044e0bfc8bcbe5ddf",
          "display_value": "P1000228 - Lenovo ThinkStation S20"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        },
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001011",
        "sys_id": "9d766f168729a1105d0055373cbb3597",
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "product": {
          "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
          "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
        },
        "active": "true",
        "name": "IBA",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001013",
        "sys_id": "bd955a2687ada1100b6afc86dabb35fb",
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "consumer": {
          "sys_id": "59e788fbdb1b1200b6075200cf9619d2",
          "display_value": "Gilly Parker"
        },
        "product": {
          "sys_id": "1a13974053500010df5dddeeff7b122c",
          "display_value": "12000XHD Digital Press"
        },
        "active": "true",
        "name": "IBConsumer"
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0000901",
        "sys_id": "f77c7542b7343300ece839a6ee11a991",
        "product": {
          "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
          "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
        },
        "active": "true",
        "name": "KX Series - KX5001",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitem/{id}

指定されたインストールベースアイテムレコードとその子階層を返します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitem/{id}

デフォルト URL: /api/sn_install_base/integrations/installbaseitem/{id}

注:

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

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

表 : 14. クエリパラメーター
名前	説明
sys_class_name	目的のレコードがインストールベースアイテム [sn_install_base_item] テーブルを拡張するテーブル内にある場合、クエリーする拡張テーブルの名前。このテーブルは、sn_install_base_itemテーブルを拡張する必要があります。データタイプ：文字列
sysparm_depth	返される子インストールベースアイテムの階層の最大深度。データタイプ：整数デフォルト値：7 最大:10
sysparm_limit	各子階層で返す最大レコード数。データタイプ：整数デフォルト値：10 最大：100

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

ヘッダー

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

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

ステータスコード

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

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


名前	説明
childInstallBase	指定したインストールベースアイテムに関連付けられた子インストールベースアイテムレコードのリスト。データタイプ: オブジェクト `"childinstallbase": { "items": [Array], "sysparm_depth": Integer }`
childInstallbase.items	指定されたインストールベースアイテムに関連付けられた子インストールベースアイテム。この配列内の値は、このセクションのさらに下の items[] 配列の下で定義されます。
childinstallbase.sysparm_depth	インストールベースアイテムの子レベル。データタイプ：整数
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
has_children	要求されたインストールベースアイテムレコードに子インストールベースアイテムレコードがあるかどうかを示すフラグ。 true:子インストールベースアイテムレコードがあります。 false:子インストールベースアイテムレコードがありません。データタイプ：ブーリアン
item	指定されたフィルター結果に一致したインストールベースアイテム。データタイプ: オブジェクト "item": { "account": {Object}, "active": "String", "asset": {Object}, "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": "Object", "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "service_context": {Object}, "service_organization" {Object}, "sys_class_name": "String", "sys_id": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" }
item.account	インストールベースアイテムレコードに関連付けられた顧客アカウントの詳細。データタイプ: オブジェクト `"account": { "display_value": "String", "sys_id": "String" }`
item.account.display_value	インストールベースアイテムレコードに関連付けられた顧客アカウントのテキスト名。この値を使用して、UI に顧客アカウント名を表示します。データタイプ：文字列
item.account.sys_id	インストールベースアイテムレコードに関連付けられた顧客アカウントレコードのSys_id。データタイプ：文字列
item.active	インストールベースアイテムがアクティブかどうかを示すフラグ。可能な値： true:インストールベースアイテムはアクティブです。 false:インストールベースアイテムは非アクティブです。データタイプ:ブーリアン文字列
item.asset	インストールベースアイテムレコードに関連付けられた資産の詳細。データタイプ: オブジェクト `"asset": { "display_value": "String", "sys_id": "String" }`
item.asset.display_value	インストールベースアイテムレコードに関連付けられた資産のテキスト名。この値を使用して、UI に資産名を表示します。データタイプ：文字列
item.asset.sys_id	インストールベースアイテムレコードに関連付けられた資産レコードのSys_id。データタイプ：文字列
item.configuration_item	インストールベースアイテムレコードに関連付けられた構成アイテムの詳細。データタイプ: オブジェクト `"configuration_item": { "display_value": "String", "sys_id": "String" }`
item.configuration_item.display_value	インストールベースアイテムレコードに関連付けられた構成アイテムのテキスト名。この値を使用して、UI に構成アイテム名を表示します。データタイプ：文字列
item.configuration_item.sys_id	インストールベースアイテムレコードに関連付けられた構成アイテムレコードのSys_id。データタイプ：文字列
item.consumer	インストールベースアイテムレコードに関連付けられたコンシューマーの詳細。注: コンシューマーフィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer": { "display_value": "String", "sys_id": "String" }`
item.consumer.display_value	インストールベースアイテムレコードに関連付けられたコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。データタイプ：文字列
item.consumer.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列
item.consumer_profile	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルの詳細。注: [コンシューマープロファイル] フィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer_profile": { "display_value": "String", "sys_id": "String" }`
item.consumer_profile.display_value	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルのテキスト名。この値を使用して、UI にコンシューマープロファイル名を表示します。データタイプ：文字列
item.consumer_profile.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルレコードのSys_id。データタイプ：文字列
item.contact	インストールベースアイテムレコードを担当するアカウント連絡先の詳細。データタイプ: オブジェクト `"contact": { "display_value": "String", "sys_id": "String" }`
item.contact.display_value	インストールベースアイテムレコードに関連付けられたアカウント連絡先のテキスト名。この値を使用して、アカウントの連絡先名を UI に表示します。データタイプ：文字列
item.contact.sys_id	インストールベースアイテムレコードに関連付けられたアカウント連絡先レコードのSys_id。データタイプ：文字列
item.health_status	インストールベースアイテムの現在の健全性ステータスに関する詳細。プロアクティブカスタマーサービスオペレーション (com.snc.proactive_cs_itom) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"health_status": { "display_value": "String", "value": "String" }`
item.health_status.display_value	インストールベースアイテムの現在の健全性ステータスを示すテキスト文字列。この値を使用して、UI に健康状態を表示します。データタイプ：文字列
item.health_status.value	インストールベースアイテムの健全性ステータスの内部値。データタイプ：文字列
item.health_status_last_updated	インストールベースアイテムの健全性ステータスが最後に更新された日時。データタイプ：文字列
item.household	インストールベースアイテムレコードに関連付けられた世帯の詳細。カスタマーサービス世帯 (com.snc.household) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"household": { "display_value": "String", "sys_id": "String" }`
item.household.display_value	インストールベースアイテムレコードに関連付けられた世帯のテキスト名。この値を使用して、UI に世帯名を表示します。データタイプ：文字列
item.household.sys_id	インストールベースアイテムレコードに関連付けられた世帯のSys_id。データタイプ：文字列
item.install_date	インストールベースアイテムがアクティブになった日付に関する詳細。データタイプ: オブジェクト `"install_date": { "display_value": "String", "value": "String" }`
item.install_date.display_value	テキストインストール日。この値を使用して、インストール日を UI に表示します。データタイプ：文字列
item.install_date.value	インストール日の内部値。データタイプ：文字列
item.location	インストールベースアイテムの場所に関する詳細。データタイプ: オブジェクト `"location": { "display_value": "String", "sys_id": "String" }`
item.location.display_value	インストールベースアイテムの場所のテキスト名。この値を使用して、場所の名前を UI に表示します。データタイプ：文字列
item.location.sys_id	インストールベースアイテムレコードに関連付けられた場所レコードのSys_id。データタイプ：文字列
item.name	インストールベースアイテムの名前。データタイプ：文字列
item.number	インストールベースアイテムの一意の ID。データタイプ：文字列
item.parent	インストールベースアイテムレコードの親レコードに関する詳細。データタイプ: オブジェクト `"parent": { "display_value": "String", "sys_id": "String" }`
item.parent.display_value	インストールベースアイテムレコードに関連付けられた親レコードのテキスト名。この値を使用して、UI に親名を表示します。データタイプ：文字列
item.parent.sys_id	インストールベースアイテムレコードに関連付けられた親レコードのSys_id。データタイプ：文字列
item.product	インストールベースアイテムレコードに関連付けられた製品モデルの詳細。この情報を使用して、製品モデルに関連付けられたサービスを識別します。データタイプ: オブジェクト `"product": { "display_value": "String", "sys_id": "String" }`
item.product.display_value	インストールベースアイテムレコードに関連付けられた製品モデルのテキスト名。この値を使用して、UI に製品名を表示します。データタイプ：文字列
item.product.sys_id	インストールベースアイテムレコードに関連付けられた製品モデルレコードのSys_id。データタイプ：文字列
item.service_context	インストールベースアイテムレコードに関連付けられたサービスコンテキストの詳細。データタイプ: オブジェクト `"service_context": { "display_value": "String", "sys_id": "String" }`
item.service_context.display_value	インストールベースアイテムレコードに関連付けられたサービスコンテキストの詳細。データタイプ: オブジェクト `"service_context": { "display_value": "String", "sys_id": "String" }`
item.service_context.sys_id	インストールベースアイテムレコードに関連付けられたサービスコンテキストレコードのSys_id。データタイプ：文字列
item.service_organization	インストールベースアイテムレコードに関連付けられたサービス組織に関する詳細。Service Organization (com.snc.service_organization) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"service_organization": { "display_value": "String", "sys_id": "String" }`
item.service_organization.display_value	インストールベースアイテムレコードに関連付けられたサービス組織のテキスト名。この値を使用して、サービス組織名を UI に表示します。データタイプ：文字列
item.service_organization.sys_id	インストールベースアイテムレコードに関連付けられたサービス組織レコードのSys_id。データタイプ：文字列
item.sys_クラス_名	インストールベースアイテムレコードを含むテーブル。データタイプ：文字列
item.sys_id	インストールベースアイテムレコードのSys_id。sys_class_name パラメーターで指定されたテーブルにあります。データタイプ：文字列
item.sys_mod_count	関連付けられたインストールベースアイテムレコードが変更された回数。データタイプ：文字列
item.state	インストールベースアイテムの現在のステータスに関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
item.state.display_value	インストールベースアイテムの現在のステータスを示すテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
item.state.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
item.status	インストールベースアイテムのステータスに関する詳細。データタイプ: オブジェクト `"status": { "display_value": "String", "value": "String" }`
item.status.display_value	インストールベースアイテムのステータスのテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
item.status.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
item.uninstall_date	インストールベースアイテムが非アクティブになった日付に関する詳細。データタイプ: オブジェクト `"uninstall_date": { "display_value": "String", "value": "String" }`
item.uninstall_date.display_value	テキストのアンインストール日。この値を使用して、アンインストール日を UI に表示します。データタイプ：文字列
item.uninstall_date.value	アンインストール日の内部値。データタイプ：文字列
ステータス	エンドポイントコールのステータス。データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを呼び出す方法を示しています。関連付けられたインストールベースアイテムに子がありません。

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitem/f77c7542b7343300ece839a6ee11a991" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0000901",
      "sys_id": "f77c7542b7343300ece839a6ee11a991",
      "product": {
        "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
        "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
      },
      "active": "true",
      "name": "KX Series - KX5001",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    },
    "hasChildren": "false"
  }
}

cURL 要求

次のコード例は、最大深度 4 つの子レベルを指定して、このエンドポイントを呼び出す方法を示しています。

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/e0a80e4b87b521100b6afc86dabb3565?depth=4" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0001073",
      "sys_id": "e0a80e4b87b521100b6afc86dabb3565",
      "health_status": {
        "value": "not_available",
        "display_value": "Not Available"
      },
      "active": "true",
      "name": "parent",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    },
    "hasChildren": "true",
    "childinstallbase": {
      "sysparm_depth": 2,
      "items": [
        {
          "parent": {
            "sys_id": "e0a80e4b87b521100b6afc86dabb3565",
            "display_value": "parent"
          },
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001074",
          "sys_id": "6db80e4b87b521100b6afc86dabb356b",
          "state": {
            "value": "in_use",
            "display_value": "In Use"
          },
          "health_status": {
            "value": "not_available",
            "display_value": "Not Available"
          },
          "active": "true",
          "name": "child1",
          "account": {
            "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
            "display_value": "Boxeo"
          },
          "hasChildren": "true",
          "items": {
            "sysparm_depth": 3,
            "items": [
              {
                "parent": {
                  "sys_id": "6db80e4b87b521100b6afc86dabb356b",
                  "display_value": "child1"
                },
                "sys_class_name": "sn_install_base_item",
                "number": "IBITM0001075",
                "sys_id": "36ecce4b87b521100b6afc86dabb3503",
                "health_status": {
                  "value": "not_available",
                  "display_value": "Not Available"
                },
                "active": "true",
                "name": "childL2",
                "account": {
                  "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
                  "display_value": "Boxeo"
                },
                "hasChildren": "false"
              }
            ]
          }
        }
      ]
    }
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitems/{id}/cases

指定されたインストールベースアイテムレコードに関連付けられたケースを返します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/cases

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/cases

注:

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

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

表 : 20. クエリパラメーター
名前	説明
フィールドの名前と値のペア	ケースレコードのフィルタリングに使用するフィールドと値のペア。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。たとえば、承認フィールドが「却下」に設定され、カテゴリフィールドが「2」に設定されているレコードのみを返すには、 `&approval=rejected&category=2` を渡します。データタイプ：文字列テーブル:ケース [sn_customerservice_case] デフォルト：すべてのフィールド
sys_class_name	(sn_customerservice_caseではない) 拡張ケーステーブルを使用している場合、クエリーする拡張テーブルの名前。データタイプ：文字列デフォルト:sn_customerservice_case
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。データタイプ：数値デフォルト値：20 最大：100
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0

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

ヘッダー

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

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

ステータスコード

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

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


要素	説明
ケース	指定されたインストールベースアイテムレコードに関連付けられたケースのリスト。データタイプ：オブジェクトのアレイ "cases": [ { "account": "String", "active": Boolean, "active_account_escalation": "String", "active_escalation": "String", "activity_due": "String", "additional_assignee_list": "String", "approval": "String", "approval_history": "String", "approval_set": "String", "asset": "String", "assigned_on": "String", "assigned_to": "String", "assignment_group": "String", "auto_close": Boolean, "business_duration": "String", "business_impact": "String", "business_service": "String", "calendar_duration": "String", "case": "String", "case_report": "String", "category": Number, "cause": "String", "caused_by": "String", "change": "String", "child_case_creation_progress": Boolean, "closed_at": "String", "closed_by": "String", "close_notes: "String", "cmdb_ci": "String", "comments": "String", "comments_and_work_notes": "String", "company": "String", "consumer": "String", "contact": "String", "contact_local_time: "String", "contact_time_zone": "String", "contact_type": "String", "contract": "String", "contributor_groups": "String", "contributor_users": "String", "correlation_display": "String", "correlation_id": "String", "delivery_plan": "String", "delivery_task": "String", "description": "string", "due_date": "String", "entitlement": "String", "escalation": Number, "expected_start": "String", "first_response_time": "String", "follow_the_sun": Boolean, "follow_up": "String", "group_list": [Array], "impact": Number, "internal_user": "String", "initiated_as_request": Boolean, "knowledge": Boolean, "location": "String", "made_sla": Boolean, "major_case_state": "String", "needs_attention": Boolean, "notes_to_comments": Boolean, "notify": Number, "number": "String", "opened_at": "String", "opened_by": "String", "order": Number, "parent": "String", "partner": "String", "partner_contact": "String", "priority": Number, "proactive": Boolean, "probable_cause": "String", "problem": "String", "product": "String", "reassignment_count": Number, "recipient_list": "String", "rejection_goto": "String", "resolution_code": "String", "resolved_at": "String", "resolved_by": "String", "route_reason": "String", "service_offering": "String", "short_description": "String", "skills": "String", "sla_due": "String", "sn_app_cs_social_social_profile": "String", "sold_product": "String", "stage": "String", "state": Number, "subcategory": Number, "support_manager" "String", "sync_driver": Boolean, "sys_class_name": "String", "sys_domain": "String", "sys_domain_path": "String", "sys_id": "String", "task_effective_number": "String", "time_worked": "String", "universal_request": "String", "upon_approval": "String", "upon_reject": "String", "urgency": Number, "user_input": "String", "variables": "String", "watch_list": [Array], "wf_activity": "String", "work_end": "String", "work_notes": "String", "work_notes_list": [Array], "work_start": "String"
cases.account	ケースに関連付けられたアカウントレコードの sys_id。データタイプ：文字列テーブル:アカウント [customer_account]
cases.active	ケースがオープンかアクティブかを示すフラグ。可能な値： true：ケースはアクティブです。 false：ケースはクローズされました。データタイプ：ブールデフォルト：true
cases.active_account_escalation	ケースに関連付けられたアクティブなアカウントエスカレーションの sys_id。データタイプ：文字列テーブル:エスカレーション [sn_customerservice_escalation]
cases.active_escalation	ケースに関連付けられたアクティブなエスカレーションレコードのSys_id。データタイプ：文字列テーブル:エスカレーション [sn_customerservice_escalation]
cases.activity_due	関連付けられたケースの完了予定日。データタイプ：文字列
cases.additional_assignee_list	アカウントにアサインされた追加のユーザー (プライマリアサイニーを除く) のsys_idsのリスト。データタイプ：アレイ最大：4,000 テーブル:ユーザー [sys_user]
cases.approval	必要な承認のタイプを説明する文字列。可能な値： approved cancelled duplicate not_required not requested rejected requested データタイプ：文字列最大文字数：40 デフォルト：not requested
cases.approval_history	ケースに関連付けられているすべての承認のリスト。データタイプ：文字列最大文字数：4,000
cases.approval_set	関連するアクションが承認された日時。データタイプ：文字列
cases.asset	ケースに関連付けられた資産レコードの sys_id。データタイプ：文字列テーブル:資産 [alm_asset]
cases.assigned_on	assigned_to パラメーターで識別されたユーザーにケースがアサインされた日時。データタイプ：文字列 (日付) 最大長：40
cases.assigned_to	ケースにアサインされたユーザーの sys_id。テーブル:ユーザー [sys_user] データタイプ：文字列
cases.assignment_group	ケースにアサインされたカスタマーサービスエージェントグループの sys_id。データタイプ：文字列テーブル： Group [sys_user_group]
cases.auto_close	ケースが自動的にクローズされたかどうかを示すフラグ。可能な値： true：ケースは自動的にクローズされました false:ケースは自動的にクローズされませんでした。データタイプ：ブーリアンデフォルト値：false
cases.business_duration	ケースの完了までにかかったカレンダー上の作業時間、作業日数、および作業週数。データタイプ：文字列
cases.business_impact	関連する顧客に対する問題の影響。データタイプ：文字列最大文字数：4,000
cases.business_service	ケースに関連付けられたサービスレコードの sys_id。データタイプ：文字列テーブル:サービス [cmdb_ci_service]
cases.calendar_duration	ケースの完了までにかかったカレンダー上の時間、日数、および週数。データタイプ：文字列 (期間) 最大長：40
ケース.ケース	ケースの簡単な説明とケース番号。データタイプ：文字列最大長：300
cases.case_report	関連するケースレポートの sys_id。データタイプ：文字列テーブル:ケースレポート [sn_customerservice_case_report]
cases.category	ケースカテゴリ。可能な値： 0：質問 1：問題 2：機能データタイプ：数値 (整数) デフォルト値：1
cases.cause	問題の原因に関する詳細。データタイプ：文字列最大長：4,000
cases.caused_by	ケースが作成される原因となった変更要求の sys_id。データタイプ：文字列テーブル：変更要求 [change_request]
cases.change	ケースが作成される原因となった変更要求の sys_id。データタイプ：文字列テーブル：変更要求 [change_request]
cases.child_case_creation_progress	ケースが重大なケースから作成された子ケースであるかどうかを示すフラグ。可能な値： true：重大なケースから作成された子ケース false：子ケースではありませんデータタイプ：ブール
cases.closed_at	ケースがクローズされた日時。データタイプ：文字列
cases.closed_by	ケースをクローズしたユーザーの sys_id。データタイプ：文字列テーブル:ユーザー [sys_user]
cases.close_notes	ケースがクローズされたときに作成されたメモ。データタイプ：文字列最大長：4,000
cases.cmdb_ci	ケースに関連付けられた構成アイテムの sys_id。データタイプ：文字列テーブル:構成アイテム [cmdb_ci]
cases.comments	ケースに関する追加のコメント。データタイプ：文字列最大長：4,000
cases.comments_and_work_notes	ケースに対して入力されたコメントと作業メモ。データタイプ：文字列最大長：4,000
Cases.Company	ケースに関連付けられた会社の sys_id。データタイプ：文字列テーブル:会社 [core_company]
cases.consumer	企業/消費者間ケースのみ。このケースに関して連絡先となる人のSys_id。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
Cases.Contact	企業間ベースのケースのみ。このケースに関する連絡担当者の sys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
cases.contact_local_time	連絡先の現地時間。データタイプ：文字列最大長：70
cases.contact_time_zone	ケースに関連付けられた連絡先のタイムゾーン。データタイプ：文字列最大長：40
cases.contact_type	ケースが最初にレポートされた方法。可能な値： chat email phone social web データタイプ：文字列最大長：40
ケース.契約	ケースに関連付けられた契約の sys_id。この契約には、ケースに関連付けられた会社に提供されるサポートのタイプに関する情報が含まれています。契約には会社と連絡先、および対象となる特定の資産が含まれる場合があります。1 つの契約に、複数のサービスエンタイトルメントと SLA を含めることもできます。データタイプ：文字列テーブル:契約 [ast_contract]
cases.contributor_groups	ケースに貢献したユーザーグループの sys_id のリスト。データタイプ：文字列テーブル： Group [sys_user_group]
cases.contributor_users	ケースに貢献したユーザーの sys_id のリスト。データタイプ：文字列テーブル:ユーザー [sys_user]
cases.correlation_display	相関ディスプレイ。データタイプ：文字列最大長：100
cases.correlation_id	相関識別子。データタイプ：文字列最大長：100
cases.delivery_plan	このケースの親実行計画の sys_id。データタイプ：文字列テーブル:実行計画 [sc_cat_item_delivery_plan]
cases.delivery_task	実行計画タスクの sys_id。データタイプ：文字列テーブル:実行計画タスク [sc_cat_item_delivery_task]
cases.description	ケースに関連する問題の詳細な説明。データタイプ：文字列最大長：4,000
cases.due_date	ケースのクローズ予定日。データタイプ：文字列
cases.entitlement	ケースに関連付けられたエンタイトルメントレコードの sys_id。エンタイトルメントによって、顧客が受けるサポートのタイプやサポートされるコミュニケーションチャネルが定義されます。エンタイトルメントは、製品、資産、アカウント、契約に関連付けることができます。データタイプ：文字列テーブル:エンタイトルメント [service_entitlement]
Cases.escalation	現在のエスカレーションレベル。可能な値： 0：通常 1：中 2：高 3：期限切れデータタイプ：数値 (整数) デフォルト：0
cases.expected_start	ケースの作業開始予定日時。データタイプ：文字列
cases.first_response_time	ケースに対して最初のアクションが実行された日時。データタイプ：文字列
cases.follow_the_sun	ケースをグローバルフォローアップに渡す必要があるかどうかを示すフラグ。顧客が [優先度 1：重大] または [優先度 2 - 高] のケースにさらにコメントを入力した場合、またはケースが昇格された場合は、このフラグが自動的に true に設定されます。可能な値： true：ケースをグローバルフォローアップに渡す必要があります false:ケースをグローバルフォローアップに渡すべきではありませんデータタイプ：ブーリアンデフォルト値：false
cases.follow_up	次のフォローアップアクションの日時。データタイプ：文字列
cases.group_list	ケースに関連付けられたグループレコードの sys_id のリスト。データタイプ：アレイテーブル： Group [sys_user_group]
Cases.Impact	顧客への影響。可能な値： 1 ：高 2 ：中 3：低データタイプ：数値 (整数) デフォルト値：3
cases.internal_user	このケースの内部ユーザーのSys_id。データタイプ：文字列テーブル:ユーザー [sys_user]
cases.initiated_as_request	この照会が顧客による要求として開始されたかどうかを示すフラグ。可能な値： true：照会は顧客によって開始されました。 false:照会は顧客によって開始されませんでした。データタイプ：ブーリアンデフォルト値：false
cases.knowledge	指定された問題に利用可能なナレッジベース記事があるかどうかを示すフラグ。可能な値： true：この問題に利用可能なナレッジベース記事があります false：この問題に利用可能なナレッジベース記事がありませんデータタイプ：ブールデフォルト値：false
cases.location	会社の場所を説明するレコードの sys_id。データタイプ：文字列テーブル:場所 [cmn_location]
cases.made_sla	ケースが関連するサービスレベルアグリーメントに従って解決されたかどうかを示すフラグ。可能な値： true：SLA に従ってケースが解決されました false:ケースは SLA に従って解決されませんでしたデータタイプ：ブーリアンデフォルト：true
cases.major_case_state	重大なケースの現在のステータス。可能な値： accepted：マネージャーが重大なケースを作成したとき、またはマネージャーが候補ケースを昇格させたときの初期ステータス。 canceled：ケースがキャンセルされました。 proposed：エージェントまたはマネージャーが候補ケースを作成または提案したときの初期ステータス。 rejected：マネージャーが候補ケースを却下しました。データタイプ：文字列最大長：40
needs_attention	ケースに注意が必要かどうかを示すフラグ。可能な値： true：ケースに追加の注意が必要です false:ケースに追加の注意は必要ありませんデータタイプ：ブーリアンデフォルト値：false
cases.notes_to_comments	解決メモをコメントに追加するかどうかを示すフラグ。可能な値： true：解決メモを追加すると、コメントにも追加されます false:コメントに解決メモを含める必要はありませんデータタイプ：ブーリアン
cases.notify	連絡先/コンシューマーに通知するために使用する方法。可能な値： 1：通知しない 2：メール送信 3：電話データタイプ：数値 (整数) デフォルト値：1
cases.number	ケース番号。データタイプ：文字列最大長：40
cases.opened_at	ケースがオープンされた日時。データタイプ：文字列
cases.opened_by	ケースを最初にオープンしたユーザーの sys_id。データタイプ：文字列テーブル:ユーザー [sys_user]
cases.order	ケースの順序。データタイプ：数値 (整数)
cases.parent	このケース (子) が関連付けられている親ケースの sys_id。データタイプ：文字列テーブル:タスク [task]
ケース.パートナー	ケースに関連付けられたパートナーの sys_id。データタイプ：文字列テーブル:アカウント [customer_account]
cases.partner_contact	ケースに関連付けられたパートナーの連絡先の sys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
cases.priority	ケースの優先度。可能な値： 1：重大 2：高 3：中 4：低データタイプ：数値 (整数) デフォルト：4
Cases.Proactive	照会がプロアクティブに監視されているかどうかを示すフラグ。可能な値： true：プロアクティブに監視されています。 false：監視されていません。データタイプ：ブールデフォルト：false
cases.probable_cause	ケースに関連する問題の考えられる原因。データタイプ：文字列最大長：4,000
Cases.Problem	顧客に発生している問題の sys_id。データタイプ：文字列テーブル：問題 [problem]
cases.product	ケースに関連付けられた資産の製品モデルの sys_id。モデルとは、「Apple Mac Book Pro」など、資産の特定のバージョンや構成のことです。データタイプ：文字列テーブル:製品モデル [cmdb_model]
cases.reassignment_count	ケースを進行させる担当者にケースが再アサインされた回数。データタイプ：数値 (整数) デフォルト：0
cases.recipient_list	このケースに関するコミュニケーションの受信者のリストを含むレコードの sys_id。データタイプ：文字列テーブル:受信者リスト [sn_publications_recipients_list]
cases.rejection_goto	ケースが却下された場合に実行するタスクの sys_id。データタイプ：文字列テーブル:タスク [task]
cases.resolution_code	ケースの解決ステータス (「Solved - サポートによって解決/ガイダンスの提供」など)。データタイプ：文字列最大長：40
cases.resolved_at	ケースが解決された日時。データタイプ：文字列
cases.resolved_by	ケースを解決したユーザーの sys_id。データタイプ：文字列テーブル:ユーザー [sys_user]
cases.route_reason	ケースが別のアサイニーにルーティングされた理由。データタイプ：数値 (整数) 最大長：40
cases.service_offering	支払照会に関連付けられたサービスオファリングのSys_id。サービスオファリングは、可用性、スコープ、価格設定、およびパッケージングのオプションに関して、サービスのレベルを一意に定義します。データタイプ：文字列テーブル：サービスオファリング [service_offering]
cases.short_description	ケースの簡潔な説明。データタイプ：文字列最大長：160
cases.skills	ケースを完了するために必要なスキルの一意の識別子 (sys_id) のリスト。データタイプ：文字列テーブル:スキル [cmn_skill]
cases.sla_due	関連するサービスレベルアグリーメントに基づいてケースをクローズする必要がある日時。データタイプ：文字列
cases.sn_app_cs_social_social_profile	ケースに関連付けられたソーシャルメディアプロファイルの sys_id。データタイプ：文字列テーブル:ソーシャルプロファイル [sn_app_cs_social_social_profile]
cases.sold_product	関連付けられた製品の sys_id。データタイプ：文字列テーブル:販売済み製品 [sn_install_base_sold_product]
cases.stage	[完了してクローズ]、[却下してクローズ]、[ドキュメントの確認]、[認証] などの照会のステージ。データタイプ：文字列最大長：40
cases.state	ケースの現在のステータス。可能な値： 1：新規 3：クローズ済み 6：解決済み 10：オープン 18：情報待ちデータタイプ：数値 (整数) デフォルト値：1
cases.subcategory	ケースのサブカテゴリ。可能な値： 0：質問データタイプ：数値 (整数) デフォルト：0
cases.support_manager	ケースにアサインされた CSM マネージャーの sys_id。データタイプ：文字列テーブル:ユーザー [sys_user]
cases.sync_driver	ドライバーの同期があるかどうかを示すフラグ。可能な値： true：ドライバーは同期されています false:ドライバーが同期されていませんデータタイプ：ブーリアン
cases.sys_クラス_名	ケースレコードを含むテーブル。データタイプ：文字列最大長：80
cases.sys_domain	ケースに関連付けられたドメイン。データタイプ：文字列最大長：32 デフォルト：global
cases.sys_ドメイン_パス	ドメインパス。データタイプ：文字列最大長：255 デフォルト：/
cases.sys_id	ケースの一意の識別子。データタイプ：文字列最大長：32
cases.task_effective_number	識別番号。タスクにユニバーサル要求が関連付けられている場合、それは UR 番号です。それ以外の場合は、現在のタスク番号です。データタイプ：文字列最大長：40
cases.time_worked	ケースの合計作業時間。データタイプ：文字列
cases.universal_request	この照会が含まれているユニバーサルタスクのSys_id。データタイプ：文字列テーブル:タスク [task]
cases.upon_approval	ケースが承認された場合に実行するアクション。可能な値： do_nothing proceed データタイプ：文字列最大長：40 デフォルト：proceed
cases.upon_reject	ケースが却下された場合に実行するアクション。可能な値： cancel goto データタイプ：文字列最大長：40 デフォルト：cancel
cases.urgency	ケースの緊急度。可能な値： 1 ：高 2 ：中 3：低データタイプ：数値 (整数) デフォルト値：3
cases.user_input	追加のユーザー入力。データタイプ：文字列最大長：4,000
cases.variables	ケースに関連付けられた変数の名前と値のペア。データタイプ：文字列最大長：40
cases.watch_list	追加のコメントが追加された場合、またはケースのステータスが「解決済み」または「クローズ済み」に変更された場合に、このケースに関する通知を受信するユーザーの sys_id のリスト。データタイプ：アレイテーブル:ユーザー [sys_user]
cases.wf_activity	ケースに関連付けられたワークフローアクティビティレコードの sys_id。データタイプ：文字列テーブル:ワークフローアクティビティ [wf_activity]
cases.work_end	ケースの作業が終了した日時。データタイプ：文字列
cases.work_notes	ケースの解決方法に関する情報、またはケースの解決手順。データタイプ：文字列最大長：4,000
cases.work_notes_list	作業メモが追加されたときに、このケースについての通知を受け取る内部ユーザーの sys_id のリスト。データタイプ：アレイテーブル:ユーザー [sys_user]
cases.work_start	ケースの作業が開始された日時。データタイプ：文字列
has_more	返すレコードが他にもテーブルにあるかどうかを示すフラグ。可能な値： true:返されるレコードが増えます。 false:返すレコードがこれ以上ありません。データタイプ:ブーリアン文字列
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。応答では、ブールパラメーター hasMore が返されます。フィルター基準を満たす、返されるレコードが他にもあるかどうかを示します。データタイプ：数値デフォルト：10
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターには負数を指定しないでください。データタイプ：数値デフォルト：0

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/1474a3c853500010df5dddeeff7b12ec/cases" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "cases": [
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001034",
        "initiated_as_request": "0",
        "state": "1",
        "case": "Performance is impacted with latest updateCS0001034",
        "knowledge": "0",
        "impact": "3",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "0",
        "short_description": "Performance is impacted with latest update",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001034",
        "opened_by": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "follow_the_sun": "0",
        "entitlement": {
          "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd",
          "display_value": "24x7 Customer Support"
        },
        "opened_at": {
          "value": "2023-03-20 14:53:51",
          "display_value": "2023-03-20 07:53:51"
        },
        "case_report": {
          "sys_id": "85e8604c87f521100b6afc86dabb35b9",
          "display_value": "CSR0010014"
        },
        "subcategory": "0",
        "install_base": {
          "sys_id": "1474a3c853500010df5dddeeff7b12ec",
          "display_value": "Boxeo - Development"
        },
        "proactive": "0",
        "auto_close": "0",
        "sys_id": "92c8684087b521105d0055373cbb357e",
        "contact_type": {
          "value": "web",
          "display_value": "Web"
        },
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001008",
        "initiated_as_request": "0",
        "state": "1",
        "case": "Test AlertCS0001008",
        "knowledge": "0",
        "impact": "3",
        "active": "1",
        "auto_created_case": "0",
        "priority": "1",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "1",
        "short_description": "Test Alert",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001008",
        "opened_by": {
          "sys_id": "08c83021acbe7300964fca436af2bb97",
          "display_value": "noc_operator "
        },
        "follow_the_sun": "0",
        "opened_at": {
          "value": "2023-03-15 08:02:58",
          "display_value": "2023-03-15 01:02:58"
        },
        "case_report": {
          "sys_id": "a4fa9d9a872d61105d0055373cbb356e",
          "display_value": "CSR0010005"
        },
        "subcategory": "0",
        "proactive": "1",
        "auto_close": "0",
        "sys_id": "60ea199a872d61105d0055373cbb35c9",
        "contact_type": {
          "value": "proactive",
          "display_value": "Alert"
        },
        "alert": {
          "sys_id": "506a559a872d61105d0055373cbb3581",
          "display_value": "Alert0010008"
        },
        "urgency": "3",
        "action_status": "4",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1"
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001033",
        "initiated_as_request": "0",
        "state": "1",
        "case": "System is downCS0001033",
        "knowledge": "0",
        "impact": "3",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "0",
        "short_description": "System is down",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001033",
        "opened_by": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "follow_the_sun": "0",
        "entitlement": {
          "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd",
          "display_value": "24x7 Customer Support"
        },
        "opened_at": {
          "value": "2023-03-20 14:52:48",
          "display_value": "2023-03-20 07:52:48"
        },
        "case_report": {
          "sys_id": "64b86c0c87f521100b6afc86dabb35fc",
          "display_value": "CSR0010013"
        },
        "subcategory": "0",
        "install_base": {
          "sys_id": "1474a3c853500010df5dddeeff7b12ec",
          "display_value": "Boxeo - Development"
        },
        "proactive": "0",
        "auto_close": "0",
        "sys_id": "7c98a04087b521105d0055373cbb352e",
        "contact_type": {
          "value": "web",
          "display_value": "Web"
        },
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001048",
        "initiated_as_request": "0",
        "state": "1",
        "case": "AIB with Single accountCS0001048",
        "knowledge": "0",
        "impact": "3",
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "1",
        "short_description": "AIB with Single account",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001048",
        "opened_by": {
          "sys_id": "08c83021acbe7300964fca436af2bb97",
          "display_value": "noc_operator "
        },
        "contact": {
          "sys_id": "4d147a386f0331003b3c498f5d3ee437",
          "display_value": "Julie Lewis"
        },
        "follow_the_sun": "0",
        "opened_at": {
          "value": "2023-03-24 03:28:58",
          "display_value": "2023-03-23 20:28:58"
        },
        "case_report": {
          "sys_id": "4082be81877161100b6afc86dabb35fe",
          "display_value": "CSR0010023"
        },
        "subcategory": "0",
        "proactive": "1",
        "auto_close": "0",
        "sys_id": "6a723e81877161100b6afc86dabb35cf",
        "contact_type": {
          "value": "proactive",
          "display_value": "Alert"
        },
        "alert": {
          "sys_id": "6b227681877161100b6afc86dabb35d5",
          "display_value": "Alert0010094"
        },
        "urgency": "3",
        "action_status": "4",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems

指定されたインストールベースアイテムレコードに関連付けられた子インストールベースアイテムを返します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/childinstallbaseitems

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems

注:

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

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

表 : 26. クエリパラメーター
名前	説明
フィールドの名前と値のペア	子インストールベースアイテムレコードをフィルタリングするために使用するフィールドと値のペア。 sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。たとえば、ステータスフィールドが「in_use」に設定され、ステータスフィールドが「replacement」に設定されているレコードのみを返すには、 `&state=in_use&status=replacement` を渡します。データタイプ：文字列デフォルト：すべてのフィールドテーブル:インストールベースアイテム [sn_install_base_item]
sys_class_name	(sn_install_base_itemではない) 拡張インストールベースアイテムテーブルを使用する場合、クエリーする拡張テーブルの名前。データタイプ：文字列デフォルト:sn_install_base_item
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。データタイプ：数値デフォルト値：20 最大：100
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0

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

ヘッダー

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

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

ステータスコード

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

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


名前	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
has_more	返すレコードが他にもテーブルにあるかどうかを示すフラグ。可能な値： true:返されるレコードが増えます。 false:返すレコードがこれ以上ありません。データタイプ:ブーリアン文字列
アイテム	指定されたフィルター結果に一致したインストールベースアイテムのリスト。データタイプ：オブジェクトのアレイ "items":[ { "account": {Object}, "active": "String", "asset": {Object}, "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": {Object}, "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "service_context": {Object}, "service_organization" {Object}, "sys_class_name": "String", "sys_id": "String", "sys_mod_count": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" } ]
items.account	インストールベースアイテムレコードに関連付けられた顧客アカウントの詳細。データタイプ: オブジェクト `"account": { "display_value": "String", "sys_id": "String" }`
items.account.display_value	インストールベースアイテムレコードに関連付けられた顧客アカウントのテキスト名。この値を使用して、UI に顧客アカウント名を表示します。データタイプ：文字列
items.account.sys_id	インストールベースアイテムレコードに関連付けられた顧客アカウントレコードのSys_id。データタイプ：文字列
items.active	インストールベースアイテムがアクティブかどうかを示すフラグ。可能な値： true:インストールベースアイテムはアクティブです。 false:インストールベースアイテムは非アクティブです。データタイプ:ブーリアン文字列
items.asset	インストールベースアイテムレコードに関連付けられた資産の詳細。データタイプ: オブジェクト `"asset": { "display_value": "String", "sys_id": "String" }`
items.asset.display_value	インストールベースアイテムレコードに関連付けられた資産のテキスト名。この値を使用して、UI に資産名を表示します。データタイプ：文字列
items.asset.sys_id	インストールベースアイテムレコードに関連付けられた資産レコードのSys_id。データタイプ：文字列
items.configuration_item	インストールベースアイテムレコードに関連付けられた構成アイテムの詳細。データタイプ: オブジェクト `"configuration_item": { "display_value": "String", "sys_id": "String" }`
items.configuration_item.display_value	インストールベースアイテムレコードに関連付けられた構成アイテムのテキスト名。この値を使用して、UI に構成アイテム名を表示します。データタイプ：文字列
items.configuration_item.sys_id	インストールベースアイテムレコードに関連付けられた構成アイテムレコードのSys_id。データタイプ：文字列
items.consumer	インストールベースアイテムレコードに関連付けられたコンシューマーの詳細。注: コンシューマーフィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer": { "display_value": "String", "sys_id": "String" }`
items.consumer.display_value	インストールベースアイテムレコードに関連付けられたコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。データタイプ：文字列
items.consumer.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列
items.consumer_profile	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルの詳細。注: [コンシューマープロファイル] フィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer_profile": { "display_value": "String", "sys_id": "String" }`
items.consumer_profile.display_value	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルのテキスト名。この値を使用して、UI にコンシューマープロファイル名を表示します。データタイプ：文字列
items.consumer_profile.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルレコードのSys_id。データタイプ：文字列
items.contact	インストールベースアイテムレコードを担当するアカウント連絡先の詳細。データタイプ: オブジェクト `"contact": { "display_value": "String", "sys_id": "String" }`
items.contact.display_value	インストールベースアイテムレコードに関連付けられたアカウント連絡先のテキスト名。この値を使用して、アカウントの連絡先名を UI に表示します。データタイプ：文字列
items.contact.sys_id	インストールベースアイテムレコードに関連付けられたアカウント連絡先レコードのSys_id。データタイプ：文字列
items.health_status	インストールベースアイテムの現在の健全性ステータスに関する詳細。プロアクティブカスタマーサービスオペレーション (com.snc.proactive_cs_itom) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"health_status": { "display_value": "String", "value": "String" }`
items.health_status.display_value	インストールベースアイテムの現在の健全性ステータスを示すテキスト文字列。この値を使用して、UI に健康状態を表示します。データタイプ：文字列
items.health_status.value	インストールベースアイテムの健全性ステータスの内部値。データタイプ：文字列
items.health_status_last_updated	インストールベースアイテムの健全性ステータスが最後に更新された日時。データタイプ：文字列
items.household	インストールベースアイテムレコードに関連付けられた世帯の詳細。カスタマーサービス世帯 (com.snc.household) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"household": { "display_value": "String", "sys_id": "String" }`
items.household.display_value	インストールベースアイテムレコードに関連付けられた世帯のテキスト名。この値を使用して、UI に世帯名を表示します。データタイプ：文字列
items.household.sys_id	インストールベースアイテムレコードに関連付けられた世帯のSys_id。データタイプ：文字列
items.install_date	インストールベースアイテムがアクティブになった日付に関する詳細。データタイプ: オブジェクト `"install_date": { "display_value": "String", "value": "String" }`
items.install_date.display_value	テキストインストール日。この値を使用して、インストール日を UI に表示します。データタイプ：文字列
items.install_date.value	インストール日の内部値。データタイプ：文字列
items.location	インストールベースアイテムの場所に関する詳細。データタイプ: オブジェクト `"location": { "display_value": "String", "sys_id": "String" }`
items.location.display_value	インストールベースアイテムの場所のテキスト名。この値を使用して、場所の名前を UI に表示します。データタイプ：文字列
items.location.sys_id	インストールベースアイテムレコードに関連付けられた場所レコードのSys_id。データタイプ：文字列
items.name	インストールベースアイテムの名前。データタイプ：文字列
items.number	インストールベースアイテムの一意の ID。データタイプ：文字列
items.parent	インストールベースアイテムレコードの親レコードに関する詳細。データタイプ: オブジェクト `"parent": { "display_value": "String", "sys_id": "String" }`
items.parent.display_value	インストールベースアイテムレコードに関連付けられた親レコードのテキスト名。この値を使用して、UI に親名を表示します。データタイプ：文字列
items.parent.sys_id	インストールベースアイテムレコードに関連付けられた親レコードのSys_id。データタイプ：文字列
items.product	インストールベースアイテムレコードに関連付けられた製品モデルの詳細。この情報を使用して、製品モデルに関連付けられたサービスを識別します。データタイプ: オブジェクト `"product": { "display_value": "String", "sys_id": "String" }`
items.product.display_value	インストールベースアイテムレコードに関連付けられた製品モデルのテキスト名。この値を使用して、UI に製品名を表示します。データタイプ：文字列
items.product.sys_id	インストールベースアイテムレコードに関連付けられた製品モデルレコードのSys_id。データタイプ：文字列
items.service_context	インストールベースアイテムレコードに関連付けられたサービスコンテキストの詳細。データタイプ: オブジェクト `"service_context": { "display_value": "String", "sys_id": "String" }`
items.service_context.display_value	インストールベースアイテムレコードに関連付けられたサービスコンテキストのテキスト名。この値を使用して、UI にサービスコンテキスト名を表示します。データタイプ：文字列
items.service_context.sys_id	インストールベースアイテムレコードに関連付けられたサービスコンテキストレコードのSys_id。データタイプ：文字列
items.service_organization	インストールベースアイテムレコードに関連付けられたサービス組織に関する詳細。Service Organization (com.snc.service_organization) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"service_organization": { "display_value": "String", "sys_id": "String" }`
items.service_organization.display_value	インストールベースアイテムレコードに関連付けられたサービス組織のテキスト名。この値を使用して、サービス組織名を UI に表示します。データタイプ：文字列
items.service_organization.sys_id	インストールベースアイテムレコードに関連付けられたサービス組織レコードのSys_id。データタイプ：文字列
items.sys_class_name	インストールベースアイテムレコードを含むテーブル。データタイプ：文字列
items.sys_id	インストールベースアイテムレコードのSys_id。sys_class_name パラメーターで指定されたテーブルにあります。データタイプ：文字列
items.sys_mod_count	関連付けられたインストールベースアイテムレコードが変更された回数。データタイプ：文字列
items.state	インストールベースアイテムの現在のステータスに関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
items.state.display_value	インストールベースアイテムの現在のステータスを示すテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
items.state.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
items.status	インストールベースアイテムのステータスに関する詳細。データタイプ: オブジェクト `"status": { "display_value": "String", "value": "String" }`
items.status.display_value	インストールベースアイテムのステータスのテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
items.status.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
items.uninstall_date	インストールベースアイテムが非アクティブになった日付に関する詳細。データタイプ: オブジェクト `"uninstall_date": { "display_value": "String", "value": "String" }`
items.uninstall_date.display_value	テキストのアンインストール日。この値を使用して、アンインストール日を UI に表示します。データタイプ：文字列
items.uninstall_date.value	アンインストール日の内部値。データタイプ：文字列
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_depth	階層内の、返される子インストールベースアイテムの深さのレベル数。データタイプ：整数
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/767f34d378d21110f877d304c76fdd2a/childinstallbaseitems?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "items": [
      {
        "parent": {
          "sys_id": "767f34d378d21110f877d304c76fdd2a",
          "display_value": "X5 Sport Utility 4D"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001005",
        "sys_id": "0704dfcc39265110f87734024cfbc222",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "consumer": {
          "sys_id": "bab5139ab3401010700b4d43c6a8dc41",
          "display_value": "Charles Barkley"
        },
        "product": {
          "sys_id": "56c84f0439265110f87734024cfbc233",
          "display_value": "Electric Power-Assist Speed-Sensing Steering"
        },
        "active": "true",
        "name": "Electric Power-Assist Speed-Sensing Steering",
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitems/{id}/contracts

指定されたインストールベースアイテムレコードに関連付けられた契約を返します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/contracts

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/contracts

注:

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

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

表 : 32. クエリパラメーター
名前	説明
フィールドの名前と値のペア	契約レコードのフィルタリングに使用するフィールドと値のペア。デフォルトでは、これは契約 [ast_contract] テーブルのフィールドを参照します。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。たとえば、renewable フィールドが「true」に設定されているレコードのみを返すには、 `&renewable=true` を渡します。データタイプ：文字列デフォルト：すべてのフィールド
sys_class_name	(ast_contractではない) 拡張コントラクトテーブルを使用している場合、クエリーする拡張テーブルの名前。データタイプ：文字列デフォルト:ast_contract
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。データタイプ：数値デフォルト値：20 最大：100
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0

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

ヘッダー

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

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

ステータスコード

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

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


名前	説明
契約	指定されたインストールベースアイテムレコードに関連付けられた契約のリスト。データタイプ：オブジェクトのアレイ "contracts": [ { "active": "String", "approver": {Object}, "commitment": "String", "consumer": {Object}, "cost_adjustment": "String", "cost_adjustment_percentage": "String", "cost_per_unit": "String", "contract_composite": "String", "ends": "String", "expiration": {Object}, "lifetime_cost": "String", "monthly_cost": "String", "number": "String", "payment_amount": "String", "payment_schedule": {Object}, "ratecard": "String", "renewable": "String", "sales_tax": "String", "short_description": "String", "starts": "String", "state": {Object}, "sub_total_cost": "String", "sys_class_name": "String", "sys_domain_path": "String", "sys_id": "String", "tax_cost": "String", "tax_exempt": "String", "tax_rate": "String", "total_cost": "String", "vendor_contract": "String", "yearly_cost": "String" } ]
契約.アクティブ	契約がアクティブかどうかを示すフラグ。可能な値： true:契約はアクティブです。 false:契約は非アクティブです。データタイプ:ブーリアン文字列
contracts.approver	契約を承認する権限を持つ人物の詳細。データタイプ: オブジェクト `"approver": { "display_value": "String", "sys_id": "String" }`
contracts.approver.display_value	契約レコードに関連付けられた承認者のテキスト名。この値を使用して、UI に承認者名を表示します。データタイプ：文字列
contracts.approver.sys_id	契約レコードに関連付けられた承認者レコードのSys_id。データタイプ：文字列
contracts.consumer	契約レコードに関連付けられたコンシューマーの詳細。注: コンシューマーフィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer": { "display_value": "String", "sys_id": "String" }`
contracts.consumer.display_value	契約レコードに関連付けられたコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。データタイプ：文字列
contracts.consumer.sys_id	契約レコードに関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列
contracts.cost_adjustment	契約に適用された費用調整のタイプ可能な値：修正済みマニュアル CPI(消費者物価指数) データタイプ：文字列
contracts.cost_adjustment_percentage	契約の価格の増減率。価格の減額を示すには、割合をマイナス値で入力します。[コスト調整] または [コスト調整率] を指定することができますが、両方を指定することはできません。データタイプ：文字列
contracts.cost_per_unit	製品プロバイダーからの単位当たりのコスト。データタイプ：文字列
contracts.ends	契約が終了する日付。データタイプ：文字列
contracts.expiration	関連付けられた契約の有効期限ステータスに関する詳細。データタイプ: オブジェクト `"expiration": { "display_value": "String", "sys_id": "String" }`
contracts.expiration.display_value	関連付けられた契約の有効期限ステータス。この値を使用して、有効期限ステータスを UI に表示します。データタイプ：文字列
contracts.expiration.sys_id	契約レコードに関連付けられた有効期限レコードのSys_id。データタイプ：文字列
contracts.lifetime_cost	契約のライフタイムコスト。データタイプ：文字列
contracts.monthly_cost	契約の月次コスト。データタイプ：文字列
contracts.number	契約番号。データタイプ：文字列
contracts.payment_amount	この契約の受領当事者に直接支払われた金額。データタイプ：文字列
contracts.payment_schedule	契約に関連付けられた支払いスケジュールの詳細。データタイプ: オブジェクト `"payment_schedule": { "display_value": "String", "sys_id": "String" }`
contracts.payment_schedule.display_value	関連付けられた契約の支払いスケジュール。この値を使用して、支払いスケジュールを UI に表示します。データタイプ：文字列
contracts.payment_schedule.value	この契約の支払スケジュールの内部値 (日次、週次、月次など)。データタイプ：文字列
contracts.ratecard	この契約に関連付けられたレートカードがあるかどうかを示すフラグ。可能な値： true:レートカード。 false:レートカードなし。データタイプ:ブーリアン文字列テーブル:レートケア [fm_contract_rate_card]
契約.更新可能	契約が更新可能かどうかを示すフラグ。可能な値： true:契約は更新可能です。 false:契約は更新できません。データタイプ:ブーリアン文字列
contracts.sales_tax	この契約で参照される品目に消費税が課されるかどうかを示すフラグ。可能な値： true:消費税が請求されます。 false:消費税は請求されません。データタイプ:ブーリアン文字列
contracts.short_description	契約の簡単な説明。データタイプ：文字列
contracts.starts	契約の開始日。データタイプ：文字列
契約.状況	契約の現在のステータスに関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
contracts.state.display_value	契約の現在のステータスを示す文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
contracts.state.value	内部値または契約のステータス。データタイプ：文字列
contracts.sub_total_cost	契約のコストの小計。データタイプ：文字列
contracts.sys_クラス_名	契約レコードを含むテーブル。データタイプ：文字列
contracts.sys_ドメイン_パス	この契約が利用可能なドメインへのパス。データタイプ：文字列デフォルト:"/" = グローバルドメイン
contracts.sys_id	関連付けられた契約レコードのSys_id。データタイプ：文字列
contracts.tax_cost	契約にかかる合計税額。このフィールドは、[適用される税] フィールドが `[売上]` として選択されている場合にのみ表示されます。データタイプ：文字列
contracts.tax_exempt	この契約に関連する品目が非課税かどうかを示すフラグ。可能な値： true:アイテムは非課税です。 false:アイテムは非課税ではありません。データタイプ:ブーリアン文字列
contracts.tax_rate	契約に関連付けられた課税品目に課される税率。データタイプ：文字列
contracts.total_cost	調整適用後の契約の最終費用。契約に 1 つ以上のレートカードがある場合、このフィールドにはすべてのレートカードの合計値が表示されます。データタイプ：文字列
contracts.vendor_contract	ベンダーの契約番号。データタイプ：文字列
contracts.yearly_cost	契約の 1 年あたりのコスト。データタイプ：文字列
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
has_more	返すレコードが他にもテーブルにあるかどうかを示すフラグ。可能な値： true:返されるレコードが増えます。 false:返すレコードがこれ以上ありません。データタイプ:ブーリアン文字列
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/contracts" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "contracts": [
      {
        "cost_adjustment_percentage": "0",
        "total_cost": "0",
        "cost_adjustment": "0",
        "tax_rate": "7.75",
        "number": "CNTR0000701",
        "tax_cost": "0",
        "sub_total_cost": "0",
        "state": {
          "value": "expired",
          "display_value": "Expired"
        },
        "starts": "2016-07-01",
        "contract_composite": "CoolMate KL300 1 year Limited Warranty\n\t\tCNTR0000701",
        "tax_exempt": "false",
        "yearly_cost": "0",
        "active": "true",
        "payment_amount": "0",
        "commitment": "0",
        "sys_domain_path": "/",
        "payment_schedule": {
          "value": "Monthly",
          "display_value": "Monthly"
        },
        "renewable": "true",
        "expiration": {
          "sys_id": "c752e78ec3103000c111113e5bba8f3a",
          "display_value": "Expired"
        },
        "short_description": "CoolMate KL300 1 year Limited Warranty\n\t\t",
        "ratecard": "false",
        "sys_class_name": "ast_contract",
        "sys_id": "3f9db778c3302200e7c7d44d81d3ae0a",
        "ends": "2017-06-30",
        "consumer": {
          "sys_id": "59e788fbdb1b1200b6075200cf9619d2",
          "display_value": "Gilly Parker"
        },
        "approver": {
          "sys_id": "f2c0b27247702000cdd1706eecde27c8",
          "display_value": "Software Manager"
        },
        "monthly_cost": "0",
        "vendor_contract": "CNTR0000701",
        "lifetime_cost": "0",
        "sales_tax": "true",
        "cost_per_unit": "0"
      }
    ],
    "status": "SUCCESS"
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitems/{id}/entitlements

指定されたインストールベースアイテムレコードに関連付けられたエンタイトルメントを返します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/entitlements

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/entitlements

注:

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

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

表 : 38. クエリパラメーター
名前	説明
フィールドの名前と値のペア	エンタイトルメントレコードをフィルタリングするために使用するフィールドと値のペア。デフォルトでは、これはエンタイトルメント [service_entitlement] テーブルのフィールドを参照します。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。たとえば、アクティブなレコードのみを返すには、 `&active=true` を渡します。データタイプ：文字列デフォルト：すべてのフィールド
sys_class_name	拡張エンタイトルメントテーブル (service_entitlementではない) を使用している場合、クエリーする拡張テーブルの名前。データタイプ：文字列デフォルト:service_entitlement
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。データタイプ：数値デフォルト値：20 最大：100
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0

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

ヘッダー

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

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

ステータスコード

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

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


名前	説明
エンタイトルメント	指定されたインストールベースアイテムレコードに関連付けられたエンタイトルメントのリスト。データタイプ: オブジェクト `"entitlements": { "account": {Object}, "active": "String", "business_hour": {Object}, "contract": {Object}, "end_date": "String", "entitlement_name": "String", "install_base_item": {Object}, "per_unit": "String", "start_date": "String", "sys_id": "String", "total_units": "String", "remaining_units": "String", "unit": {Object} }`
entitlements.account	エンタイトルメントレコードに関連付けられたアカウントの詳細。データタイプ: オブジェクト `"account": { "display_value": "String", "sys_id": "String" }`
entitlements.account.display_value	エンタイトルメントレコードに関連付けられたアカウントのテキスト名。この値を使用して、アカウント名を UI に表示します。データタイプ：文字列
entitlements.account.sys_id	エンタイトルメントレコードに関連付けられたアカウントレコードのSys_id。データタイプ：文字列
エンタイトルメント.アクティブ	エンタイトルメントがアクティブかどうかを示すフラグ。可能な値： 0:エンタイトルメントがアクティブではありません。 1:エンタイトルメントはアクティブです。データタイプ：文字列デフォルト値：1
entitlements.business_hour	エンタイトルメントレコードの営業時間に関する詳細。データタイプ: オブジェクト `"business_hour": { "display_value": "String", "sys_id": "String" }`
entitlements.business_hour.display_value	エンタイトルメントレコードに関連付けられた営業時間レコードのテキスト名。この値を使用して、UI に営業時間を表示します。データタイプ：文字列
entitlements.business_hour.sys_id	エンタイトルメントレコードに関連付けられた営業時間レコードのSys_id。データタイプ：文字列
エンタイトルメント.契約	エンタイトルメントレコードに関連付けられた契約の詳細。データタイプ: オブジェクト `"contract": { "display_value": "String", "sys_id": "String" }`
entitlements.contract.display_value	エンタイトルメントレコードに関連付けられた契約のテキスト名。この値を使用して、UI に契約名を表示します。データタイプ：文字列
entitlements.contract.sys_id	エンタイトルメントレコードに関連付けられた契約レコードのSys_id。データタイプ：文字列
entitlements.end_date	エンタイトルメントの終了日。データタイプ：文字列
entitlements.entitlement_name	エンタイトルメントの名前。データタイプ：文字列
entitlements.install_base_item	エンタイトルメントレコードに関連付けられたインストールベースアイテムの詳細。データタイプ: オブジェクト `"install_base_item": { "display_value": "String", "sys_id": "String" }`
entitlements.install_base_item.display_value	エンタイトルメントレコードに関連付けられたインストールベースアイテムのテキスト名。この値を使用して、インストールベースアイテム名を UI に表示します。データタイプ：文字列
entitlements.install_base_item.sys_id	エンタイトルメントレコードに関連付けられたインストールベースアイテムレコードのSys_id。データタイプ：文字列
entitlements.per_unit	単位内の製品の数。たとえば、unit`がケース`の場合、ケースあたり 12 個のアイテムがある場合、この値は 12 になります。データタイプ：文字列
entitlements.start_date	エンタイトルメントの開始日。データタイプ：文字列
entitlements.sys_id	関連付けられたエンタイトルメントレコードのSys_id。データタイプ：文字列
entitlements.total_units	元々利用可能だったユニットの数。データタイプ：文字列
entitlements.remaining_units	残りのユニット数。データタイプ：文字列
entitlements.unit	エンタイトルメントレコードに関連付けられたアイテムの単位に関する詳細。データタイプ: オブジェクト `"unit": { "display_value": "String", "value": "String" }`
entitlements.unit.display_value	エンタイトルメントレコードに関連付けられたアイテムの単位のテキスト名。この値を使用して、UI にユニット名を表示します。データタイプ：文字列
entitlements.unit.value	エンタイトルメントレコードに関連付けられたアイテムの単位の内部名。データタイプ：文字列
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
has_more	返すレコードが他にもテーブルにあるかどうかを示すフラグ。可能な値： true:返されるレコードが増えます。 false:返すレコードがこれ以上ありません。データタイプ:ブーリアン文字列
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/entitlements" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "entitlements": [
      {
        "end_date": "2023-04-28",
        "remaining_units": "4978",
        "business_hour": {
          "sys_id": "08fcd0830a0a0b2600079f56b1adb9ae",
          "display_value": "8-5 weekdays"
        },
        "entitlement_name": "Entitlement",
        "sys_id": "7206095d87f121105d0055373cbb3504",
        "total_units": "5000",
        "start_date": "2023-03-27",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "unit": {
          "value": "cases",
          "display_value": "Cases"
        },
        "per_unit": "0",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitems/{id}/maintenanceplans

指定されたインストールベースアイテムレコードに関連付けられたメンテナンス計画を返します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/maintenanceplans

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/maintenanceplans

注:

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

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

表 : 44. クエリパラメーター
名前	説明
フィールドの名前と値のペア	メンテナンス計画レコードのフィルタリングに使用するフィールドと値のペア。デフォルトでは、これはメンテナンス計画 [sm_maint_plan] テーブルのフィールドを参照します。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。たとえば、アクティブなレコードのみを返すには、 `&active=true` を渡します。データタイプ：文字列デフォルト：すべてのフィールド
sys_class_name	(maintenanceplans ではなく) 拡張メンテナンス計画テーブルを使用している場合、クエリーする拡張テーブルの名前。データタイプ：文字列デフォルト:maintenanceplans
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。データタイプ：数値デフォルト値：20 最大：100
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0

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

ヘッダー

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

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

ステータスコード

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

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


名前	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
has_more	返すレコードが他にもテーブルにあるかどうかを示すフラグ。可能な値： true:返されるレコードが増えます。 false:返すレコードがこれ以上ありません。データタイプ:ブーリアン文字列
メンテナンス計画	指定されたインストールベースアイテムレコードに関連付けられたメンテナンス計画のリスト。データタイプ：オブジェクトのアレイ `"maintenanceplans": [ { "active": "String", "apply_to_new": "String", "allow_future_wo": "String", "maintenance_override_policy": {Object}, "model": "String", "name": "String", "number": "String", "propagation_flag": "String", "sys_class_name": "String", "sys_id": "String", "table": "String", "type": {Object} } ]`
メンテナンス計画。能動	メンテナンス計画がアクティブかどうかを示すフラグ。可能な値： true:メンテナンス計画がアクティブです。 false:メンテナンス計画は非アクティブです。データタイプ：文字列
メンテナンス計画。apply_to_new	このメンテナンス計画に定義されたスケジュールが、前回の計画の実行以降に指定されたテーブルに追加されたすべてのレコードに適用され、フィルター条件に入力された条件を満たしているかどうかを示すフラグ。可能な値： true:すべての新しいレコードに適用されます。 false:すべての新しいレコードに適用されるわけではありません。データタイプ：文字列
メンテナンス計画。allow_future_wo	作業指示をメンテナンス計画に関連付けることができるかどうかを示すフラグ。可能な値： true:新しい作業指示書を関連付けることができます。 false:新しい作業指示を関連付けることはできません。データタイプ：文字列
メンテナンス計画。maintenance_override_policy	メンテナンス計画のメンテナンス上書きポリシーに関する詳細。データタイプ: オブジェクト `"maintenance_override_policy": { "display_value": "String", "value": "String" }`
メンテナンス計画。maintenance_override_policy。display_value	上書きポリシーを説明するテキスト文字列。この値を使用して、UI に上書きポリシーを表示します。データタイプ：文字列
メンテナンス計画。maintenance_override_policy。価値	上書きポリシーの内部値。データタイプ：文字列
メンテナンス計画。モデル	メンテナンス計画に関連付けられたモデルレコードのSys_id。データタイプ：文字列
メンテナンス計画。数	メンテナンス計画番号。データタイプ：文字列
メンテナンス計画。propagation_flag	メンテナンス計画を反映できるかどうかを示すフラグ。可能な値： true:メンテナンス計画を伝播できます。 false:メンテナンス計画を伝播できません。データタイプ：文字列
メンテナンス計画。sys_class_name	メンテナンス計画レコードを含むテーブル。データタイプ：文字列
メンテナンス計画。sys_id	関連するメンテナンス計画のSys_id。データタイプ：文字列
メンテナンス計画。テーブル	関連するインストールベース時間レコードを含むテーブル。データタイプ：文字列
メンテナンス計画。種類	メンテナンス計画のタイプに関する詳細。データタイプ: オブジェクト `"type": { "display_value": "String", "value": "String" }`
メンテナンス計画。種類。display_value	メンテナンス計画タイプを説明するテキスト文字列。この値を使用して、UI にタイプを表示します。データタイプ：文字列
メンテナンス計画。種類。価値	メンテナンス計画タイプの内部値。データタイプ：文字列
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/maintenanceplans" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "maintenanceplans": [
      {
        "propagation_flag": "false",
        "active": "true",
        "type": {
          "value": "install_base",
          "display_value": "Install base"
        },
        "maintenance_override_policy": {
          "value": "do_nothing",
          "display_value": "Leave alone"
        },
        "sys_class_name": "wm_planned_work_plan",
        "allow_future_wo": "true",
        "sys_id": "0b809d70877561105d0055373cbb357f",
        "number": "WP0001026",
        "name": "Plan 10",
        "model": "8583ce8237732000158bbfc8bcbe5dd9",
        "apply_to_new": "true",
        "table": "sn_install_base_item"
      }
    ],
    "status": "SUCCESS"
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitems/{id}/relatedparties

指定されたインストールベースアイテムレコードに関連付けられた関係者を返します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties

注:

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

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

表 : 50. クエリパラメーター
名前	説明
フィールドの名前と値のペア	関係者レコードをフィルタリングするために使用するフィールドと値のペア。デフォルトでは、これは関係者 [sn_install_base_related_party] テーブルのフィールドを参照します。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。たとえば、特定のアカウントと責任者をフィルタリングする場合は、& `account=86837a386f0331003b3c498f5d3ee4ca&responsibility=c009bbedb3730010700b4d43c6a8dcef` の 2 つのレコードのsys_idsを渡します。データタイプ：文字列デフォルト：すべてのフィールド
sys_class_name	(sn_install_base_related_partyではない) 拡張関係者テーブルを使用している場合、クエリーする拡張テーブルの名前。データタイプ：文字列デフォルト:sn_install_base_related_party
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。データタイプ：数値デフォルト値：20 最大：100
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0

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

ヘッダー

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

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

ステータスコード

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

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


[Name (名前)]	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
has_more	返すレコードが他にもテーブルにあるかどうかを示すフラグ。可能な値： true:返されるレコードが増えます。 false:返すレコードがこれ以上ありません。データタイプ:ブーリアン文字列
関係者	指定されたインストールベースアイテムレコードに関連付けられた関係者のリスト。データタイプ：オブジェクトのアレイ `"relatedparties": [ { "account": {Object}, "consumer": {Object}, "contact": {Object}, "install_base_item": {Object}, "responsibility": {Object}, "service_organization": {Object}, "sys_class_name": "String", "sys_id": "String", "type": {Object}, "user": {Object} } ]`
relatedParties.account	関係者レコードに関連付けられたアカウントの詳細。データタイプ: オブジェクト `account": { "display_value": "String", "sys_id": "String" }`
relatedparties.account.display_value	関係者レコードに関連付けられたアカウントのテキスト名。この値を使用して、アカウント名を UI に表示します。データタイプ：文字列
relatedparties.account.sys_id	関係者レコードに関連付けられたアカウントレコードのSys_id。データタイプ：文字列
relatedParties.Consumer	関係者レコードに関連付けられたコンシューマーの詳細。データタイプ: オブジェクト `"consumer": { "display_value": "String", "sys_id": "String" }`
relatedparties.consumer.display_value	関係者レコードに関連付けられたコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。データタイプ：文字列
relatedparties.consumer.sys_id	関係者レコードに関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列
RelatedParties.Contact	関係者レコードを担当するアカウント連絡先の詳細。データタイプ: オブジェクト `"contact": { "display_value": "String", "sys_id": "String" }`
relatedparties.contact.display_value	関係者レコードに関連付けられた連絡先のテキスト名。この値を使用して、連絡先名を UI に表示します。データタイプ：文字列
relatedparties.contact.sys_id	関係者レコードに関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
relatedparties.install_base_item	関係者レコードに関連付けられたインストールベースアイテムの詳細。データタイプ: オブジェクト `"install_base_item": { "display_value": "String", "sys_id": "String" }`
relatedparties.install_base_item.display_value	関係者レコードに関連付けられたインストールベースアイテムのテキスト名。この値を使用して、インストールベースアイテム名を UI に表示します。データタイプ：文字列
relatedparties.install_base_item.sys_id	関係者レコードに関連付けられたインストールベースアイテムレコードのSys_id。データタイプ：文字列
relatedParties.responsibility	インストールベース情報のアクセスレベルに関する詳細。データタイプ: オブジェクト `"responsibility": { "display_value": "String", "sys_id": "String" }`
relatedparties.responsibility.display_value	インストールベース情報のアクセスレベルのテキスト表示値。データタイプ：文字列
relatedparties.responsibility.sys_id	関連付けられた責任レコードのSys_id。このレコードは、インストールベース情報のアクセスレベルを定義します。このパラメーターは、[ related_party ] フィールドも指定されている場合にのみ有効です。指定した場合、 related_party パラメーターと responsibility パラメーターの両方に一致するインストールベースアイテムのみを返します。詳細については次を参照してください。 Configure related parties for items received データタイプ：文字列テーブル:責任の定義 [sn_customerservice_responsibility_def]
relatedparties.service_organization	関係者レコードに関連付けられたサービス組織に関する詳細。データタイプ: オブジェクト `"service_organization": { "display_value": "String", "sys_id": "String" }`
relatedparties.service_organization.display_value	関係者レコードに関連付けられたサービス組織のテキスト名。この値を使用して、サービス組織名を UI に表示します。データタイプ：文字列
relatedparties.service_organization.sys_id	関係者レコードに関連付けられたサービス組織レコードのSys_id。データタイプ：文字列テーブル:サービス組織 [sn_customer_service_organization]
relatedparties.sys_クラス_名	関係者レコードを含むテーブル。データタイプ：文字列デフォルト:sn_install_base_related_party
relatedparties.sys_id	関連する関係者レコードのSys_id。データタイプ：文字列
relatedParties.type	関係者レコードに関連付けられた連絡先のタイプに関する詳細。データタイプ: オブジェクト `"type": { "display_value": "String", "sys_id": "String" }`
relatedparties.type.display_value	関係者レコードに関連付けられた連絡先タイプのテキスト名。この値を使用して、連絡先のタイプを UI に表示します。詳細については、「Create related party configurations」を参照してください。可能なタイプ: 承認済みアカウント認定コンシューマー認定連絡先認定貢献者認定メンバー認証サービス組織リストされたアカウントリストされたコンシューマーリストされた連絡先リストされた貢献者リストされたメンバーリストされたサービス組織データタイプ：文字列
relatedparties.type.sys_id	関係者レコードに関連付けられたタイプレコードのSys_id。データタイプ：文字列
relatedParties.user	関係者レコードに関連付けられたユーザーの詳細。データタイプ: オブジェクト `"user": { "display_value": "String", "sys_id": "String" }`
relatedparties.user.display_value	関係者レコードに関連付けられたユーザーのテキスト名。この値を使用して、UI にユーザー名を表示します。データタイプ：文字列
relatedparties.user.sys_id	関係者レコードに関連付けられたユーザーレコードのSys_id。データタイプ：文字列テーブル:ユーザー [sys_user]
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/relatedparties" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：


  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "relatedparties": [
      {
        "type": {
          "sys_id": "68ec8b2965e99110f87764df53db779f",
          "display_value": "Authorized Contact"
        },
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "sys_class_name": "sn_install_base_related_party",
        "sys_id": "8547774087f561100b6afc86dabb351a",
        "responsibility": {
          "sys_id": "c009bbedb3730010700b4d43c6a8dcef",
          "display_value": "Authorized Representative"
        },
        "contact": {
          "sys_id": "dc0185d94f341200025ba3618110c77c",
          "display_value": "Cindy Contact"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitems/{id}/soldproducts

指定されたインストールベースアイテムレコードに関連付けられた販売済み製品レコードを返します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/soldproducts

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/soldproducts

注:

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

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

表 : 56. クエリパラメーター
名前	説明
フィールドの名前と値のペア	関係者レコードをフィルタリングするために使用するフィールドと値のペア。デフォルトでは、これは販売済み製品 [sn_install_base_sold_product] テーブルのフィールドを参照します。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。たとえば、特定のアカウントに販売された商品をフィルタリングする場合は、渡された値がアカウントのsys_idである `&account=86837a386f0331003b3c498f5d3ee4ca` のようなものを渡します。データタイプ：文字列デフォルト：すべてのフィールド
sys_class_name	拡張販売済み製品テーブル (sn_install_base_sold_productではない) を使用している場合、クエリーする拡張テーブルの名前。データタイプ：文字列デフォルト:sn_install_base_sold_product
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。データタイプ：数値デフォルト値：20 最大：100
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0

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

ヘッダー

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

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

ステータスコード

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

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


名前	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
has_more	返すレコードが他にもテーブルにあるかどうかを示すフラグ。可能な値： true:返されるレコードが増えます。 false:返すレコードがこれ以上ありません。データタイプ:ブーリアン文字列
販売済み製品	指定されたインストールベースアイテムレコードに関連付けられた販売済み製品のリスト。データタイプ：オブジェクトのアレイ `"soldproducts":[ { "account": {Object}, "contact": {Object}, "name": "String", "number": "String", "product": {Object}, "sys_class_name": "String", "sys_id": "String", "state": {Object} } ]`
soldproducts.account	製品レコードに関連付けられているアカウントの詳細。データタイプ: オブジェクト `account": { "display_value": "String", "sys_id": "String" }`
soldproducts.account.display_value	製品レコードに関連付けられたアカウントのテキスト名。この値を使用して、アカウント名を UI に表示します。データタイプ：文字列
soldproducts.account.sys_id	製品レコードに関連付けられたアカウントレコードのSys_id。データタイプ：文字列
soldproducts.contact	製品を担当するアカウント連絡先の詳細。データタイプ: オブジェクト `"contact": { "display_value": "String", "sys_id": "String" }`
soldproducts.contact.display_value	製品に関連付けられた連絡先のテキスト名。この値を使用して、連絡先名を UI に表示します。データタイプ：文字列
soldproducts.contact.sys_id	製品レコードに関連付けられた連絡先レコードのSys_id。データタイプ：文字列
soldproducts.name	製品の名前。データタイプ：文字列
soldproducts.number	製品番号。データタイプ：文字列
soldproducts.sys_クラス_名	製品レコードを含むテーブル。データタイプ：文字列
soldproducts.sys_id	関連付けられた製品の sys_id。データタイプ：文字列
soldProducts.State	製品の現在のステータスに関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
soldproducts.state.display_value	製品の現在のステータスを示すテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
soldproducts.state.value	製品のステータスの内部値。データタイプ：文字列
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/soldproducts?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "soldproducts": [
      {
        "product": {
          "sys_id": "a9a2d0c3c6112276010db16c5ddd3461",
          "display_value": "Lenovo ThinkStation S20"
        },
        "sys_class_name": "sn_install_base_sold_product",
        "number": "SLPRD0001008",
        "sys_id": "17a3a7128729a1105d0055373cbb35fb",
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "name": "SP B2B",
        "state": {
          "value": "active",
          "display_value": "Active"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

インストールベースアイテム:GET /sn_install_base/integrations/installbaseitems/{id}/workorders

指定されたインストールベースアイテムレコードに関連付けられた作業指示書を返します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/workorders

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/workorders

注:

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

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

表 : 62. クエリパラメーター
名前	説明
フィールドの名前と値のペア	関係者レコードをフィルタリングするために使用するフィールドと値のペア。デフォルトでは、これは販売済み製品 [sn_install_base_sold_product] テーブルのフィールドを参照します。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。たとえば、特定のアカウントに販売された商品をフィルタリングする場合は、渡された値がアカウントのsys_idである `&account=86837a386f0331003b3c498f5d3ee4ca` のようなものを渡します。データタイプ：文字列デフォルト：すべてのフィールド
sys_class_name	拡張販売済み製品テーブル (sn_install_base_sold_productではない) を使用している場合、クエリーする拡張テーブルの名前。データタイプ：文字列デフォルト:sn_install_base_sold_product
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。データタイプ：数値デフォルト値：10
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。データタイプ：数値デフォルト：0

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

ヘッダー

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

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

ステータスコード

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

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


名前	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
has_more	返すレコードが他にもテーブルにあるかどうかを示すフラグ。可能な値： true:返されるレコードが増えます。 false:返すレコードがこれ以上ありません。データタイプ:ブーリアン文字列
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列
作業指示	指定されたインストールベースアイテムレコードに関連付けられた作業指示書のリスト。データタイプ：オブジェクトのアレイ "workorders":[ { "active": "String", "approval": {Object}, "billable": "String", "escalation": "String", "has_appointment": "String", "hierarchical_variables": "String", "impact": "String", "install_base_item": {Object}, "is_catalog": "String", "knowledge": "String", "location": {Object}, "made_sla": "String", "needs_attention": "String", "number": "String", "opened_at": {Object}, "opened_by": {Object}, "opened_for": {Object}, "priority": "String", "reassignment_count": "String", "reschedule_maintenance_if_canceled": "String", "short_description": "String", "sla_suspended": "String", "state": "String", "sys_class_name": "String", "sys_domain_path": "String" "sys_id": "String", "task_created": "String", "task_effective_number": "String", "template_workflow_invoked": "String", "upon_approval": {Object}, "upon_reject": {Object}, "urgency": "String" } ]
workorders.active	作業指示がアクティブかどうかを示すフラグ。可能な値： true:作業指示書はアクティブです。 false:作業指示書は非アクティブです。データタイプ:ブーリアン文字列
workorders.approval	作業指示の現在の承認プロセスに関する詳細。データタイプ: オブジェクト `"approval": { "display_value": "String", "value": "String" }`
作業指示書。approval.display_value	承認プロセスの現在のステータスを示すテキスト文字列。この値を使用して、承認ステータスを UI に表示します。データタイプ：文字列
作業指示書。approval.value	承認プロセスのステータスの内部値。データタイプ：文字列
作業指示書。請求	作業指示が請求可能かどうかを示すフラグ。可能な値： true:作業指示書は請求可能です。 false:作業指示書は請求できませんデータタイプ:ブーリアン文字列
作業指示書。エスカレーション	作業指示のエスカレーションレベル。データタイプ：文字列
作業指示書。has_appointment	作業指示にスケジュールされた予約があるかどうかを示すフラグ。可能な値： true:作業指示に予約があります。 false:作業指示に予約がありません。データタイプ:ブーリアン文字列
作業指示書。install_base_item	作業指示レコードに関連付けられたインストールベースアイテムの詳細。データタイプ: オブジェクト `"install_base_item": { "display_value": "String", "sys_id": "String" }`
作業指示書。install_base_item。display_value	作業指示レコードに関連付けられたインストールベースアイテムのテキスト名。この値を使用して、インストールベースアイテム名を UI に表示します。データタイプ：文字列
作業指示書。install_base_item.sys_id	作業指示レコードに関連付けられたインストールベースアイテムレコードのSys_id。データタイプ：文字列
作業指示書。is_catalog	がカタログに含まれているかどうかを示すフラグ。可能な値： true:作業指示はカタログの一部です。 false:作業指示はカタログに含まれません。データタイプ:ブーリアン文字列
workorders.knowledge	指定された作業指示書の問題に利用可能なナレッジベース記事があるかどうかを示すフラグ。可能な値： true:この問題のナレッジベース記事が利用可能です。 false:ナレッジベース記事はこの問題に利用できません。データタイプ:ブーリアン文字列
workorders.location	作業が必要なアイテムの場所に関する詳細。データタイプ: オブジェクト `"location": { "display_value": "String", "sys_id": "String" }`
作業指示書。場所。display_value	作業するアイテムの場所のテキスト名。この値を使用して、UI に場所を表示します。データタイプ：文字列
作業指示書。場所。sys_id	作業指示レコードに関連付けられた場所レコードのSys_id。データタイプ：文字列
作業指示書。made_sla	作業指示書に関連付けられた作業が、関連するサービスレベルアグリーメント (SLA) を満たしているかどうかを示すフラグ。可能な値： true:SLA が満たされています。 false:SLA が満たされていません。データタイプ:ブーリアン文字列
作業指示書。needs_attention	この作業指示に注意が必要かどうかを示すフラグ。可能な値： true:作業指示に注意が必要です。 false:作業指示に注意は必要ありません。データタイプ:ブーリアン文字列
作業指示書。数	作業指示書の識別に使用される一意の番号。データタイプ：文字列
作業指示書。opened_at	作業指示書がオープンされたときの詳細。データタイプ: オブジェクト `"opened_at": { "display_value": "String", "value": "String" }`
作業指示書。opened_at。display_value	作業指示書がオープンされた日時。この値を使用して、値を UI に表示します。データタイプ：文字列
作業指示書。opened_at。価値	作業指示書がオープンされた日時。データタイプ：文字列
作業指示書。opened_by	作業指示書をオープンした人物の詳細。データタイプ: オブジェクト `"opened_by": { "display_value": "String", "sys_id": "String" }`
作業指示書。opened_by。display_value	作業指示書をオープンした人物のテキスト名。この値を使用して、この名前を UI に表示します。データタイプ：文字列
作業指示書。opened_by。sys_id	作業指示書を開いたユーザーのユーザーレコードSys_id。データタイプ：文字列
workorders.opened_for	作業指示書がオープンされた人物の詳細 ( opened_by 者と異なる場合)。データタイプ: オブジェクト `"opened_for": { "display_value": "String", "sys_id": "String" }`
作業指示書。opened_for。display_value	作業指示書がオープンされた対象者のテキスト名。この値を使用して、この名前を UI に表示します。データタイプ：文字列
作業指示書。opened_for。sys_id	作業指示書がオープンされた対象者のユーザーレコードのSys_id。データタイプ：文字列
workorders.priority	作業指示の優先度。データタイプ：文字列
作業指示書。reassignment_count	作業指示書が、作業指示書の進行を担当する人物に再アサインされた回数。データタイプ：文字列
作業指示書。reschedule_maintenance_if_canceled	関連する作業指示書がキャンセルされた場合に作業を再スケジュールするかどうかを示すフラグ。可能な値： true:作業を再スケジュールします。 false:作業を再スケジュールする前に確認します。データタイプ:ブーリアン文字列
作業指示書。short_description	作業指示に関連する作業を説明する簡単なテキスト。データタイプ：文字列
作業指示書。sla_suspended	作業指示書に関連付けられた SLA が一時停止されているかどうかを示すフラグ。有効な値： true:SLA が中断されました。 false:SLA は一時停止されていません。データタイプ:ブーリアン文字列
workorders.state	作業指示の現在のステータス。データタイプ：文字列
作業指示書。sys_class_name	作業指示レコードを含むテーブル。データタイプ：文字列
作業指示書。sys_domain_path	ドメインパス。データタイプ：文字列
workorders.sys_id	関連付けられた作業指示レコードのSys_id。データタイプ：文字列
作業指示書。task_created	この作業指示書のタスクが作成されたかどうかを示すフラグ。可能な値： true:この作業指示書のタスクが作成されました。 false:この作業指示書のタスクが作成されていません。データタイプ:ブーリアン文字列
作業指示書。task_effective_number	作業指示書の識別に使用される一意の番号。データタイプ：文字列
作業指示書。template_workflow_invoked	この作業指示書に対して関連ワークフローが呼び出されたかどうかを示すフラグ。可能な値： true:ワークフローが呼び出されました。 false:ワークフローは呼び出されていません。データタイプ:ブーリアン文字列
作業指示書。upon_approval	作業指示が承認された場合に実行する次のアクションに関する詳細。データタイプ: オブジェクト `"upon_approval": { "display_value": "String", "value": "String" }`
作業指示書。upon_approval。display_value	作業指示が承認された場合に実行するアクションのテキスト文字列。この値を使用して、この情報を UI に表示します。データタイプ：文字列
作業指示書。upon_approval。価値	作業指示が承認された場合に実行するアクション。可能な値： do_nothing proceed データタイプ：文字列
作業指示書。upon_reject	作業指示書が却下された場合に実行する次のアクションに関する詳細。データタイプ: オブジェクト `"upon_reject": { "display_value": "String", "value": "String" }`
作業指示書。upon_reject。display_value	作業指示が却下された場合に実行するアクションのテキスト文字列。この値を使用して、この情報を UI に表示します。データタイプ：文字列
作業指示書。upon_reject。価値	作業指示書が却下された場合に取るアクション。可能な値： cancel goto データタイプ：文字列
workorders.urgency	作業指示書の緊急度。データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/workorders?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "workorders": [
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "WO0010372",
        "state": "1",
        "template_workflow_invoked": "false",
        "knowledge": "false",
        "impact": "3",
        "active": "true",
        "priority": "4",
        "sys_domain_path": "/",
        "sla_suspended": "false",
        "needs_attention": "false",
        "short_description": "Test WO1",
        "sys_class_name": "wm_order",
        "reschedule_maintenance_if_canceled": "true",
        "reassignment_count": "0",
        "hierarchical_variables": "variable_pool",
        "opened_for": {
          "sys_id": "85453c616fc331003b3c498f5d3ee4fa",
          "display_value": "Jodi Seals"
        },
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "has_appointment": "false",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "spam": "false",
        "made_sla": "true",
        "is_catalog": "false",
        "task_effective_number": "WO0010372",
        "opened_by": {
          "sys_id": "85453c616fc331003b3c498f5d3ee4fa",
          "display_value": "Jodi Seals"
        },
        "opened_at": {
          "value": "2023-03-20 13:33:22",
          "display_value": "2023-03-20 06:33:22"
        },
        "task_created": "false",
        "sys_id": "19761cc087b521100b6afc86dabb352f",
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "billable": "false",
        "location": {
          "sys_id": "1cd145bc23070110766713d1d7bf654f",
          "display_value": "2866 Stevens Creek Blvd,Santa Clara,CA"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

インストールベースアイテム:PATCH /sn_install_base/integrations/installbaseitems/{id}

指定されたインストールベースアイテムレコードを指定されたフィールド値で更新します。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}

注:

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

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

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

表 : 69. 要求本文パラメーター (XML または JSON)
名前	説明
アカウント	アカウントのインストールベースアイテムを作成するときに必要です。インストールベースアイテムに関連付けるアカウントのSys_id。注: account パラメーターを渡す場合、consumer パラメーターも渡すことはできません。データタイプ：文字列テーブル:アカウント [customer_account]
アクティブ	インストールベースアイテムがアクティブかどうかを示すフラグ。有効な値： true、「true」、または「0」:アイテムはアクティブです。 false、「false」、または「1」:アイテムはアクティブではありません。データタイプ：ブーリアンデフォルト：true
資産	インストールベースアイテムレコードに関連付けられた資産のSys_id。データタイプ：文字列テーブル:資産 [alm_asset]
child_install_base_items	このインストールベースアイテムに関連付けられた子インストールベースアイテムのリスト。注: 次の子インストールベースアイテムフィールドは、その親と異なることはできません。アカウント consumer 連絡先サービス組織データタイプ：オブジェクトのアレイ `"child_install_base_items": [ { "name": "String", "product": "String" } ]`
child_install_base_items.name	子インストールベースアイテムの名前。データタイプ：文字列
child_install_base_items.product	関連付けられた子ベースアイテムレコードのSys_id。データタイプ：文字列テーブル:インストールベースアイテム [sn_install_base_item]
configuration_item	インストールベースアイテムレコードに関連付けられた構成アイテムのSys_id。データタイプ：文字列テーブル:構成アイテム [cmdb_ci]
consumer	コンシューマーのインストールベースアイテムを作成するときに必要です。インストールベースアイテムレコードに関連付けられたコンシューマーのSys_id。注: consumer パラメーターを渡す場合、account パラメーターも渡すことはできません。また、B2B2C プラグインがインスタンスにインストールされている場合にのみ、コンシューマーをインストールベースアイテムに関連付けることができます。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
consumer_profile	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルのSys_id。データタイプ：文字列テーブル:消費者プロファイル [sn_csm_consumer_profile]
連絡先	インストールベースアイテムに対して主に責任を負うアカウント連絡先レコードのSys_id。注: 連絡先は、アカウントのインストールベースアイテムに対してのみ指定できます。データタイプ：文字列テーブル:連絡先 [customer_contact]
世帯	インストールベースアイテムレコードに関連付けられた世帯のSys_id。注: このフィールドは、カスタマーサービス世帯 (com.snc.household) プラグインがインストールされている場合にのみ有効です。データタイプ：文字列テーブル:世帯 [csm_household]
install_date	インストールベースアイテムがアクティブになる日付。データタイプ：文字列形式：yyyy-MM-dd HH:mm:ss
場所	関連製品の場所のSys_id。データタイプ：文字列テーブル:場所 [cmn_location]
名前	インストールベースアイテムの名前。データタイプ：文字列
番号	インストールベースアイテムの一意の識別子。データタイプ：文字列デフォルト:エンドポイントによって自動的に生成されます。
親	このインストールベースアイテムレコードの親レコードのSys_id。データタイプ：文字列テーブル:インストールベースアイテム [sn_install_base_item]
product_model	インストールベースアイテムレコードに関連付けられた製品モデルのSys_id。データタイプ：文字列テーブル:製品モデル [cmdb_model]
数量	インストールされているアイテムの数。データタイプ：整数
service_context	イベント管理から影響度の重大度を計算するために基になる CI に関連付けられているサービスのSys_id。詳細については、「Service health status for install base」を参照してください。注: このフィールドは、イベント管理によるプロアクティブカスタマーサービスオペレーションプラグインがインストールされている場合にのみ有効です。データタイプ：文字列
service_organization	サービス組織のインストールベースアイテムを作成するときに必要です。顧客にサービスを提供する際に関与するサービス組織レコードのSys_id。注: このパラメーターを渡す場合は、アカウント、連絡先、またはコンシューマーのパラメーターも渡さないでください。service_organization パラメーターは、Service Organization (com.snc.service_organization) プラグインがインスタンスにインストールされている場合にのみ使用できます。データタイプ：文字列テーブル:サービス組織 [sn_customer_service_organization]
状況	インストールベースアイテムの現在のステータス。有効な値： in_use 非アクティブデータタイプ：文字列
ステータス	製品のステータス。有効な値：オリジナル置換データタイプ：文字列
sys_class_name	インストールベースアイテムレコードを更新する拡張インストールベーステーブルの名前。データタイプ：文字列
uninstall_date	インストールベースが非アクティブになる日付。データタイプ：文字列形式：yyyy-MM-dd HH:mm:ss

ヘッダー

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

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

ステータスコード

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

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


名前	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
item	更新されたインストールベースアイテムの詳細。データタイプ: オブジェクト `"item": { "account": {Object}, "active": Boolean, "name": "String", "number": "String", "state": {Object}, "sys_class_name": {Object}, "sys_id": "String" }`
item.account	インストールベースアイテムレコードに関連付けられた顧客アカウントの詳細。データタイプ: オブジェクト `"account": { "display_value": "String", "sys_id": "String" }`
item.account.display_value	インストールベースアイテムレコードに関連付けられた顧客アカウントのテキスト名。この値を使用して、UI に顧客アカウント名を表示します。データタイプ：文字列
item.account.sys_id	インストールベースアイテムレコードに関連付けられた顧客アカウントレコードのSys_id。データタイプ：文字列
item.active	インストールベースアイテムがアクティブかどうかを示すフラグ。可能な値： true:インストールベースアイテムはアクティブです。 false:インストールベースアイテムは非アクティブです。データタイプ:ブーリアン文字列
item.name	インストールベースアイテムの名前。データタイプ：文字列
item.number	インストールベースアイテムの一意の ID。データタイプ：文字列
item.state	インストールベースアイテムの現在のステータスに関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
item.state.display_value	インストールベースアイテムの現在のステータスを示すテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
item.state.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
item.sys_クラス_名	インストールベースアイテムを含むテーブルの詳細。データタイプ: オブジェクト `"sys_class_name": { "display_value": "String", "value": "String" }`
item.sys_class_name.display_value	インストールベースアイテムを含むテーブルの名前のテキスト文字列。この値を使用して、UI にテーブル名を表示します。データタイプ：文字列
item.sys_class_name.value	インストールベースアイテムを含むテーブルの内部値データタイプ：文字列
item.sys_id	インストールベースアイテムレコードのSys_id。sys_class_name パラメーターで指定されたテーブルにあります。データタイプ：文字列
ステータス	エンドポイントコールのステータス。データタイプ：文字列

cURL 要求

次のコード例は、インストールベースアイテムレコードの名前フィールドとアクティブフィールドを更新する方法を示しています。

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"KX Series - KX5001\",
  \"active\":true
}" \
--user 'username':'password'

返される結果：

{
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": {
        "value": "sn_install_base_item",
        "display_value": "Install Base Item"
      },
      "number": "IBITM0001001",
      "sys_id": "bc610d38cb76211050501ebfe8076d8b",
      "state": {
        "value": "inactive",
        "display_value": "Inactive"
      },
      "active": "false",
      "name": "NewTestIB",
      "account": {
        "sys_id": "8637a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}
      
}

インストールベースアイテム:PATCH /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

指定されたインストールベースアイテムに関連付けられた、指定された関係者レコードを要求本文の値で更新します。

インストールベースアイテムに関連付けられた関係者のタイプを変更する必要がある場合は、現在の関係者タイプのタイプ固有のフィールドを削除し、新しい関係者タイプのタイプ固有のフィールドに置き換える必要があります。たとえば、承認済みアカウントのタイプから認定コンシューマーに変更するには、以下を渡します。

type =「認定コンシューマー」
account = ""
consumer = 「コンシューマーレコードの<sys_id>」
responsibility =「消費者の責任<sys_id>」

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

注:

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

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

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

表 : 75. 要求本文パラメーター (XML または JSON)
名前	説明
アカウント	typeパラメーターが次のいずれかである場合は必須です。 `承認済みアカウント` `認定連絡先` `リストされたアカウント` `リストされた連絡先` インストールベースアイテムに関連付けるアカウントのSys_id。注: account パラメーターを渡す場合、consumer パラメーターも渡すことはできません。データタイプ：文字列テーブル:アカウント [customer_account]
consumer	typeパラメーターが`認定コンシューマー`または`リストコンシューマー`の場合は必須です。インストールベースアイテムレコードに関連付けられたコンシューマーのSys_id。注: consumer パラメーターを渡す場合、account パラメーターも渡すことはできません。また、B2B2C プラグインがインスタンスにインストールされている場合にのみ、コンシューマーをインストールベースアイテムに関連付けることができます。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
連絡先	関係者レコードに関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
責任	関連付けられた責任レコードのSys_id。このレコードは、インストールベース情報のアクセスレベルを定義します。このパラメーターは、[ related_party ] フィールドも指定されている場合にのみ有効です。指定した場合、 related_party パラメーターと responsibility パラメーターの両方に一致するインストールベースアイテムのみを返します。詳細については次を参照してください。 Configure related parties for items received データタイプ：文字列テーブル:責任の定義 [sn_customerservice_responsibility_def]
service_organization	typeパラメーターが次のいずれかである場合は必須です。 `認定メンバー` `認証サービス組織` `リストされたメンバー` `リストされたサービス組織` 顧客にサービスを提供する際に関与するサービス組織レコードのSys_id。注: このパラメーターを渡す場合は、アカウント、連絡先、またはコンシューマーのパラメーターも渡さないでください。service_organization パラメーターは、Service Organization (com.snc.service_organization) プラグインがインスタンスにインストールされている場合にのみ使用できます。データタイプ：文字列テーブル:サービス組織 [sn_customer_service_organization]
sys_class_name	関係者レコードを含むテーブル。データタイプ：文字列デフォルト:sn_install_base_related_party
type	必須。作成する関係者のタイプSys_id。可能なタイプ: 承認済みアカウント認定コンシューマー認定連絡先認定貢献者認定メンバー認証サービス組織リストされたアカウントリストされたコンシューマーリストされた連絡先リストされた貢献者リストされたメンバーリストされたサービス組織データタイプ：文字列テーブル:関係者構成 [sn_customerservice_related_party_configuration]
user	typeパラメーターが次の関係者タイプのいずれかである場合は必須です。 `認定貢献者` `認定メンバー` `リストされた貢献者` `リストされたメンバー` 関係者レコードに関連付けられたユーザーレコードのSys_id。データタイプ：文字列テーブル:ユーザー [sys_user] `認定メンバー`および`リストメンバー`の場合、このユーザーは指定されたservice_organizationレコードに関連付けられている必要があります。

ヘッダー

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

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

ステータスコード

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

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


名前	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
item	関係者レコードの詳細。データタイプ：アレイ `"item": { "account": {Object}, "consumer": {Object}, "contact": {Object}, "install_base_item": {Object}, "responsibility": {Object}, "service_organization": {Object}, "sys_class_name": "String", "sys_id": "String", "type": {Object}, "user": {Object} }`
item.account	関係者レコードに関連付けられたアカウントの詳細。データタイプ: オブジェクト `account": { "display_value": "String", "sys_id": "String" }`
item.account.display_value	関係者レコードに関連付けられたアカウントのテキスト名。この値を使用して、アカウント名を UI に表示します。データタイプ：文字列
item.account.sys_id	関係者レコードに関連付けられたアカウントレコードのSys_id。データタイプ：文字列
item.consumer	関係者レコードに関連付けられたコンシューマーの詳細。データタイプ: オブジェクト `"consumer": { "display_value": "String", "sys_id": "String" }`
item.consumer.display_value	関係者レコードに関連付けられたコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。データタイプ：文字列
item.consumer.sys_id	関係者レコードに関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列
item.contact	関係者レコードを担当するアカウント連絡先の詳細。データタイプ: オブジェクト `"contact": { "display_value": "String", "sys_id": "String" }`
item.contact.display_value	関係者レコードに関連付けられた連絡先のテキスト名。この値を使用して、連絡先名を UI に表示します。データタイプ：文字列
item.contact.sys_id	関係者レコードに関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
item.install_base_item	関係者レコードに関連付けられたインストールベースアイテムの詳細。データタイプ: オブジェクト `"install_base_item": { "display_value": "String", "sys_id": "String" }`
item.install_base_item.display_value	関係者レコードに関連付けられたインストールベースアイテムのテキスト名。この値を使用して、インストールベースアイテム名を UI に表示します。データタイプ：文字列
item.install_base_item.sys_id	関係者レコードに関連付けられたインストールベースアイテムレコードのSys_id。データタイプ：文字列
item.responsibility	インストールベース情報のアクセスレベルに関する詳細。データタイプ: オブジェクト `"responsibility": { "display_value": "String", "sys_id": "String" }`
item.responsibility.display_value	インストールベース情報のアクセスレベルのテキスト表示値。データタイプ：文字列
item.responsibility.sys_id	関連付けられた責任レコードのSys_id。このレコードは、インストールベース情報のアクセスレベルを定義します。このパラメーターは、[ related_party ] フィールドも指定されている場合にのみ有効です。指定した場合、 related_party パラメーターと responsibility パラメーターの両方に一致するインストールベースアイテムのみを返します。詳細については次を参照してください。 Configure related parties for items received データタイプ：文字列テーブル:責任の定義 [sn_customerservice_responsibility_def]
item.sys_クラス_名	関係者レコードを含むテーブル。データタイプ：文字列デフォルト:sn_install_base_related_party
item.sys_id	関連する関係者レコードのSys_id。データタイプ：文字列
item.type	関係者レコードに関連付けられた連絡先のタイプに関する詳細。データタイプ: オブジェクト `"type": { "display_value": "String", "sys_id": "String" }`
item.type.display_value	関係者レコードに関連付けられた連絡先タイプのテキスト名。この値を使用して、連絡先のタイプを UI に表示します。詳細については、「Create related party configurations」を参照してください。可能なタイプ: 承認済みアカウント認定コンシューマー認定連絡先認定貢献者認定メンバー認証サービス組織リストされたアカウントリストされたコンシューマーリストされた連絡先リストされた貢献者リストされたメンバーリストされたサービス組織データタイプ：文字列
item.type.sys_id	関係者レコードに関連付けられたタイプレコードのSys_id。データタイプ：文字列
item.user	関係者レコードに関連付けられたユーザーの詳細。データタイプ: オブジェクト `"user": { "display_value": "String", "sys_id": "String" }`
item.user.display_value	関係者レコードに関連付けられたユーザーのテキスト名。この値を使用して、UI にユーザー名を表示します。データタイプ：文字列
item.user.sys_id	関係者レコードに関連付けられたユーザーレコードのSys_id。データタイプ：文字列テーブル:ユーザー [sys_user]
status	エンドポイントコールのステータス。データタイプ：文字列
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを呼び出して、関係者に関連付けられた連絡先レコードを更新する方法を示しています。

curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"contact\": \"dc0185d94f341200025ba3618110c77c\"
}" \
--user 'username':'password'

返される結果：

{
"result":
  {
    "type": {
      "display_value":"Authorized Contact",
      "sys_id":"68ec8b2965e99110f87764df53db779f"
    },
    "install_base_item": {
      "display_value":"KX Series - KX5000",
      "sys_id":"f77c7542b7343300ece839a6ee11a991"
    },
    "sys_class_name":"sn_install_base_related_party",
    "sys_id":"4659539814ac6910f877ae314c1fb43a",
    "responsibility": {
      "display_value":"Authorized Representative",
      "sys_id":"c009bbedb3730010700b4d43c6a8dcef"
    },
    "contact": {
      "display_value":"Cindy Contact",
      "sys_id":"dc0185d94f341200025ba3618110c77c"
    },
    "account": {
      "display_value":"Boxeo",
      "value":"86837a386f0331003b3c498f5d3ee4ca"
    },
    "status":"SUCCESS",
  }
}

インストールベースアイテム:PATCH /sn_install_base/integrations/installbaseitems/{id}/uninstall

指定されたインストールベースアイテムをアンインストールします。

アンインストールは、[ active ] フィールドを false に設定し、[ unistall_date ] フィールドを指定された日付に設定することで構成されます。日付値が指定されていない場合は空です。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/uninstall

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/uninstall

注:

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

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

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

表 : 81. 要求本文パラメーター (XML または JSON)
名前	説明
uninstall_date	指定されたインストールベースアイテムをアンインストールする日付。指定しない場合は、すぐにアンインストールされます。データタイプ：文字列形式：yyyy-mm-dd hh:mm:ss

ヘッダー

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

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

ステータスコード

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

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


名前	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
item	アンインストールされたアイテムの説明。データタイプ: オブジェクト "item": { "account": {Object}, "active": "String", "asset": {Object}, "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": {Object}, "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "service_context": {Object}, "service_organization" {Object}, "sys_class_name": "String", "sys_id": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" }
item.account	インストールベースアイテムレコードに関連付けられた顧客アカウントの詳細。データタイプ: オブジェクト `"account": { "display_value": "String", "sys_id": "String" }`
item.account.display_value	インストールベースアイテムレコードに関連付けられた顧客アカウントのテキスト名。この値を使用して、UI に顧客アカウント名を表示します。データタイプ：文字列
item.account.sys_id	インストールベースアイテムレコードに関連付けられた顧客アカウントレコードのSys_id。データタイプ：文字列
item.active	インストールベースアイテムがアクティブかどうかを示すフラグ。可能な値： true:インストールベースアイテムはアクティブです。 false:インストールベースアイテムは非アクティブです。データタイプ:ブーリアン文字列
item.asset	インストールベースアイテムレコードに関連付けられた資産の詳細。データタイプ: オブジェクト `"asset": { "display_value": "String", "sys_id": "String" }`
item.asset.display_value	インストールベースアイテムレコードに関連付けられた資産のテキスト名。この値を使用して、UI に資産名を表示します。データタイプ：文字列
item.asset.sys_id	インストールベースアイテムレコードに関連付けられた資産レコードのSys_id。データタイプ：文字列
item.child_install_base_items	このインストールベースアイテムに関連付けられた子インストールベースアイテムのリスト。注: 次の子インストールベースアイテムフィールドは、その親と異なることはできません。アカウント consumer 連絡先サービス組織データタイプ：オブジェクトのアレイ `"child_install_base_items": [ { "name": "String", "product": "String" } ]`
item.child_install_base_items.name	子インストールベースアイテムの名前。データタイプ：文字列
item.child_install_base_items.product	関連付けられた子ベースアイテムレコードのSys_id。データタイプ：文字列テーブル:インストールベースアイテム [sn_install_base_item]
item.configuration_item	インストールベースアイテムレコードに関連付けられた構成アイテムの詳細。データタイプ: オブジェクト `"configuration_item": { "display_value": "String", "sys_id": "String" }`
item.configuration_display_value	インストールベースアイテムレコードに関連付けられた構成アイテムのテキスト名。この値を使用して、UI に構成アイテム名を表示します。データタイプ：文字列
item.configuration_sys_id	インストールベースアイテムレコードに関連付けられた構成アイテムレコードのSys_id。データタイプ：文字列
item.consumer	インストールベースアイテムレコードに関連付けられたコンシューマーの詳細。注: コンシューマーフィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer": { "display_value": "String", "sys_id": "String" }`
item.consumer.display_value	インストールベースアイテムレコードに関連付けられたコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。データタイプ：文字列
item.consumer.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列
item.consumer_profile	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルの詳細。注: [コンシューマープロファイル] フィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer_profile": { "display_value": "String", "sys_id": "String" }`
item.consumer_profile.display_value	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルのテキスト名。この値を使用して、UI にコンシューマープロファイル名を表示します。データタイプ：文字列
item.consumer_profile.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルレコードのSys_id。データタイプ：文字列
item.contact	インストールベースアイテムレコードを担当するアカウント連絡先の詳細。データタイプ: オブジェクト `"contact": { "display_value": "String", "sys_id": "String" }`
item.contact.display_value	インストールベースアイテムレコードに関連付けられたアカウント連絡先のテキスト名。この値を使用して、アカウントの連絡先名を UI に表示します。データタイプ：文字列
item.contact.sys_id	インストールベースアイテムレコードに関連付けられたアカウント連絡先レコードのSys_id。データタイプ：文字列
item.health_status	インストールベースアイテムの現在の健全性ステータスに関する詳細。プロアクティブカスタマーサービスオペレーション (com.snc.proactive_cs_itom) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"health_status": { "display_value": "String", "value": "String" }`
item.health_status.display_value	インストールベースアイテムの現在の健全性ステータスを示すテキスト文字列。この値を使用して、UI に健康状態を表示します。データタイプ：文字列
item.health_status.value	インストールベースアイテムの健全性ステータスの内部値。データタイプ：文字列
item.health_status_last_updated	インストールベースアイテムの健全性ステータスが最後に更新された日時。データタイプ：文字列
item.household	インストールベースアイテムレコードに関連付けられた世帯の詳細。カスタマーサービス世帯 (com.snc.household) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"household": { "display_value": "String", "sys_id": "String" }`
item.household.display_value	インストールベースアイテムレコードに関連付けられた世帯のテキスト名。この値を使用して、UI に世帯名を表示します。データタイプ：文字列
item.household.sys_id	インストールベースアイテムレコードに関連付けられた世帯のSys_id。データタイプ：文字列
item.install_date	インストールベースアイテムがアクティブになった日付に関する詳細。データタイプ: オブジェクト `"install_date": { "display_value": "String", "value": "String" }`
item.install_date.display_value	テキストインストール日。この値を使用して、インストール日を UI に表示します。データタイプ：文字列
item.install_date.value	インストール日の内部値。データタイプ：文字列
item.location	インストールベースアイテムの場所に関する詳細。データタイプ: オブジェクト `"location": { "display_value": "String", "sys_id": "String" }`
item.location.display_value	インストールベースアイテムの場所のテキスト名。この値を使用して、場所の名前を UI に表示します。データタイプ：文字列
item.location.sys_id	インストールベースアイテムレコードに関連付けられた場所レコードのSys_id。データタイプ：文字列
item.name	インストールベースアイテムの名前。データタイプ：文字列
item.number	インストールベースアイテムの一意の ID。データタイプ：文字列
item.parent	インストールベースアイテムレコードの親レコードに関する詳細。データタイプ: オブジェクト `"parent": { "display_value": "String", "sys_id": "String" }`
item.parent.display_value	インストールベースアイテムレコードに関連付けられた親レコードのテキスト名。この値を使用して、UI に親名を表示します。データタイプ：文字列
item.parent.sys_id	インストールベースアイテムレコードに関連付けられた親レコードのSys_id。データタイプ：文字列
item.product	インストールベースアイテムレコードに関連付けられた製品モデルの詳細。この情報を使用して、製品モデルに関連付けられたサービスを識別します。データタイプ: オブジェクト `"product": { "display_value": "String", "sys_id": "String" }`
item.product.display_value	インストールベースアイテムレコードに関連付けられた製品モデルのテキスト名。この値を使用して、UI に製品名を表示します。データタイプ：文字列
item.product.sys_id	インストールベースアイテムレコードに関連付けられた製品モデルレコードのSys_id。データタイプ：文字列
item.quantity	インストールされているアイテムの数。データタイプ：整数
item.service_context	インストールベースアイテムレコードに関連付けられたサービスコンテキストの詳細。データタイプ: オブジェクト `"service_context": { "display_value": "String", "sys_id": "String" }`
item.service_context.display_value	インストールベースアイテムレコードに関連付けられたサービスコンテキストの詳細。データタイプ: オブジェクト `"service_context": { "display_value": "String", "sys_id": "String" }`
item.service_context.sys_id	インストールベースアイテムレコードに関連付けられたサービスコンテキストレコードのSys_id。データタイプ：文字列
item.service_organization	インストールベースアイテムレコードに関連付けられたサービス組織に関する詳細。Service Organization (com.snc.service_organization) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"service_organization": { "display_value": "String", "sys_id": "String" }`
item.service_organization.display_value	インストールベースアイテムレコードに関連付けられたサービス組織のテキスト名。この値を使用して、サービス組織名を UI に表示します。データタイプ：文字列
item.service_organization.sys_id	インストールベースアイテムレコードに関連付けられたサービス組織レコードのSys_id。データタイプ：文字列
item.sys_クラス_名	インストールベースアイテムレコードを含むテーブル。データタイプ：文字列
item.sys_id	インストールベースアイテムレコードのSys_id。sys_class_name パラメーターで指定されたテーブルにあります。データタイプ：文字列
item.state	インストールベースアイテムの現在のステータスに関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
item.state.display_value	インストールベースアイテムの現在のステータスを示すテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
item.state.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
item.status	インストールベースアイテムのステータスに関する詳細。データタイプ: オブジェクト `"status": { "display_value": "String", "value": "String" }`
item.status.display_value	インストールベースアイテムのステータスのテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
item.status.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
item.uninstall_date	インストールベースアイテムが非アクティブになった日付に関する詳細。データタイプ: オブジェクト `"uninstall_date": { "display_value": "String", "value": "String" }`
item.uninstall_date.display_value	テキストのアンインストール日。この値を使用して、アンインストール日を UI に表示します。データタイプ：文字列
item.uninstall_date.value	アンインストール日の内部値。データタイプ：文字列
status	エンドポイントコールのステータス。データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/uninstall" \
--request PATCH \
--header "Accept:application/json" \
--user 'username':'password'

返される結果：

{
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": {
        "value": "sn_install_base_item",
        "display_value": "Install Base Item"
      },
      "number": "IBITM0000901",
      "sys_id": "f77c7542b7343300ece839a6ee11a991",
      "contact": {
        "sys_id": "4d147a386f0331003b3c498f5d3ee437",
        "display_value": "Julie Lewis"
      },
      "state": {
        "value": "inactive",
        "display_value": "Inactive"
      },
      "active": "false",
      "configuration_item": {
        "sys_id": "e5a28e07c30202001efd5cb981d3aedb",
        "display_value": "KX Series - KX5000"
      },
      "name": "KX Series - KX5000",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}

インストールベースアイテム:POST /sn_install_base/integrations/installbaseitems

デフォルトのインストールベースアイテムテーブル、またはその拡張テーブル (指定されている場合) に 1 つ以上のインストールベースアイテムレコードを作成し、指定されたフィールド値を設定します。

単一のインストールベースアイテムレコードを作成する場合は、要求本文に含めるすべてのフィールドを含むオブジェクトを要求本文に渡します。1 回の呼び出しで複数のインストールベースアイテムレコードを作成すると、作成するすべてのレコードを含むオブジェクトのアレイを要求本文に渡します。エンドポイントは、各レコード作成オブジェクトを個別に処理してレポートします。1 つ以上のレコードの作成に失敗した場合、他のレコードの作成には影響しません。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems

デフォルト URL: /api/sn_install_base/integrations/installbaseitems

注:

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

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

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

表 : 87. 要求本文パラメーター (XML または JSON)
名前	説明
アカウント	アカウントのインストールベースアイテムを作成するときに必要です。インストールベースアイテムに関連付けるアカウントのSys_id。注: account パラメーターを渡す場合、consumer パラメーターも渡すことはできません。データタイプ：文字列テーブル:アカウント [customer_account]
アクティブ	インストールベースアイテムがアクティブかどうかを示すフラグ。有効な値： true、「true」、または「0」:アイテムはアクティブです。 false、「false」、または「1」:アイテムはアクティブではありません。データタイプ：ブーリアンデフォルト：true
資産	インストールベースアイテムレコードに関連付けられた資産のSys_id。データタイプ：文字列テーブル:資産 [alm_asset]
child_install_base_items	このインストールベースアイテムに関連付けられた子インストールベースアイテムのリスト。注: 次の子インストールベースアイテムフィールドは、その親と異なることはできません。アカウント consumer 連絡先サービス組織データタイプ：オブジェクトのアレイ `"child_install_base_items": [ { "name": "String", "product": "String" } ]`
child_install_base_items.name	子インストールベースアイテムの名前。データタイプ：文字列
child_install_base_items.product	関連付けられた子ベースアイテムレコードのSys_id。データタイプ：文字列テーブル:インストールベースアイテム [sn_install_base_item]
configuration_item	インストールベースアイテムレコードに関連付けられた構成アイテムのSys_id。データタイプ：文字列テーブル:構成アイテム [cmdb_ci]
consumer	コンシューマーのインストールベースアイテムを作成するときに必要です。インストールベースアイテムレコードに関連付けられたコンシューマーのSys_id。注: consumer パラメーターを渡す場合、account パラメーターも渡すことはできません。また、B2B2C プラグインがインスタンスにインストールされている場合にのみ、コンシューマーをインストールベースアイテムに関連付けることができます。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
consumer_profile	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルのSys_id。データタイプ：文字列テーブル:消費者プロファイル [sn_csm_consumer_profile]
連絡先	インストールベースアイテムに対して主に責任を負うアカウント連絡先レコードのSys_id。注: 連絡先は、アカウントのインストールベースアイテムに対してのみ指定できます。データタイプ：文字列テーブル:連絡先 [customer_contact]
世帯	インストールベースアイテムレコードに関連付けられた世帯のSys_id。注: このフィールドは、カスタマーサービス世帯 (com.snc.household) プラグインがインストールされている場合にのみ有効です。データタイプ：文字列テーブル:世帯 [csm_household]
install_date	インストールベースアイテムがアクティブになる日付。データタイプ：文字列形式：yyyy-MM-dd HH:mm:ss
場所	関連製品の場所のSys_id。データタイプ：文字列テーブル:場所 [cmn_location]
名前	インストールベースアイテムの名前。データタイプ：文字列
番号	インストールベースアイテムの一意の識別子。データタイプ：文字列デフォルト:エンドポイントによって自動的に生成されます。
親	このインストールベースアイテムレコードの親レコードのSys_id。データタイプ：文字列テーブル:インストールベースアイテム [sn_install_base_item]
product_model	インストールベースアイテムレコードに関連付けられた製品モデルのSys_id。データタイプ：文字列テーブル:製品モデル [cmdb_model]
数量	インストールされているアイテムの数。データタイプ：整数
service_context	イベント管理から影響度の重大度を計算するために基になる CI に関連付けられているサービスのSys_id。詳細については、「Service health status for install base」を参照してください。注: このフィールドは、イベント管理によるプロアクティブカスタマーサービスオペレーションプラグインがインストールされている場合にのみ有効です。データタイプ：文字列
service_organization	サービス組織のインストールベースアイテムを作成するときに必要です。顧客にサービスを提供する際に関与するサービス組織レコードのSys_id。注: このパラメーターを渡す場合は、アカウント、連絡先、またはコンシューマーのパラメーターも渡さないでください。service_organization パラメーターは、Service Organization (com.snc.service_organization) プラグインがインスタンスにインストールされている場合にのみ使用できます。データタイプ：文字列テーブル:サービス組織 [sn_customer_service_organization]
状況	インストールベースアイテムの現在のステータス。有効な値： in_use 非アクティブデータタイプ：文字列
ステータス	製品のステータス。有効な値：オリジナル置換データタイプ：文字列
sys_class_name	インストールベースアイテムレコードを作成する拡張インストールベーステーブルの名前。データタイプ：文字列デフォルト:インストールベースアイテム [sn_install_base_item] テーブル
uninstall_date	インストールベースが非アクティブになる日付。データタイプ：文字列形式：yyyy-MM-dd HH:mm:ss

ヘッダー

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

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

ステータスコード

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

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


名前	説明
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
item	指定されたフィルター結果に一致したインストールベースアイテム。空でないフィールドのみが返されます。データタイプ：オブジェクトのアレイ "item": { "account": {Object}, "active": "String", "asset": {Object}, "child_install_base_items": {Object}, "condition": "String", "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": {Object}, "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "quantity": Integer, "service_context": {Object}, "service_organization" {Object}, "sys_id": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" }
item.account	インストールベースアイテムレコードに関連付けられた顧客アカウントの詳細。データタイプ: オブジェクト `"account": { "display_value": "String", "sys_id": "String" }`
item.account.display_value	インストールベースアイテムレコードに関連付けられた顧客アカウントのテキスト名。この値を使用して、UI に顧客アカウント名を表示します。データタイプ：文字列
item.account.sys_id	インストールベースアイテムレコードに関連付けられた顧客アカウントレコードのSys_id。データタイプ：文字列
item.active	インストールベースアイテムがアクティブかどうかを示すフラグ。可能な値： true:インストールベースアイテムはアクティブです。 false:インストールベースアイテムは非アクティブです。データタイプ:ブーリアン文字列
item.asset	インストールベースアイテムレコードに関連付けられた資産の詳細。データタイプ: オブジェクト `"asset": { "display_value": "String", "sys_id": "String" }`
item.asset.display_value	インストールベースアイテムレコードに関連付けられた資産のテキスト名。この値を使用して、UI に資産名を表示します。データタイプ：文字列
item.asset.sys_id	インストールベースアイテムレコードに関連付けられた資産レコードのSys_id。データタイプ：文字列
item.child_install_base_items	このインストールベースアイテムに関連付けられた子インストールベースアイテムのリスト。注: 次の子インストールベースアイテムフィールドは、その親と異なることはできません。アカウント consumer 連絡先サービス組織データタイプ：オブジェクトのアレイ `"child_install_base_items": [ { "name": "String", "product": "String" } ]`
item.child_install_base_items.name	子インストールベースアイテムの名前。データタイプ：文字列
item.child_install_base_items.product	関連付けられた子ベースアイテムレコードのSys_id。データタイプ：文字列テーブル:インストールベースアイテム [sn_install_base_item]
item.configuration_item	インストールベースアイテムレコードに関連付けられた構成アイテムの詳細。データタイプ: オブジェクト `"configuration_item": { "display_value": "String", "sys_id": "String" }`
item.configuration_item.display_value	インストールベースアイテムレコードに関連付けられた構成アイテムのテキスト名。この値を使用して、UI に構成アイテム名を表示します。データタイプ：文字列
item.configuration_item.sys_id	インストールベースアイテムレコードに関連付けられた構成アイテムレコードのSys_id。データタイプ：文字列
item.consumer	インストールベースアイテムレコードに関連付けられたコンシューマーの詳細。注: コンシューマーフィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer": { "display_value": "String", "sys_id": "String" }`
item.consumer.display_value	インストールベースアイテムレコードに関連付けられたコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。データタイプ：文字列
item.consumer.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列
item.consumer_profile	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルの詳細。注: [コンシューマープロファイル] フィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。データタイプ: オブジェクト `"consumer_profile": { "display_value": "String", "sys_id": "String" }`
item.consumer_profile.display_value	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルのテキスト名。この値を使用して、UI にコンシューマープロファイル名を表示します。データタイプ：文字列
item.consumer_profile.sys_id	インストールベースアイテムレコードに関連付けられたコンシューマープロファイルレコードのSys_id。データタイプ：文字列
item.contact	インストールベースアイテムレコードを担当するアカウント連絡先の詳細。データタイプ: オブジェクト `"contact": { "display_value": "String", "sys_id": "String" }`
item.contact.display_value	インストールベースアイテムレコードに関連付けられたアカウント連絡先のテキスト名。この値を使用して、アカウントの連絡先名を UI に表示します。データタイプ：文字列
item.contact.sys_id	インストールベースアイテムレコードに関連付けられたアカウント連絡先レコードのSys_id。データタイプ：文字列
item.health_status	インストールベースアイテムの現在の健全性ステータスに関する詳細。プロアクティブカスタマーサービスオペレーション (com.snc.proactive_cs_itom) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"health_status": { "display_value": "String", "value": "String" }`
item.health_status.display_value	インストールベースアイテムの現在の健全性ステータスを示すテキスト文字列。この値を使用して、UI に健康状態を表示します。データタイプ：文字列
item.health_status.value	インストールベースアイテムの健全性ステータスの内部値。データタイプ：文字列
item.health_status_last_updated	インストールベースアイテムの健全性ステータスが最後に更新された日時。データタイプ：文字列
item.household	インストールベースアイテムレコードに関連付けられた世帯の詳細。カスタマーサービス世帯 (com.snc.household) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"household": { "display_value": "String", "sys_id": "String" }`
item.household.display_value	インストールベースアイテムレコードに関連付けられた世帯のテキスト名。この値を使用して、UI に世帯名を表示します。データタイプ：文字列
item.household.sys_id	インストールベースアイテムレコードに関連付けられた世帯のSys_id。データタイプ：文字列
item.install_date	インストールベースアイテムがアクティブになった日付に関する詳細。データタイプ: オブジェクト `"install_date": { "display_value": "String", "value": "String" }`
item.install_date.display_value	テキストインストール日。この値を使用して、インストール日を UI に表示します。データタイプ：文字列
item.install_date.value	インストール日の内部値。データタイプ：文字列
item.location	インストールベースアイテムの場所に関する詳細。データタイプ: オブジェクト `"location": { "display_value": "String", "sys_id": "String" }`
item.location.display_value	インストールベースアイテムの場所のテキスト名。この値を使用して、場所の名前を UI に表示します。データタイプ：文字列
item.location.sys_id	インストールベースアイテムレコードに関連付けられた場所レコードのSys_id。データタイプ：文字列
item.name	インストールベースアイテムの名前。データタイプ：文字列
item.number	インストールベースアイテムの一意の ID。データタイプ：文字列
item.parent	インストールベースアイテムレコードの親レコードに関する詳細。データタイプ: オブジェクト `"parent": { "display_value": "String", "sys_id": "String" }`
item.parent.display_value	インストールベースアイテムレコードに関連付けられた親レコードのテキスト名。この値を使用して、UI に親名を表示します。データタイプ：文字列
item.parent.sys_id	インストールベースアイテムレコードに関連付けられた親レコードのSys_id。データタイプ：文字列
item.product	インストールベースアイテムレコードに関連付けられた製品モデルの詳細。この情報を使用して、製品モデルに関連付けられたサービスを識別します。データタイプ: オブジェクト `"product": { "display_value": "String", "sys_id": "String" }`
item.product.display_value	インストールベースアイテムレコードに関連付けられた製品モデルのテキスト名。この値を使用して、UI に製品名を表示します。データタイプ：文字列
item.product.sys_id	インストールベースアイテムレコードに関連付けられた製品モデルレコードのSys_id。データタイプ：文字列
item.quantity	インストールされているアイテムの数。データタイプ：整数
item.service_context	インストールベースアイテムレコードに関連付けられたサービスコンテキストの詳細。データタイプ: オブジェクト `"service_context": { "display_value": "String", "sys_id": "String" }`
item.service_context.display_value	インストールベースアイテムレコードに関連付けられたサービスコンテキストの詳細。データタイプ: オブジェクト `"service_context": { "display_value": "String", "sys_id": "String" }`
item.service_context.sys_id	インストールベースアイテムレコードに関連付けられたサービスコンテキストレコードのSys_id。データタイプ：文字列
item.service_organization	インストールベースアイテムレコードに関連付けられたサービス組織に関する詳細。Service Organization (com.snc.service_organization) プラグインがインストールされている場合にのみ返されます。データタイプ: オブジェクト `"service_organization": { "display_value": "String", "sys_id": "String" }`
item.service_organization.display_value	インストールベースアイテムレコードに関連付けられたサービス組織のテキスト名。この値を使用して、サービス組織名を UI に表示します。データタイプ：文字列
item.service_organization.sys_id	インストールベースアイテムレコードに関連付けられたサービス組織レコードのSys_id。データタイプ：文字列
item.sys_クラス_名	インストールベースアイテムレコードを含むテーブル。データタイプ：文字列
item.sys_id	インストールベースアイテムレコードのSys_id。sys_class_name パラメーターで指定されたテーブルにあります。データタイプ：文字列
item.state	インストールベースアイテムの現在のステータスに関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
item.state.display_value	インストールベースアイテムの現在のステータスを示すテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
item.state.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
item.status	インストールベースアイテムのステータスに関する詳細。データタイプ: オブジェクト `"status": { "display_value": "String", "value": "String" }`
item.status.display_value	インストールベースアイテムのステータスのテキスト文字列。この値を使用して、UI にステータスを表示します。データタイプ：文字列
item.status.value	インストールベースアイテムのステータスの内部値。データタイプ：文字列
item.uninstall_date	インストールベースアイテムが非アクティブになった日付に関する詳細。データタイプ: オブジェクト `"uninstall_date": { "display_value": "String", "value": "String" }`
item.uninstall_date.display_value	テキストのアンインストール日。この値を使用して、アンインストール日を UI に表示します。データタイプ：文字列
item.uninstall_date.value	アンインストール日の内部値。データタイプ：文字列
ステータス	エンドポイントコールのステータス。データタイプ：文字列

cURL 要求

次のコード例は、単一のインストールベースアイテムレコードを作成する方法を示しています。

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\":\"Base Monitor\",
  \"quantity\": 4,
  \"account\":\"86837a386f0331003b3c498f5d3ee4ca\",
  \"contact\": \"dc0185d94f341200025ba3618110c77c\",
  \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\",
  \"state\":\"in_use\"
}" \
--user 'username':'password'

結果を返す:空でないフィールドのみが返されます。

{
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0001003",
      "sys_id": "27cb093114c66910f877324710112fd6",
      "contact": {
        "sys_id": "dc0185d94f341200025ba3618110c77c",
        "display_value": "Cindy Contact"
      },
      "state": {
        "value": "in_use",
        "display_value": "In Use"
      },
      "quantity": "4",
      "active": "true",
      "configuration_item": {
        "sys_id": "0c43baaac61122750182c132ee74bcf0",
        "display_value": "3D Pinball"
      },
      "name": "Base Monitor",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}

cURL 要求

次のコード例は、複数のインストールベースアイテムレコードを作成する方法を示しています。

curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "[
  {
    \"name\":\"AST4 Laptop\",
    \"consumer\":\"b119803fdb1b1200b6075200cf961917\",
    \"status\":\"replacement\",
    \"install_date\":\"2023-05-18 12:00:00\",
    \"uninstall_date\":\"2023-09-28 12:00:00\"
  },
{
    \"name\":\"Base Monitor\",
    \"quantity\": 4,
    \"account\":\"86837a386f0331003b3c498f5d3ee4ca\",
    \"contact\": \"dc0185d94f341200025ba3618110c77c\",
    \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\",
    \"state\":\"in_use\"
  }
]" \
--user 'username':'password'

結果を返す:空でないフィールドのみが返されます。

{
  "result": {
    "status": "SUCCESS",
    "items": [
      {
        "status": "SUCCESS",
        "item": {
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001018",
          "sys_id": "16fe91b1140a6910f877324710112f40",
          "uninstall_date": {
            "value": "2023-09-28 12:00:00",
            "display_value": "2023-09-28 05:00:00"
          },
          "install_date": {
            "value": "2023-05-18 12:00:00",
            "display_value": "2023-05-18 05:00:00"
          },
          "consumer": {
            "sys_id": "b119803fdb1b1200b6075200cf961917",
            "display_value": "Silvester Erik"
          },
          "active": "true",
          "name": "AST4 Laptop",
          "status": {
            "value": "replacement",
            "display_value": "Replacement"
          }
        }
      },
      {
        "status": "SUCCESS",
        "item": {
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001019",
          "sys_id": "5efe91b1140a6910f877324710112f40",
          "contact": {
            "sys_id": "dc0185d94f341200025ba3618110c77c",
            "display_value": "Cindy Contact"
          },
          "state": {
            "value": "in_use",
            "display_value": "In Use"
          },
          "quantity": "4",
          "active": "true",
          "configuration_item": {
            "sys_id": "0c43baaac61122750182c132ee74bcf0",
            "display_value": "3D Pinball"
          },
          "name": "Base Monitor",
          "account": {
            "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
            "display_value": "Boxeo"
          }
        }
      }
    ]
  }
}

インストールベースアイテム:POST /sn_install_base/integrations/installbaseitems/{id}/relatedparties

関係者レコードを作成し、指定されたインストールベースアイテムレコードに関連付けます。要求パラメーターで指定された値は、新しく作成された関係者レコードに保存されます。

URL 形式

バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties

デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties

注:

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

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

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

表 : 93. 要求本文パラメーター (XML または JSON)
名前	説明
アカウント	typeパラメーターが次のいずれかである場合は必須です。 `承認済みアカウント` `認定連絡先` `リストされたアカウント` `リストされた連絡先` インストールベースアイテムに関連付けるアカウントのSys_id。注: account パラメーターを渡す場合、consumer パラメーターも渡すことはできません。データタイプ：文字列テーブル:アカウント [customer_account]
consumer	typeパラメーターが`認定コンシューマー`または`リストコンシューマー`の場合は必須です。インストールベースアイテムレコードに関連付けられたコンシューマーのSys_id。注: consumer パラメーターを渡す場合、account パラメーターも渡すことはできません。また、B2B2C プラグインがインスタンスにインストールされている場合にのみ、コンシューマーをインストールベースアイテムに関連付けることができます。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
連絡先	関係者レコードに関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
install_base_item	関係者レコードに関連付けられたインストールベースアイテムレコードのSys_id。データタイプ：文字列
責任	関連付けられた責任レコードのSys_id。このレコードは、インストールベース情報のアクセスレベルを定義します。このパラメーターは、[ related_party ] フィールドも指定されている場合にのみ有効です。指定した場合、 related_party パラメーターと responsibility パラメーターの両方に一致するインストールベースアイテムのみを返します。詳細については次を参照してください。 Configure related parties for items received データタイプ：文字列テーブル:責任の定義 [sn_customerservice_responsibility_def]
service_organization	typeパラメーターが次のいずれかである場合は必須です。 `認定メンバー` `認証サービス組織` `リストされたメンバー` `リストされたサービス組織` 顧客にサービスを提供する際に関与するサービス組織レコードのSys_id。注: このパラメーターを渡す場合は、アカウント、連絡先、またはコンシューマーのパラメーターも渡さないでください。service_organization パラメーターは、Service Organization (com.snc.service_organization) プラグインがインスタンスにインストールされている場合にのみ使用できます。データタイプ：文字列テーブル:サービス組織 [sn_customer_service_organization]
sys_class_name	関係者レコードを含むテーブル。データタイプ：文字列デフォルト:sn_install_base_related_party
type	必須。作成する関係者のタイプSys_id。可能なタイプ: 承認済みアカウント認定コンシューマー認定連絡先認定貢献者認定メンバー認証サービス組織リストされたアカウントリストされたコンシューマーリストされた連絡先リストされた貢献者リストされたメンバーリストされたサービス組織データタイプ：文字列テーブル:関係者構成 [sn_customerservice_related_party_configuration]
user	typeパラメーターが次の関係者タイプのいずれかである場合は必須です。 `認定貢献者` `認定メンバー` `リストされた貢献者` `リストされたメンバー` `認定メンバー`および`リストメンバー`の場合、このユーザーは指定されたservice_organizationレコードに関連付けられている必要があります。関係者レコードに関連付けられたユーザーレコードのSys_id。データタイプ：文字列テーブル:ユーザー [sys_user]

ヘッダー

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

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

ステータスコード

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

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


名前	説明
アカウント	関係者レコードに関連付けられたアカウントの詳細。データタイプ: オブジェクト `account": { "display_value": "String", "sys_id": "String" }`
account.display_value	関係者レコードに関連付けられたアカウントのテキスト名。この値を使用して、アカウント名を UI に表示します。データタイプ：文字列
account.sys_id	関係者レコードに関連付けられたアカウントレコードのSys_id。データタイプ：文字列
consumer	関係者レコードに関連付けられたコンシューマーの詳細。データタイプ: オブジェクト `"consumer": { "display_value": "String", "sys_id": "String" }`
consumer.display_value	関係者レコードに関連付けられたコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。データタイプ：文字列
consumer.sys_id	関係者レコードに関連付けられたコンシューマーレコードのSys_id。データタイプ：文字列
連絡先	関係者レコードを担当するアカウント連絡先の詳細。データタイプ: オブジェクト `"contact": { "display_value": "String", "sys_id": "String" }`
contact.display_value	関係者レコードに関連付けられた連絡先のテキスト名。この値を使用して、連絡先名を UI に表示します。データタイプ：文字列
contact.sys_id	関係者レコードに関連付けられた連絡先レコードのSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
エラー	要求を処理しようとしたときに発生したエラーに関する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	関連するエラーに関するその他の詳細。データタイプ：文字列
error.message	要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。データタイプ：文字列
install_base_item	関係者レコードに関連付けられたインストールベースアイテムの詳細。データタイプ: オブジェクト `"install_base_item": { "display_value": "String", "sys_id": "String" }`
install_base_item.display_value	関係者レコードに関連付けられたインストールベースアイテムのテキスト名。この値を使用して、インストールベースアイテム名を UI に表示します。データタイプ：文字列
install_base_item.sys_id	関係者レコードに関連付けられたインストールベースアイテムレコードのSys_id。データタイプ：文字列
責任	インストールベース情報のアクセスレベルに関する詳細。データタイプ: オブジェクト `"responsibility": { "display_value": "String", "sys_id": "String" }`
responsibility.display_value	インストールベース情報のアクセスレベルのテキスト表示値。データタイプ：文字列
responsibility.sys_id	関連付けられた責任レコードのSys_id。このレコードは、インストールベース情報のアクセスレベルを定義します。このパラメーターは、[ related_party ] フィールドも指定されている場合にのみ有効です。指定した場合、 related_party パラメーターと responsibility パラメーターの両方に一致するインストールベースアイテムのみを返します。詳細については次を参照してください。 Configure related parties for items received データタイプ：文字列テーブル:責任の定義 [sn_customerservice_responsibility_def]
status	エンドポイントコールのステータス。データタイプ：文字列
sys_class_name	関係者レコードを含むテーブル。データタイプ：文字列デフォルト:sn_install_base_related_party
sys_id	関連する関係者レコードのSys_id。データタイプ：文字列
sysparm_limit	返されたレコードの数。この値が元の要求で指定されていない場合は、デフォルト値が使用されます。データタイプ：数値
sysparm_offset	レコードが評価され、取得された関連テーブル内のオフセット (開始点)。データタイプ：文字列
type	関係者レコードに関連付けられた連絡先のタイプに関する詳細。データタイプ: オブジェクト `"type": { "display_value": "String", "sys_id": "String" }`
type.display_value	関係者レコードに関連付けられた連絡先タイプのテキスト名。この値を使用して、連絡先のタイプを UI に表示します。詳細については、「Create related party configurations」を参照してください。可能なタイプ: 承認済みアカウント認定コンシューマー認定連絡先認定貢献者認定メンバー認証サービス組織リストされたアカウントリストされたコンシューマーリストされた連絡先リストされた貢献者リストされたメンバーリストされたサービス組織データタイプ：文字列
type.sys_id	関係者レコードに関連付けられたタイプレコードのSys_id。データタイプ：文字列
user	関係者レコードに関連付けられたユーザーの詳細。データタイプ: オブジェクト `"user": { "display_value": "String", "sys_id": "String" }`
user.display_value	関係者レコードに関連付けられたユーザーのテキスト名。この値を使用して、UI にユーザー名を表示します。データタイプ：文字列
user.sys_id	関係者レコードに関連付けられたユーザーレコードのSys_id。データタイプ：文字列テーブル:ユーザー [sys_user]

cURL 要求

次のコード例は、このエンドポイントを呼び出して承認済みアカウント関連レコードを作成し、インストールベースアイテムに関連付ける方法を示しています。

curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "contact":"0a232a0013691200042ab3173244b075",
  "type":"68ec8b2965e99110f87764df53db779f",
  "account":"86837a386f0331003b3c498f5d3ee4ca",
  "install_base_item":"f77c7542b7343300ece839a6ee11a991",
  "responsibility":"c009bbedb3730010700b4d43c6a8dcef",
  "sys_class_name":"sn_install_base_related_party"
}" \
--user 'username':'password'

返される結果：

{
"result":
  {
    "type": {
      "display_value":"Authorized Contact",
      "sys_id":"68ec8b2965e99110f87764df53db779f"
    },
    "install_base_item": {
      "display_value":"KX Series - KX5000",
      "sys_id":"f77c7542b7343300ece839a6ee11a991"
    },
    "sys_class_name":"sn_install_base_related_party",
    "sys_id":"4659539814ac6910f877ae314c1fb43a",
    "responsibility": {
      "display_value":"Authorized Representative",
      "sys_id":"c009bbedb3730010700b4d43c6a8dcef"
    },
    "contact": {
      "display_value":"Cindy Contact",
      "sys_id":"dc0185d94f341200025ba3618110c77c"
    },
    "account": {
      "display_value":"Boxeo",
      "value":"86837a386f0331003b3c498f5d3ee4ca"
    },
    "status":"SUCCESS",
  }
}