CMDB インスタンス API

CMDB インスタンス API は、既存の 構成管理データベース (CMDB) テーブルでの作成、読み取り、更新、および削除操作を可能にするエンドポイントを提供します。一度に 1 つのレコードのみを挿入、更新、または削除できます。

この API を使用するには、ユーザーに ITIL ロールが必要です。

CMDB インスタンス - DELETE /now/cmdb/instance/{classname}/{sys_id}/relation/{rel_sys_id}

指定された構成アイテム (CI) の関係を削除します。

URL 形式

バージョニングされた URL: /api/now/{api_version}/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}

デフォルトの URL：/api/now/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}

注:

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

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

表 : 1. パスパラメーター

名前	説明
className	CMDB クラス名。これは、cmdb_ci_linux_server や cmdb_ci_apache_web_server などの目的の CI レコードを含むテーブルの名前です。 データタイプ：文字列
rel_sys_id	削除する関係の sys_id。 データタイプ：文字列
sys_id	CI の sys_id。 データタイプ：文字列

表 : 2. クエリパラメーター

名前	説明
なし

表 : 3. 要求本文パラメーター (XML または JSON)

名前	説明
なし

ヘッダー

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

表 : 4. 要求ヘッダー

ヘッダー	説明
なし

表 : 5. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 6. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
405	無効なメソッドです。この機能は無効です。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

名前	説明
なし

サンプル cURL 要求

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/0f4ac6c4b750230096c3e4f6ee11a9fe/relation/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--user 'username':'password'

CMDB インスタンス - GET /now/cmdb/instance/{classname}

指定された 構成管理データベース (CMDB) クラス (テーブル) で利用可能な構成アイテム (CI) を返します。

URL 形式

バージョニングされた URL: /api/now/{api_version}/cmdb/instance/{className}

デフォルトの URL：/api/now/cmdb/instance/{className}

注:

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

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

表 : 7. パスパラメーター

名前	説明
className	CMDB クラス名。これは、cmdb_ci_linux_server や cmdb_ci_apache_web_server などの目的の CI レコードを含むテーブルの名前です。 データタイプ：文字列

表 : 8. クエリパラメーター

名前	説明
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。 この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。 注: 異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。 データタイプ：数値 デフォルト値：20 最大：100
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「sysparm_offset=sysparm_offset+sysparm_limit」を使用します。 sysparm_offset パラメーターに負の数を渡さないでください。 データタイプ：数値 デフォルト：0
sysparm_query	結果セットのフィルタリングに使用されるエンコードされたクエリ。UI フィルターを使用して、適切にエンコードクエリーを取得できます。 構文：sysparm_query=<col_name><operator><value>。 <col_name>：フィルターを適用するテーブル列の名前。 <operator>：次の値をサポートします。 =：<value> と完全一致します。 !=：<value> と一致しません。 ^：複数のクエリステートメントの論理 AND。 ^OR：複数のクエリステートメントの論理 OR。 LIKE：指定された文字列が <col_name> に含まれています。データタイプが文字列である <col_name> フィールドに対してのみ機能します。 STARTSWITH：<col_name> は指定された文字列で始まります。データタイプが文字列である <col_name> フィールドに対してのみ機能します。 ENDSWITH：<col_name> は指定した文字列で終了します。データタイプが文字列である <col_name> フィールドに対してのみ機能します。 <value>：照合する値。 すべてのパラメーターで大文字と小文字が区別されます。クエリには、sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>] のように、複数のエントリを含めることができます。 例： (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) エンコードクエリーは、機能別の順番もサポートしています。特定のフィールドに基づいて回答を並べ替えるには、ORDERBY と ORDERBYDESC の句を sysparm_query で使用します。 構文： ORDERBY<col_name> ORDERBYDESC<col_name> 例：sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory このクエリは、すべてのアクティブなレコードをフィルタリングし、結果を番号で昇順に並べ替えた後、カテゴリで降順に並べ替えます。 フィールド名が無効というようにクエリの一部が無効であると、インスタンスは無効な部分を無視します。次に、クエリの有効部分のみを使用して行を返します。この動作は glide.invalid_query.returns_no_rows プロパティを使用してコントロールできます。無効なクエリに行を返さないようにするには、このプロパティを true に設定します。 注: glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンスのすべてのクエリの動作を管理します。 データタイプ：文字列

表 : 9. 要求本文パラメーター (XML または JSON)

名前	説明
なし

ヘッダー

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

表 : 10. 要求ヘッダー

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

表 : 11. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 12. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
405	無効なメソッドです。この機能は無効です。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

名前	説明
name	指定されたクラス内の CI の名前。 データタイプ：文字列
sys_id	CI の sys_id。 データタイプ：文字列

サンプル cURL 要求

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

"result": [
  {
    "sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
    "name": "PS LinuxApp01"
  },
  {
    "sys_id": "3a5dd3dbc0a8ce0100655f1ec66ed42c",
    "name": "PS LinuxApp02"
  }
]

CMDB インスタンス - GET /now/cmdb/instance/{classname}/{sys_id}

指定された構成アイテム (CI) レコードの属性と関係情報を返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/cmdb/instance/{className}/{sys_id}

デフォルトの URL：/api/now/cmdb/instance/{className}/{sys_id}

注:

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

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

表 : 13. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
className	CMDB クラス名。これは、cmdb_ci_linux_server や cmdb_ci_apache_web_server などの目的の CI レコードを含むテーブルの名前です。 データタイプ：文字列
sys_id	取得する CI レコードの sys_id。 データタイプ：文字列

表 : 14. クエリパラメーター

名前	説明
なし

表 : 15. 要求本文パラメーター (XML または JSON)

名前	説明
なし

ヘッダー

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

表 : 16. 要求ヘッダー

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

表 : 17. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 18. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
405	無効なメソッドです。この機能は無効です。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

表 : 19. 応答パラメーター

名前	説明
attributes	現在 CI レコードにあるデータ属性。使用可能な属性は、指定された CMDB クラスによって異なります。cmdb_ci_linux_server や cmdb_ci_mfp_printer など、通常は「cmdb_ci」で始まる関連する CMDB テーブルで使用可能な属性を見つけることができます。 データタイプ：オブジェクト
error	エンドポイント要求の処理中に発生したエラーに関する情報。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" }
error.detail	エラーに関する追加情報。 データタイプ：文字列
error.message	エラーを識別するメッセージ。 データタイプ：文字列
inbound_relations	CI に関連付けられたインバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	インバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.target	ターゲットのインバウンド関係を説明する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	ユーザーインターフェイスに表示するインバウンド関係の名前。 データタイプ：文字列
inbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからインバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
inbound_relations.target.value	インバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.type	インバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	ユーザーインターフェイスに表示するインバウンドタイプの名前。 データタイプ：文字列
inbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからインバウンド関係タイプを取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
inbound_relations.type.value	インバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
outbound_relations	CI に関連付けられたアウトバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
outbound_relations.sys_id	アウトバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.target	必須です。ターゲットのアウトバウンド関係に関する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.target.display_value	ユーザーインターフェイスに表示するアウトバウンド関係の名前。 データタイプ：文字列
outbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからアウトバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
outbound_relations.target.value	アウトバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.type	アウトバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.type.display_value	ユーザーインターフェイスに表示するアウトバウンドタイプの名前。 データタイプ：文字列
outbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからアウトバウンド関係を取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
outbound_relations.type.value	アウトバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
status	エラーが発生した場合にのみ表示されます。エンドポイント処理のステータス。 可能な値：failure データタイプ：文字列

サンプル cURL 要求

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "outbound_relations": [
      {
        "sys_id": "3a62e64ac0a8ce0100aead1e3fd5439f",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      },
      {
        "sys_id": "3a67513fc0a8ce0100914a76cea11b02",
        "type": {
          "display_value": "Exchanges data with::Exchanges data with",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
          "value": "607ad1b2c0a8010e01941856b365af90"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      }
    ],
    "attributes": {
      "firewall_status": "Intranet",
      "os_address_width": "",
      "attested_date": "",
      "operational_status": "1",
      "os_service_pack": "",
      "cpu_core_thread": "",
      "cpu_manufacturer": "",
      "sys_updated_on": "2020-07-08 11:16:51",
      "discovery_source": "",
      "first_discovered": "",
      "due_in": "",
      "used_for": "Production",
      "invoice_number": "",
      "gl_account": "",
      "sys_created_by": "glide.maint",
      "warranty_expiration": "",
      "ram": "2048",
      "cpu_name": "",
      "cpu_speed": "2800",
      "owned_by": "",
      "checked_out": "",
      "kernel_release": "",
      "sys_domain_path": "/",
      "classification": "Production",
      "disk_space": "40",
      "object_id": "",
      "maintenance_schedule": "",
      "cost_center": "",
      "attested_by": "",
      "dns_domain": "",
      "assigned": "2020-01-04 07:00:00",
      "purchase_date": "",
      "life_cycle_stage": "",
      "short_description": "",
      "cd_speed": "",
      "floppy": "",
      "managed_by": {
        "display_value": "Lynda Caraway",
        "link": "https://instance.service-now.com/api/now/table/sys_user/8a826bf03710200044e0bfc8bcbe5d72",
        "value": "8a826bf03710200044e0bfc8bcbe5d72"
      },
      "os_domain": "",
      "last_discovered": "",
      "can_print": "false",
      "sys_class_name": "cmdb_ci_linux_server",
      "manufacturer": {
        "display_value": "Iris",
        "link": "https://instance.servicenow.com/api/now/table/core_company/c115c2f737e3100044e0bfc8bcbe5d46",
        "value": "c115c2f737e3100044e0bfc8bcbe5d46"
      },
      "cpu_count": "1",
      "vendor": {
        "display_value": "Cloudward Inc",
        "link": "https://instance.servicenow.com/api/now/table/core_company/3efe8c4c37423000158bbfc8bcbe5d7d",
        "value": "3efe8c4c37423000158bbfc8bcbe5d7d"
      },
      "life_cycle_stage_status": "",
      "model_number": "",
      "assigned_to": "",
      "start_date": "",
      "os_version": "2.6.9-22.0.1.ELsmp",
      "serial_number": "",
      "cd_rom": "false",
      "support_group": "",
      "unverified": "false",
      "correlation_id": "",
      "attributes": "",
      "asset": {
        "display_value": "P1000091 - Iris 5875",
        "link": "https://instance.servicenow.com/api/now/table/alm_asset/0bc1ba8837f3100044e0bfc8bcbe5dbb",
        "value": "0bc1ba8837f3100044e0bfc8bcbe5dbb"
      },
      "form_factor": "",
      "cpu_core_count": "",
      "skip_sync": "false",
      "attestation_score": "",
      "sys_updated_by": "system",
      "sys_created_on": "2008-10-26 17:17:28",
      "sys_domain": {
        "display_value": "global",
        "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
        "value": "global"
      },
      "cpu_type": "Intel",
      "install_date": "2019-08-18 08:00:00",
      "asset_tag": "P1000091",
      "dr_backup": "",
      "hardware_substatus": "",
      "fqdn": "",
      "change_control": "",
      "internet_facing": "false",
      "delivery_date": "",
      "hardware_status": "",
      "install_status": "1",
      "supported_by": "",
      "name": "PS LinuxApp01",
      "subcategory": "",
      "default_gateway": "",
      "chassis_type": "",
      "virtual": "false",
      "assignment_group": "",
      "managed_by_group": "",
      "sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
      "po_number": "",
      "checked_in": "",
      "sys_class_path": "/!!/!2/!(/!!/!0",
      "mac_address": "",
      "company": {
        "display_value": "ACME Corporation",
        "link": "https://instance.servicenow.com/api/now/table/core_company/e7c1f3d53790200044e0bfc8bcbe5deb",
        "value": "e7c1f3d53790200044e0bfc8bcbe5deb"
      },
      "justification": "",
      "department": "",
      "cost": "45557.5",
      "comments": "",
      "os": "Linux Red Hat",
      "sys_mod_count": "24",
      "monitor": "false",
      "model_id": {
        "display_value": "Iris 5875",
        "link": "https://instance.servicenow.com/api/now/table/cmdb_model/5f5fbcc3c0a8010e00f3b27814f3b96b",
        "value": "5f5fbcc3c0a8010e00f3b27814f3b96b"
      },
      "ip_address": "",
      "duplicate_of": "",
      "sys_tags": "",
      "cost_cc": "USD",
      "order_date": "",
      "schedule": "",
      "environment": "",
      "due": "",
      "attested": "false",
      "location": {
        "display_value": "322 West 52nd Street, New York,NY",
        "link": "https://instance.servicenow.com/api/now/table/cmn_location/25ab9f690a0a0bb3001c5fec1d0d7bcb",
        "value": "25ab9f690a0a0bb3001c5fec1d0d7bcb"
      },
      "category": "Do not migrate to asset",
      "fault_count": "0",
      "host_name": "",
      "lease_id": ""
    },
    "inbound_relations": [
      {
        "sys_id": "3a5e4d8ac0a8ce010005145afb730818",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS Apache01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
          "value": "3a27d4370a0a0bb4006316812bf45439"
        }
      },
      {
        "sys_id": "3a5e4d9cc0a8ce010097f2f5c2f65fd8",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS Apache02",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27f1520a0a0bb400ecd6ff7afcf036",
          "value": "3a27f1520a0a0bb400ecd6ff7afcf036"
        }
      },
      {
        "sys_id": "3a5e4d9fc0a8ce0100a3754fac26fe56",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS Apache03",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a2810c20a0a0bb400268337d6e942ca",
          "value": "3a2810c20a0a0bb400268337d6e942ca"
        }
      }
    ]
  }
}

CMDB インスタンス - POST /now/cmdb/instance/{classname}

指定された 構成管理データベース (CMDB) テーブル内に、指定された送信関係と受信関係を持つ単一の構成アイテム (CI) を作成します。

注:

CMDB クラスに従属識別ルールが定義されている場合、入力ペイロードには既存の CI のsys_idが含まれている必要があります。たとえば、 outbound_relations の場合、 target パラメーターには既存の CI のsys_idが含まれている必要があります。この CI は子になります。inbound_relationsでは、親になります。

  "depends_on": {
    "outbound_relations":
      {
        "target": "b4fd7c8437201000deeabfc8bcbe5dc1",
        "type": "60bc4e22c0a8010e01f074cbe6bd73c3"
      }
    }

URL 形式

バージョニングされた URL: /api/now/{api_version}/cmdb/instance/{className}

デフォルトの URL：/api/now/cmdb/instance/{className}

注:

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

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

表 : 20. パスパラメーター

名前	説明
className	CMDB クラス名。これは、cmdb_ci_linux_server や cmdb_ci_apache_web_server などの目的の CI レコードを含むテーブルの名前です。 データタイプ：文字列

表 : 21. クエリパラメーター

名前	説明
なし

表 : 22. 要求本文パラメーター (XML または JSON)

名前	説明
属性	CI レコードで定義するデータ属性。使用可能な属性は、指定された CMDB クラスによって異なります。cmdb_ci_linux_server や cmdb_ci_mfp_printer など、通常は「cmdb_ci」で始まる関連する CMDB テーブルで使用可能な属性を見つけることができます。 データタイプ：オブジェクト
inbound_relations	CI に関連付けるインバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "inbound_relations": [ { "target": "String", "type": "String" } ]
inbound_relations.target	inbound_relations が指定されている場合は必須です。指定された CI に関連付けるターゲットインバウンド関係の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.type	inbound_relations が指定されている場合は必須です。インバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
outbound_relations	CI に関連付けるアウトバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "outbound_relations": [ { "target": "String", "type": "String" } ]
outbound_relations.target	outbound_relations が指定されている場合は必須です。ターゲットのアウトバウンド関係の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.type	outbound_relations が指定されている場合は必須です。アウトバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
source	必須です。情報を更新したエンティティ。これは、構成アイテム [cmdb_ci] テーブルの discovery_source フィールドで指定された選択値の 1 つである必要があります。 データタイプ：文字列

ヘッダー

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

表 : 23. 要求ヘッダー

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

表 : 24. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 25. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
405	無効なメソッドです。この機能は無効です。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

表 : 26. 応答パラメーター

名前	説明
attributes	現在 CI レコードにあるデータ属性。使用可能な属性は、指定された CMDB クラスによって異なります。cmdb_ci_linux_server や cmdb_ci_mfp_printer など、通常は「cmdb_ci」で始まる関連する CMDB テーブルで使用可能な属性を見つけることができます。 データタイプ：オブジェクト
error	エンドポイント要求の処理中に発生したエラーに関する情報。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" }
error.detail	エラーに関する追加情報。 データタイプ：文字列
error.message	エラーを識別するメッセージ。 データタイプ：文字列
inbound_relations	CI に関連付けられたインバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	インバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.target	ターゲットのインバウンド関係を説明する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	ユーザーインターフェイスに表示するインバウンド関係の名前。 データタイプ：文字列
inbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからインバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
inbound_relations.target.value	インバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.type	インバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	ユーザーインターフェイスに表示するインバウンドタイプの名前。 データタイプ：文字列
inbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからインバウンド関係タイプを取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
inbound_relations.type.value	インバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
outbound_relations	CI に関連付けられたアウトバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
outbound_relations.sys_id	アウトバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.target	必須です。ターゲットのアウトバウンド関係に関する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.target.display_value	ユーザーインターフェイスに表示するアウトバウンド関係の名前。 データタイプ：文字列
outbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからアウトバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
outbound_relations.target.value	アウトバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.type	アウトバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.type.display_value	ユーザーインターフェイスに表示するアウトバウンドタイプの名前。 データタイプ：文字列
outbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからアウトバウンド関係を取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
outbound_relations.type.value	アウトバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
status	エラーが発生した場合にのみ表示されます。エンドポイント処理のステータス。 可能な値：failure データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "outbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    },
    {
      "type" : "607ad1b2c0a8010e01941856b365af90",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    }
  ],
  "attributes": {
    "name" : "lnux999",
    "firewall_status": "Intranet"
  },
  "source": "ServiceNow",
  "inbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a27d4370a0a0bb4006316812bf45439"
    }
  ]
}

{
    "result": {
        "outbound_relations": [
            {
                "sys_id": "403ff2641b425010593876a61a4bcb4b",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            },
            {
                "sys_id": "443ff2641b425010593876a61a4bcb4c",
                "type": {
                    "display_value": "Exchanges data with::Exchanges data with",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
                    "value": "607ad1b2c0a8010e01941856b365af90"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            }
        ],
        "attributes": {
            "firewall_status": "Intranet",
            "os_address_width": "",
            "attested_date": "",
            "operational_status": "1",
            "os_service_pack": "",
            "cpu_core_thread": "",
            "cpu_manufacturer": "",
            "sys_updated_on": "2020-07-13 20:27:28",
            "discovery_source": "ServiceNow",
            "first_discovered": "2020-07-13 20:27:28",
            "due_in": "",
            "used_for": "Production",
            "invoice_number": "",
            "gl_account": "",
            "sys_created_by": "dora.gray",
            "warranty_expiration": "",
            "ram": "",
            "cpu_name": "",
            "cpu_speed": "",
            "owned_by": "",
            "checked_out": "",
            "kernel_release": "",
            "sys_domain_path": "/",
            "classification": "Production",
            "disk_space": "",
            "object_id": "",
            "maintenance_schedule": "",
            "cost_center": "",
            "attested_by": "",
            "dns_domain": "",
            "assigned": "",
            "purchase_date": "",
            "life_cycle_stage": "",
            "short_description": "",
            "cd_speed": "",
            "floppy": "",
            "managed_by": "",
            "os_domain": "",
            "last_discovered": "2020-07-13 20:27:28",
            "can_print": "false",
            "sys_class_name": "cmdb_ci_linux_server",
            "manufacturer": "",
            "cpu_count": "",
            "vendor": "",
            "life_cycle_stage_status": "",
            "model_number": "",
            "assigned_to": "",
            "start_date": "",
            "os_version": "",
            "serial_number": "",
            "cd_rom": "false",
            "support_group": "",
            "unverified": "false",
            "correlation_id": "",
            "attributes": "",
            "asset": "",
            "form_factor": "",
            "cpu_core_count": "",
            "skip_sync": "false",
            "attestation_score": "",
            "sys_updated_by": "dora.gray",
            "sys_created_on": "2020-07-13 20:27:28",
            "sys_domain": {
                "display_value": "global",
                "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
                "value": "global"
            },
            "cpu_type": "",
            "install_date": "",
            "asset_tag": "",
            "dr_backup": "",
            "hardware_substatus": "",
            "fqdn": "",
            "change_control": "",
            "internet_facing": "true",
            "delivery_date": "",
            "hardware_status": "installed",
            "install_status": "1",
            "supported_by": "",
            "name": "lnux299",
            "subcategory": "Computer",
            "default_gateway": "",
            "chassis_type": "",
            "virtual": "false",
            "assignment_group": "",
            "managed_by_group": "",
            "sys_id": "0c3ff2641b425010593876a61a4bcb39",
            "po_number": "",
            "checked_in": "",
            "sys_class_path": "/!!/!2/!(/!!/!0",
            "mac_address": "",
            "company": "",
            "justification": "",
            "department": "",
            "cost": "",
            "comments": "",
            "os": "",
            "sys_mod_count": "0",
            "monitor": "false",
            "model_id": "",
            "ip_address": "",
            "duplicate_of": "",
            "sys_tags": "",
            "cost_cc": "USD",
            "order_date": "",
            "schedule": "",
            "environment": "",
            "due": "",
            "attested": "false",
            "location": "",
            "category": "Hardware",
            "fault_count": "0",
            "host_name": "",
            "lease_id": ""
        },
        "inbound_relations": [
            {
                "sys_id": "c03ff2641b425010593876a61a4bcb49",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS Apache01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
                    "value": "3a27d4370a0a0bb4006316812bf45439"
                }
            }
        ]
    }
}

cURL 要求

次のコード例は、依存識別ルールが定義されているクラスに対してこのエンドポイントを呼び出す方法を示しています。outbound_relations.targetはペイロードに含まれ、既存の CI のsys_idが含まれている必要があります。

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "attributes": {
    "name": "test",
    "sys_class_name":"cmdb_ci_db_mssql_instance",
    "instance_name":"Iname"
  },
  "source": "ServiceNow",
  "depends_on": {
    "outbound_relations":
      {
        "target": "b4fd7c8437201000deeabfc8bcbe5dc1",
        "type": "60bc4e22c0a8010e01f074cbe6bd73c3"
      }
    }
  }
}

{
  "result": {
    "outbound_relations": [
      {
        "sys_id": "505cfa3a53662110af64ddeeff7b1217",
        "type": {
          "display_value": "Runs on::Runs",
          "link": http://instance.servicenow.com/api/now/table/cmdb_rel_type/60bc4e22c0a8010e01f074cbe6bd73c3,
          "value": "60bc4e22c0a8010e01f074cbe6bd73c3"
        },
        "target": {
          "display_value": "*ANNIE-IBM",
          "link": http://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/b4fd7c8437201000deeabfc8bcbe5dc1,
          "value": "b4fd7c8437201000deeabfc8bcbe5dc1"
        }
      }
    ],
    "attributes": {
      "attested_date": "",
      "operational_status": "1",
      "running_process_command": "",
      "sys_updated_on": "2023-05-05 21:28:24",
      "type": "",
      "running_process_key_parameters": "",
      "rp_command_hash": "",
      "discovery_source": "ServiceNow",
      "first_discovered": "2023-05-05 21:28:24",
      "due_in": "",
      "service_pack": "",
      "used_for": "Production",
      "is_clustered": "false",
      "invoice_number": "",
      "gl_account": "",
      "sys_created_by": "admin",
      "warranty_expiration": "",
      "owned_by": "",
      "checked_out": "",
      "rp_key_parameters_hash": "",
      "sys_domain_path": "/",
      "business_unit": "",
      "version": "",
      "cpu_sockets": "",
      "maintenance_schedule": "",
      "cost_center": "",
      "attested_by": "",
      "dns_domain": "",
      "assigned": "",
      "purchase_date": "",
      "life_cycle_stage": "",
      "short_description": "",
      "managed_by": "",
      "port_dynamic": "false",
      "last_discovered": "2023-05-05 21:28:24",
      "can_print": "false",
      "sys_class_name": "cmdb_ci_db_mssql_instance",
      "manufacturer": "",
      "cl_port": "",
      "vendor": "",
      "life_cycle_stage_status": "",
      "model_number": "",
      "config_file": "",
      "assigned_to": "",
      "start_date": "",
      "instance_name": "Iname",
      "serial_number": "",
      "engine_edition": "",
      "support_group": "",
      "version_name": "",
      "unverified": "false",
      "correlation_id": "",
      "attributes": "",
      "asset": "",
      "config_directory": "",
      "tcp_port": "",
      "listener_name": "",
      "skip_sync": "false",
      "pid": "",
      "attestation_score": "",
      "sys_updated_by": "admin",
      "install_directory": "",
      "sys_created_on": "2023-05-05 21:28:24",
      "sys_domain": {
        "display_value": "global",
        "link": http://instance.servicenow.com/api/now/table/sys_user_group/global,
        "value": "global"
      },
      "install_date": "",
      "asset_tag": "",
      "fqdn": "",
      "change_control": "",
      "delivery_date": "",
      "install_status": "1",
      "supported_by": "",
      "name": "test",
      "subcategory": "Database",
      "assignment_group": "",
      "edition": "",
      "managed_by_group": "",
      "sys_id": "185cba3a53662110af64ddeeff7b12af",
      "po_number": "",
      "database": "",
      "checked_in": "",
      "sys_class_path": "/!!/!(/!2/!,",
      "mac_address": "",
      "company": "",
      "justification": "",
      "department": "",
      "cost": "",
      "comments": "",
      "attestation_status": "Not Yet Reviewed",
      "sys_mod_count": "0",
      "monitor": "false",
      "model_id": "",
      "ip_address": "",
      "duplicate_of": "",
      "sys_tags": "",
      "cost_cc": "USD",
      "order_date": "",
      "schedule": "",
      "environment": "",
      "due": "",
      "attested": "false",
      "location": "",
      "category": "Resource",
      "fault_count": "0",
      "lease_id": ""
    },
    "inbound_relations": []
  }
}

cURL 要求

次のコード例は、依存識別ルールが定義されているクラスにsys_idが渡されない場合に返される内容を示しています。sys_idが無効な場合も同じ結果になります。

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data "{
  "attributes": {
    "name": "test",
    "sys_class_name":"cmdb_ci_db_mssql_instance",
    "instance_name":"Iname"
  },
  "source": "ServiceNow",
  "depends_on": {
    "outbound_relations": {
        "type": "60bc4e22c0a8010e01f074cbe6bd73c3"
    }
  }
}

{
  "error": {
    "detail": "Exception while executing request: null Check logs for error trace or enable glide.rest.debug property to verify REST request processing",
    "message": "Exception while executing request: null"
  },
  "status": "failure"
}

CMDB インスタンス:PUT /now/cmdb/instance/{classname}/{sys_id}

指定された構成アイテム (CI) レコードを、指定された属性の名前と値のペアで更新します。このエンドポイントは、関連付けられた関係を作成、更新、または削除しません。

注:

このエンドポイントは HTML 仕様に準拠していません。標準の PUT エンドポイントには、要求に含まれていない要素を削除するという破壊的な性質があります。このエンドポイントは、指定されていない要素を削除しません。

URL 形式

バージョニングされた URL：/api/now/{api_version}/cmdb/instance/{className}/{sys_id}

デフォルトの URL：/api/now/cmdb/instance/{className}/{sys_id}

注:

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

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

表 : 27. パスパラメーター

名前	説明
className	CMDB クラス名。これは、cmdb_ci_linux_server や cmdb_ci_apache_web_server などの目的の CI レコードを含むテーブルの名前です。 データタイプ：文字列
sys_id	更新する CI レコードの sys_id。 データタイプ：文字列

表 : 28. クエリパラメーター

名前	説明
なし

表 : 29. 要求本文パラメーター (XML または JSON)

名前	説明
attributes	CI レコードで置き換えるデータ属性。使用可能な属性は、指定された CMDB クラスによって異なります。cmdb_ci_linux_server や cmdb_ci_mfp_printer など、通常は「cmdb_ci」で始まる関連する CMDB テーブルで使用可能な属性を見つけることができます。 証明書の詳細については、「 CIs attestation」を参照してください。 データタイプ: オブジェクト
source	必須です。情報を更新したエンティティ。これは、構成アイテム [cmdb_ci] テーブルの discovery_source フィールドで指定された選択値の 1 つである必要があります。 データタイプ：文字列

ヘッダー

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

表 : 30. 要求ヘッダー

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

表 : 31. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 32. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
405	無効なメソッドです。この機能は無効です。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

表 : 33. 応答パラメーター

名前	説明
attributes	現在 CI レコードにあるデータ属性。使用可能な属性は、指定された CMDB クラスによって異なります。cmdb_ci_linux_server や cmdb_ci_mfp_printer など、通常は「cmdb_ci」で始まる関連する CMDB テーブルで使用可能な属性を見つけることができます。 データタイプ：オブジェクト
error	エンドポイント要求の処理中に発生したエラーに関する情報。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" }
error.detail	エラーに関する追加情報。 データタイプ：文字列
error.message	エラーを識別するメッセージ。 データタイプ：文字列
inbound_relations	CI に関連付けられたインバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	インバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.target	ターゲットのインバウンド関係を説明する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	ユーザーインターフェイスに表示するインバウンド関係の名前。 データタイプ：文字列
inbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからインバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
inbound_relations.target.value	インバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.type	インバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	ユーザーインターフェイスに表示するインバウンドタイプの名前。 データタイプ：文字列
inbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからインバウンド関係タイプを取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
inbound_relations.type.value	インバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
outbound_relations	CI に関連付けられたアウトバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
outbound_relations.sys_id	アウトバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.target	必須です。ターゲットのアウトバウンド関係に関する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.target.display_value	ユーザーインターフェイスに表示するアウトバウンド関係の名前。 データタイプ：文字列
outbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからアウトバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
outbound_relations.target.value	アウトバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.type	アウトバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.type.display_value	ユーザーインターフェイスに表示するアウトバウンドタイプの名前。 データタイプ：文字列
outbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからアウトバウンド関係を取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
outbound_relations.type.value	アウトバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
status	エラーが発生した場合にのみ表示されます。エンドポイント処理のステータス。 可能な値：failure データタイプ：文字列

サンプル cURL 要求

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "attributes": {
    "firewall_status": "Extranet",
    "discovery_source": "ServiceNows",
    "name": "Linux299",
    "used_for": "Pre-production",
    "container": "Box"
  },
  "source": "ServiceNow"
}

{
    "result": {
        "outbound_relations": [
            {
                "sys_id": "403ff2641b425010593876a61a4bcb4b",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            },
            {
                "sys_id": "443ff2641b425010593876a61a4bcb4c",
                "type": {
                    "display_value": "Exchanges data with::Exchanges data with",
                    "link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
                    "value": "607ad1b2c0a8010e01941856b365af90"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            }
        ],
        "attributes": {
            "firewall_status": "Extranet",
            "os_address_width": "",
            "attested_date": "",
            "operational_status": "1",
            "os_service_pack": "",
            "cpu_core_thread": "",
            "cpu_manufacturer": "",
            "sys_updated_on": "2020-07-13 20:59:40",
            "discovery_source": "ServiceNow",
            "first_discovered": "2020-07-13 20:27:28",
            "due_in": "",
            "used_for": "Pre-production",
            "invoice_number": "",
            "gl_account": "",
            "sys_created_by": "dora.gray",
            "warranty_expiration": "",
            "ram": "",
            "cpu_name": "",
            "cpu_speed": "",
            "owned_by": "",
            "checked_out": "",
            "kernel_release": "",
            "sys_domain_path": "/",
            "classification": "Production",
            "disk_space": "",
            "object_id": "",
            "maintenance_schedule": "",
            "cost_center": "",
            "attested_by": "",
            "dns_domain": "",
            "assigned": "",
            "purchase_date": "",
            "life_cycle_stage": "",
            "short_description": "",
            "cd_speed": "",
            "floppy": "",
            "managed_by": "",
            "os_domain": "",
            "last_discovered": "2020-07-13 20:59:40",
            "can_print": "false",
            "sys_class_name": "cmdb_ci_linux_server",
            "manufacturer": "",
            "cpu_count": "",
            "vendor": "",
            "life_cycle_stage_status": "",
            "model_number": "",
            "assigned_to": "",
            "start_date": "",
            "os_version": "",
            "serial_number": "",
            "cd_rom": "false",
            "support_group": "",
            "unverified": "false",
            "correlation_id": "",
            "attributes": "",
            "asset": {
                "display_value": "Unknown",
                "link": "https://instance.service-now.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
                "value": "21cfba641b425010593876a61a4bcb52"
            },
            "form_factor": "",
            "cpu_core_count": "",
            "skip_sync": "false",
            "attestation_score": "",
            "sys_updated_by": "dora.gray",
            "sys_created_on": "2020-07-13 20:27:28",
            "sys_domain": {
                "display_value": "global",
                "link": "https://instance.service-now.com/api/now/table/sys_user_group/global",
                "value": "global"
            },
            "cpu_type": "",
            "install_date": "",
            "asset_tag": "",
            "dr_backup": "",
            "hardware_substatus": "",
            "fqdn": "",
            "change_control": "",
            "internet_facing": "true",
            "delivery_date": "",
            "hardware_status": "installed",
            "install_status": "1",
            "supported_by": "",
            "name": "Linux299",
            "subcategory": "Computer",
            "default_gateway": "",
            "chassis_type": "",
            "virtual": "false",
            "assignment_group": "",
            "managed_by_group": "",
            "sys_id": "0c3ff2641b425010593876a61a4bcb39",
            "po_number": "",
            "checked_in": "",
            "sys_class_path": "/!!/!2/!(/!!/!0",
            "mac_address": "",
            "company": "",
            "justification": "",
            "department": "",
            "cost": "",
            "comments": "",
            "os": "",
            "sys_mod_count": "3",
            "monitor": "false",
            "model_id": {
                "display_value": "Unknown",
                "link": "https://instance.service-now.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
                "value": "0ce0a2681b4e1010593876a61a4bcba6"
            },
            "ip_address": "",
            "duplicate_of": "",
            "sys_tags": "",
            "cost_cc": "USD",
            "order_date": "",
            "schedule": "",
            "environment": "",
            "due": "",
            "attested": "false",
            "location": "",
            "category": "Hardware",
            "fault_count": "0",
            "host_name": "",
            "lease_id": ""
        },
        "inbound_relations": [
            {
                "sys_id": "c03ff2641b425010593876a61a4bcb49",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS Apache01",
                    "link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
                    "value": "3a27d4370a0a0bb4006316812bf45439"
                }
            }
        ]
    }
}

CMDB インスタンス - POST /now/cmdb/instance/{classname}/{sys_id}/relation

指定された構成アイテム (CI) に受信および/または送信の関係を追加します。指定された CI は親です。

URL 形式

バージョニングされた URL: /api/now/{api_version}/cmdb/instance/{className}/{sys_id}/relation

デフォルトの URL：/api/now/cmdb/instance/{className}/{sys_id}/relation

注:

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

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

表 : 34. パスパラメーター

名前	説明
className	CMDB クラス名。これは、cmdb_ci_linux_server や cmdb_ci_apache_web_server などの目的の CI レコードを含むテーブルの名前です。 データタイプ：文字列
sys_id	更新する CI レコードの sys_id。 データタイプ：文字列

表 : 35. クエリパラメーター

名前	説明
なし

表 : 36. 要求本文パラメーター (XML または JSON)

名前	説明
inbound_relations	CI に関連付けるインバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "inbound_relations": [ { "target": "String", "type": "String" } ]
inbound_relations.target	inbound_relations が指定されている場合は必須です。指定された CI に関連付けるターゲットインバウンド関係の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.type	inbound_relations が指定されている場合は必須です。インバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
outbound_relations	CI に関連付けるアウトバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "outbound_relations": [ { "target": "String", "type": "String" } ]
outbound_relations.target	outbound_relations が指定されている場合は必須です。ターゲットのアウトバウンド関係の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.type	outbound_relations が指定されている場合は必須です。アウトバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
source	必須です。情報を更新したエンティティ。これは、構成アイテム [cmdb_ci] テーブルの discovery_source フィールドで指定された選択値の 1 つである必要があります。 データタイプ：文字列

ヘッダー

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

表 : 37. 要求ヘッダー

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

表 : 38. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 39. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
405	無効なメソッドです。この機能は無効です。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

表 : 40. 応答パラメーター

名前	説明
attributes	現在 CI レコードにあるデータ属性。使用可能な属性は、指定された CMDB クラスによって異なります。cmdb_ci_linux_server や cmdb_ci_mfp_printer など、通常は「cmdb_ci」で始まる関連する CMDB テーブルで使用可能な属性を見つけることができます。 データタイプ：オブジェクト
error	エンドポイント要求の処理中に発生したエラーに関する情報。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" }
error.detail	エラーに関する追加情報。 データタイプ：文字列
error.message	エラーを識別するメッセージ。 データタイプ：文字列
inbound_relations	CI に関連付けられたインバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	インバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.target	ターゲットのインバウンド関係を説明する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	ユーザーインターフェイスに表示するインバウンド関係の名前。 データタイプ：文字列
inbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからインバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
inbound_relations.target.value	インバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.type	インバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	ユーザーインターフェイスに表示するインバウンドタイプの名前。 データタイプ：文字列
inbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからインバウンド関係タイプを取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
inbound_relations.type.value	インバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
outbound_relations	CI に関連付けられたアウトバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
outbound_relations.sys_id	アウトバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.target	必須です。ターゲットのアウトバウンド関係に関する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.target.display_value	ユーザーインターフェイスに表示するアウトバウンド関係の名前。 データタイプ：文字列
outbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからアウトバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
outbound_relations.target.value	アウトバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.type	アウトバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.type.display_value	ユーザーインターフェイスに表示するアウトバウンドタイプの名前。 データタイプ：文字列
outbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからアウトバウンド関係を取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
outbound_relations.type.value	アウトバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
status	エラーが発生した場合にのみ表示されます。エンドポイント処理のステータス。 可能な値：failure データタイプ：文字列

サンプル cURL 要求

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/3a290cc60a0a0bb400000bdb386af1cf/relation" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "outbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    },
    {
      "type" : "607ad1b2c0a8010e01941856b365af90",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    }
  ],
  "source": "ServiceNow",
  "inbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a27d4370a0a0bb4006316812bf45439"
    }
  ]
}

{
    "result": {
        "outbound_relations": [
            {
                "sys_id": "403ff2641b425010593876a61a4bcb4b",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            },
            {
                "sys_id": "443ff2641b425010593876a61a4bcb4c",
                "type": {
                    "display_value": "Exchanges data with::Exchanges data with",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
                    "value": "607ad1b2c0a8010e01941856b365af90"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            }
        ],
        "attributes": {
            "firewall_status": "Active",
            "os_address_width": "",
            "attested_date": "",
            "operational_status": "1",
            "os_service_pack": "",
            "cpu_core_thread": "",
            "cpu_manufacturer": "",
            "sys_updated_on": "2020-07-13 21:24:05",
            "discovery_source": "ServiceNow",
            "first_discovered": "2020-07-13 20:27:28",
            "due_in": "",
            "used_for": "Production",
            "invoice_number": "",
            "gl_account": "",
            "sys_created_by": "dora.gray",
            "warranty_expiration": "",
            "ram": "",
            "cpu_name": "",
            "cpu_speed": "",
            "owned_by": "",
            "checked_out": "",
            "kernel_release": "",
            "sys_domain_path": "/",
            "classification": "Production",
            "disk_space": "",
            "object_id": "",
            "maintenance_schedule": "",
            "cost_center": "",
            "attested_by": "",
            "dns_domain": "",
            "assigned": "",
            "purchase_date": "",
            "life_cycle_stage": "",
            "short_description": "",
            "cd_speed": "",
            "floppy": "",
            "managed_by": "",
            "os_domain": "",
            "last_discovered": "2020-07-13 21:24:05",
            "can_print": "false",
            "sys_class_name": "cmdb_ci_linux_server",
            "manufacturer": "",
            "cpu_count": "",
            "vendor": "",
            "life_cycle_stage_status": "",
            "model_number": "",
            "assigned_to": "",
            "start_date": "",
            "os_version": "",
            "serial_number": "",
            "cd_rom": "false",
            "support_group": "",
            "unverified": "false",
            "correlation_id": "",
            "attributes": "",
            "asset": {
                "display_value": "Unknown",
                "link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
                "value": "21cfba641b425010593876a61a4bcb52"
            },
            "form_factor": "",
            "cpu_core_count": "",
            "skip_sync": "false",
            "attestation_score": "",
            "sys_updated_by": "dora.gray",
            "sys_created_on": "2020-07-13 20:27:28",
            "sys_domain": {
                "display_value": "global",
                "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
                "value": "global"
            },
            "cpu_type": "",
            "install_date": "",
            "asset_tag": "",
            "dr_backup": "",
            "hardware_substatus": "",
            "fqdn": "",
            "change_control": "",
            "internet_facing": "true",
            "delivery_date": "",
            "hardware_status": "installed",
            "install_status": "1",
            "supported_by": "",
            "name": "Linux299",
            "subcategory": "Computer",
            "default_gateway": "",
            "chassis_type": "",
            "virtual": "false",
            "assignment_group": "",
            "managed_by_group": "",
            "sys_id": "0c3ff2641b425010593876a61a4bcb39",
            "po_number": "",
            "checked_in": "",
            "sys_class_path": "/!!/!2/!(/!!/!0",
            "mac_address": "",
            "company": "",
            "justification": "",
            "department": "",
            "cost": "",
            "comments": "",
            "os": "",
            "sys_mod_count": "4",
            "monitor": "false",
            "model_id": {
                "display_value": "Unknown",
                "link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
                "value": "0ce0a2681b4e1010593876a61a4bcba6"
            },
            "ip_address": "",
            "duplicate_of": "",
            "sys_tags": "",
            "cost_cc": "USD",
            "order_date": "",
            "schedule": "",
            "environment": "",
            "due": "",
            "attested": "false",
            "location": "",
            "category": "Hardware",
            "fault_count": "0",
            "host_name": "",
            "lease_id": ""
        },
        "inbound_relations": [
            {
                "sys_id": "c03ff2641b425010593876a61a4bcb49",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS Apache01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
                    "value": "3a27d4370a0a0bb4006316812bf45439"
                }
            }
        ]
    }
}

CMDB インスタンス - PATCH /now/cmdb/instance/{classname}/{sys_id}

指定された構成アイテム (CI) レコードの属性を、指定された名前と値のペアに置き換えます。このエンドポイントは、関連付けられた関係を作成、更新、または削除しません。

URL 形式

バージョニングされた URL：/api/now/{api_version}/cmdb/instance/{className}/{sys_id}

デフォルトの URL：/api/now/cmdb/instance/{className}/{sys_id}

注:

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

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

表 : 41. パスパラメーター

名前	説明
className	CMDB クラス名。これは、cmdb_ci_linux_server や cmdb_ci_apache_web_server などの目的の CI レコードを含むテーブルの名前です。 データタイプ：文字列
sys_id	更新する CI レコードの sys_id。 データタイプ：文字列

表 : 42. クエリパラメーター

名前	説明
なし

表 : 43. 要求本文パラメーター (XML または JSON)

名前	説明
attributes	CI レコードで置き換えるデータ属性。使用可能な属性は、指定された CMDB クラスによって異なります。cmdb_ci_linux_server や cmdb_ci_mfp_printer など、通常は「cmdb_ci」で始まる関連する CMDB テーブルで使用可能な属性を見つけることができます。 証明書の詳細については、「 CIs attestation」を参照してください。 データタイプ: オブジェクト
source	必須です。情報を更新したエンティティ。これは、構成アイテム [cmdb_ci] テーブルの discovery_source フィールドで指定された選択値の 1 つである必要があります。 データタイプ：文字列

ヘッダー

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

表 : 44. 要求ヘッダー

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

表 : 45. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 46. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
405	無効なメソッドです。この機能は無効です。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

表 : 47. 応答パラメーター

名前	説明
attributes	現在 CI レコードにあるデータ属性。使用可能な属性は、指定された CMDB クラスによって異なります。cmdb_ci_linux_server や cmdb_ci_mfp_printer など、通常は「cmdb_ci」で始まる関連する CMDB テーブルで使用可能な属性を見つけることができます。 データタイプ：オブジェクト
error	エンドポイント要求の処理中に発生したエラーに関する情報。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" }
error.detail	エラーに関する追加情報。 データタイプ：文字列
error.message	エラーを識別するメッセージ。 データタイプ：文字列
inbound_relations	CI に関連付けられたインバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	インバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.target	ターゲットのインバウンド関係を説明する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	ユーザーインターフェイスに表示するインバウンド関係の名前。 データタイプ：文字列
inbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからインバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
inbound_relations.target.value	インバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
inbound_relations.type	インバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	ユーザーインターフェイスに表示するインバウンドタイプの名前。 データタイプ：文字列
inbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからインバウンド関係タイプを取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
inbound_relations.type.value	インバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
outbound_relations	CI に関連付けられたアウトバウンド関係を定義するオブジェクトのリスト。 データタイプ：アレイ "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
outbound_relations.sys_id	アウトバウンド CI 関係の sys_id。CI 関係 [cmdb_rel_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.target	必須です。ターゲットのアウトバウンド関係に関する情報。 データタイプ：オブジェクト "target": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.target.display_value	ユーザーインターフェイスに表示するアウトバウンド関係の名前。 データタイプ：文字列
outbound_relations.target.link	構成アイテム [cmdb_ci] テーブルからアウトバウンド関係を取得するために使用する CMDB REST エンドポイント URL。 データタイプ：文字列
outbound_relations.target.value	アウトバウンド CI の sys_id。構成アイテム [cmdb_ci] テーブルにあります。 データタイプ：文字列
outbound_relations.type	アウトバウンド関係のタイプに関する情報。 データタイプ：オブジェクト "type": { "display_value": "String", "link": "String", "value": "String" }
outbound_relations.type.display_value	ユーザーインターフェイスに表示するアウトバウンドタイプの名前。 データタイプ：文字列
outbound_relations.type.link	CI 関係タイプ [cmdb_rel_type] テーブルからアウトバウンド関係を取得するために使用するテーブル REST エンドポイント URL。 データタイプ：文字列
outbound_relations.type.value	アウトバウンド関係のタイプの sys_id。CI 関係タイプ [cmdb_rel_type] テーブルにあります。 データタイプ：文字列
status	エラーが発生した場合にのみ表示されます。エンドポイント処理のステータス。 可能な値：failure データタイプ：文字列

サンプル cURL 要求

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_class_sw/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password"\
--data {
    "attributes": {
      "firewall_status": "Active",
      "name": "Linux299",
      "used_for": "Production"
    },
    "source": "ServiceNow"
}

{
  "result": {
    "outbound_relations": [
      {
        "sys_id": "403ff2641b425010593876a61a4bcb4b",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      },
      {
        "sys_id": "443ff2641b425010593876a61a4bcb4c",
        "type": {
          "display_value": "Exchanges data with::Exchanges data with",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
          "value": "607ad1b2c0a8010e01941856b365af90"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      }
    ],
    "attributes": {
      "firewall_status": "Active",
      "os_address_width": "",
      "attested_date": "",
      "operational_status": "1",
      "os_service_pack": "",
      "cpu_core_thread": "",
      "cpu_manufacturer": "",
      "sys_updated_on": "2020-07-13 21:24:05",
      "discovery_source": "ServiceNow",
      "first_discovered": "2020-07-13 20:27:28",
      "due_in": "",
      "used_for": "Production",
      "invoice_number": "",
      "gl_account": "",
      "sys_created_by": "dora.gray",
      "warranty_expiration": "",
      "ram": "",
      "cpu_name": "",
      "cpu_speed": "",
      "owned_by": "",
      "checked_out": "",
      "kernel_release": "",
      "sys_domain_path": "/",
      "classification": "Production",
      "disk_space": "",
      "object_id": "",
      "maintenance_schedule": "",
      "cost_center": "",
      "attested_by": "",
      "dns_domain": "",
      "assigned": "",
      "purchase_date": "",
      "life_cycle_stage": "",
      "short_description": "",
      "cd_speed": "",
      "floppy": "",
      "managed_by": "",
      "os_domain": "",
      "last_discovered": "2020-07-13 21:24:05",
      "can_print": "false",
      "sys_class_name": "cmdb_ci_linux_server",
      "manufacturer": "",
      "cpu_count": "",
      "vendor": "",
      "life_cycle_stage_status": "",
      "model_number": "",
      "assigned_to": "",
      "start_date": "",
      "os_version": "",
      "serial_number": "",
      "cd_rom": "false",
      "support_group": "",
      "unverified": "false",
      "correlation_id": "",
      "attributes": "",
      "asset": {
        "display_value": "Unknown",
        "link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
        "value": "21cfba641b425010593876a61a4bcb52"
      },
      "form_factor": "",
      "cpu_core_count": "",
      "skip_sync": "false",
      "attestation_score": "",
      "sys_updated_by": "dora.gray",
      "sys_created_on": "2020-07-13 20:27:28",
      "sys_domain": {
        "display_value": "global",
        "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
        "value": "global"
      },
      "cpu_type": "",
      "install_date": "",
      "asset_tag": "",
      "dr_backup": "",
      "hardware_substatus": "",
      "fqdn": "",
      "change_control": "",
      "internet_facing": "true",
      "delivery_date": "",
      "hardware_status": "installed",
      "install_status": "1",
      "supported_by": "",
      "name": "Linux299",
      "subcategory": "Computer",
      "default_gateway": "",
      "chassis_type": "",
      "virtual": "false",
      "assignment_group": "",
      "managed_by_group": "",
      "sys_id": "0c3ff2641b425010593876a61a4bcb39",
      "po_number": "",
      "checked_in": "",
      "sys_class_path": "/!!/!2/!(/!!/!0",
      "mac_address": "",
      "company": "",
      "justification": "",
      "department": "",
      "cost": "",
      "comments": "",
      "os": "",
      "sys_mod_count": "4",
      "monitor": "false",
      "model_id": {
        "display_value": "Unknown",
        "link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
        "value": "0ce0a2681b4e1010593876a61a4bcba6"
      },
      "ip_address": "",
      "duplicate_of": "",
      "sys_tags": "",
      "cost_cc": "USD",
      "order_date": "",
      "schedule": "",
      "environment": "",
      "due": "",
      "attested": "false",
      "location": "",
      "category": "Hardware",
      "fault_count": "0",
      "host_name": "",
      "lease_id": ""
    },
    "inbound_relations": [
      {
        "sys_id": "c03ff2641b425010593876a61a4bcb49",
         "type": {
           "display_value": "Depends on::Used by",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
            "value": "1a9cb166f1571100a92eb60da2bce5c5"
          },
          "target": {
            "display_value": "PS Apache01",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
            "value": "3a27d4370a0a0bb4006316812bf45439"
          }
        }
      ]
    }
}