--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # インストールベースアイテム API # インストールベースアイテム API {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：284分 インストールベースアイテム API は、ServiceNowインスタンス内のインストールベースアイテムレコードにアクセスして管理するためのエンドポイントを提供します。 インストールベースアイテムは、顧客用に構成された製品のインスタンスを表します。インストールベースアイテムを使用すると、顧客が行ったすべての購入を追跡できます。 この API を使用して、\[インストールベース関連パーティ\] 関連リストで CRUD 操作を実行することもできます。さらに、ケース、契約、エンタイトルメント、メンテナンス計画、販売済み製品、作業指示書など、他のインストールベースアイテム関連リストのレコードを読み取ることができます。 この API にアクセスするには、実行しようとしている CRUD アクションのタイプに応じて、sn_install_base.ib_api_write または sn_install_base.ib_api_read ロールのいずれかが必要です。 この API のさまざまなエンドポイントにアクセスするには、次のプラグインをインストールする必要があります。 * カスタマーサービスインストールベース管理 (com.snc.install_base) * メンテナンス計画と作業指示書のデータを取得する場合は、計画作業管理 (sn_fsm_planned_wm)。 この API は `sn_install_base` 名前空間で実行されます。 注: この API は、エンドポイント応答で空でないフィールドのみを返します。また、sys_id フィールドを除き、システムレベルのフィールド (先頭に「sys_」が付いているフィールド) は返されません。 インストールベースアイテムの詳細については、「 [Create an install base item](https://www.servicenow.com/docs/access?context=create-install-base-item&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。 ## インストールベースアイテム:DELETE /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id} {#ariaid-title2} 指定されたインストールベースアイテムレコードから、指定された関係者レコードの関連付けを解除します。
### 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 エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-DELETE-relatedparties__entry__2}{#integrat-DELETE-relatedparties__version-not_optional-RESTAPI}{#integrat-DELETE-relatedparties__integrate-id-entry}{#integrat-DELETE-relatedparties__related_party_sys_id-integrate-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | | related_party_sys_id | 関係者レコードのSys_id。 データタイプ：文字列 テーブル:インストールベース関連パーティ \[sn_install_base_related_party\] | [表 : 1. パスパラメーター] {#integrat-DELETE-relatedparties__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメーター] {#integrat-DELETE-relatedparties__entry__14} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-DELETE-relatedparties__entry__18}{#integrat-DELETE-relatedparties__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 4. 要求ヘッダー] {#integrat-DELETE-relatedparties__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-DELETE-relatedparties__entry__26}{#integrat-DELETE-relatedparties__entry-200-status-code}{#integrat-DELETE-relatedparties__entry-403-status-code}{#integrat-DELETE-relatedparties__entry-404-status-code}{#integrat-DELETE-relatedparties__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-DELETE-relatedparties__id_zk1_w5w_ywb__entry__2}{#integrat-DELETE-relatedparties__error-integration-entry}{#integrat-DELETE-relatedparties__error_detail-integration-entry}{#integrat-DELETE-relatedparties__error_message-integration-entry}{#integrat-DELETE-relatedparties__result-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | 関連するエラーに関するその他の詳細。 データタイプ：文字列 | | error.message | 要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。 データタイプ：文字列 | | result | エンドポイントの結果の説明。 データタイプ: オブジェクト | | result.status | エンドポイント要求のステータス。 可能な値： * 成功 * 失敗 データタイプ：文字列 | [ ] {#integrat-DELETE-relatedparties__id_zk1_w5w_ywb} ### 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 {#ariaid-title3} すべてのインストールベースアイテムを返します。呼び出し内でパラメーターを渡して、返される結果をフィルタリングできます。 ### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems デフォルト URL: /api/sn_install_base/integrations/installbaseitems 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-installbaseitems__entry__2}{#integrat-GET-installbaseitems__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 7. パスパラメーター] {#integrat-GET-installbaseitems__entry__6}{#integrat-GET-installbaseitems__sysparm-limit-RESTAPI}{#integrat-GET-installbaseitems__sysparm_offset-ph-RESTAPI} | 名前 | 説明 | |-|-| | フィールドの名前と値のペア | インストールベースアイテムレコードのフィルタリングに使用するフィールドと値のペア。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。 たとえば、ステータスフィールドが「in_use」に設定され、ステータスフィールドが「置換」に設定されているレコードのみを返すには、 `&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](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=australia&pubname=australia-government-industry&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | sys_class_name | 目的のレコードがインストールベースアイテム \[sn_install_base_item\] テーブルを拡張するテーブル内にある場合は、クエリ対象の拡張テーブルの名前。 データタイプ：文字列 | | sysparm_limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。 この制限は、ACL 評価の前に適用されます。アクセス権のあるレコードを含めて、レコードが返されない場合は、アクセス権のあるレコードが最初に返されるようにレコードの順序を並べ替えます。 注: sysparm_limit値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。 データタイプ：数値 デフォルト：10000 | | sysparm_offset | レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。{#integrat-GET-installbaseitems__sysparm_offset-p-RESTAPI} sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0 | [表 : 8. クエリパラメーター] {#integrat-GET-installbaseitems__entry__20} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-installbaseitems__entry__24}{#integrat-GET-installbaseitems__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 10. 要求ヘッダー] {#integrat-GET-installbaseitems__entry__28} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-installbaseitems__entry__32}{#integrat-GET-installbaseitems__entry-200-status-code}{#integrat-GET-installbaseitems__entry-400-status-code}{#integrat-GET-installbaseitems__entry-403-status-code}{#integrat-GET-installbaseitems__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 12. ステータスコード] ### 応答本文のパラメーター (JSON または XML) 次の戻り結果は、インストールベースアイテム \[sn_install_base_items\] テーブルから返されたレコードの戻り値のみを示しています。 {#integrat-GET-installbaseitems__id_qgj_jg2_zwb__entry__2}{#integrat-GET-installbaseitems__has_more-integration-entry}{#integrat-GET-installbaseitems__account-integration-entry}{#integrat-GET-installbaseitems__account_display_value-integration-entry}{#integrat-GET-installbaseitems__account_sys_id-integration-entry}{#integrat-GET-installbaseitems__active-integration-entry}{#integrat-GET-installbaseitems__asset-integration-entry}{#integrat-GET-installbaseitems__asset_display_value-integration-entry}{#integrat-GET-installbaseitems__asset_sys_id-integration-entry}{#integrat-GET-installbaseitems__configuration_item-integration-entry}{#integrat-GET-installbaseitems__configuration_item_display_value-integration-entry}{#integrat-GET-installbaseitems__configuration_item_sys_id-integration-entry}{#integrat-GET-installbaseitems__consumer-integration-entry}{#integrat-GET-installbaseitems__consumer_display_value-integration-entry}{#integrat-GET-installbaseitems__consumer_sys_id-integration-entry}{#integrat-GET-installbaseitems__consumer_profile-integration-entry}{#integrat-GET-installbaseitems__consumer_profile_display_value-integration-entry}{#integrat-GET-installbaseitems__consumer_profile_sys_id-integration-entry}{#integrat-GET-installbaseitems__contact-integration-entry}{#integrat-GET-installbaseitems__contact_display_value-integration-entry}{#integrat-GET-installbaseitems__contact_sys_id-integration-entry}{#integrat-GET-installbaseitems__health_status-integration-entry}{#integrat-GET-installbaseitems__health_status_display_value-integration-entry}{#integrat-GET-installbaseitems__health_status_value-integration-entry}{#integrat-GET-installbaseitems__health_status_last_updated-integration-entry}{#integrat-GET-installbaseitems__household-integration-entry}{#integrat-GET-installbaseitems__household_display_value-integration-entry}{#integrat-GET-installbaseitems__household_sys_id-integration-entry}{#integrat-GET-installbaseitems__install_date-integration-entry}{#integrat-GET-installbaseitems__install_date_display_value-integration-entry}{#integrat-GET-installbaseitems__install_date_value-integration-entry}{#integrat-GET-installbaseitems__location-integration-entry}{#integrat-GET-installbaseitems__location_display_value-integration-entry}{#integrat-GET-installbaseitems__location_sys_id-integration-entry}{#integrat-GET-installbaseitems__name-integration-entry}{#integrat-GET-installbaseitems__number-integration-entry}{#integrat-GET-installbaseitems__parent-integration-entry}{#integrat-GET-installbaseitems__parent_display_value-integration-entry}{#integrat-GET-installbaseitems__parent_sys_id-integration-entry}{#integrat-GET-installbaseitems__product-integration-entry}{#integrat-GET-installbaseitems__product_display_value-integration-entry}{#integrat-GET-installbaseitems__product_sys_id-integration-entry}{#integrat-GET-installbaseitems__service_context-integration-entry}{#integrat-GET-installbaseitems__service_context_display_value-integration-entry}{#integrat-GET-installbaseitems__service_context_sys_id-integration-entry}{#integrat-GET-installbaseitems__service_organization-integration-entry}{#integrat-GET-installbaseitems__service_organization_display_value-integration-entry}{#integrat-GET-installbaseitems__service_organization_sys_id-integration-entry}{#integrat-GET-installbaseitems__sys_class_name-integration-entry}{#integrat-GET-installbaseitems__sys_id-integration-entry}{#integrat-GET-installbaseitems__sys_mod_count-integration-entry}{#integrat-GET-installbaseitems__state-integration-entry}{#integrat-GET-installbaseitems__state_display_value-integration-entry}{#integrat-GET-installbaseitems__state_value-integration-entry}{#integrat-GET-installbaseitems__status1-integration-entry}{#integrat-GET-installbaseitems__status1_display_value-integration-entry}{#integrat-GET-installbaseitems__status1_value-integration-entry}{#integrat-GET-installbaseitems__uninstall_date-integration-entry}{#integrat-GET-installbaseitems__uninstall_date_display_value-integration-entry}{#integrat-GET-installbaseitems__uninstall_date_value-integration-entry}{#integrat-GET-installbaseitems__status-integration-entry}{#integrat-GET-installbaseitems__sysparm_depth-integration-entry}{#integrat-GET-installbaseitems__sysparm_limit-integration-entry}{#integrat-GET-installbaseitems__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "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 | レコードが評価および取得された関連テーブル内のオフセット (開始点)。 データタイプ：文字列 | [ ] {#integrat-GET-installbaseitems__id_qgj_jg2_zwb} ### 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 要求 {#integrat-GET-installbaseitems__example_rfd_jc4_1xb} 次のコード例は、\[インストールベースアイテム\] テーブル内でフィールド 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 要求 {#integrat-GET-installbaseitems__example_zwr_sg4_1xb} 次のコード例は、 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} {#ariaid-title4} 指定されたインストールベースアイテムレコードとその子階層を返します。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitem/{id} デフォルト URL: /api/sn_install_base/integrations/installbaseitem/{id} 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-installbaseitems-id__entry__2}{#integrat-GET-installbaseitems-id__version-not_optional-RESTAPI}{#integrat-GET-installbaseitems-id__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 13. パスパラメーター] {#integrat-GET-installbaseitems-id__entry__8} | 名前 | 説明 | |-|-| | sys_class_name | 目的のレコードがインストールベースアイテム \[sn_install_base_item\] テーブルを拡張するテーブルにある場合、クエリ対象の拡張テーブルの名前。このテーブルはsn_install_base_itemテーブルを拡張する必要があります。 データタイプ：文字列 | | sysparm_depth | 返される子インストールベースアイテムの階層の最大深度。 データタイプ：整数 デフォルト値：7 最大:10 | | sysparm_limit | 各子階層で返すレコードの最大数。 データタイプ：整数 デフォルト：10 最大:100 | [表 : 14. クエリパラメーター] {#integrat-GET-installbaseitems-id__entry__16} | 名前 | 説明 | |-|-| | なし | | [表 : 15. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-installbaseitems-id__entry__20}{#integrat-GET-installbaseitems-id__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 16. 要求ヘッダー] {#integrat-GET-installbaseitems-id__entry__24} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-installbaseitems-id__entry__28}{#integrat-GET-installbaseitems-id__entry-200-status-code}{#integrat-GET-installbaseitems-id__entry-400-status-code}{#integrat-GET-installbaseitems-id__entry-403-status-code}{#integrat-GET-installbaseitems-id__entry-404-status-code}{#integrat-GET-installbaseitems-id__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-GET-installbaseitems-id__id_fw5_m3f_xwb__entry__2}{#integrat-GET-installbaseitems-id__error-integration-entry}{#integrat-GET-installbaseitems-id__error_detail-integration-entry}{#integrat-GET-installbaseitems-id__error_message-integration-entry}{#integrat-GET-installbaseitems-id__account-integration-row}{#integrat-GET-installbaseitems-id__account_display_value-integration-row}{#integrat-GET-installbaseitems-id__account_sys_id-integration-row}{#integrat-GET-installbaseitems-id__active-integration-row}{#integrat-GET-installbaseitems-id__name-integration-row}{#integrat-GET-installbaseitems-id__number-integration-row}{#integrat-GET-installbaseitems-id__sys_class_name-integration-row}{#integrat-GET-installbaseitems-id__sys_id-integration-row}{#integrat-GET-installbaseitems-id__state-integration-row}{#integrat-GET-installbaseitems-id__state_display_value-integration-row}{#integrat-GET-installbaseitems-id__state_value-integration-row}{#integrat-GET-installbaseitems-id__status-integration-row} | 名前 | 説明 | |-|-| | 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": { "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_class_name | インストールベースアイテムレコードを含むテーブル。 データタイプ：文字列 | | 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 | アンインストール日の内部値。 データタイプ：文字列 | | status | エンドポイント呼び出しのステータス。 データタイプ：文字列 | [ ] {#integrat-GET-installbaseitems-id__id_fw5_m3f_xwb} ### 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 要求 {#integrat-GET-installbaseitems-id__example_zsw_b5v_1xb} 次のコード例は、最大深度 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 {#ariaid-title5} 指定されたインストールベースアイテムレコードに関連付けられたケースを返します。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/cases デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/cases 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-cases__entry__2}{#integrat-GET-cases__version-not_optional-RESTAPI}{#integrat-GET-cases__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 19. パスパラメーター] {#integrat-GET-cases__entry__8}{#integrat-GET-cases__sysparm-limit-RESTAPI}{#integrat-GET-cases__sysparm_offset-ph-RESTAPI} | 名前 | 説明 | |-|-| | フィールドの名前と値のペア | ケースレコードのフィルタリングに使用するフィールドと値のペア。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値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。 データタイプ：数値 デフォルト：10000 | | sysparm_offset | レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。{#integrat-GET-cases__sysparm_offset-p-RESTAPI} sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0 | [表 : 20. クエリパラメーター] {#integrat-GET-cases__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 21. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-cases__entry__22}{#integrat-GET-cases__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 22. 要求ヘッダー] {#integrat-GET-cases__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 23. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-cases__entry__30}{#integrat-GET-cases__entry-200-status-code}{#integrat-GET-cases__entry-400-status-code}{#integrat-GET-cases__entry-403-status-code}{#integrat-GET-cases__entry-404-status-code}{#integrat-GET-cases__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 24. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-GET-cases__entry__42}{#integrat-GET-cases__casetable-contact_type-maxLength}{#integrat-GET-cases__description_maxLength}{#integrat-GET-cases__priority_default}{#integrat-GET-cases__short_description_maxLength}{#integrat-GET-cases__has_more-integration-entry}{#integrat-GET-cases__status-integration-entry}{#integrat-GET-cases__sysparm-limit-entry}{#integrat-GET-cases__sysparm-offset-entry} | 要素 | 説明 | |-|-| | ケース | 指定されたインストールベースアイテムレコードに関連付けられたケースのリスト。 データタイプ：オブジェクトのアレイ "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 | 必要な承認のタイプを説明する文字列。 可能な値： * 承認済み * キャンセル * 重複 * not_required * 未要求 * 却下 * requested (要求済み) データタイプ：文字列 最大文字数:40 デフォルト:未要求 | | 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 | ケースが最初に報告された方法。 可能な値： * チャット * メール * phone * ソーシャル * Web データタイプ：文字列 最大長：40 | | cases.contract | ケースに関連付けられた契約のSys_id。この契約には、ケースに関連付けられた会社に提供されるサポートのタイプに関する情報が含まれています。契約には、会社、連絡先、対象となる特定の資産を含めることができます。1 つの契約に、複数のサービスエンタイトルメントと SLA を含めることもできます。 データタイプ：文字列 テーブル:契約 \[ast_contract\] | | cases.contributor_groups | ケースに関与したユーザーグループのsys_idsのリスト。 データタイプ：文字列 テーブル： Group \[sys_user_group\] | | cases.contributor_users | ケースに貢献したユーザーのsys_idsのリスト。 データタイプ：文字列 テーブル： ユーザー \[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_idsリスト。 データタイプ：アレイ テーブル： Group \[sys_user_group\] | | cases.impact | 顧客への影響。 可能な値： * 1:高 * 2:中 * 3:低 データタイプ:数値 (整数) デフォルト値：3 | | cases.internal_user | このケースの内部ユーザーのSys_id。 データタイプ：文字列 テーブル： ユーザー \[sys_user\] | | cases.initiated_as_request | この照会が顧客の要求として開始されたかどうかを示すフラグ。 可能な値： * true:顧客によって開始された照会。 * false:照会は顧客によって開始されたものではありません。 データタイプ：ブール デフォルト値：false | | ケース.ナレッジ | 指定された問題で利用可能なナレッジベース記事があるかどうかを示すフラグ。 可能な値： * true:この問題のナレッジベース記事が利用可能です * false:この問題のナレッジベース記事は利用できません データタイプ：ブール デフォルト値：false | | cases.location | 会社の場所を説明するレコードのSys_id。 データタイプ：文字列 テーブル:場所 \[cmn_location\] | | cases.made_sla | ケースが関連するサービスレベルアグリーメントに沿って解決されたかどうかを示すフラグ。 可能な値： * true:ケースは SLA に沿って解決されました * false:ケースは SLA に従って解決されませんでした データタイプ：ブール デフォルト：true | | cases.major_case_state | 重大なケースの現在のステータス。 可能な値： * 承認済み:マネージャーが重大なケースを作成したとき、またはマネージャーが候補ケースを昇格させたときの初期ステータス。 * canceled:ケースはキャンセルされます。 * 提案済み:エージェントまたはマネージャーが候補ケースを作成または提案したときの初期ステータス。 * 却下:マネージャーが却下した候補ケース。 データタイプ：文字列 最大長：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\] | | cases.partner | ケースに関連付けられているパートナーの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 | ケースの解決ステータス (「解決済み:提供されたサポート/ガイダンスによって修正」など)。 データタイプ：文字列 最大長：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_class_name | ケースレコードを含むテーブル。 データタイプ：文字列 最大長：80 | | cases.sys_domain | ケースに関連付けられたドメイン。 データタイプ：文字列 最大長:32 デフォルト:グローバル | | cases.sys_domain_path | ドメインパス。 データタイプ：文字列 最大長: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 * 続行 データタイプ：文字列 最大長：40 デフォルト:続行 | | cases.upon_reject | ケースが却下された場合に実行するアクション。 可能な値： * キャンセル * goto データタイプ：文字列 最大長：40 デフォルト値: cancel | | cases.urgency | ケースの緊急度。 可能な値： * 1:高 * 2:中 * 3:低 データタイプ:数値 (整数) デフォルト値：3 | | cases.user_input | 追加のユーザー入力。 データタイプ：文字列 最大長:4,000 | | cases.variables | ケースに関連付けられた変数の名前と値のペア。 データタイプ：文字列 最大長：40 | | cases.watch_list | 追加のコメントが追加された場合、またはケースのステータスが \[解決済み\] または \[クローズ済み\] に変更された場合に、このケースに関する通知を受信するユーザーのsys_idsのリスト。 データタイプ：アレイ テーブル： ユーザー \[sys_user\] | | cases.wf_activity | ケースに関連付けられたワークフローアクティビティレコードのSys_id。 データタイプ：文字列 テーブル:ワークフローアクティビティ \[wf_activity\] | | cases.work_end | ケースの作業が終了した日時。 データタイプ：文字列 | | cases.work_notes | ケースの解決方法に関する情報、またはケースを解決するために実行した手順。 データタイプ：文字列 最大長:4,000 | | cases.work_notes_list | 作業メモが追加されたときにこのケースに関する通知を受け取る内部ユーザーのsys_idsのリスト。 データタイプ：アレイ テーブル： ユーザー \[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 update​CS0001034", "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 Alert​CS0001008", "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 down​CS0001033", "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 account​CS0001048", "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 {#ariaid-title6} 指定されたインストールベースアイテムレコードに関連付けられた子インストールベースアイテムを返します。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/childinstallbaseitems デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-childinstallitems__entry__2}{#integrat-GET-childinstallitems__version-not_optional-RESTAPI}{#integrat-GET-childinstallitems__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 25. パスパラメーター] {#integrat-GET-childinstallitems__entry__8}{#integrat-GET-childinstallitems__sysparm-limit-RESTAPI}{#integrat-GET-childinstallitems__sysparm_offset-ph-RESTAPI} | 名前 | 説明 | |-|-| | フィールドの名前と値のペア | 子インストールベースアイテムレコードをフィルタリングするために使用するフィールドと値のペア。 sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。 たとえば、ステータスフィールドが「in_use」に設定され、ステータスフィールドが「置換」に設定されているレコードのみを返すには、 `&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値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。 データタイプ：数値 デフォルト：10000 | | sysparm_offset | レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。{#integrat-GET-childinstallitems__sysparm_offset-p-RESTAPI} sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0 | [表 : 26. クエリパラメーター] {#integrat-GET-childinstallitems__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 27. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-childinstallitems__entry__22}{#integrat-GET-childinstallitems__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 28. 要求ヘッダー] {#integrat-GET-childinstallitems__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-childinstallitems__entry__30}{#integrat-GET-childinstallitems__entry-200-status-code}{#integrat-GET-childinstallitems__entry-400-status-code}{#integrat-GET-childinstallitems__entry-403-status-code}{#integrat-GET-childinstallitems__entry-404-status-code}{#integrat-GET-childinstallitems__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 30. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-GET-childinstallitems__id_qfp_hxl_xwb__entry__2}{#integrat-GET-childinstallitems__has_more-integration-entry}{#integrat-GET-childinstallitems__account-integration-entry}{#integrat-GET-childinstallitems__account_display_value-integration-entry}{#integrat-GET-childinstallitems__account_sys_id-integration-entry}{#integrat-GET-childinstallitems__active-integration-entry}{#integrat-GET-childinstallitems__asset-integration-entry}{#integrat-GET-childinstallitems__asset_display_value-integration-entry}{#integrat-GET-childinstallitems__asset_sys_id-integration-entry}{#integrat-GET-childinstallitems__configuration_item-integration-entry}{#integrat-GET-childinstallitems__configuration_item_display_value-integration-entry}{#integrat-GET-childinstallitems__configuration_item_sys_id-integration-entry}{#integrat-GET-childinstallitems__consumer-integration-entry}{#integrat-GET-childinstallitems__consumer_display_value-integration-entry}{#integrat-GET-childinstallitems__consumer_sys_id-integration-entry}{#integrat-GET-childinstallitems__consumer_profile-integration-entry}{#integrat-GET-childinstallitems__consumer_profile_display_value-integration-entry}{#integrat-GET-childinstallitems__consumer_profile_sys_id-integration-entry}{#integrat-GET-childinstallitems__contact-integration-entry}{#integrat-GET-childinstallitems__contact_display_value-integration-entry}{#integrat-GET-childinstallitems__contact_sys_id-integration-entry}{#integrat-GET-childinstallitems__health_status-integration-entry}{#integrat-GET-childinstallitems__health_status_display_value-integration-entry}{#integrat-GET-childinstallitems__health_status_value-integration-entry}{#integrat-GET-childinstallitems__health_status_last_updated-integration-entry}{#integrat-GET-childinstallitems__household-integration-entry}{#integrat-GET-childinstallitems__household_display_value-integration-entry}{#integrat-GET-childinstallitems__household_sys_id-integration-entry}{#integrat-GET-childinstallitems__install_date-integration-entry}{#integrat-GET-childinstallitems__install_date_display_value-integration-entry}{#integrat-GET-childinstallitems__install_date_value-integration-entry}{#integrat-GET-childinstallitems__location-integration-entry}{#integrat-GET-childinstallitems__location_display_value-integration-entry}{#integrat-GET-childinstallitems__location_sys_id-integration-entry}{#integrat-GET-childinstallitems__name-integration-entry}{#integrat-GET-childinstallitems__number-integration-entry}{#integrat-GET-childinstallitems__parent-integration-entry}{#integrat-GET-childinstallitems__parent_display_value-integration-entry}{#integrat-GET-childinstallitems__parent_sys_id-integration-entry}{#integrat-GET-childinstallitems__product-integration-entry}{#integrat-GET-childinstallitems__product_display_value-integration-entry}{#integrat-GET-childinstallitems__product_sys_id-integration-entry}{#integrat-GET-childinstallitems__service_context-integration-entry}{#integrat-GET-childinstallitems__service_context_display_value-integration-entry}{#integrat-GET-childinstallitems__service_context_sys_id-integration-entry}{#integrat-GET-childinstallitems__service_organization-integration-entry}{#integrat-GET-childinstallitems__service_organization_display_value-integration-entry}{#integrat-GET-childinstallitems__service_organization_sys_id-integration-entry}{#integrat-GET-childinstallitems__sys_class_name-integration-entry}{#integrat-GET-childinstallitems__sys_id-integration-entry}{#integrat-GET-childinstallitems__sys_mod_count-integration-entry}{#integrat-GET-childinstallitems__state-integration-entry}{#integrat-GET-childinstallitems__state_display_value-integration-entry}{#integrat-GET-childinstallitems__state_value-integration-entry}{#integrat-GET-childinstallitems__status1-integration-entry}{#integrat-GET-childinstallitems__status1_display_value-integration-entry}{#integrat-GET-childinstallitems__status1_value-integration-entry}{#integrat-GET-childinstallitems__uninstall_date-integration-entry}{#integrat-GET-childinstallitems__uninstall_date_display_value-integration-entry}{#integrat-GET-childinstallitems__uninstall_date_value-integration-entry}{#integrat-GET-childinstallitems__status-integration-entry}{#integrat-GET-childinstallitems__sysparm_depth-integration-entry}{#integrat-GET-childinstallitems__sysparm_limit-integration-entry}{#integrat-GET-childinstallitems__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "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 | レコードが評価および取得された関連テーブル内のオフセット (開始点)。 データタイプ：文字列 | [ ] {#integrat-GET-childinstallitems__id_qfp_hxl_xwb} ### 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 {#ariaid-title7} 指定されたインストールベースアイテムレコードに関連付けられた契約を返します。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/contracts デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/contracts 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-contracts__entry__2}{#integrat-GET-contracts__version-not_optional-RESTAPI}{#integrat-GET-contracts__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 31. パスパラメーター] {#integrat-GET-contracts__entry__8}{#integrat-GET-contracts__sysparm-limit-RESTAPI}{#integrat-GET-contracts__sysparm_offset-ph-RESTAPI} | 名前 | 説明 | |-|-| | フィールドの名前と値のペア | 契約レコードのフィルタリングに使用するフィールドと値のペア。デフォルトでは、これは契約 \[ast_contract\] テーブルのフィールドを参照します。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。 たとえば、更新可能フィールドが「true」に設定されているレコードのみを返すには、 `&renewable=true` を渡します。 データタイプ：文字列 デフォルト:すべてのフィールド | | sys_class_name | 拡張契約テーブル (ast_contract ではない) を使用する場合、クエリする拡張テーブルの名前。 データタイプ：文字列 デフォルト値:ast_contract | | sysparm_limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。 この制限は、ACL 評価の前に適用されます。アクセス権のあるレコードを含めて、レコードが返されない場合は、アクセス権のあるレコードが最初に返されるようにレコードの順序を並べ替えます。 注: sysparm_limit値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。 データタイプ：数値 デフォルト：10000 | | sysparm_offset | レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。{#integrat-GET-contracts__sysparm_offset-p-RESTAPI} sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0 | [表 : 32. クエリパラメーター] {#integrat-GET-contracts__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 33. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-contracts__entry__22}{#integrat-GET-contracts__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 34. 要求ヘッダー] {#integrat-GET-contracts__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 35. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-contracts__entry__30}{#integrat-GET-contracts__entry-200-status-code}{#integrat-GET-contracts__entry-400-status-code}{#integrat-GET-contracts__entry-403-status-code}{#integrat-GET-contracts__entry-404-status-code}{#integrat-GET-contracts__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 36. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-GET-contracts__entry__42}{#integrat-GET-contracts__error-integration-entry}{#integrat-GET-contracts__error_detail-integration-entry}{#integrat-GET-contracts__error_message-integration-entry}{#integrat-GET-contracts__has_more-integration-entry}{#integrat-GET-contracts__status-integration-entry}{#integrat-GET-contracts__sysparm_limit-integration-entry}{#integrat-GET-contracts__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | 契約 | 指定されたインストールベースアイテムレコードに関連付けられた契約のリスト。 データタイプ:オブジェクトのアレイ "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" } ] | | contracts.active | 契約がアクティブかどうかを示すフラグ。 可能な値： * true:契約はアクティブです。 * false:契約は非アクティブです。 データタイプ:ブール文字列 | | 契約.承認者 | 契約を承認する権限を持つユーザーの詳細。 データタイプ: オブジェクト "approver": { "display_value": "String", "sys_id": "String" } | | contracts.approver.display_value | 契約レコードに関連付けられた承認者のテキスト名。この値を使用して、UI に承認者名を表示します。 データタイプ：文字列 | | contracts.approver.sys_id | 契約レコードに関連付けられた承認者レコードのSys_id。 データタイプ：文字列 | | 契約.コンシューマー | 契約レコードに関連付けられているコンシューマーに関する詳細。 注: \[コンシューマー\] フィールドは、B2B2C プラグインがインストールされている場合にのみ使用できます。 データタイプ: オブジェクト "consumer": { "display_value": "String", "sys_id": "String" } | | contracts.consumer.display_value | 契約レコードに関連付けられているコンシューマーのテキスト名。この値を使用して、UI にコンシューマー名を表示します。 データタイプ：文字列 | | contracts.consumer.sys_id | 契約レコードに関連付けられたコンシューマーレコードのSys_id。 データタイプ：文字列 | | contracts.cost_adjustment | 契約に適用された費用調整のタイプ 可能な値： * 固定 * マニュアル * CPI(消費者物価指数) {#integrat-GET-contracts__ul_xwv_cny_3xb} データタイプ：文字列 | | 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\] | | contracts.renewable | 契約が更新可能かどうかを示すフラグ。 可能な値： * true:契約は更新可能です。 * false:契約は更新できません。 データタイプ:ブール文字列 | | contracts.sales_tax | この契約で参照される品目に対して消費税を課すべきかどうかを示すフラグ。 可能な値： * true:売上税が請求されます。 * false:消費税はかかりません。 データタイプ:ブール文字列 | | contracts.short_description | 契約の簡単な説明。 データタイプ：文字列 | | contracts.starts | 契約の開始日。 データタイプ：文字列 | | contracts.state | 契約の現在のステータスに関する詳細。 データタイプ: オブジェクト "state": { "display_value": "String", "value": "String" } | | contracts.state.display_value | 契約の現在の状況を示すテキスト文字列。この値を使用して、UI にステータスを表示します。 データタイプ：文字列 | | contracts.state.value | 内部値または契約のステータス。 データタイプ：文字列 | | contracts.sub_total_cost | 契約コストの小計。 データタイプ：文字列 | | contracts.sys_class_name | 契約レコードを含むテーブル。 データタイプ：文字列 | | contracts.sys_domain_path | この契約が利用可能なドメインへのパス。 データタイプ：文字列 デフォルト:「/」=グローバルドメイン | | 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 | 契約の年間コスト。 データタイプ：文字列 | | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "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\t​CNTR0000701", "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 {#ariaid-title8} 指定されたインストールベースアイテムレコードに関連付けられたエンタイトルメントを返します。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/entitlements デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/entitlements 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-entitlements__entry__2}{#integrat-GET-entitlements__version-not_optional-RESTAPI}{#integrat-GET-entitlements__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 37. パスパラメーター] {#integrat-GET-entitlements__entry__8}{#integrat-GET-entitlements__sysparm-limit-RESTAPI}{#integrat-GET-entitlements__sysparm_offset-ph-RESTAPI} | 名前 | 説明 | |-|-| | フィールドの名前と値のペア | エンタイトルメントレコードのフィルタリングに使用するフィールドと値のペア。デフォルトでは、これはエンタイトルメント \[service_entitlement\] テーブルのフィールドを参照します。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。 たとえば、アクティブなレコードのみを返すには、 `&active=true` を渡します。 データタイプ：文字列 デフォルト:すべてのフィールド | | sys_class_name | 拡張エンタイトルメントテーブル (service_entitlement ではない) を使用している場合、クエリ対象の拡張テーブルの名前。 データタイプ：文字列 デフォルト値:service_entitlement | | sysparm_limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。 この制限は、ACL 評価の前に適用されます。アクセス権のあるレコードを含めて、レコードが返されない場合は、アクセス権のあるレコードが最初に返されるようにレコードの順序を並べ替えます。 注: sysparm_limit値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。 データタイプ：数値 デフォルト：10000 | | sysparm_offset | レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。{#integrat-GET-entitlements__sysparm_offset-p-RESTAPI} sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0 | [表 : 38. クエリパラメーター] {#integrat-GET-entitlements__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 39. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-entitlements__entry__22}{#integrat-GET-entitlements__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 40. 要求ヘッダー] {#integrat-GET-entitlements__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 41. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-entitlements__entry__30}{#integrat-GET-entitlements__entry-200-status-code}{#integrat-GET-entitlements__entry-400-status-code}{#integrat-GET-entitlements__entry-403-status-code}{#integrat-GET-entitlements__entry-404-status-code}{#integrat-GET-entitlements__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 42. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-GET-entitlements__entry__42}{#integrat-GET-entitlements__error-integration-entry}{#integrat-GET-entitlements__error_detail-integration-entry}{#integrat-GET-entitlements__error_message-integration-entry}{#integrat-GET-entitlements__has_more-integration-entry}{#integrat-GET-entitlements__status-integration-entry}{#integrat-GET-entitlements__sysparm_limit-integration-entry}{#integrat-GET-entitlements__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | エンタイトルメント | 指定されたインストールベースアイテムレコードに関連付けられたエンタイトルメントのリスト。 データタイプ: オブジェクト "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。 データタイプ：文字列 | | entitlements.active | エンタイトルメントがアクティブかどうかを示すフラグ。 可能な値： * 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。 データタイプ：文字列 | | entitlements.contract | エンタイトルメントレコードに関連付けられた契約の詳細。 データタイプ: オブジェクト "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 {#ariaid-title9} 指定されたインストールベースアイテムレコードに関連付けられたメンテナンス計画を返します。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/maintenanceplans デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/maintenanceplans 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-maintenanceplans__entry__2}{#integrat-GET-maintenanceplans__version-not_optional-RESTAPI}{#integrat-GET-maintenanceplans__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 43. パスパラメーター] {#integrat-GET-maintenanceplans__entry__8}{#integrat-GET-maintenanceplans__sysparm-limit-RESTAPI}{#integrat-GET-maintenanceplans__sysparm_offset-ph-RESTAPI} | 名前 | 説明 | |-|-| | フィールドの名前と値のペア | メンテナンス計画レコードのフィルタリングに使用するフィールドと値のペア。デフォルトでは、これはメンテナンス計画 \[sm_maint_plan\] テーブルのフィールドを参照します。sys_class_nameで別のテーブルを指定する場合は、そのテーブルのフィールドを指定します。 1 つ以上のフィールドと値のペアを渡して、返される結果をフィルタリングできます。 たとえば、アクティブなレコードのみを返すには、 `&active=true` を渡します。 データタイプ：文字列 デフォルト:すべてのフィールド | | sys_class_name | (メンテナンス計画ではない) 拡張メンテナンス計画テーブルを使用する場合、クエリする拡張テーブルの名前。 データタイプ：文字列 デフォルト:maintenanceplans | | sysparm_limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。 この制限は、ACL 評価の前に適用されます。アクセス権のあるレコードを含めて、レコードが返されない場合は、アクセス権のあるレコードが最初に返されるようにレコードの順序を並べ替えます。 注: sysparm_limit値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。 データタイプ：数値 デフォルト：10000 | | sysparm_offset | レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。{#integrat-GET-maintenanceplans__sysparm_offset-p-RESTAPI} sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0 | [表 : 44. クエリパラメーター] {#integrat-GET-maintenanceplans__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 45. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-maintenanceplans__entry__22}{#integrat-GET-maintenanceplans__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 46. 要求ヘッダー] {#integrat-GET-maintenanceplans__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 47. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-maintenanceplans__entry__30}{#integrat-GET-maintenanceplans__entry-200-status-code}{#integrat-GET-maintenanceplans__entry-400-status-code}{#integrat-GET-maintenanceplans__entry-403-status-code}{#integrat-GET-maintenanceplans__entry-404-status-code}{#integrat-GET-maintenanceplans__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 48. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-GET-maintenanceplans__entry__42}{#integrat-GET-maintenanceplans__error-integration-entry}{#integrat-GET-maintenanceplans__error_detail-integration-entry}{#integrat-GET-maintenanceplans__error_message-integration-entry}{#integrat-GET-maintenanceplans__has_more-integration-entry}{#integrat-GET-maintenanceplans__status-integration-entry}{#integrat-GET-maintenanceplans__sysparm_limit-integration-entry}{#integrat-GET-maintenanceplans__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "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 {#ariaid-title10} 指定されたインストールベースアイテムレコードに関連付けられた関係者を返します。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-relatedparties__entry__2}{#integrat-GET-relatedparties__version-not_optional-RESTAPI}{#integrat-GET-relatedparties__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 49. パスパラメーター] {#integrat-GET-relatedparties__entry__8}{#integrat-GET-relatedparties__sysparm-limit-RESTAPI}{#integrat-GET-relatedparties__sysparm_offset-ph-RESTAPI} | 名前 | 説明 | |-|-| | フィールドの名前と値のペア | 関係者レコードのフィルタリングに使用するフィールドと値のペア。デフォルトでは、これは関係者 \[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値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。 データタイプ：数値 デフォルト：10000 | | sysparm_offset | レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。{#integrat-GET-relatedparties__sysparm_offset-p-RESTAPI} sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0 | [表 : 50. クエリパラメーター] {#integrat-GET-relatedparties__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 51. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-relatedparties__entry__22}{#integrat-GET-relatedparties__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 52. 要求ヘッダー] {#integrat-GET-relatedparties__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 53. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-relatedparties__entry__30}{#integrat-GET-relatedparties__entry-200-status-code}{#integrat-GET-relatedparties__entry-400-status-code}{#integrat-GET-relatedparties__entry-403-status-code}{#integrat-GET-relatedparties__entry-404-status-code}{#integrat-GET-relatedparties__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 54. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-GET-relatedparties__id_gls_y2f_zwb__entry__2}{#integrat-GET-relatedparties__related_parties-integration-entry}{#integrat-GET-relatedparties__account-rp-integration-entry}{#integrat-GET-relatedparties__account_display_value-rp-integration-entry}{#integrat-GET-relatedparties__account_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__consumer-rp-integration-entry}{#integrat-GET-relatedparties__consumer_display_value-rp-integration-entry}{#integrat-GET-relatedparties__consumer_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__contact-rp-integration-entry}{#integrat-GET-relatedparties__contact_display_value-rp-integration-entry}{#integrat-GET-relatedparties__contact_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__install_base_item-rp-integration-entry}{#integrat-GET-relatedparties__install_base_item_display_value-rp-integration-entry}{#integrat-GET-relatedparties__install_base_item_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__responsibility-rp-integration-entry}{#integrat-GET-relatedparties__responsibility_display_value-rp-integration-entry}{#integrat-GET-relatedparties__responsibility_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__sys_class_name-rp-integration-entry}{#integrat-GET-relatedparties__sys_id-rp-integration-entry}{#integrat-GET-relatedparties__type-rp-integration-entry}{#integrat-GET-relatedparties__type_display_value-rp-integration-entry}{#integrat-GET-relatedparties__type_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__user-rp-integration-entry}{#integrat-GET-relatedparties__user_display_value-rp-integration-entry}{#integrat-GET-relatedparties__user_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__status-integration-entry}{#integrat-GET-relatedparties__sysparm_limit-integration-entry}{#integrat-GET-relatedparties__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "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](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=australia&pubname=australia-government-industry&ft:locale=en-US) データタイプ：文字列 テーブル:責任の定義 \[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_class_name | 関係者レコードを含むテーブル。 データタイプ：文字列 デフォルト値: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](https://www.servicenow.com/docs/access?context=adding-related-party-config-to-case&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。 可能なタイプ: * 承認済みアカウント * 認定コンシューマー * 認定連絡先 * 認定貢献者 * 認定メンバー * 認証サービス組織 * リストされたアカウント * リストされたコンシューマー * リストされた連絡先 * リストされた貢献者 * リストされたメンバー * リストされたサービス組織 データタイプ：文字列 | | 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 | レコードが評価および取得された関連テーブル内のオフセット (開始点)。 データタイプ：文字列 | [ ] {#integrat-GET-relatedparties__id_gls_y2f_zwb} ### 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 {#ariaid-title11} 指定されたインストールベースアイテムレコードに関連付けられた販売済み製品レコードを返します。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/soldproducts デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/soldproducts 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-soldproducts__entry__2}{#integrat-GET-soldproducts__version-not_optional-RESTAPI}{#integrat-GET-soldproducts__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 55. パスパラメーター] {#integrat-GET-soldproducts__entry__8}{#integrat-GET-soldproducts__sysparm-limit-RESTAPI}{#integrat-GET-soldproducts__sysparm_offset-ph-RESTAPI} | 名前 | 説明 | |-|-| | フィールドの名前と値のペア | 関係者レコードのフィルタリングに使用するフィールドと値のペア。デフォルトでは、これは販売済み製品 \[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値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。 データタイプ：数値 デフォルト：10000 | | sysparm_offset | レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。{#integrat-GET-soldproducts__sysparm_offset-p-RESTAPI} sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0 | [表 : 56. クエリパラメーター] {#integrat-GET-soldproducts__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 57. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-soldproducts__entry__22}{#integrat-GET-soldproducts__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 58. 要求ヘッダー] {#integrat-GET-soldproducts__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 59. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-soldproducts__entry__30}{#integrat-GET-soldproducts__entry-200-status-code}{#integrat-GET-soldproducts__entry-400-status-code}{#integrat-GET-soldproducts__entry-403-status-code}{#integrat-GET-soldproducts__entry-404-status-code}{#integrat-GET-soldproducts__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 60. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-GET-soldproducts__entry__42}{#integrat-GET-soldproducts__error-integration-entry}{#integrat-GET-soldproducts__error_detail-integration-entry}{#integrat-GET-soldproducts__error_message-integration-entry}{#integrat-GET-soldproducts__has_more-integration-entry}{#integrat-GET-soldproducts__status-integration-entry}{#integrat-GET-soldproducts__sysparm_limit-integration-entry}{#integrat-GET-soldproducts__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "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} } ] | | 販売済み製品.アカウント | 製品レコードに関連付けられているアカウントの詳細。 データタイプ: オブジェクト account": { "display_value": "String", "sys_id": "String" } | | soldproducts.account.display_value | 製品レコードに関連付けられているアカウントのテキスト名。この値を使用して、アカウント名を UI に表示します。 データタイプ：文字列 | | soldproducts.account.sys_id | 製品レコードに関連付けられたアカウントレコードのSys_id。 データタイプ：文字列 | | 販売済み製品.連絡先 | 製品を担当するアカウント担当者の詳細。 データタイプ: オブジェクト "contact": { "display_value": "String", "sys_id": "String" } | | soldproducts.contact.display_value | 製品に関連付けられた連絡先のテキスト名。この値を使用して、連絡先名を UI に表示します。 データタイプ：文字列 | | soldproducts.contact.sys_id | 製品レコードに関連付けられた連絡先レコードのSys_id。 データタイプ：文字列 | | soldproducts.name | 製品の名前。 データタイプ：文字列 | | soldproducts.number | 製品番号。 データタイプ：文字列 | | soldproducts.sys_class_name | 製品レコードを含むテーブル。 データタイプ：文字列 | | 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 {#ariaid-title12} 指定されたインストールベースアイテムレコードに関連付けられた作業指示書を返します。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/workorders デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/workorders 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-GET-workorders__entry__2}{#integrat-GET-workorders__version-not_optional-RESTAPI}{#integrat-GET-workorders__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 61. パスパラメーター] {#integrat-GET-workorders__entry__8}{#integrat-GET-workorders__sysparm_offset-ph-RESTAPI} | 名前 | 説明 | |-|-| | フィールドの名前と値のペア | 関係者レコードのフィルタリングに使用するフィールドと値のペア。デフォルトでは、これは販売済み製品 \[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` を使用します。{#integrat-GET-workorders__sysparm_offset-p-RESTAPI} sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0 | [表 : 62. クエリパラメーター] {#integrat-GET-workorders__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 63. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-GET-workorders__entry__22}{#integrat-GET-workorders__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 64. 要求ヘッダー] {#integrat-GET-workorders__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 65. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-GET-workorders__entry__30}{#integrat-GET-workorders__entry-200-status-code}{#integrat-GET-workorders__entry-400-status-code}{#integrat-GET-workorders__entry-403-status-code}{#integrat-GET-workorders__entry-404-status-code}{#integrat-GET-workorders__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 66. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-GET-workorders__entry__42}{#integrat-GET-workorders__error-integration-entry}{#integrat-GET-workorders__error_detail-integration-entry}{#integrat-GET-workorders__error_message-integration-entry}{#integrat-GET-workorders__has_more-integration-entry}{#integrat-GET-workorders__status-integration-entry}{#integrat-GET-workorders__sysparm_limit-integration-entry}{#integrat-GET-workorders__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "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:作業指示は請求できません {#integrat-GET-workorders__ul_ign_q2w_4xb} データタイプ:ブール文字列 | | 作業指示書。エスカレーション | 作業指示書のエスカレーションレベル。 データタイプ：文字列 | | 作業指示書。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 * 続行 データタイプ：文字列 | | 作業指示書。upon_reject | 作業指示書が却下された場合に次に実行するアクションに関する詳細。 データタイプ: オブジェクト "upon_reject": { "display_value": "String", "value": "String" } | | 作業指示書。upon_reject。display_value | 作業指示書が却下された場合に実行するアクションのテキスト文字列。この情報を UI に表示するには、この値を使用します。 データタイプ：文字列 | | 作業指示書。upon_reject。価値 | 作業指示が却下された場合に実行するアクション。 可能な値： * キャンセル * 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} {#ariaid-title13} 指定されたインストールベースアイテムレコードを指定されたフィールド値で更新します。 ### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id} デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id} 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-PATCH-installbaseitems__entry__2}{#integrat-PATCH-installbaseitems__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 67. パスパラメーター] {#integrat-PATCH-installbaseitems__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 68. クエリパラメーター] {#integrat-PATCH-installbaseitems__id_x5m_53g_xwb__entry__2}{#integrat-PATCH-installbaseitems__account-request-integration-entry}{#integrat-PATCH-installbaseitems__active-request-integration-entry}{#integrat-PATCH-installbaseitems__asset-request-integration-entry}{#integrat-PATCH-installbaseitems__child_install_base_items-request-integration-entry}{#integrat-PATCH-installbaseitems__child_install_base_items_name-request-integration-entry}{#integrat-PATCH-installbaseitems__child_install_base_items_product-request-integration-entry}{#integrat-PATCH-installbaseitems__configuration_item-request-integration-entry}{#integrat-PATCH-installbaseitems__consumer-request-integration-entry}{#integrat-PATCH-installbaseitems__consumer_profile-request-integration-entry}{#integrat-PATCH-installbaseitems__contact-request-integration-entry}{#integrat-PATCH-installbaseitems__household-request-integration-entry}{#integrat-PATCH-installbaseitems__install_date-request-integration-entry}{#integrat-PATCH-installbaseitems__location-request-integration-entry}{#integrat-PATCH-installbaseitems__name-request-integration-entry}{#integrat-PATCH-installbaseitems__number-request-integration-entry}{#integrat-PATCH-installbaseitems__parent-request-integration-entry}{#integrat-PATCH-installbaseitems__product-request-integration-entry}{#integrat-PATCH-installbaseitems__quantity-request-integration-entry}{#integrat-PATCH-installbaseitems__service_context-request-integration-entry}{#integrat-PATCH-installbaseitems__service_organization-request-integration-entry}{#integrat-PATCH-installbaseitems__state-request-integration-entry}{#integrat-PATCH-installbaseitems__status-request-integration-entry}{#integrat-PATCH-installbaseitems__uninstall_date-request-integration-entry} | 名前 | 説明 | |-|-| | アカウント | アカウントのインストールベースアイテムを作成するときに必要です。 インストールベースアイテムに関連付けるアカウントのSys_id。 注: accountパラメーターを渡した場合、consumerパラメーターも渡すことはできません。 データタイプ：文字列 テーブル:アカウント \[customer_account\] | | アクティブ | インストールベースアイテムがアクティブかどうかを示すフラグ。 有効な値： * true、「true」、または「0」:アイテムはアクティブです。 * false、「false」、または「1」:アイテムはアクティブではありません。 データタイプ：ブーリアン デフォルト：true | | 資産 | インストールベースアイテムレコードに関連付けられた資産のSys_id。 データタイプ：文字列 テーブル:資産 \[alm_asset\] | | child_install_base_items | このインストールベースアイテムに関連付けられた子インストールベースアイテムのリスト。 注: 次の子インストールベースアイテムフィールドは、その親と異なるものにはできません。 * アカウント * consumer * 連絡先 * サービス組織 {#integrat-PATCH-installbaseitems__ul_fkz_s33_wxb} データタイプ：オブジェクトのアレイ "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 | | location | 関連製品の場所のSys_id。 データタイプ：文字列 テーブル:場所 \[cmn_location\] | | name | インストールベースアイテムの名前。 データタイプ：文字列 | | number | インストールベースアイテムの一意の識別子。 データタイプ：文字列 デフォルト:エンドポイントによって自動的に生成されます。 | | 親 | このインストールベースアイテムレコードの親レコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | | product_model | インストールベースアイテムレコードに関連付けられた製品モデルのSys_id。 データタイプ：文字列 テーブル:製品モデル \[cmdb_model\] | | 数量 | インストールされているアイテムの数。 データタイプ：整数 | | service_context | イベント管理から影響度の重大度を計算するために基になる CI に関連付けられているサービスのSys_id。詳細については、「[Service health status for install base](https://www.servicenow.com/docs/access?context=service-health-pcso&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。 注: このフィールドは、イベント管理によるプロアクティブカスタマーサービスオペレーションプラグインがインストールされている場合にのみ有効です。 データタイプ：文字列 | | service_organization | サービス組織のインストールベースアイテムを作成するときに必要です。 顧客にサービスを提供する際に関与するサービス組織レコードのSys_id。 注: このパラメーターを渡す場合は、アカウント、連絡先、またはコンシューマーのパラメーターも渡さないでください。service_organization パラメーターは、サービス組織 (com.snc.service_organization) プラグインがインスタンスにインストールされている場合にのみ使用できます。 データタイプ：文字列 テーブル:サービス組織 \[sn_customer_service_organization\] | | 状況 | インストールベースアイテムの現在のステータス。 有効な値： * in_use * inactive データタイプ：文字列 | | status | 製品のステータス。 有効な値： * オリジナル * 交換 データタイプ：文字列 | | sys_class_name | インストールベースアイテムレコードを更新する拡張インストールベーステーブルの名前。 データタイプ：文字列 | | uninstall_date | インストールベースが非アクティブになる日付。 データタイプ：文字列 形式：yyyy-MM-dd HH:mm:ss | [表 : 69. 要求本文パラメーター (XML または JSON)] {#integrat-PATCH-installbaseitems__id_x5m_53g_xwb} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-PATCH-installbaseitems__entry__60}{#integrat-PATCH-installbaseitems__accept-RESTAPI}{#integrat-PATCH-installbaseitems__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 70. 要求ヘッダー] {#integrat-PATCH-installbaseitems__entry__66} | ヘッダー | 説明 | |-|-| | なし | | [表 : 71. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-PATCH-installbaseitems__entry__70}{#integrat-PATCH-installbaseitems__entry-200-status-code}{#integrat-PATCH-installbaseitems__entry-400-status-code}{#integrat-PATCH-installbaseitems__entry-403-status-code}{#integrat-PATCH-installbaseitems__entry-404-status-code}{#integrat-PATCH-installbaseitems__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 72. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-PATCH-installbaseitems__id_zk1_w5w_ywb__entry__2}{#integrat-PATCH-installbaseitems__error-integration-entry}{#integrat-PATCH-installbaseitems__error_detail-integration-entry}{#integrat-PATCH-installbaseitems__error_message-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | 関連するエラーに関するその他の詳細。 データタイプ：文字列 | | error.message | 要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。 データタイプ：文字列 | | アイテム | 更新されたインストールベースアイテムの詳細。 データタイプ: オブジェクト "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_class_name | インストールベースアイテムを含むテーブルの詳細。 データタイプ: オブジェクト "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 パラメーターで指定されたテーブルにあります。 データタイプ：文字列 | | status | エンドポイント呼び出しのステータス。 データタイプ：文字列 | [ ] {#integrat-PATCH-installbaseitems__id_zk1_w5w_ywb} ### 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} {#ariaid-title14} 指定されたインストールベースアイテムに関連付けられている、指定された関係者レコードを要求本文の値で更新します。 インストールベースアイテムに関連付けられた関係者のタイプを変更する必要がある場合は、現在の関係者タイプのタイプ固有のフィールドを削除し、新しい関係者タイプのタイプ固有のフィールドに置き換える必要があります。たとえば、承認済みアカウントのタイプから認定コンシューマーに変更するには、以下を渡します。 * type =「認定コンシューマー」 * account = "" * consumer =「コンシューマーレコードの\」 * responsibility =「消費者の責任\」 ### 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 エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-PATCH-relatedparties__entry__2}{#integrat-PATCH-relatedparties__version-not_optional-RESTAPI}{#integrat-PATCH-relatedparties__integrate-id-entry}{#integrat-PATCH-relatedparties__related_party_sys_id-integrate-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | | related_party_sys_id | 関係者レコードのSys_id。 データタイプ：文字列 テーブル:インストールベース関連パーティ \[sn_install_base_related_party\] | [表 : 73. パスパラメーター] {#integrat-PATCH-relatedparties__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 74. クエリパラメーター] {#integrat-PATCH-relatedparties__entry__14}{#integrat-PATCH-relatedparties__account-request-integration-entry}{#integrat-PATCH-relatedparties__consumer-request-integration-entry}{#integrat-PATCH-relatedparties__service_organization-request-integration-entry} | 名前 | 説明 | |-|-| | アカウント | 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](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=australia&pubname=australia-government-industry&ft:locale=en-US) データタイプ：文字列 テーブル:責任の定義 \[sn_customerservice_responsibility_def\] | | service_organization | typeパラメーターが次のいずれかの場合は必須です。 * 認定メンバー * 認証サービス組織 * リストされたメンバー * リストされたサービス組織 顧客にサービスを提供する際に関与するサービス組織レコードのSys_id。 注: このパラメーターを渡す場合は、アカウント、連絡先、またはコンシューマーのパラメーターも渡さないでください。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\] | | ユーザー | typeパラメーターが次のいずれかの関係者タイプである場合は必須です。 * 認定貢献者 * 認定メンバー * リストされた貢献者 * リストされたメンバー 関係者レコードに関連付けられたユーザーレコードのSys_id。 データタイプ：文字列 テーブル： ユーザー \[sys_user\] \[認定メンバー\] および \[リストメンバー\] の場合、このユーザーは指定されたservice_organizationレコードに関連付けられている必要があります。 | [表 : 75. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-PATCH-relatedparties__entry__32}{#integrat-PATCH-relatedparties__accept-RESTAPI}{#integrat-PATCH-relatedparties__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 76. 要求ヘッダー] {#integrat-PATCH-relatedparties__entry__38} | ヘッダー | 説明 | |-|-| | なし | | [表 : 77. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-PATCH-relatedparties__entry__42}{#integrat-PATCH-relatedparties__entry-200-status-code}{#integrat-PATCH-relatedparties__entry-400-status-code}{#integrat-PATCH-relatedparties__entry-403-status-code}{#integrat-PATCH-relatedparties__entry-404-status-code}{#integrat-PATCH-relatedparties__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 78. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-PATCH-relatedparties__id_gls_y2f_zwb__entry__2}{#integrat-PATCH-relatedparties__error-integration-entry}{#integrat-PATCH-relatedparties__error_detail-integration-entry}{#integrat-PATCH-relatedparties__error_message-integration-entry}{#integrat-PATCH-relatedparties__status-integration-entry}{#integrat-PATCH-relatedparties__sysparm_limit-integration-entry}{#integrat-PATCH-relatedparties__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | 関連するエラーに関するその他の詳細。 データタイプ：文字列 | | error.message | 要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。 データタイプ：文字列 | | アイテム | 関係者レコードの詳細。 データタイプ：アレイ "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](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=australia&pubname=australia-government-industry&ft:locale=en-US) データタイプ：文字列 テーブル:責任の定義 \[sn_customerservice_responsibility_def\] | | item.sys_class_name | 関係者レコードを含むテーブル。 データタイプ：文字列 デフォルト値: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](https://www.servicenow.com/docs/access?context=adding-related-party-config-to-case&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。 可能なタイプ: * 承認済みアカウント * 認定コンシューマー * 認定連絡先 * 認定貢献者 * 認定メンバー * 認証サービス組織 * リストされたアカウント * リストされたコンシューマー * リストされた連絡先 * リストされた貢献者 * リストされたメンバー * リストされたサービス組織 データタイプ：文字列 | | 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 | レコードが評価および取得された関連テーブル内のオフセット (開始点)。 データタイプ：文字列 | [ ] {#integrat-PATCH-relatedparties__id_gls_y2f_zwb} ### 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 {#ariaid-title15} 指定されたインストールベースアイテムをアンインストールします。 アンインストールは、 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 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-PATCH-uninstall__entry__2}{#integrat-PATCH-uninstall__version-not_optional-RESTAPI}{#integrat-PATCH-uninstall__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 79. パスパラメーター] {#integrat-PATCH-uninstall__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 80. クエリパラメーター] {#integrat-PATCH-uninstall__entry__12} | 名前 | 説明 | |-|-| | uninstall_date | 指定されたインストールベースアイテムをアンインストールする日付。指定しない場合は、すぐにアンインストールされます。 データタイプ：文字列 形式:yyyy-mm-dd hh:mm:ss | [表 : 81. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-PATCH-uninstall__entry__16}{#integrat-PATCH-uninstall__accept-RESTAPI}{#integrat-PATCH-uninstall__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 82. 要求ヘッダー] {#integrat-PATCH-uninstall__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 83. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-PATCH-uninstall__entry__26}{#integrat-PATCH-uninstall__entry-200-status-code}{#integrat-PATCH-uninstall__entry-400-status-code}{#integrat-PATCH-uninstall__entry-403-status-code}{#integrat-PATCH-uninstall__entry-404-status-code}{#integrat-PATCH-uninstall__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 84. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-PATCH-uninstall__entry__38}{#integrat-PATCH-uninstall__error-integration-entry}{#integrat-PATCH-uninstall__error_detail-integration-entry}{#integrat-PATCH-uninstall__error_message-integration-entry}{#integrat-PATCH-uninstall__account-integration-row}{#integrat-PATCH-uninstall__account_display_value-integration-row}{#integrat-PATCH-uninstall__account_sys_id-integration-row}{#integrat-PATCH-uninstall__active-integration-row}{#integrat-PATCH-uninstall__name-integration-row}{#integrat-PATCH-uninstall__number-integration-row}{#integrat-PATCH-uninstall__sys_class_name-integration-row}{#integrat-PATCH-uninstall__sys_id-integration-row}{#integrat-PATCH-uninstall__state-integration-row}{#integrat-PATCH-uninstall__state_display_value-integration-row}{#integrat-PATCH-uninstall__state_value-integration-row}{#integrat-PATCH-uninstall__status-integration-entry} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | 関連するエラーに関するその他の詳細。 データタイプ：文字列 | | error.message | 要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。 データタイプ：文字列 | | アイテム | アンインストールされたアイテムの説明。 データタイプ: オブジェクト "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 * 連絡先 * サービス組織 {#integrat-PATCH-uninstall__ul_fkz_s33_wxb} データタイプ：オブジェクトのアレイ "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_class_name | インストールベースアイテムレコードを含むテーブル。 データタイプ：文字列 | | 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 {#ariaid-title16} デフォルトのインストールベースアイテムテーブル、または指定されている場合はその拡張テーブルに 1 つ以上のインストールベースアイテムレコードを作成し、指定されたフィールド値を入力します。 単一のインストールベースアイテムレコードを作成する場合は、要求本文に含めるすべてのフィールドを含むオブジェクトを要求本文に渡します。1 回の呼び出しで複数のインストールベースアイテムレコードを作成する場合は、作成するすべてのレコードを含むオブジェクトのアレイを要求本文に渡します。エンドポイントは、各レコード作成オブジェクトを個別に処理し、レポートします。1 つ以上のレコードの作成に失敗しても、他のレコードの作成には影響しません。 ### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems デフォルト URL: /api/sn_install_base/integrations/installbaseitems 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-POST-installbaseitems__entry__2}{#integrat-POST-installbaseitems__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 85. パスパラメーター] {#integrat-POST-installbaseitems__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 86. クエリパラメーター] {#integrat-POST-installbaseitems__id_x5m_53g_xwb__entry__2}{#integrat-POST-installbaseitems__account-request-integration-entry}{#integrat-POST-installbaseitems__active-request-integration-entry}{#integrat-POST-installbaseitems__asset-request-integration-entry}{#integrat-POST-installbaseitems__child_install_base_items-request-integration-entry}{#integrat-POST-installbaseitems__child_install_base_items_name-request-integration-entry}{#integrat-POST-installbaseitems__child_install_base_items_product-request-integration-entry}{#integrat-POST-installbaseitems__configuration_item-request-integration-entry}{#integrat-POST-installbaseitems__consumer-request-integration-entry}{#integrat-POST-installbaseitems__consumer_profile-request-integration-entry}{#integrat-POST-installbaseitems__contact-request-integration-entry}{#integrat-POST-installbaseitems__household-request-integration-entry}{#integrat-POST-installbaseitems__install_date-request-integration-entry}{#integrat-POST-installbaseitems__location-request-integration-entry}{#integrat-POST-installbaseitems__name-request-integration-entry}{#integrat-POST-installbaseitems__number-request-integration-entry}{#integrat-POST-installbaseitems__parent-request-integration-entry}{#integrat-POST-installbaseitems__product-request-integration-entry}{#integrat-POST-installbaseitems__quantity-request-integration-entry}{#integrat-POST-installbaseitems__service_context-request-integration-entry}{#integrat-POST-installbaseitems__service_organization-request-integration-entry}{#integrat-POST-installbaseitems__state-request-integration-entry}{#integrat-POST-installbaseitems__status-request-integration-entry}{#integrat-POST-installbaseitems__uninstall_date-request-integration-entry} | 名前 | 説明 | |-|-| | アカウント | アカウントのインストールベースアイテムを作成するときに必要です。 インストールベースアイテムに関連付けるアカウントのSys_id。 注: accountパラメーターを渡した場合、consumerパラメーターも渡すことはできません。 データタイプ：文字列 テーブル:アカウント \[customer_account\] | | アクティブ | インストールベースアイテムがアクティブかどうかを示すフラグ。 有効な値： * true、「true」、または「0」:アイテムはアクティブです。 * false、「false」、または「1」:アイテムはアクティブではありません。 データタイプ：ブーリアン デフォルト：true | | 資産 | インストールベースアイテムレコードに関連付けられた資産のSys_id。 データタイプ：文字列 テーブル:資産 \[alm_asset\] | | child_install_base_items | このインストールベースアイテムに関連付けられた子インストールベースアイテムのリスト。 注: 次の子インストールベースアイテムフィールドは、その親と異なるものにはできません。 * アカウント * consumer * 連絡先 * サービス組織 {#integrat-POST-installbaseitems__ul_fkz_s33_wxb} データタイプ：オブジェクトのアレイ "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 | | location | 関連製品の場所のSys_id。 データタイプ：文字列 テーブル:場所 \[cmn_location\] | | name | インストールベースアイテムの名前。 データタイプ：文字列 | | number | インストールベースアイテムの一意の識別子。 データタイプ：文字列 デフォルト:エンドポイントによって自動的に生成されます。 | | 親 | このインストールベースアイテムレコードの親レコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | | product_model | インストールベースアイテムレコードに関連付けられた製品モデルのSys_id。 データタイプ：文字列 テーブル:製品モデル \[cmdb_model\] | | 数量 | インストールされているアイテムの数。 データタイプ：整数 | | service_context | イベント管理から影響度の重大度を計算するために基になる CI に関連付けられているサービスのSys_id。詳細については、「[Service health status for install base](https://www.servicenow.com/docs/access?context=service-health-pcso&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。 注: このフィールドは、イベント管理によるプロアクティブカスタマーサービスオペレーションプラグインがインストールされている場合にのみ有効です。 データタイプ：文字列 | | service_organization | サービス組織のインストールベースアイテムを作成するときに必要です。 顧客にサービスを提供する際に関与するサービス組織レコードのSys_id。 注: このパラメーターを渡す場合は、アカウント、連絡先、またはコンシューマーのパラメーターも渡さないでください。service_organization パラメーターは、サービス組織 (com.snc.service_organization) プラグインがインスタンスにインストールされている場合にのみ使用できます。 データタイプ：文字列 テーブル:サービス組織 \[sn_customer_service_organization\] | | 状況 | インストールベースアイテムの現在のステータス。 有効な値： * in_use * inactive データタイプ：文字列 | | status | 製品のステータス。 有効な値： * オリジナル * 交換 データタイプ：文字列 | | sys_class_name | インストールベースアイテムレコードを作成する拡張インストールベーステーブルの名前。 データタイプ：文字列 デフォルト:インストールベースアイテム \[sn_install_base_item\] テーブル | | uninstall_date | インストールベースが非アクティブになる日付。 データタイプ：文字列 形式：yyyy-MM-dd HH:mm:ss | [表 : 87. 要求本文パラメーター (XML または JSON)] {#integrat-POST-installbaseitems__id_x5m_53g_xwb} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-POST-installbaseitems__entry__60}{#integrat-POST-installbaseitems__accept-RESTAPI}{#integrat-POST-installbaseitems__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 88. 要求ヘッダー] {#integrat-POST-installbaseitems__entry__66} | ヘッダー | 説明 | |-|-| | なし | | [表 : 89. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-POST-installbaseitems__entry__70}{#integrat-POST-installbaseitems__entry-200-status-code}{#integrat-POST-installbaseitems__entry-400-status-code}{#integrat-POST-installbaseitems__entry-403-status-code}{#integrat-POST-installbaseitems__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 90. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-POST-installbaseitems__id_fw5_m3f_xwb__entry__2}{#integrat-POST-installbaseitems__error-integration-entry}{#integrat-POST-installbaseitems__error_detail-integration-entry}{#integrat-POST-installbaseitems__error_message-integration-entry}{#integrat-POST-installbaseitems__account-integration-row}{#integrat-POST-installbaseitems__account_display_value-integration-row}{#integrat-POST-installbaseitems__account_sys_id-integration-row}{#integrat-POST-installbaseitems__active-integration-row}{#integrat-POST-installbaseitems__name-integration-row}{#integrat-POST-installbaseitems__number-integration-row}{#integrat-POST-installbaseitems__sys_class_name-integration-row}{#integrat-POST-installbaseitems__sys_id-integration-row}{#integrat-POST-installbaseitems__state-integration-row}{#integrat-POST-installbaseitems__state_display_value-integration-row}{#integrat-POST-installbaseitems__state_value-integration-row}{#integrat-POST-installbaseitems__status-integration-row} | 名前 | 説明 | |-|-| | エラー | 要求の処理中に発生したエラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | 関連するエラーに関するその他の詳細。 データタイプ：文字列 | | error.message | 要求を実行しようとしたときに発生した問題を説明するエラーメッセージ。 データタイプ：文字列 | | アイテム | 指定したフィルター結果に一致したインストールベースアイテム。空でないフィールドのみが返されます。 データタイプ：オブジェクトのアレイ "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 * 連絡先 * サービス組織 {#integrat-POST-installbaseitems__d3166e1034} データタイプ：オブジェクトのアレイ "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_class_name | インストールベースアイテムレコードを含むテーブル。 データタイプ：文字列 | | 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 | エンドポイント呼び出しのステータス。 データタイプ：文字列 | [ ] {#integrat-POST-installbaseitems__id_fw5_m3f_xwb} ### cURL 要求 {#integrat-POST-installbaseitems__example_hb3_rsd_bxb} 次のコード例は、単一のインストールベースアイテムレコードを作成する方法を示しています。 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 {#ariaid-title17} 関係者レコードを作成し、指定されたインストールベースアイテムレコードに関連付けます。要求パラメーターで指定された値は、新しく作成された関係者レコードに保存されます。
### URL 形式 バージョニングされた URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties デフォルト URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#integrat-POST-relatedparties__entry__2}{#integrat-POST-relatedparties__version-not_optional-RESTAPI}{#integrat-POST-relatedparties__integrate-id-entry} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | ID | インストールベースアイテムレコードのSys_id。 データタイプ：文字列 テーブル:インストールベースアイテム \[sn_install_base_item\] | [表 : 91. パスパラメーター] {#integrat-POST-relatedparties__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 92. クエリパラメーター] {#integrat-POST-relatedparties__entry__12}{#integrat-POST-relatedparties__account-request-integration-entry}{#integrat-POST-relatedparties__consumer-request-integration-entry}{#integrat-POST-relatedparties__service_organization-request-integration-entry} | 名前 | 説明 | |-|-| | アカウント | 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](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=australia&pubname=australia-government-industry&ft:locale=en-US) データタイプ：文字列 テーブル:責任の定義 \[sn_customerservice_responsibility_def\] | | service_organization | typeパラメーターが次のいずれかの場合は必須です。 * 認定メンバー * 認証サービス組織 * リストされたメンバー * リストされたサービス組織 顧客にサービスを提供する際に関与するサービス組織レコードのSys_id。 注: このパラメーターを渡す場合は、アカウント、連絡先、またはコンシューマーのパラメーターも渡さないでください。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\] | | ユーザー | typeパラメーターが次のいずれかの関係者タイプである場合は必須です。 * 認定貢献者 * 認定メンバー * リストされた貢献者 * リストされたメンバー \[認定メンバー\] および \[リストメンバー\] の場合、このユーザーは指定されたservice_organizationレコードに関連付けられている必要があります。 関係者レコードに関連付けられたユーザーレコードのSys_id。 データタイプ：文字列 テーブル： ユーザー \[sys_user\] | [表 : 93. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#integrat-POST-relatedparties__entry__32}{#integrat-POST-relatedparties__accept-RESTAPI}{#integrat-POST-relatedparties__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 94. 要求ヘッダー] {#integrat-POST-relatedparties__entry__38} | ヘッダー | 説明 | |-|-| | なし | | [表 : 95. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#integrat-POST-relatedparties__entry__42}{#integrat-POST-relatedparties__entry-200-status-code}{#integrat-POST-relatedparties__entry-400-status-code}{#integrat-POST-relatedparties__entry-403-status-code}{#integrat-POST-relatedparties__entry-404-status-code}{#integrat-POST-relatedparties__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 96. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#integrat-POST-relatedparties__entry__54}{#integrat-POST-relatedparties__error-integration-entry}{#integrat-POST-relatedparties__error_detail-integration-entry}{#integrat-POST-relatedparties__error_message-integration-entry}{#integrat-POST-relatedparties__status-integration-entry}{#integrat-POST-relatedparties__sysparm_limit-integration-entry}{#integrat-POST-relatedparties__sysparm_offset-integration-entry} | 名前 | 説明 | |-|-| | アカウント | 関係者レコードに関連付けられているアカウントの詳細。 データタイプ: オブジェクト 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](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=australia&pubname=australia-government-industry&ft:locale=en-US) データタイプ：文字列 テーブル:責任の定義 \[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](https://www.servicenow.com/docs/access?context=adding-related-party-config-to-case&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。 可能なタイプ: * 承認済みアカウント * 認定コンシューマー * 認定連絡先 * 認定貢献者 * 認定メンバー * 認証サービス組織 * リストされたアカウント * リストされたコンシューマー * リストされた連絡先 * リストされた貢献者 * リストされたメンバー * リストされたサービス組織 データタイプ：文字列 | | type.sys_id | 関係者レコードに関連付けられたタイプレコードのSys_id。 データタイプ：文字列 | | ユーザー | 関係者レコードに関連付けられているユーザーの詳細。 データタイプ: オブジェクト "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", } }