変更管理 API

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：350分

    • 変更管理 API は、サードパーティアプリケーションと ServiceNow 変更管理 プロセスとの統合を可能にするエンドポイントを提供します。

    アプリケーションを ServiceNow 変更管理 プロセスと統合することで、どこで開始されたかにかかわらず、すべての変更要求が信頼できる唯一の情報源となり、単一の監査ソースが提供されます。

    この REST API は、変更管理プロセスを外部アプリケーションと統合したり、 ServiceNow クライアントサイドアプリケーションを開発したりする場合に使用します。

    この REST API により、インテグレーターは次のことが可能になります。

    • 公開された標準的な変更要求テンプレートから標準的な変更要求を開始します。
    • 緊急または通常タイプの変更要求を作成します。
    • 変更要求について、変更要求テーブルに存在するフィールドを更新します。
    • 変更タスクテーブルおよび作業タスクに存在するフィールドを、作成からクローズ/キャンセルまで更新します。
    • 特定の変更要求、標準テンプレート、変更要求タスク、または変更モデルを取得します。
    • ページネーションを使用して、複数の変更要求、標準テンプレート、変更要求タスクを取得します。
    • リスク評価を実行します。
    • 影響を受けたサービスをリフレッシュします。
    • 変更要求に関連付けられた関連する承認アクティビティを生成して処理します。
    • 潜在的なスケジュールの競合を特定し、競合が存在しない期間を特定します。
    • 変更要求、変更要求タスク、および競合チェックプロセスを削除します。
    • 変更モデルレコードに基づいて変更要求レコードを作成します。
    • 現在のステータスを含む、指定された変更要求で利用可能なステータスのリストを取得します。
    変更管理 API は、ワークフロースタジオ と ワークフロー を使用する ITIL タイプと変更モデルをサポートしています。変更モデルは、目的に合った変更をもたらします。タイプとモデルは、変更要求を次のステータスに進めるために満たす必要がある移行基準を定義します。この基準は、状況、ワークフロー、ツール、およびビジネスルールを使用して定義できます。
    • 従来の ITIL タイプ:標準、緊急、および通常。
    • 変更モデルの状況:新規、スケジュール済み、実装、レビュー、およびクローズ済み。

    ServiceNowインスタンス内で追加の変更モデルを構成し、この API のエンドポイントを使用して、それらの変更モデルに基づいて変更要求を作成できます。変更管理 - GET /sn_chg_rest/change/model/{sys_id}エンドポイントと変更管理 - GET /sn_chg_rest/change/modelエンドポイントを使用して、インスタンスで利用可能な変更モデルを取得します。次に、 変更管理 - POST /sn_chg_rest/change を使用して、指定された変更モデルに基づいて変更要求を作成します。

    変更モデルの構成の詳細については、「 変更管理の構成」を参照してください。

    変更管理エンドポイントにアクセスするには、次のロールが必要です。
    • 削除:change_manager またはアドミン
    • GET:change_manager、itil、sn_change_read、または admin
    • パッチ/POST:change_manager、itil、または admin

    さらに、アドミニストレーターは変更プロパティを設定して変更管理の動作を設定できます。これらのプロパティのリストと使用可能な機能の説明については、「 変更管理プロパティ」を参照してください。

    変更管理 - DELETE /sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}

    指定されたsys_idsで識別される変更要求タスクを削除します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task/{task_sys_id}

    デフォルト URL: /api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}

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

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

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

    データタイプ：文字列
    change_sys_id タスクが関連付けられている変更要求のSys_id。タスクが指定された変更要求に実際に関連付けられていることを確認します。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    task_sys_id 削除する変更要求タスクのSys_id。

    データタイプ：文字列

    テーブル:変更タスク [change_task]
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア すべてのフィールド (キー) と、削除前に特定された変更要求タスクに関連付けられた値。

    データタイプ: オブジェクト
    親 このタスクが関連付けられた変更要求に関する情報。

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

    parent: {
  display_value: "String", 
  value: "String"
}
    parent.display_value UI に表示する親タスクのSys_id。

    データタイプ：文字列
    parent.value 親タスクのSys_id。

    データタイプ：文字列
    sys_id 削除された変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5" \
--request DELETE \
--header "Accept:application/json" \ 
--user "username":"password"
    {
  result: [
    {
      sys_id: {
        value: "12629ec4b750230096c3e4f6ee11a9d5",
        display_value: "12629ec4b750230096c3e4f6ee11a9d5"
      },
      parent: {
        value: "0f4ac6c4b750230096c3e4f6ee11a9fe", 
        display_value: "CHG0033046 "
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Retire both nodes",
        display_value: "Retire both nodes"
      }
    }
  ]
}

    変更管理 - DELETE /sn_chg_rest/change/{sys_id}

    指定されたsys_idに関連付けられている変更要求を削除します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 削除する変更要求レコードのSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 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 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    result 削除された変更要求レコード。このオブジェクトの各要素は、変更要求 [change_request] テーブルのレコード内のフィールドに対応しています。

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

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

    {
  "result":
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Reboot the server at 6 am",
        "value": "Reboot the server at 6 am"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "b0dbda5347c12200e0ef563dbb9a718f",
        "value": "b0dbda5347c12200e0ef563dbb9a718f"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
}

    変更管理 - DELETE /sn_chg_rest/change/{sys_id}/conflict

    指定された変更要求 (sys_id) に対して実行中の競合チェックプロセスをキャンセルします。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/conflict

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}/conflict

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

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

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

    データタイプ：文字列
    sys_id 実行中の競合チェックプロセスをキャンセルする変更要求レコードのSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    ステータスコード

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

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。キャンセル要求が失敗しました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    なし

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request DELETE \
--user "username":"password"

    None

    変更管理 - DELETE /sn_chg_rest/change/emergency/{sys_id}

    指定されたsys_idによって識別される緊急変更要求を削除します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/emergency/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/emergency/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 削除する緊急変更要求のSys_id。

    データタイプ：文字列

    テーブル:変更要求 [change_request]
    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 24. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ: オブジェクト
    状況 削除前の変更要求のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「緊急」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「緊急」です。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: {
        value: "b0dbda5347c12200e0ef563dbb9a718f", 
        display_value: "b0dbda5347c12200e0ef563dbb9a718f"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      },
    }, 
  ]
}

    変更管理 - DELETE /sn_chg_rest/change/normal/{sys_id}

    指定されたsys_idによって識別される通常の変更要求を削除します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/normal/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/normal/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 削除する通常の変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 26. クエリパラメーター
    名前 説明
    なし
    表 : 27. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ: オブジェクト
    状況 削除前の変更要求のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「標準」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「標準」です。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      },
    }, 
  ]
}

    変更管理 - DELETE /sn_chg_rest/change/standard/{sys_id}

    指定されたsys_idによって識別される標準的な変更要求を削除します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/standard/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/standard/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 削除する標準的な変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 32. クエリパラメーター
    名前 説明
    なし
    表 : 33. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 35. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 36. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア すべてのフィールド (キー) と、識別された変更要求に関連付けられた値。
    状況 削除前の変更要求のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求の一意の識別子。

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: "1c87925347c12200e0ef563dbb9a7177",
      state: {
        value: "-5", 
        display_value: "New"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    }, 
  ]
}

    変更管理 - GET /sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule

    構成アイテム ID と期間で利用可能なタイムスロットを取得できるようにします。オプションで予定開始時間を含めることもできます。

    必要なロール:sn_change_writer

    注:
    このエンドポイントを実行しても、利用可能な開始時間と終了時間は表示されません。応答本文 worker.link プロパティで指定されたリンクを使用して、スケジュールデータを取得します。
    関連項目：

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/ci/{cmdb_ci_sys_id}/schedule

    デフォルト URL: /api/sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule

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

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

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

    データタイプ：文字列
    cmdb_ci_sys_id 構成アイテムレコードのSys_id。このエンドポイントには変更要求は必要ありません。

    データタイプ：文字列

    テーブル:構成アイテム [cmdb_ci]
    表 : 38. クエリパラメーター
    名前 説明
    duration_in_seconds 変更の期間 (秒)、つまり変更要求タスクの完了に必要な時間。

    データタイプ：整数
    planned_start_time オプション。変更要求の実装開始が予定されている日時 (UTC)。

    この時間以降に開始可能なタイムスロットを取得します。指定しない場合、システムは現在の時刻を開始時間として使用します。

    形式:yyyy-mm-dd hh:mm:ss

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

    ヘッダー

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

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

    デフォルト： application/json
    表 : 41. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 42. ステータスコード
    ステータスコード 説明
    202 システムが要求を承認しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    考えられる問題:
    • 指定されたsys_idでcmdb_ciが見つかりません。レコードが存在しないか、ユーザーに読み取りアクセス権がありません。
    • duration_in_secondsクエリパラメーター値が指定されていません。
    • duration_in_secondsが無効であるか、クエリパラメーター値がplanned_start_time指定されています。

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

    名前 説明
    エラー エンドポイント要求の処理中に発生したエラーに関する情報。

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

    "error": {
  "detail": "String",
  "message": "String",
  "status": "String"
}
    error.detail エラーに関する追加情報。

    データタイプ：文字列
    error.message エラーを特定するメッセージ。

    データタイプ：文字列
    メッセージ メッセージ情報。
    データタイプ: オブジェクト
    "messages": {
  "errorMessages": [Array],
  "infoMessages": [Array],
  "warningMessages": [Array]
}
    messages.errorMessages 要求の処理中にエラーメッセージが発生しました。

    データタイプ：アレイ
    messages.infoMessages 要求の処理中に検出された情報メッセージ。

    データタイプ：アレイ
    messages.warningMessages 要求の処理中に検出された警告メッセージ。

    データタイプ：アレイ
    要求 元のエンドポイント要求。

    データタイプ：文字列
    状況 ワーカーの現在のステータスに関する情報。

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

    state: {
  display_value: "String", 
  value: Number
}
    state.display_value ワーカーの状態の表示値。これらの値は、 state.value パラメーターに直接関連しています。

    可能な値：

    • 完了
    • エラー
    • 対応中
    • 待機中

    データタイプ：文字列
    state.value ワーカーのステータスの数値。

    可能な値：

    • 1
    • 2
    • 3
    • 4

    データタイプ：数値
    type 要求のタイプ。

    有効な値:スケジュール

    データタイプ：文字列
    ワーカー 関連付けられたワーカーに関する情報。

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

    "worker": {
  "link": "String",
  "sysId": "String"
}
    worker.link タイムスロットデータを取得するためのリンク。GET /sn_chg_rest/change/worker/{sys_id} のsys_idを使用して結果を表示します。

    データタイプ：文字列
    worker.sysId 変更要求に関連付けられたワーカーのSys_id。

    データタイプ：文字列
    status エラーが発生した場合にのみ表示されます。エンドポイント処理のステータス。

    可能な値:失敗

    データタイプ：文字列

    対応可能なタイムスロットを取得

    worker.linkで指定された値を使用して、スケジュール期間の詳細を取得します。値は次の形式です。

    https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>

    GET /sn_chg_rest/change/worker/{sys_id} のworker_sys_idを使用して結果を表示します。

    応答本文にはステータスが含まれ、処理が完了すると結果が提供されます。

    ワーカー応答本文パラメーターの結果は、タイムスロットの空き状況によって異なります。
    • 指定されたタイムスロットがスケジュールタイムスロット内の変更要求に利用可能な場合、ワーカー API は payload.spans プロパティに利用可能なタイムスロットをリストします。それ以外の場合、 payload.spans プロパティは結果に表示されません。
    • 定義されたスケジュールのタイムスロット内に指定された変更要求期間に利用可能なタイムスロットがない場合、 messages.infoMessages には次のように記載されます。 D
      注:
      変更要求スケジュールのタイムスロットのデフォルト値は 90 日です。この値を変更するには、 change.conflict.next_available.schedule_window プロパティを変更します。詳細については、「 競合分析プロパティの構成」を参照してください。

    次の GET /sn_chg_rest/change/worker/{sys_id} の例は、worker.link の詳細で指定された ID を使用して提供される出力を示しています。結果には、タスク期間で利用可能なオープンタイムスパンが一覧表示されます。

    {
  "result": {
    "worker": {
      "sysId": "d7d1f2b4a444b010f87712198fe9caae",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/d7d1f2b4a444b010f87712198fe9caae"
    },
    "request": "{\"cmdb_ci_sys_id\":\"82967cdd0ad3370236092104ce988d76\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    },
    "payload": {
      "spans": [
        {
          "start": {
            "value": "2021-05-15 08:00:00",
            "display_value": "2021-05-15 01:00:00"
          },
          "end": {
            "value": "2021-05-15 11:00:00",
            "display_value": "2021-05-15 04:00:00"
          }
        },
        {
          "start": {
            "value": "2021-05-22 08:00:00",
            "display_value": "2021-05-22 01:00:00"
          },
          "end": {
            "value": "2021-05-22 11:00:00",
            "display_value": "2021-05-22 04:00:00"
          }
        },
        ...
      ]
    }
  }
}

    cURL 要求

    curl "https://instance.service-now.com/api/sn_chg_rest/change/ci/<cmdb_ci_sys_id>/schedule?duration_in_seconds=10800" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    結果には、GET /sn_chg_rest/change/worker/ エンドポイントで指定されたsys_idを実行するために使用できる worker.link の詳細が含まれます。

    {
  "result": {
    "worker": {
      "sysId": "1049419c1b4c3010f58a6572604bcb7a",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/1049419c1b4c3010f58a6572604bcb7a"
    },
    "request": "{\"cmdb_ci_sys_id\":\"<cmdb_ci_sys_id>\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

    変更管理 - GET /sn_chg_rest/change

    指定された基準に基づいて 1 つ以上の変更要求を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change

    デフォルト URL: /api/sn_chg_rest/change

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

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

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

    データタイプ：文字列
    表 : 44. クエリパラメーター
    名前 説明
    名前と値のペア 結果セットのフィルタリングに使用する名前と値のペア。名前は、指定された値がフィルタリングされるフィールドです。このパラメーターは sysparm_queryと相互に排他的です。たとえば、 &sysparm_query=active=true を使用する代わりに、 &active=true を使用して呼び出し元ステートメントを簡略化できます。フィールドが選択タイプまたは参照タイプのフィールドである場合は、&state=7 ではなく &state=closed のように表示値を使用することもできます。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります ( 例:&active=true&assigned_to=john.smith)。

    データタイプ：文字列
    order 返された変更要求をソートするためのフィールド。

    データタイプ：文字列

    デフォルト: 名前
    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>:次の値をサポートします。
      • =:<col_name>は<値>と完全に一致します。
      • !=:<col_name> が <value> と一致しません。
      • LIKE:<col_name>には指定された文字列 <value> が含まれています。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • STARTSWITH:<col_name>は、指定された文字列 <value> で始まります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ENDSWITH:<col_name>は指定された文字列 <value> で終わります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ^:クエリ条件を追加するための AND 演算子。結果セットに含まれるレコードは両方の条件に一致します。
      • ^OR:クエリ条件を追加するための OR 演算子。結果セットに含まれるレコードは、少なくとも 1 つの条件に一致します。
    • <value>:フィルターを適用する値。
    演算子の詳細については、「Operators available for filters and queries」を参照してください。

    クエリには複数の条件を含めることができます。たとえば、次のクエリは、発信者が現在のユーザーであり、レコードがアクティブなレコードを返します。

    sysparm_query=caller_id=javascript:gs.getUserID()^active=true

    エンコードクエリでは、昇順および降順による並べ替えの機能もサポートされています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで ORDERBY 句と ORDERBYDESC 句を使用します。

    構文:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    たとえば、次のクエリでは、すべてのアクティブなレコードを取得し、結果を番号の昇順に並べ替え、次にカテゴリ別に降順に並べ替えます。

    sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCカテゴリ

    デフォルトでは、無効なフィールド名など、クエリの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。プロパティ glide.invalid_query.returns_no_rows を true に設定すると、代わりに無効なクエリに対して行を返さないようにします。
    注:
    glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。

    データタイプ：文字列
    テキスト検索 すべての通常の変更要求レコードフィールドを検索するために使用する文字列。この検索では ServiceNow フルテキスト検索プラットフォーム機能を使用します。ServiceNow検索機能の詳細については、「検索管理」を参照してください。

    デフォルト値: IR_AND_OR_QUERY
    表 : 45. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 47. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 48. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    要素 説明
    result 1 つ以上の変更要求レコードオブジェクトを含むリスト。各オブジェクトは変更要求を記述します。変更要求オブジェクトの各要素は、変更要求 [change_request] テーブルの関連レコードのフィールドに対応します。

    すべての要素には 、値 と display_value の名前と値のペアが含まれます。日付フィールドには、名前と値 display_value_internal ペアも含まれます。

    データタイプ：アレイ
    action_status 関連する変更要求の現在のアクションステータス。

    可能な値：

    • 1:社内でブロック済み
    • 2:顧客によりブロック済み
    • 3:社内でおよび顧客によりブロック済み
    • 4:要注意

    データタイプ：数値
    アクティブ 変更要求がアクティブかどうかを示すフラグ。

    可能な値：

    • true:変更要求はアクティブです
    • false:変更要求はアクティブではありません

    データタイプ：ブーリアン

    デフォルト：true
    activity_due 関連するケースの完了予定日時。

    データタイプ：文字列
    additional_assignee_list 変更要求の作業にアサインされた追加担当者のsys_idsのリスト。

    データタイプ：アレイ
    approval 必要な承認プロセスのタイプ。

    データタイプ：文字列

    デフォルト:未要求
    approval_history 最新の承認履歴ジャーナルエントリ。

    データタイプ：文字列
    approval_set 関連付けられたアクションが承認された日時。

    データタイプ：文字列
    assigned_to 変更要求にアサインされたユーザーのSys_id。

    データタイプ：文字列
    assignment_group 変更要求にアサインされたグループのSys_id。

    データタイプ：文字列
    backout_plan 変更を元に戻す必要がある場合に実行する計画の説明。

    データタイプ：文字列
    business_duration 変更を完了するためにかかった予定作業時間、作業日数、および作業週の長さ。

    データタイプ：文字列
    business_service 変更要求に関連付けられたビジネスサービスのSys_id。サービス [cmdb_ci_service] テーブルにあります。

    データタイプ：文字列
    cab_date 変更諮問委員会 (CAB) が開合する日付。

    データタイプ：文字列
    cab_delegate CAB 会議中に CAB マネージャーの代理を務めることができるユーザーのSys_id。ユーザー [sys_user] テーブルにあります

    データタイプ：文字列
    cab_recommendation 変更要求に対する CAB の推奨事項の説明。

    データタイプ：文字列

    最大長:4,000
    cab_required CAB が必要かどうかを示すフラグ。
    可能な値：
    • true:変更諮問委員会が必要です。
    • false:変更諮問委員会は必要ありません。

    データタイプ：ブーリアン

    デフォルト値：false
    calendar_duration 現在、 変更管理で使用されていません。

    データタイプ：文字列
    category ハードウェア、ネットワーク、ソフトウェアなど、変更のカテゴリ。

    データタイプ：文字列

    デフォルト:その他
    change_plan 変更要求を管理および制御するためのアクティビティとロール。

    データタイプ：文字列
    chg_model 関連する変更要求の基になっている変更モデルのSys_id。変更モデルは、変更要求に対して完了する必要がある状況フロー、移行、およびプロセスアクティビティを定義します。

    データタイプ：文字列

    テーブル:変更モデル [chg_model]
    closed_at 関連する変更要求がクローズされた日時。

    データタイプ：文字列
    closed_by 変更要求をクローズした人物のSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    close_code 変更要求がクローズされたときにアサインされたコード。たとえば、[成功]、[成功したが問題あり]、[不成功] などです。

    データタイプ：文字列
    close_notes ユーザーが変更要求を閉じるときに入力したメモ。

    データタイプ：文字列
    cmdb_ci 変更要求に関連付けられた構成アイテムのSys_id。

    データタイプ：文字列

    テーブル:構成アイテム [cmdb_ci]
    コメント 関連する変更要求に入力された顧客向けの作業メモのリスト。

    データタイプ：アレイ
    comments_and_work_notes 関連する変更要求に対して入力された内部および顧客向けの作業メモのリスト。

    データタイプ：アレイ

    最大長:4,000
    会社 変更要求に関連付けられている会社のSys_id。

    データタイプ：文字列

    テーブル:会社 [core_company]
    conflict_last_run 変更の要求で競合の検出スクリプトが最後に実行された日時。

    データタイプ：文字列
    conflict_status 競合検出スクリプトによって検出された現在の競合ステータス (競合や未実行など)。

    データタイプ：文字列

    最大長：40

    デフォルト:未実行
    contact_type 変更要求が最初に要求されたメソッド。
    可能な値：
    • チャット
    • メール
    • phone
    • ソーシャル
    • Web

    データタイプ：文字列
    contract 変更要求に関連付けられた契約のSys_id。

    データタイプ：文字列

    テーブル:契約 [ast_contract]
    correlation_display correlation_idの分かりやすい名前。

    データタイプ：文字列

    最大長:100
    correlation_id サードパーティシステム内の一致する変更要求レコードのグローバル一意識別子 (GUID)。

    データタイプ：文字列

    最大長:100
    delivery_plan 使用されなくなりました。変更要求に関連付けられた配送計画のSys_id。

    データタイプ：文字列

    テーブル:実行計画 [sc_cat_item_delivery_plan]
    delivery_task 使用されなくなりました。変更要求に関連付けられた配送タスクのSys_id。

    データタイプ：文字列

    テーブル:実行計画タスク [sc_cat_item_delivery_task]
    description 変更要求の詳細な説明。

    データタイプ：文字列

    最大長:4,000
    due_date タスクの期日。変更要求プロセスでは使用されません。

    データタイプ：文字列
    end_date 変更要求を完了する日時。

    データタイプ：文字列
    escalation 現在のエスカレーションレベル。

    可能な値：

    • 0:通常
    • 1:中
    • 2:高
    • 3:期限切れ

    データタイプ:数値 (整数)

    デフォルト：0
    expected_start タスクを開始する日時。変更要求プロセスでは使用されません。

    データタイプ：文字列
    follow_up ユーザーが変更要求者をフォローアップした日時。

    データタイプ：文字列
    group_list 変更要求に関連付けられたsys_idsとグループの名前のリスト。

    データタイプ：アレイ

    最大長:4,000
    impact 変更要求に対する影響は、顧客にもたらします。

    可能な値：

    • 1:高
    • 2:中
    • 3:低

    データタイプ:数値 (整数)

    デフォルト値：3
    implementation_plan この変更を実装するために実行する一連のステップ。また、ステップ間の依存関係と各ステップのアサイニーの詳細も含まれます。

    データタイプ：文字列

    最大長:4,000
    正当性 この変更を実装するメリットと、この変更が実装されない場合の影響。

    データタイプ：文字列

    最大長:4,000
    ナレッジ 変更要求に関連付けられたナレッジベース (KB) 記事があるかどうかを示すフラグ。
    可能な値：
    • true:関連する KB 記事
    • false:関連する KB 記事なし

    データタイプ：ブーリアン
    location 変更要求で参照されている機器の場所のSys_idと名前。

    データタイプ：文字列

    テーブル:場所 [cmn_location]
    made_sla 使用されなくなりました。変更要求が関連するサービスレベルアグリーメントに沿って実装されたかどうかを示すフラグ。

    データタイプ：ブーリアン
    needs_attention 変更要求に注意が必要かどうかを示すフラグ。

    可能な値：

    • true:変更要求には追加の注意が必要です。
    • false:変更要求に追加の注意は必要ありません。

    データタイプ：ブーリアン

    デフォルト値：false
    number CHG0040007 など、システムによって変更要求にアサインされた変更番号。

    データタイプ：文字列
    on_hold 変更要求が現在保留中かどうかを示すフラグ。
    可能な値：
    • true:保留
    • false:保留中ではない

    データタイプ：ブーリアン

    デフォルト値：false
    on_hold_reason on_holdパラメーターが「true」の場合、変更要求が保留になっている理由の説明。

    データタイプ：文字列

    最大長:4,000
    on_hold_task on_holdパラメーターが「true」の場合、保留が解除される前に完了する必要があるタスクのsys_idsのリストが表示されます。

    データタイプ：文字列

    最大長:4,000
    open_at 変更リリースが作成された日時。

    データタイプ：文字列
    opened_by 変更リリースを作成したユーザーのSys_idと名前。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    order 変更管理では使用されません。データベースからレコードを取得する場合などにレコードを並べ替えるためのオプションの数値フィールド。

    データタイプ:数値 (整数)
    outside_maintenance_schedule 変更要求に対して外部会社によるメンテナンスがスケジュールされているかどうかを示すフラグ。
    可能な値：
    • true:外部メンテナンスが予定されています
    • false:外部メンテナンスはスケジュールされていません

    データタイプ：ブーリアン

    デフォルト値：false
    親 この変更要求に対する親タスクのSys_idと名前 (存在する場合)。

    データタイプ：文字列

    テーブル:タスク [task]
    フェーズ 変更要求の現在のフェーズ。これにより、変更の実行内容がより詳細に定義されます。
    可能な値：
    • accept
    • ビルド
    • 計画
    • 要求済み

    データタイプ：文字列
    phase_state 変更用に作成する必要があるレコードChange_phase。これらはカテゴリに依存しているため、変更のタイプごとに異なるchange_phaseレコードが存在する可能性があります。各change_phaseにはスケジュールと一連の承認者を含めることができるため、change_phaseレコードは承認プロセスを制御する機会を提供します。
    可能な値：
    • complete
    • 保留
    • open
    • 却下
    • 要求済み
    • work in progress

    データタイプ：文字列
    priority 変更要求の優先度。
    可能な値：
    • 1:重大
    • 2:高
    • 3:中
    • 4:低

    データタイプ:数値 (整数)

    デフォルト：4
    production_system 変更要求が本番環境にある ServiceNow インスタンスに対するものであるかどうかを示すフラグ。
    可能な値：
    • true:本番環境
    • false:非本番環境

    データタイプ：ブーリアン
    理由 変更要求が開始された理由の説明。
    可能な値：
    • ビジネス要件
    • ハードウェアのアップグレード
    • 法律
    • 場所の変更
    • ネットワーク要件
    • 新規または削除された CI
    • その他
    • 問題が解決しました
    • 製品またはサービスが変更されました
    • ソフトウェアのアップグレード
    • ユーザー要求

    データタイプ：文字列

    最大長：40
    reassignment_count 変更要求が新しい所有者に再アサインされた回数。

    データタイプ:数値 (整数)

    デフォルト：0
    rejection_goto 変更要求が却下された場合に実行するタスクのSys_id。

    データタイプ：文字列

    テーブル:タスク [task]
    requested_by 変更を要求したユーザーのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    requested_by_date 変更の実装期日として要求された日時。

    データタイプ：文字列
    review_comments 変更要求のレビュー時に入力されたコメント。

    データタイプ：文字列

    最大長:4,000
    review_date 変更要求がレビューされた日付。

    データタイプ：文字列
    review_status 要求された変更要求レビューの現在のステータス。

    データタイプ：文字列
    risk 変更要求に関連付けられたリスクのレベル。
    有効な値：
    • 1:高
    • 2:中
    • 3:低

    データタイプ：数値

    デフォルト値：3
    risk_impact_analysis 変更要求実装のリスクの説明と分析。

    データタイプ：文字列

    最大長:4,000
    route_reason 現在、 変更管理で使用されていません。変更要求が転送された理由。
    可能な値：
    • 1:解決する転送
    • 9:解決しない転送

    データタイプ：数値
    scope 変更要求のサイズ。
    可能な値：
    • 1:大規模
    • 2:大
    • 3:中
    • 4:小
    • 5:小

    データタイプ：数値

    デフォルト値：3
    service_offering 変更要求に関連付けられたサービスオファリングのSys_id。サービスオファリングは、可用性、スコープ、価格設定、およびパッケージングオプションに関してサービスのレベルを一意に定義します。

    データタイプ：文字列

    テーブル:オファリング [service_offering]
    short_description 変更要求の説明。

    データタイプ：文字列

    最大長：40
    スキル 変更要求を実装するために必要なすべてのスキルのsys_idsのリスト。

    データタイプ：アレイ

    テーブル:スキル [cmn_skill]
    sla_due 使用されなくなりました。関連するサービスレベルアグリーメントに基づいて変更要求を完了する必要がある日時。

    データタイプ：文字列
    sn_esign_document 変更要求に添付されている電子署名済みドキュメントのSys_id。

    データタイプ：文字列

    テーブル:添付ファイル [sys_attachment]
    sn_esign_esignature_configuration 関連ドキュメントに使用される電子署名署名テンプレートのSys_id。

    データタイプ：文字列

    テーブル:電子署名テンプレート [sn_esign_configuration]
    start_date 変更要求の実装開始が予定されている日時。

    データタイプ：文字列
    状況 変更要求の現在のステータス。可能な値は変更モデルで定義されます。

    データタイプ:数値 (整数)

    デフォルト値：1
    std_change_producer_version 変更要求に関連付けられたレコードプロデューサーと変更提案のSys_id。また、提案から作成された成功した変更要求と失敗した変更要求の数と割合も含まれます。

    データタイプ：文字列

    テーブル:標準的な変更テンプレートのバージョン [std_change_producer_version]
    sys_class_name 変更要求が配置されているテーブルの名前。

    データタイプ：文字列
    sys_created_by 変更要求を最初に作成したユーザーの名前。

    データタイプ：文字列

    最大長：40
    sys_created_on 関連する変更要求レコードが最初に作成された日時。

    データタイプ：文字列
    sys_domain インスタンスでドメインを使用する場合は、変更モジュールレコードが関連付けられているドメインの名前。

    データタイプ：文字列
    sys_domain_path インスタンスでドメインを使用する場合は、関連する変更モジュールレコードが存在するドメインパス。

    データタイプ：文字列
    sys_id 関連する変更要求レコードの一意の識別子。

    データタイプ：文字列
    sys_mod_count ケースが最初に作成されてからの更新回数。

    データタイプ:数値 (整数)
    sys_updated_by ケースを最後に更新したユーザー。

    データタイプ：文字列

    最大長：40
    sys_updated_on ケースが最後に更新された日時。

    データタイプ：文字列
    task_effective_number ユニバーサル要求番号。

    データタイプ：文字列

    最大長：40
    task_for 変更管理では使用されません。タスクが作成されたユーザーのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    test_plan 変更に関連付けられたテスト計画の説明。

    データタイプ：文字列

    最大長:4,000
    time_worked 変更要求の合計作業時間。

    データタイプ：文字列
    type 変更要求タイプ。
    可能な値：
    • 緊急
    • 標準
    • standard

    データタイプ：文字列

    最大長：40
    権限なし 変更要求が許可されていないかどうかを示すフラグ
    可能な値：
    • true:権限なし
    • false:認可済み

    データタイプ：ブーリアン
    universal_request この変更要求が含まれている親ユニバーサル要求のSys_id。

    データタイプ：文字列

    テーブル:タスク [task]
    upon_approval 変更要求が承認された場合に実行するアクション。

    可能な値：

    • do_nothing
    • 続行

    データタイプ：文字列

    最大長：40

    デフォルト:続行
    upon_reject 変更要求が却下された場合に実行するアクション。

    可能な値：

    • キャンセル
    • goto

    データタイプ：文字列

    最大長：40

    デフォルト値: cancel
    urgency 変更要求の緊急度。

    可能な値：

    • 1:高
    • 2:中
    • 3:低

    データタイプ:数値 (整数)

    デフォルト値：3
    user_input 追加のユーザー入力。

    データタイプ：文字列

    最大長:4,000
    variables 変更要求に関連付けられた変数の名前と値のペア。

    データタイプ：文字列

    最大長：40
    watch_list 追加のコメントが追加されたとき、または変更要求状況が「解決済み」または「クローズ済み」に変更された場合に、この変更要求に関する通知を受け取るユーザーのsys_idsのリスト。

    データタイプ：アレイ

    テーブル： ユーザー [sys_user]
    wf_activity 変更要求に関連付けられたワークフローアクティビティレコードのSys_id。

    データタイプ：文字列

    テーブル:ワークフローアクティビティ [wf_activity]
    work_end 変更要求の作業が終了した日時。

    データタイプ：文字列
    work_notes 変更要求を解決する方法に関する情報、または変更要求を解決するために実行する手順。

    データタイプ：文字列

    最大長:4,000
    work_notes_list 作業メモが追加されたときにこの変更要求に関する通知を受け取る内部ユーザーのsys_idsのリスト。

    データタイプ：アレイ

    テーブル： ユーザー [sys_user]
    work_start 変更要求に対して作業が開始された日時。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    簡潔にするために、結果には 1 つの変更要求レコードのみが含まれます。

    {
  "result": [
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Clear BGP sessions on a Cisco router",
        "value": "Clear BGP sessions on a Cisco router"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "1766f1de47410200e90d87e8dee490f6",
        "value": "1766f1de47410200e90d87e8dee490f6"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
  ]
}

    変更管理 - GET /sn_chg_rest/change/{change_sys_id}/nextstates

    現在のステータスを含む、指定された変更要求で利用可能なステータスのリストを取得します。

    利用可能な場合は、実装された変更管理のバージョンに基づいて次のステータスに移行する方法も提供します。変更が変更モデル駆動型である場合、エンドポイントは合格したかそうでないかの条件を返します。また、特定の移行のすべての条件に合格したかどうかに関する情報も提供します。この情報は、タイプ駆動型および従来の変更要求では利用できません。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/nextstates

    デフォルト URL: /api/sn_chg_rest/change/{change_sys_id}/nextstates

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

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

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

    データタイプ：文字列
    change_sys_id 変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 50. クエリパラメーター
    名前 説明
    なし
    表 : 51. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 53. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 54. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    404 見つかりません。要求されたアイテムが見つかりませんでした。

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

    名前 説明
    available_states 現在のステータスを含む、指定された変更要求で利用可能なステータスの値。

    データタイプ：アレイ
    state_label ラベルを利用可能なステータスに関連付けるキーと値のペア。

    データタイプ: オブジェクト
    state_transitions 利用可能な各ステータスに移行するために必要なものに関する情報。使用可能なそれぞれの異なる「状態」は、独自の Array にあり、その状態にあるための条件セットがそれぞれ独自のオブジェクトにあります。

    データタイプ：アレイ

    "state_transitions": [
  {
    "automatic_transition": Boolean,
    "conditions": [Array],
    "display_value": "String",
    "from_state": "String",
    "sys_id": "String",
    "to_state": "String",
    "transition_available": Boolean
  }
]
    state_transitions.automatic_transition

    このステータスに自動的に移行するかどうかを示すフラグ。

    有効な値：
    • true:変更要求は自動的にこのステータスに移行します。
    • false:変更要求は自動的にこのステータスに移行しません。

    データタイプ：ブーリアン
    state_transitions.conditions 状態に関連付けられている条件のリスト。

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

    "conditions": [
  {
    "condition": {Object},
    "passed": Boolean
  }
]
    state_transitions.conditions.condition 特定の条件の値。

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

    "condition": {
  "description": "String",
  "name": "String",
  "sys_id": "String"
}
    state_transitions.conditions.condition.description 条件の説明

    データタイプ：文字列
    state_transitions.conditions.condition.name 条件の名前。

    データタイプ：文字列
    state_transitions.conditions.condition.sys_id 条件のSys_id。

    データタイプ：文字列
    state_transitions.conditions.passed

    変更要求が関連する条件を満たしたかどうかを示すフラグ。

    有効な値：
    • true:条件を満たしました。
    • false:条件を満たしていません。
    state_transitions.display_value ステータスの説明が表示されます。

    データタイプ：文字列
    state_transitions.from_state 変更要求の移行元のステータスの値。

    データタイプ：文字列
    state_transitions.sys_id 移行ステータスのSys_id。

    データタイプ：文字列
    state_transitions.to_state 変更要求の移行先のステータスの値。

    データタイプ：文字列
    state_transitions.transition_available

    変更要求が現在のステータスからこのステータスに移行できるかどうかを示すフラグ。

    有効な値：
    • true:このステータスに移行できます。
    • false:このステータスに移行できません。

    cURL 要求

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

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f"/nextstates \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    結果を返します:

    {
  "result": {
    "available_states": [ "0", "4", "-1" ], // State values
    "state_transitions": [
      [
        {
          "sys_id": "7a0d2ccdc343101035ae3f52c1d3ae2e", // sttrm_state_transition sys id
          "display_value": "Implement to Review",
          "from_state": "-1",
          "to_state": "0",
          "transition_available": false, // If true, can move to this state
          "automatic_transition": true, // If true, automatically moves to this state
          "conditions": [
            {
              "passed": false, // If true, change request met this condition
              "condition": {
                "name": "No active Change Tasks",
                "description": null,
                "sys_id": "3c1d2ccdc343101035ae3f52c1d3aea4"
              }
            }
          ]
        },
        {
          "sys_id": "db401481c343101035ae3f52c1d3aedd",
          "display_value": "Implement to Review",
          "from_state": "-1",
          "to_state": "0",
          "transition_available": true,
          "automatic_transition": false,
          "conditions": [
            {
              "passed": true,
              "condition": {
                "name": "Not On hold",
                "description": null,
                "sys_id": "2132deb6c303101035ae3f52c1d3ae8c"
              }
            }
          ]
        }
      ],
      [
        {
          "sys_id": "5327c551c343101035ae3f52c1d3aeec",
          "display_value": "Implement to Canceled",
          "from_state": "-1",
          "to_state": "4",
          "transition_available": true,
          "automatic_transition": false,
          "conditions": []
        }
      ]
    ],
    "state_label": { // state value to label pairs
      "0": "Review",
      "4": "Canceled",
      "-1": "Implement"
    }
  }
}

    変更管理 - GET /sn_chg_rest/change/{change_sys_id}/schedule

    変更要求に利用可能なタイムスロットを取得できるようにします。

    必要なロール:sn_change_writer

    注:
    このエンドポイントを実行しても、利用可能な開始時間と終了時間は表示されません。応答本文 worker.link プロパティで指定されたリンクを使用して、スケジュールデータを取得します。
    関連項目：

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/schedule

    デフォルト URL: /api/sn_chg_rest/change/{change_sys_id}/schedule

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

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

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

    データタイプ：文字列
    change_sys_id 次の利用可能なタイムスロットを検索するための変更要求のSys_id。

    選択する変更要求には、計画開始時刻と計画終了時刻を含む構成アイテム (cmdb_ci) が必要です。

    テーブル：変更要求 [change_request]
    表 : 56. クエリパラメーター
    名前 説明
    なし
    表 : 57. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 59. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 60. ステータスコード
    ステータスコード 説明
    202 システムが要求を承認しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    考えられる問題:
    • 指定された変更要求に予定された開始時刻と終了時刻がありません。
    • 指定された変更要求には、関連する構成アイテム (cmdb_ci) がありません。
    • ユーザーには、変更要求のフィールドへの読み取りアクセス権がありません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    考えられる問題:
    • 指定された情報に基づいて変更要求を見つけることができません。
    • ユーザーにはレコードへの読み取りアクセス権がありません。

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

    名前 説明
    エラー エンドポイント要求の処理中に発生したエラーに関する情報。

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

    "error": {
  "detail": "String",
  "message": "String",
  "status": "String"
}
    error.detail エラーに関する追加情報。

    データタイプ：文字列
    error.message エラーを特定するメッセージ。

    データタイプ：文字列
    メッセージ メッセージ情報。
    データタイプ: オブジェクト
    "messages": {
  "errorMessages": [Array],
  "infoMessages": [Array],
  "warningMessages": [Array]
}
    messages.errorMessages 要求の処理中にエラーメッセージが発生しました。

    データタイプ：アレイ
    messages.infoMessages 要求の処理中に検出された情報メッセージ。

    データタイプ：アレイ
    messages.warningMessages 要求の処理中に検出された警告メッセージ。

    データタイプ：アレイ
    要求 元のエンドポイント要求。

    データタイプ：文字列
    状況 ワーカーの現在のステータスに関する情報。

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

    state: {
  display_value: "String", 
  value: Number
}
    state.display_value ワーカーの状態の表示値。これらの値は、 state.value パラメーターに直接関連しています。

    可能な値：

    • 完了
    • エラー
    • 対応中
    • 待機中

    データタイプ：文字列
    state.value ワーカーのステータスの数値。

    可能な値：

    • 1
    • 2
    • 3
    • 4

    データタイプ：数値
    type 要求のタイプ。

    有効な値:スケジュール

    データタイプ：文字列
    ワーカー 関連付けられたワーカーに関する情報。

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

    "worker": {
  "link": "String",
  "sysId": "String"
}
    worker.link タイムスロットデータを取得するためのリンク。GET /sn_chg_rest/change/worker/{sys_id} のsys_idを使用して結果を表示します。

    データタイプ：文字列
    worker.sysId 変更要求に関連付けられたワーカーのSys_id。

    データタイプ：文字列
    status エラーが発生した場合にのみ表示されます。エンドポイント処理のステータス。

    可能な値:失敗

    データタイプ：文字列

    対応可能なタイムスロットを取得

    worker.linkで指定された値を使用して、スケジュール期間の詳細を取得します。値は次の形式です。

    https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>

    GET /sn_chg_rest/change/worker/{worker_sys_id} のworker_sys_idを使用して結果を表示します。

    応答本文にはステータスが含まれ、処理が完了すると結果が提供されます。

    ワーカー応答本文パラメーターの結果は、タイムスロットの空き状況によって異なります。
    • 指定されたタイムスロットがスケジュールタイムスロット内の変更要求に利用可能な場合、ワーカー API は payload.spans プロパティに利用可能なタイムスロットをリストします。それ以外の場合、 payload.spans プロパティは結果に表示されません。
    • 定義されたスケジュールのタイムスロット内に指定された変更要求期間に利用可能なタイムスロットがない場合、 messages.infoMessages には次のように記載されます。 D
      注:
      変更要求スケジュールのタイムスロットのデフォルト値は 90 日です。この値を変更するには、 change.conflict.next_available.schedule_window プロパティを変更します。詳細については、「 競合分析プロパティの構成」を参照してください。

    次の GET /sn_chg_rest/change/worker/{sys_id} の例は、worker.link の詳細で指定された ID を使用して提供される出力を示しています。結果には、タスク期間で利用可能なオープンタイムスパンが一覧表示されます。

    {
  "result": {
    "worker": {
      "sysId": "9b3f62e0a4c87010f87712198fe9cad1",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    },
    "payload": {
      "spans": [
        {
          "start": {
            "value": "2021-05-08 08:00:00",
            "display_value": "2021-05-08 01:00:00"
          },
          "end": {
            "value": "2021-05-08 11:00:00",
            "display_value": "2021-05-08 04:00:00"
          }
        },
        {
          "start": {
            "value": "2021-05-15 08:00:00",
            "display_value": "2021-05-15 01:00:00"
          },
          "end": {
            "value": "2021-05-15 11:00:00",
            "display_value": "2021-05-15 04:00:00"
          }
        },
        ...
      ]
    }
  }
}

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/change/{change_sys_id}/schedule" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    結果には、GET /sn_chg_rest/change/worker/ エンドポイントで指定されたsys_idを実行するために使用できる worker.link の詳細が含まれます。

    {
  "result": {
    "worker": {
      "sysId": "9b3f62e0a4c87010f87712198fe9cad1",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

    変更管理 - GET /sn_chg_rest/change/{change_sys_id}/task

    指定された基準に基づいて、指定された変更要求に関連付けられた 1 つ以上のタスクを取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task

    デフォルト URL: /api/sn_chg_rest/change/{change_sys_id}/task

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

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

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

    データタイプ：文字列
    change_sys_id タスクを取得する変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 62. クエリパラメーター
    名前 説明
    キーと値のペア 要求の作成時に変更するフィールド。キーはテンプレート内のフィールド名で、値はフィールドに入力する情報です。
    変更できず、渡された場合に無視されるフィールド:
    • ビジネスルール
    • ACL で定義されている読み取り専用フィールド
    • 存在しないフィールド

    データタイプ：文字列
    order 返された変更要求をソートするためのフィールド。

    データタイプ：文字列
    sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：数値

    デフォルト：500
    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>:次の値をサポートします。
      • =:<col_name>は<値>と完全に一致します。
      • !=:<col_name> が <value> と一致しません。
      • LIKE:<col_name>には指定された文字列 <value> が含まれています。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • STARTSWITH:<col_name>は、指定された文字列 <value> で始まります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ENDSWITH:<col_name>は指定された文字列 <value> で終わります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ^:クエリ条件を追加するための AND 演算子。結果セットに含まれるレコードは両方の条件に一致します。
      • ^OR:クエリ条件を追加するための OR 演算子。結果セットに含まれるレコードは、少なくとも 1 つの条件に一致します。
    • <value>:フィルターを適用する値。
    演算子の詳細については、「Operators available for filters and queries」を参照してください。

    クエリには複数の条件を含めることができます。たとえば、次のクエリは、発信者が現在のユーザーであり、レコードがアクティブなレコードを返します。

    sysparm_query=caller_id=javascript:gs.getUserID()^active=true

    エンコードクエリでは、昇順および降順による並べ替えの機能もサポートされています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで ORDERBY 句と ORDERBYDESC 句を使用します。

    構文:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    たとえば、次のクエリでは、すべてのアクティブなレコードを取得し、結果を番号の昇順に並べ替え、次にカテゴリ別に降順に並べ替えます。

    sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCカテゴリ

    デフォルトでは、無効なフィールド名など、クエリの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。プロパティ glide.invalid_query.returns_no_rows を true に設定すると、代わりに無効なクエリに対して行を返さないようにします。
    注:
    glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。

    データタイプ：文字列
    テキスト検索 すべての変更タスクレコードフィールドの検索に使用する文字列。この検索では ServiceNow 全文検索プラットフォーム機能を使用し、デフォルトは IR_AND_OR_QUERY です。

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

    ヘッダー

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

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

    デフォルト： application/json
    表 : 65. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 66. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア すべてのフィールド (キー) と、削除前に特定された変更要求タスクに関連付けられた値。

    データタイプ: オブジェクト
    親 タスクに関連付けられた変更要求に関する情報。

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

    parent: {
  display_value: "String", 
  value: "String"
}
    parent.display_value UI に表示する変更要求情報。

    データタイプ：文字列
    parent.value タスクに関連付けられた変更要求のSys_id。

    データタイプ：文字列
    sys_id 変更要求タスクのSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求タスクのSys_id。

    データタイプ：文字列
    sys_id.value 変更要求タスクのSys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    {
    result: [
        {
            sys_id: {
                value: "12629ec4b750230096c3e4f6ee11a9d5",
                display_value: "12629ec4b750230096c3e4f6ee11a9d5"
            },
            parent: {
                value: "0f4ac6c4b750230096c3e4f6ee11a9fe ", 
                display_value: "CHG0033046 "
            },
            ..., // all valid fields in record, example below
            short_description: {
                value: "Retire node",
                display_value: "Retire node"
            }
        }, 
        { // next record found }, ... // and so on
    ]
}

    変更管理 - GET /sn_chg_rest/change/{sys_id}

    指定されたsys_idによって識別される変更要求を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 変更要求レコードのSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 68. クエリパラメーター
    名前 説明
    なし
    表 : 69. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 71. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 72. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    要素 説明
    result 1 つ以上の変更要求レコードオブジェクトを含むリスト。各オブジェクトは変更要求を記述します。変更要求オブジェクトの各要素は、変更要求 [change_request] テーブルの関連レコードのフィールドに対応します。

    すべての要素には 、値 と display_value の名前と値のペアが含まれます。日付フィールドには、名前と値 display_value_internal ペアも含まれます。

    データタイプ：アレイ
    action_status 関連する変更要求の現在のアクションステータス。

    可能な値：

    • 1:社内でブロック済み
    • 2:顧客によりブロック済み
    • 3:社内でおよび顧客によりブロック済み
    • 4:要注意

    データタイプ：数値
    アクティブ 変更要求がアクティブかどうかを示すフラグ。

    可能な値：

    • true:変更要求はアクティブです
    • false:変更要求はアクティブではありません

    データタイプ：ブーリアン

    デフォルト：true
    activity_due 関連するケースの完了予定日時。

    データタイプ：文字列
    additional_assignee_list 変更要求の作業にアサインされた追加担当者のsys_idsのリスト。

    データタイプ：アレイ
    approval 必要な承認プロセスのタイプ。

    データタイプ：文字列

    デフォルト:未要求
    approval_history 最新の承認履歴ジャーナルエントリ。

    データタイプ：文字列
    approval_set 関連付けられたアクションが承認された日時。

    データタイプ：文字列
    assigned_to 変更要求にアサインされたユーザーのSys_id。

    データタイプ：文字列
    assignment_group 変更要求にアサインされたグループのSys_id。

    データタイプ：文字列
    backout_plan 変更を元に戻す必要がある場合に実行する計画の説明。

    データタイプ：文字列
    business_duration 変更を完了するためにかかった予定作業時間、作業日数、および作業週の長さ。

    データタイプ：文字列
    business_service 変更要求に関連付けられたビジネスサービスのSys_id。サービス [cmdb_ci_service] テーブルにあります。

    データタイプ：文字列
    cab_date 変更諮問委員会 (CAB) が開合する日付。

    データタイプ：文字列
    cab_delegate CAB 会議中に CAB マネージャーの代理を務めることができるユーザーのSys_id。ユーザー [sys_user] テーブルにあります

    データタイプ：文字列
    cab_recommendation 変更要求に対する CAB の推奨事項の説明。

    データタイプ：文字列

    最大長:4,000
    cab_required CAB が必要かどうかを示すフラグ。
    可能な値：
    • true:変更諮問委員会が必要です。
    • false:変更諮問委員会は必要ありません。

    データタイプ：ブーリアン

    デフォルト値：false
    calendar_duration 現在、 変更管理で使用されていません。

    データタイプ：文字列
    category ハードウェア、ネットワーク、ソフトウェアなど、変更のカテゴリ。

    データタイプ：文字列

    デフォルト:その他
    change_plan 変更要求を管理および制御するためのアクティビティとロール。

    データタイプ：文字列
    chg_model 関連する変更要求の基になっている変更モデルのSys_id。変更モデルは、変更要求に対して完了する必要がある状況フロー、移行、およびプロセスアクティビティを定義します。

    データタイプ：文字列

    テーブル:変更モデル [chg_model]
    closed_at 関連する変更要求がクローズされた日時。

    データタイプ：文字列
    closed_by 変更要求をクローズした人物のSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    close_code 変更要求がクローズされたときにアサインされたコード。たとえば、[成功]、[成功したが問題あり]、[不成功] などです。

    データタイプ：文字列
    close_notes ユーザーが変更要求を閉じるときに入力したメモ。

    データタイプ：文字列
    cmdb_ci 変更要求に関連付けられた構成アイテムのSys_id。

    データタイプ：文字列

    テーブル:構成アイテム [cmdb_ci]
    コメント 関連する変更要求に入力された顧客向けの作業メモのリスト。

    データタイプ：アレイ
    comments_and_work_notes 関連する変更要求に対して入力された内部および顧客向けの作業メモのリスト。

    データタイプ：アレイ

    最大長:4,000
    会社 変更要求に関連付けられている会社のSys_id。

    データタイプ：文字列

    テーブル:会社 [core_company]
    conflict_last_run 変更の要求で競合の検出スクリプトが最後に実行された日時。

    データタイプ：文字列
    conflict_status 競合検出スクリプトによって検出された現在の競合ステータス (競合や未実行など)。

    データタイプ：文字列

    最大長：40

    デフォルト:未実行
    contact_type 変更要求が最初に要求されたメソッド。
    可能な値：
    • チャット
    • メール
    • phone
    • ソーシャル
    • Web

    データタイプ：文字列
    contract 変更要求に関連付けられた契約のSys_id。

    データタイプ：文字列

    テーブル:契約 [ast_contract]
    correlation_display correlation_idの分かりやすい名前。

    データタイプ：文字列

    最大長:100
    correlation_id サードパーティシステム内の一致する変更要求レコードのグローバル一意識別子 (GUID)。

    データタイプ：文字列

    最大長:100
    delivery_plan 使用されなくなりました。変更要求に関連付けられた配送計画のSys_id。

    データタイプ：文字列

    テーブル:実行計画 [sc_cat_item_delivery_plan]
    delivery_task 使用されなくなりました。変更要求に関連付けられた配送タスクのSys_id。

    データタイプ：文字列

    テーブル:実行計画タスク [sc_cat_item_delivery_task]
    description 変更要求の詳細な説明。

    データタイプ：文字列

    最大長:4,000
    due_date タスクの期日。変更要求プロセスでは使用されません。

    データタイプ：文字列
    end_date 変更要求を完了する日時。

    データタイプ：文字列
    escalation 現在のエスカレーションレベル。

    可能な値：

    • 0:通常
    • 1:中
    • 2:高
    • 3:期限切れ

    データタイプ:数値 (整数)

    デフォルト：0
    expected_start タスクを開始する日時。変更要求プロセスでは使用されません。

    データタイプ：文字列
    follow_up ユーザーが変更要求者をフォローアップした日時。

    データタイプ：文字列
    group_list 変更要求に関連付けられたsys_idsとグループの名前のリスト。

    データタイプ：アレイ

    最大長:4,000
    impact 変更要求に対する影響は、顧客にもたらします。

    可能な値：

    • 1:高
    • 2:中
    • 3:低

    データタイプ:数値 (整数)

    デフォルト値：3
    implementation_plan この変更を実装するために実行する一連のステップ。また、ステップ間の依存関係と各ステップのアサイニーの詳細も含まれます。

    データタイプ：文字列

    最大長:4,000
    正当性 この変更を実装するメリットと、この変更が実装されない場合の影響。

    データタイプ：文字列

    最大長:4,000
    ナレッジ 変更要求に関連付けられたナレッジベース (KB) 記事があるかどうかを示すフラグ。
    可能な値：
    • true:関連する KB 記事
    • false:関連する KB 記事なし

    データタイプ：ブーリアン
    location 変更要求で参照されている機器の場所のSys_idと名前。

    データタイプ：文字列

    テーブル:場所 [cmn_location]
    made_sla 使用されなくなりました。変更要求が関連するサービスレベルアグリーメントに沿って実装されたかどうかを示すフラグ。

    データタイプ：ブーリアン
    needs_attention 変更要求に注意が必要かどうかを示すフラグ。

    可能な値：

    • true:変更要求には追加の注意が必要です。
    • false:変更要求に追加の注意は必要ありません。

    データタイプ：ブーリアン

    デフォルト値：false
    number CHG0040007 など、システムによって変更要求にアサインされた変更番号。

    データタイプ：文字列
    on_hold 変更要求が現在保留中かどうかを示すフラグ。
    可能な値：
    • true:保留
    • false:保留中ではない

    データタイプ：ブーリアン

    デフォルト値：false
    on_hold_reason on_holdパラメーターが「true」の場合、変更要求が保留になっている理由の説明。

    データタイプ：文字列

    最大長:4,000
    on_hold_task on_holdパラメーターが「true」の場合、保留が解除される前に完了する必要があるタスクのsys_idsのリストが表示されます。

    データタイプ：文字列

    最大長:4,000
    open_at 変更リリースが作成された日時。

    データタイプ：文字列
    opened_by 変更リリースを作成したユーザーのSys_idと名前。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    order 変更管理では使用されません。データベースからレコードを取得する場合などにレコードを並べ替えるためのオプションの数値フィールド。

    データタイプ:数値 (整数)
    outside_maintenance_schedule 変更要求に対して外部会社によるメンテナンスがスケジュールされているかどうかを示すフラグ。
    可能な値：
    • true:外部メンテナンスが予定されています
    • false:外部メンテナンスはスケジュールされていません

    データタイプ：ブーリアン

    デフォルト値：false
    親 この変更要求に対する親タスクのSys_idと名前 (存在する場合)。

    データタイプ：文字列

    テーブル:タスク [task]
    フェーズ 変更要求の現在のフェーズ。これにより、変更の実行内容がより詳細に定義されます。
    可能な値：
    • accept
    • ビルド
    • 計画
    • 要求済み

    データタイプ：文字列
    phase_state 変更用に作成する必要があるレコードChange_phase。これらはカテゴリに依存しているため、変更のタイプごとに異なるchange_phaseレコードが存在する可能性があります。各change_phaseにはスケジュールと一連の承認者を含めることができるため、change_phaseレコードは承認プロセスを制御する機会を提供します。
    可能な値：
    • complete
    • 保留
    • open
    • 却下
    • 要求済み
    • work in progress

    データタイプ：文字列
    priority 変更要求の優先度。
    可能な値：
    • 1:重大
    • 2:高
    • 3:中
    • 4:低

    データタイプ:数値 (整数)

    デフォルト：4
    production_system 変更要求が本番環境にある ServiceNow インスタンスに対するものであるかどうかを示すフラグ。
    可能な値：
    • true:本番環境
    • false:非本番環境

    データタイプ：ブーリアン
    理由 変更要求が開始された理由の説明。
    可能な値：
    • ビジネス要件
    • ハードウェアのアップグレード
    • 法律
    • 場所の変更
    • ネットワーク要件
    • 新規または削除された CI
    • その他
    • 問題が解決しました
    • 製品またはサービスが変更されました
    • ソフトウェアのアップグレード
    • ユーザー要求

    データタイプ：文字列

    最大長：40
    reassignment_count 変更要求が新しい所有者に再アサインされた回数。

    データタイプ:数値 (整数)

    デフォルト：0
    rejection_goto 変更要求が却下された場合に実行するタスクのSys_id。

    データタイプ：文字列

    テーブル:タスク [task]
    requested_by 変更を要求したユーザーのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    requested_by_date 変更の実装期日として要求された日時。

    データタイプ：文字列
    review_comments 変更要求のレビュー時に入力されたコメント。

    データタイプ：文字列

    最大長:4,000
    review_date 変更要求がレビューされた日付。

    データタイプ：文字列
    review_status 要求された変更要求レビューの現在のステータス。

    データタイプ：文字列
    risk 変更要求に関連付けられたリスクのレベル。
    有効な値：
    • 1:高
    • 2:中
    • 3:低

    データタイプ：数値

    デフォルト値：3
    risk_impact_analysis 変更要求実装のリスクの説明と分析。

    データタイプ：文字列

    最大長:4,000
    route_reason 現在、 変更管理で使用されていません。変更要求が転送された理由。
    可能な値：
    • 1:解決する転送
    • 9:解決しない転送

    データタイプ：数値
    scope 変更要求のサイズ。
    可能な値：
    • 1:大規模
    • 2:大
    • 3:中
    • 4:小
    • 5:小

    データタイプ：数値

    デフォルト値：3
    service_offering 変更要求に関連付けられたサービスオファリングのSys_id。サービスオファリングは、可用性、スコープ、価格設定、およびパッケージングオプションに関してサービスのレベルを一意に定義します。

    データタイプ：文字列

    テーブル:オファリング [service_offering]
    short_description 変更要求の説明。

    データタイプ：文字列

    最大長：40
    スキル 変更要求を実装するために必要なすべてのスキルのsys_idsのリスト。

    データタイプ：アレイ

    テーブル:スキル [cmn_skill]
    sla_due 使用されなくなりました。関連するサービスレベルアグリーメントに基づいて変更要求を完了する必要がある日時。

    データタイプ：文字列
    sn_esign_document 変更要求に添付されている電子署名済みドキュメントのSys_id。

    データタイプ：文字列

    テーブル:添付ファイル [sys_attachment]
    sn_esign_esignature_configuration 関連ドキュメントに使用される電子署名署名テンプレートのSys_id。

    データタイプ：文字列

    テーブル:電子署名テンプレート [sn_esign_configuration]
    start_date 変更要求の実装開始が予定されている日時。

    データタイプ：文字列
    状況 変更要求の現在のステータス。可能な値は変更モデルで定義されます。

    データタイプ:数値 (整数)

    デフォルト値：1
    std_change_producer_version 変更要求に関連付けられたレコードプロデューサーと変更提案のSys_id。また、提案から作成された成功した変更要求と失敗した変更要求の数と割合も含まれます。

    データタイプ：文字列

    テーブル:標準的な変更テンプレートのバージョン [std_change_producer_version]
    sys_class_name 変更要求が配置されているテーブルの名前。

    データタイプ：文字列
    sys_created_by 変更要求を最初に作成したユーザーの名前。

    データタイプ：文字列

    最大長：40
    sys_created_on 関連する変更要求レコードが最初に作成された日時。

    データタイプ：文字列
    sys_domain インスタンスでドメインを使用する場合は、変更モジュールレコードが関連付けられているドメインの名前。

    データタイプ：文字列
    sys_domain_path インスタンスでドメインを使用する場合は、関連する変更モジュールレコードが存在するドメインパス。

    データタイプ：文字列
    sys_id 関連する変更要求レコードの一意の識別子。

    データタイプ：文字列
    sys_mod_count ケースが最初に作成されてからの更新回数。

    データタイプ:数値 (整数)
    sys_updated_by ケースを最後に更新したユーザー。

    データタイプ：文字列

    最大長：40
    sys_updated_on ケースが最後に更新された日時。

    データタイプ：文字列
    task_effective_number ユニバーサル要求番号。

    データタイプ：文字列

    最大長：40
    task_for 変更管理では使用されません。タスクが作成されたユーザーのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    test_plan 変更に関連付けられたテスト計画の説明。

    データタイプ：文字列

    最大長:4,000
    time_worked 変更要求の合計作業時間。

    データタイプ：文字列
    type 変更要求タイプ。
    可能な値：
    • 緊急
    • 標準
    • standard

    データタイプ：文字列

    最大長：40
    権限なし 変更要求が許可されていないかどうかを示すフラグ
    可能な値：
    • true:権限なし
    • false:認可済み

    データタイプ：ブーリアン
    universal_request この変更要求が含まれている親ユニバーサル要求のSys_id。

    データタイプ：文字列

    テーブル:タスク [task]
    upon_approval 変更要求が承認された場合に実行するアクション。

    可能な値：

    • do_nothing
    • 続行

    データタイプ：文字列

    最大長：40

    デフォルト:続行
    upon_reject 変更要求が却下された場合に実行するアクション。

    可能な値：

    • キャンセル
    • goto

    データタイプ：文字列

    最大長：40

    デフォルト値: cancel
    urgency 変更要求の緊急度。

    可能な値：

    • 1:高
    • 2:中
    • 3:低

    データタイプ:数値 (整数)

    デフォルト値：3
    user_input 追加のユーザー入力。

    データタイプ：文字列

    最大長:4,000
    variables 変更要求に関連付けられた変数の名前と値のペア。

    データタイプ：文字列

    最大長：40
    watch_list 追加のコメントが追加されたとき、または変更要求状況が「解決済み」または「クローズ済み」に変更された場合に、この変更要求に関する通知を受け取るユーザーのsys_idsのリスト。

    データタイプ：アレイ

    テーブル： ユーザー [sys_user]
    wf_activity 変更要求に関連付けられたワークフローアクティビティレコードのSys_id。

    データタイプ：文字列

    テーブル:ワークフローアクティビティ [wf_activity]
    work_end 変更要求の作業が終了した日時。

    データタイプ：文字列
    work_notes 変更要求を解決する方法に関する情報、または変更要求を解決するために実行する手順。

    データタイプ：文字列

    最大長:4,000
    work_notes_list 作業メモが追加されたときにこの変更要求に関する通知を受け取る内部ユーザーのsys_idsのリスト。

    データタイプ：アレイ

    テーブル： ユーザー [sys_user]
    work_start 変更要求に対して作業が開始された日時。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    {
  "result":
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Clear BGP sessions on a Cisco router",
        "value": "Clear BGP sessions on a Cisco router"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "1766f1de47410200e90d87e8dee490f6",
        "value": "1766f1de47410200e90d87e8dee490f6"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
}

    変更管理 - GET /sn_chg_rest/change/{sys_id}/ci

    指定された関連付けタイプに基づいて、指定された変更要求に関連付けられた複数の構成アイテム (CI) を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/ci

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}/ci

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

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

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

    データタイプ：文字列
    sys_id 関連する CMDB CI を返す変更要求のSys_id。

    データタイプ：文字列
    表 : 74. クエリパラメーター
    名前 説明
    association_type 必須です。CMDB CI と変更要求の間の関連付けのタイプ。

    有効な値：

    • 影響を受ける:変更要求の影響を受ける CI
    • impacted:変更要求によって影響を受けるサービス
    • オファリング:影響を受けるサービスオファリング

    データタイプ：文字列
    名前と値のペア 結果セットのフィルタリングに使用する名前と値のペア。名前は、指定された値がフィルタリングされるフィールドです。このパラメーターは sysparm_queryと相互に排他的です。たとえば、 &sysparm_query=active=true を使用する代わりに、 &active=true を使用して呼び出し元ステートメントを簡略化できます。フィールドが選択タイプまたは参照タイプのフィールドである場合は、&state=7 ではなく &state=closed のように表示値を使用することもできます。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります ( 例:&active=true&assigned_to=john.smith)。

    データタイプ：文字列
    sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：数値

    デフォルト：500
    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>:次の値をサポートします。
      • =:<col_name>は<値>と完全に一致します。
      • !=:<col_name> が <value> と一致しません。
      • LIKE:<col_name>には指定された文字列 <value> が含まれています。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • STARTSWITH:<col_name>は、指定された文字列 <value> で始まります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ENDSWITH:<col_name>は指定された文字列 <value> で終わります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ^:クエリ条件を追加するための AND 演算子。結果セットに含まれるレコードは両方の条件に一致します。
      • ^OR:クエリ条件を追加するための OR 演算子。結果セットに含まれるレコードは、少なくとも 1 つの条件に一致します。
    • <value>:フィルターを適用する値。
    演算子の詳細については、「Operators available for filters and queries」を参照してください。

    クエリには複数の条件を含めることができます。たとえば、次のクエリは、発信者が現在のユーザーであり、レコードがアクティブなレコードを返します。

    sysparm_query=caller_id=javascript:gs.getUserID()^active=true

    エンコードクエリでは、昇順および降順による並べ替えの機能もサポートされています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで ORDERBY 句と ORDERBYDESC 句を使用します。

    構文:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    たとえば、次のクエリでは、すべてのアクティブなレコードを取得し、結果を番号の昇順に並べ替え、次にカテゴリ別に降順に並べ替えます。

    sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCカテゴリ

    デフォルトでは、無効なフィールド名など、クエリの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。プロパティ glide.invalid_query.returns_no_rows を true に設定すると、代わりに無効なクエリに対して行を返さないようにします。
    注:
    glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。

    データタイプ：文字列
    表 : 75. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 77. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 78. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。

    エラー応答には、問題のトラブルシューティングに役立つ関連メッセージが含まれています。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    ci_item|cmdb_ci_service 関連付けタイプに応じて、ci_item変数またはcmdb_ci_service変数のいずれかです。

    データタイプ：アレイ

    ci_item|cmdb_ci_service : {
  display_value: "String", 
  value: "String"
}
    ci_item|cmdb_ci_service.value ci_itemまたはcmdb_ci_serviceのSys_id。

    データタイプ：文字列
    ci_item|cmdb_ci_service.display_value ci_itemまたはcmdb_ci_serviceの表示値。

    データタイプ：文字列
    sys_id 変更要求sys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    <record_fields> ci_itemまたはcmdb_ci_serviceレコードのすべての有効なフィールド。関連付けタイプに基づくテーブル。

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

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci?association_type=affected" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    {
  result: [
    {
      sys_id: {
        value: "92b8544047810200e90d87e8dee490b0",
        display_value: "92b8544047810200e90d87e8dee490b0"
      },
      ci_item|cmdb_ci_service : {
        value: "3a27d4370a0a0bb4006316812bf45439", 
        display_value: "PS Apache01"
      },
      ..., // all valid fields in record, table based on association type
    }, 
    { // next record found }, ... // and so on
  ]
}

    変更管理 - GET /sn_chg_rest/change/{sys_id}/conflict

    指定された変更要求に対して現在実行中の変更要求競合チェックプロセスのステータス、または最後に完了した競合チェックプロセスの結果を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/conflict

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}/conflict

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

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

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

    データタイプ：文字列
    sys_id 実行中/完了した競合チェックプロセスのステータスを返す変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 80. クエリパラメーター
    名前 説明
    なし
    表 : 81. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 83. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 84. ステータスコード
    ステータスコード 説明
    200 競合チェックプロセスの現在のステータス。競合が検出された場合は含めます。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    conflicts 変更要求に対して見つかった競合のリスト。空のオブジェクトは、競合が検出されなかったことを示します。

    データタイプ：アレイ
    job_status 実際の競合チェックジョブのステータス。

    データタイプ：文字列
    last_run 前回の競合チェックプロセスが開始された日時。

    データタイプ：文字列
    record_count チェックされたレコードの数。

    データタイプ：文字列
    status 競合チェックプロセスの結果 (「競合」や「未実行」など)。
    注:
    変更要求に競合がない場合でも、このフィールドは [競合] に設定されます。ただし、 conflicts オブジェクトは空です。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    成功した応答 - 競合なし

    {
  result: {
    status: "Conflict",
    last_run": "2018-08-30 12:58:05",
    record_count: "1",
    job_status: "2",
    conflicts: []
  }
}

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    成功した応答 - 競合あり

    {
  result: {
    status: "Conflict",
    last_run": "2018-08-30 12:58:05",
    record_count: "1",
    job_status: "2",
    conflicts: [
      {
        change: {
          display_value: "CHG0030001",
          value: "afbffb24b758230096c3e4f6ee11a972"
        },
        type: {
          display_value: "Not In Maintenance Window",
          value: "not_in_maintenance_window"
        }
        ..., // all valid fields in record, example below
      }
    ]
  }
}

    変更管理 - GET /sn_chg_rest/change/emergency

    指定された基準に基づいて 1 つ以上の緊急変更要求を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/emergency

    デフォルト URL: /api/sn_chg_rest/change/emergency

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

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

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

    データタイプ：文字列
    表 : 86. クエリパラメーター
    名前 説明
    order 返された変更要求をソートするためのフィールド。

    データタイプ：文字列

    デフォルト: number
    sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：数値

    デフォルト：500
    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>:次の値をサポートします。
      • =:<col_name>は<値>と完全に一致します。
      • !=:<col_name> が <value> と一致しません。
      • LIKE:<col_name>には指定された文字列 <value> が含まれています。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • STARTSWITH:<col_name>は、指定された文字列 <value> で始まります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ENDSWITH:<col_name>は指定された文字列 <value> で終わります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ^:クエリ条件を追加するための AND 演算子。結果セットに含まれるレコードは両方の条件に一致します。
      • ^OR:クエリ条件を追加するための OR 演算子。結果セットに含まれるレコードは、少なくとも 1 つの条件に一致します。
    • <value>:フィルターを適用する値。
    演算子の詳細については、「Operators available for filters and queries」を参照してください。

    クエリには複数の条件を含めることができます。たとえば、次のクエリは、発信者が現在のユーザーであり、レコードがアクティブなレコードを返します。

    sysparm_query=caller_id=javascript:gs.getUserID()^active=true

    エンコードクエリでは、昇順および降順による並べ替えの機能もサポートされています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで ORDERBY 句と ORDERBYDESC 句を使用します。

    構文:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    たとえば、次のクエリでは、すべてのアクティブなレコードを取得し、結果を番号の昇順に並べ替え、次にカテゴリ別に降順に並べ替えます。

    sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCカテゴリ

    デフォルトでは、無効なフィールド名など、クエリの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。プロパティ glide.invalid_query.returns_no_rows を true に設定すると、代わりに無効なクエリに対して行を返さないようにします。
    注:
    glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。

    データタイプ：文字列
    キーと値のペア 結果セットのフィルタリングに使用する名前と値のペア。名前は、指定された値がフィルタリングされるフィールドです。このパラメーターは sysparm_queryと相互に排他的です。たとえば、 &sysparm_query=active=true を使用する代わりに、 &active=true を使用して呼び出し元ステートメントを簡略化できます。フィールドが選択タイプまたは参照タイプのフィールドである場合は、&state=7 ではなく &state=closed のように表示値を使用することもできます。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります ( 例:&active=true&assigned_to=john.smith)。

    データタイプ：文字列
    テキスト検索 すべての緊急変更要求レコードフィールドの検索に使用する文字列。この検索では ServiceNow 全文検索プラットフォーム機能を使用し、デフォルトは IR_AND_OR_QUERY です。

    データタイプ：文字列
    表 : 87. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 89. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 90. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ: オブジェクト
    状況 変更要求状況。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「緊急」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「緊急」です。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      },
    }, 
    { // next record found }, ... // and so on
  ]
}

    変更管理 - GET /sn_chg_rest/change/emergency/{sys_id}

    指定されたsys_idによって識別された緊急変更要求を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/emergency/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/emergency/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 取得する緊急変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 92. クエリパラメーター
    名前 説明
    なし
    表 : 93. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 95. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 96. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ: オブジェクト
    状況 変更要求状況。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「緊急」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「緊急」です。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: {
        value: "b0dbda5347c12200e0ef563dbb9a718f", 
        display_value: "b0dbda5347c12200e0ef563dbb9a718f"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      },
    },
  ]
}

    変更管理 - GET /sn_chg_rest/change/model

    指定された基準に基づいて 1 つ以上の変更モデルを取得します。

    このエンドポイントを使用して、作成しようとしている変更要求に最適な変更モデルを検索します。詳細については、「 変更モデル」を参照してください。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/model

    デフォルト URL: /api/sn_chg_rest/change/model

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

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

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

    データタイプ：文字列
    表 : 98. クエリパラメーター
    名前 説明
    名前と値のペア 結果セットのフィルタリングに使用する名前と値のペア。名前は、指定された値がフィルタリングされるフィールドです。このパラメーターは sysparm_queryと相互に排他的です。たとえば、 &sysparm_query=active=true を使用する代わりに、 &active=true を使用して呼び出し元ステートメントを簡略化できます。フィールドが選択タイプまたは参照タイプのフィールドである場合は、&state=7 ではなく &state=closed のように表示値を使用することもできます。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります ( 例:&active=true&assigned_to=john.smith)。

    データタイプ：文字列
    order 返された変更モデルをソートするためのフィールド。

    データタイプ：文字列

    デフォルト: 名前
    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>:次の値をサポートします。
      • =:<col_name>は<値>と完全に一致します。
      • !=:<col_name> が <value> と一致しません。
      • LIKE:<col_name>には指定された文字列 <value> が含まれています。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • STARTSWITH:<col_name>は、指定された文字列 <value> で始まります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ENDSWITH:<col_name>は指定された文字列 <value> で終わります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ^:クエリ条件を追加するための AND 演算子。結果セットに含まれるレコードは両方の条件に一致します。
      • ^OR:クエリ条件を追加するための OR 演算子。結果セットに含まれるレコードは、少なくとも 1 つの条件に一致します。
    • <value>:フィルターを適用する値。
    演算子の詳細については、「Operators available for filters and queries」を参照してください。

    クエリには複数の条件を含めることができます。たとえば、次のクエリは、発信者が現在のユーザーであり、レコードがアクティブなレコードを返します。

    sysparm_query=caller_id=javascript:gs.getUserID()^active=true

    エンコードクエリでは、昇順および降順による並べ替えの機能もサポートされています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで ORDERBY 句と ORDERBYDESC 句を使用します。

    構文:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    たとえば、次のクエリでは、すべてのアクティブなレコードを取得し、結果を番号の昇順に並べ替え、次にカテゴリ別に降順に並べ替えます。

    sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCカテゴリ

    デフォルトでは、無効なフィールド名など、クエリの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。プロパティ glide.invalid_query.returns_no_rows を true に設定すると、代わりに無効なクエリに対して行を返さないようにします。
    注:
    glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。

    データタイプ：文字列
    テキスト検索 すべての変更モデルレコードフィールドの検索に使用する文字列。この検索では ServiceNow フルテキスト検索プラットフォーム機能を使用します。ServiceNow検索機能の詳細については、「検索管理」を参照してください。

    データタイプ：文字列

    デフォルト値: IR_AND_OR_QUERY
    表 : 99. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 101. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 102. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    result 1 つ以上の変更モデルレコードオブジェクトを含むリスト。各オブジェクトは変更モデルを記述します。変更モデルオブジェクトの各要素は、変更モデル [chg_model] テーブルの関連レコードのフィールドに対応します。

    すべての要素には 、値 と display_value の名前と値のペアが含まれます。名前と値 display_value_internal ペアを含むものもあります。

    データタイプ：アレイ
    result.active 関連付けられた変更モデルレコードがアクティブでインスタンス内で利用可能かどうかを示すフラグ。
    有効な値：
    • true:変更モデルはアクティブです。
    • false:変更モデルはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    result.available_in_ui 関連付けられた変更モデルレコードがユーザーインターフェイス内で利用可能かどうかを示すフラグ。
    有効な値：
    • true:変更モデルはユーザーインターフェイスで使用できます。
    • false:ユーザーインターフェイスで変更モデルを使用できません。

    データタイプ：ブーリアン

    デフォルト：true
    result.color 変更要求ランディングページで関連付けられた変更モデルの色。

    データタイプ：文字列

    デフォルト値:#cbcbcb
    result.default_change_model 関連付けられた変更モデルレコードがデフォルトの変更モデルであるかどうかを示すフラグ。
    有効な値：
    • true:デフォルト
    • false:デフォルトではありません

    データタイプ：ブーリアン

    デフォルト値：false
    result.description 変更モデルの目的の簡単な説明。

    データタイプ：文字列

    最大長:4,000
    result.name 変更モデルの名前。

    データタイプ：文字列

    最大長:200
    result.record_preset 新しい変更要求レコードが作成されたときに、関連する値とともに自動的に入力されるフィールドの名前と値のペア。値はキャレット記号で区切られます。

    例：

    "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=オートメーション : change^EQ"

    データタイプ：文字列
    result.state_field table_name での指定に基づいて選択肢を収集する選択リストフィールド。変更モデルの場合、これは常に「ステータス」に設定されます。

    データタイプ：文字列
    result.sys_class_name モジュールテーブル名を変更します。常にモデル/chg_modelを変更します。

    データタイプ：文字列
    result.sys_created_by 関連する変更モジュールレコードを最初に作成したユーザーの名前。

    データタイプ：文字列
    result.sys_created_on 変更モジュールレコードが最初に作成された日時。

    データタイプ：文字列
    result.sys_domain インスタンスでドメインを使用する場合は、変更モジュールレコードが関連付けられているドメインの名前。

    データタイプ：文字列
    result.sys_domain_path インスタンスでドメインを使用する場合は、関連する変更モジュールレコードが存在するドメインパス。

    データタイプ：文字列
    result.sys_id 関連付けられた変更モデルレコードの一意の識別子。

    データタイプ：文字列
    result.sys_mod_count 関連付けられた変更モデルレコードが変更された回数。

    データタイプ：数値
    result.sys_name 変更モデルの名前。常に name パラメーターと同じです。

    データタイプ：文字列
    result.sys_tags 変更モデルレコードに関連付けられたシステムタグ。

    データタイプ：文字列
    result.sys_updated_by 関連する変更モデルレコードを最後に更新したユーザーの名前。

    データタイプ：文字列

    最大長：40
    result.sys_updated_on 関連する変更モデルレコードが最後に更新された日時。

    データタイプ：文字列
    result.table_name 選択肢を収集する [選択リスト] フィールドを定義するテーブル。変更モデルの場合、これは常に「change_request」に設定されます。

    データタイプ：文字列

    最大長：80

    cURL 要求

    この例は、すべての変更モデルレコードを取得する要求を示しています。

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    簡潔にするために、この応答には単一の変更モデルオブジェクトのみが表示されます。

    {
  "result": [
    {
      "record_preset": {
        "display_value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ",
        "value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ"
      },
      "color": {
        "display_value": "#488df4",
        "value": "#488df4"
      },
      "default_change_model": {
        "display_value": "false",
        "value": false
      },
      "sys_mod_count": {
        "display_value": "6",
        "value": 6.0
      },
      "description": {
        "display_value": "This model is intended to capture  a record of an automated change.  There are no approvals associated with this change model.\r\n",
        "value": "This model is intended to capture  a record of an automated change.  There are no approvals associated with this change model.\r\n"
      },
      "active": {
        "display_value": "true",
        "value": true
      },
      "sys_updated_on": {
        "display_value": "2020-10-02 06:24:24",
        "value": "2020-10-02 13:24:24",
        "display_value_internal": "2020-10-02 06:24:24"
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
        "table_name": {
        "display_value": "change_request",
        "value": "change_request"
      },
      "sys_class_name": {
        "display_value": "Change Model",
        "value": "chg_model"
      },
      "sys_id": {
        "display_value": "7840d2515323101034d1ddeeff7b12a6",
        "value": "7840d2515323101034d1ddeeff7b12a6"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "available_in_ui": {
        "display_value": "false",
        "value": false
      },
      "state_field": {
        "display_value": "state",
        "value": "state"
      },
      "sys_created_on": {
        "display_value": "2020-09-28 07:33:25",
        "value": "2020-09-28 14:33:25",
        "display_value_internal": "2020-09-28 07:33:25"
      },
      "name": {
        "display_value": "Change Registration",
        "value": "Change Registration"
      },
      "sys_name": {
        "display_value": "Change Registration",
        "value": "Change Registration"
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      }
    }
  ]
}

    変更管理 - GET /sn_chg_rest/change/model/{sys_id}

    指定されたsys_idで識別される変更モデルを取得します。

    その後、この変更モデルを使用して、目的の変更要求を作成できます。変更モデルの詳細については、「 変更モデル」を参照してください。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/model/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/model/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 変更モデル [chg_model] テーブルから取得する変更モデルレコードのSys_id。

    データタイプ：文字列
    表 : 104. クエリパラメーター
    名前 説明
    なし
    表 : 105. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 107. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 108. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    result 要求された変更モデルレコードオブジェクト。このオブジェクトの各要素は、変更モデル [chg_model] テーブルのレコード内のフィールドに対応しています。

    すべての要素には、 value と display_value の名前と値のペアが含まれます。名前と値 display_value_internal ペアを含むものもあります。

    データタイプ: オブジェクト
    result.active 関連付けられた変更モデルレコードがアクティブでインスタンス内で利用可能かどうかを示すフラグ。
    有効な値：
    • true:変更モデルはアクティブです。
    • false:変更モデルはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    result.available_in_ui 関連付けられた変更モデルレコードがユーザーインターフェイス内で利用可能かどうかを示すフラグ。
    有効な値：
    • true:変更モデルはユーザーインターフェイスで使用できます。
    • false:ユーザーインターフェイスで変更モデルを使用できません。

    データタイプ：ブーリアン

    デフォルト：true
    result.color 変更要求ランディングページで関連付けられた変更モデルの色。

    データタイプ：文字列

    デフォルト値:#cbcbcb
    result.default_change_model 関連付けられた変更モデルレコードがデフォルトの変更モデルであるかどうかを示すフラグ。
    有効な値：
    • true:デフォルト
    • false:デフォルトではありません

    データタイプ：ブーリアン

    デフォルト値：false
    result.description 変更モデルの目的の簡単な説明。

    データタイプ：文字列

    最大長:4,000
    result.name 変更モデルの名前。

    データタイプ：文字列

    最大長:200
    result.record_preset 新しい変更要求レコードが作成されたときに、関連する値とともに自動的に入力されるフィールドの名前と値のペア。値はキャレット記号で区切られます。

    例：

    "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=オートメーション : change^EQ"

    データタイプ：文字列
    result.state_field table_name での指定に基づいて選択肢を収集する選択リストフィールド。変更モデルの場合、これは常に「ステータス」に設定されます。

    データタイプ：文字列
    result.sys_class_name モジュールテーブル名を変更します。常にモデル/chg_modelを変更します。

    データタイプ：文字列
    result.sys_created_by 関連する変更モジュールレコードを最初に作成したユーザーの名前。

    データタイプ：文字列
    result.sys_created_on 変更モジュールレコードが最初に作成された日時。

    データタイプ：文字列
    result.sys_domain インスタンスでドメインを使用する場合は、変更モジュールレコードが関連付けられているドメインの名前。

    データタイプ：文字列
    result.sys_domain_path インスタンスでドメインを使用する場合は、関連する変更モジュールレコードが存在するドメインパス。

    データタイプ：文字列
    result.sys_id 関連付けられた変更モデルレコードの一意の識別子。

    データタイプ：文字列
    result.sys_mod_count 関連付けられた変更モデルレコードが変更された回数。

    データタイプ：数値
    result.sys_name 変更モデルの名前。常に name パラメーターと同じです。

    データタイプ：文字列
    result.sys_tags 変更モデルレコードに関連付けられたシステムタグ。

    データタイプ：文字列
    result.sys_updated_by 関連する変更モデルレコードを最後に更新したユーザーの名前。

    データタイプ：文字列

    最大長：40
    result.sys_updated_on 関連する変更モデルレコードが最後に更新された日時。

    データタイプ：文字列
    result.table_name 選択肢を収集する [選択リスト] フィールドを定義するテーブル。変更モデルの場合、これは常に「change_request」に設定されます。

    データタイプ：文字列

    最大長：80

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model/c0efda5347c12200e0ef563dbb9a81e3" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    {
  "result": {
    "record_preset": {
      "display_value": "type=emergency^EQ",
      "value": "type=emergency^EQ"
    },
    "color": {
      "display_value": "#ea3423",
      "value": "#ea3423"
    },
    "default_change_model": {
      "display_value": "false",
      "value": false
    },
    "sys_mod_count": {
      "display_value": "2",
      "value": 2.0
    },
    "description": {
      "display_value": "ITIL Mode 1 Emergency Change",
      "value": "ITIL Mode 1 Emergency Change"
    },
    "active": {
      "display_value": "true",
      "value": true
    },
    "sys_updated_on": {
      "display_value": "2020-09-28 08:53:12",
      "value": "2020-09-28 15:53:12",
      "display_value_internal": "2020-09-28 08:53:12"
    },
    "sys_tags": {
      "display_value": "",
      "value": ""
    },
    "table_name": {
      "display_value": "change_request",
      "value": "change_request"
    },
    "sys_class_name": {
      "display_value": "Change Model",
      "value": "chg_model"
    },
    "sys_id": {
      "display_value": "c0efda5347c12200e0ef563dbb9a81e3",
      "value": "c0efda5347c12200e0ef563dbb9a81e3"
    },
    "sys_updated_by": {
      "display_value": "admin",
      "value": "admin"
    },
    "available_in_ui": {
      "display_value": "true",
      "value": true
    },
    "state_field": {
      "display_value": "state",
      "value": "state"
    },
    "sys_created_on": {
      "display_value": "2020-09-04 09:16:03",
      "value": "2020-09-04 16:16:03",
      "display_value_internal": "2020-09-04 09:16:03"
    },
    "name": {
      "display_value": "Emergency",
      "value": "Emergency"
    },
    "sys_name": {
      "display_value": "Emergency",
      "value": "Emergency"
    },
    "sys_created_by": {
      "display_value": "admin",
      "value": "admin"
    }
  }
}

    変更管理 - GET /sn_chg_rest/change/normal

    指定された基準に基づいて 1 つ以上の通常の変更要求を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/normal

    デフォルト URL: /api/sn_chg_rest/change/normal

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

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

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

    データタイプ：文字列
    表 : 110. クエリパラメーター
    名前 説明
    名前と値のペア 結果セットのフィルタリングに使用する名前と値のペア。名前は、指定された値がフィルタリングされるフィールドです。このパラメーターは sysparm_queryと相互に排他的です。たとえば、 &sysparm_query=active=true を使用する代わりに、 &active=true を使用して呼び出し元ステートメントを簡略化できます。フィールドが選択タイプまたは参照タイプのフィールドである場合は、&state=7 ではなく &state=closed のように表示値を使用することもできます。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります ( 例:&active=true&assigned_to=john.smith)。

    データタイプ：文字列
    order 返された変更要求をソートするためのフィールド。

    データタイプ：文字列
    sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：数値

    デフォルト：500
    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>:次の値をサポートします。
      • =:<col_name>は<値>と完全に一致します。
      • !=:<col_name> が <value> と一致しません。
      • LIKE:<col_name>には指定された文字列 <value> が含まれています。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • STARTSWITH:<col_name>は、指定された文字列 <value> で始まります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ENDSWITH:<col_name>は指定された文字列 <value> で終わります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ^:クエリ条件を追加するための AND 演算子。結果セットに含まれるレコードは両方の条件に一致します。
      • ^OR:クエリ条件を追加するための OR 演算子。結果セットに含まれるレコードは、少なくとも 1 つの条件に一致します。
    • <value>:フィルターを適用する値。
    演算子の詳細については、「Operators available for filters and queries」を参照してください。

    クエリには複数の条件を含めることができます。たとえば、次のクエリは、発信者が現在のユーザーであり、レコードがアクティブなレコードを返します。

    sysparm_query=caller_id=javascript:gs.getUserID()^active=true

    エンコードクエリでは、昇順および降順による並べ替えの機能もサポートされています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで ORDERBY 句と ORDERBYDESC 句を使用します。

    構文:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    たとえば、次のクエリでは、すべてのアクティブなレコードを取得し、結果を番号の昇順に並べ替え、次にカテゴリ別に降順に並べ替えます。

    sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCカテゴリ

    デフォルトでは、無効なフィールド名など、クエリの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。プロパティ glide.invalid_query.returns_no_rows を true に設定すると、代わりに無効なクエリに対して行を返さないようにします。
    注:
    glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。

    データタイプ：文字列
    テキスト検索 すべての通常の変更要求レコードフィールドを検索するために使用する文字列。この検索では、ServiceNow 全文検索プラットフォーム機能が使用され、デフォルトは IR_AND_OR_QUERY です。

    データタイプ：文字列
    表 : 111. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 113. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 114. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ: オブジェクト
    状況 削除前の変更要求のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「標準」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「標準」です。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    },
    { // next record found }, ... // and so on
  ]
}

    変更管理 - GET /sn_chg_rest/change/normal/{sys_id}

    指定されたsys_idによって識別される通常の変更要求を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/normal/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/normal/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 取得する通常の変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 116. クエリパラメーター
    名前 説明
    なし
    表 : 117. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 119. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 120. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ: オブジェクト
    状況 削除前の変更要求のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「標準」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「標準」です。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    },
  ]
}

    変更管理 - GET /sn_chg_rest/change/standard

    指定された基準に基づいて 1 つ以上の標準的な変更要求を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/standard

    デフォルト URL: /api/sn_chg_rest/change/standard

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

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

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

    データタイプ：文字列
    表 : 122. クエリパラメーター
    名前 説明
    名前と値のペア 結果セットのフィルタリングに使用する名前と値のペア。名前は、指定された値がフィルタリングされるフィールドです。このパラメーターは sysparm_queryと相互に排他的です。たとえば、 &sysparm_query=active=true を使用する代わりに、 &active=true を使用して呼び出し元ステートメントを簡略化できます。フィールドが選択タイプまたは参照タイプのフィールドである場合は、&state=7 ではなく &state=closed のように表示値を使用することもできます。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります ( 例:&active=true&assigned_to=john.smith)。

    データタイプ：文字列
    order 返された変更要求をソートするためのフィールド。

    データタイプ：文字列
    sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：文字列

    デフォルト：500
    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>:次の値をサポートします。
      • =:<col_name>は<値>と完全に一致します。
      • !=:<col_name> が <value> と一致しません。
      • LIKE:<col_name>には指定された文字列 <value> が含まれています。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • STARTSWITH:<col_name>は、指定された文字列 <value> で始まります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ENDSWITH:<col_name>は指定された文字列 <value> で終わります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ^:クエリ条件を追加するための AND 演算子。結果セットに含まれるレコードは両方の条件に一致します。
      • ^OR:クエリ条件を追加するための OR 演算子。結果セットに含まれるレコードは、少なくとも 1 つの条件に一致します。
    • <value>:フィルターを適用する値。
    演算子の詳細については、「Operators available for filters and queries」を参照してください。

    クエリには複数の条件を含めることができます。たとえば、次のクエリは、発信者が現在のユーザーであり、レコードがアクティブなレコードを返します。

    sysparm_query=caller_id=javascript:gs.getUserID()^active=true

    エンコードクエリでは、昇順および降順による並べ替えの機能もサポートされています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで ORDERBY 句と ORDERBYDESC 句を使用します。

    構文:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    たとえば、次のクエリでは、すべてのアクティブなレコードを取得し、結果を番号の昇順に並べ替え、次にカテゴリ別に降順に並べ替えます。

    sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCカテゴリ

    デフォルトでは、無効なフィールド名など、クエリの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。プロパティ glide.invalid_query.returns_no_rows を true に設定すると、代わりに無効なクエリに対して行を返さないようにします。
    注:
    glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。

    データタイプ：文字列
    テキスト検索 すべての標準的な変更要求レコードフィールドの検索に使用する文字列。この検索では ServiceNow 全文検索プラットフォーム機能を使用し、デフォルトは IR_AND_OR_QUERY です。

    データタイプ：文字列
    表 : 123. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 125. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 126. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア すべてのフィールド (キー) と、識別された変更要求に関連付けられた値。

    データタイプ: オブジェクト
    状況 削除前の変更要求のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「標準」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「標準」です。

    データタイプ：文字列

    cURL 要求のサンプル

    curl "https://instance.service-now.com/api/sn_chg_rest/v1/change/standard?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "standard",
        display_value: "Standard"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    }, 
    { // next record found }, ... // and so on
  ]
}

    変更管理 - GET /sn_chg_rest/change/standard/{sys_id}

    指定されたsys_idによって識別される標準的な変更要求を取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/standard/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/standard/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 取得する標準的な変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 128. クエリパラメーター
    名前 説明
    なし
    表 : 129. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 131. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 132. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア すべてのフィールド (キー) と、識別された変更要求に関連付けられた値。

    データタイプ: オブジェクト
    状況 削除前の変更要求のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    }, 
  ]
}

    変更管理 - GET /sn_chg_rest/change/standard/template

    指定された基準に基づいて 1 つ以上の標準的な変更テンプレートを取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/standard/template

    デフォルト URL: /api/sn_chg_rest/change/standard/template

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

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

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

    データタイプ：文字列
    表 : 134. クエリパラメーター
    名前 説明
    名前と値のペア 結果セットのフィルタリングに使用する名前と値のペア。名前は、指定された値がフィルタリングされるフィールドです。このパラメーターは sysparm_queryと相互に排他的です。たとえば、 &sysparm_query=active=true を使用する代わりに、 &active=true を使用して呼び出し元ステートメントを簡略化できます。フィールドが選択タイプまたは参照タイプのフィールドである場合は、&state=7 ではなく &state=closed のように表示値を使用することもできます。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります ( 例:&active=true&assigned_to=john.smith)。

    データタイプ：文字列
    order 返された標準的な変更テンプレートをソートするためのフィールド。

    データタイプ：文字列

    デフォルト:数値
    sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：数値

    デフォルト：500
    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>:次の値をサポートします。
      • =:<col_name>は<値>と完全に一致します。
      • !=:<col_name> が <value> と一致しません。
      • LIKE:<col_name>には指定された文字列 <value> が含まれています。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • STARTSWITH:<col_name>は、指定された文字列 <value> で始まります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ENDSWITH:<col_name>は指定された文字列 <value> で終わります。データタイプが文字列である<col_name>フィールドでのみ機能します。
      • ^:クエリ条件を追加するための AND 演算子。結果セットに含まれるレコードは両方の条件に一致します。
      • ^OR:クエリ条件を追加するための OR 演算子。結果セットに含まれるレコードは、少なくとも 1 つの条件に一致します。
    • <value>:フィルターを適用する値。
    演算子の詳細については、「Operators available for filters and queries」を参照してください。

    クエリには複数の条件を含めることができます。たとえば、次のクエリは、発信者が現在のユーザーであり、レコードがアクティブなレコードを返します。

    sysparm_query=caller_id=javascript:gs.getUserID()^active=true

    エンコードクエリでは、昇順および降順による並べ替えの機能もサポートされています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで ORDERBY 句と ORDERBYDESC 句を使用します。

    構文:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    たとえば、次のクエリでは、すべてのアクティブなレコードを取得し、結果を番号の昇順に並べ替え、次にカテゴリ別に降順に並べ替えます。

    sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCカテゴリ

    デフォルトでは、無効なフィールド名など、クエリの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。プロパティ glide.invalid_query.returns_no_rows を true に設定すると、代わりに無効なクエリに対して行を返さないようにします。
    注:
    glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。

    データタイプ：文字列
    テキスト検索 すべての標準的な変更要求レコードフィールドの検索に使用する文字列。この検索では、ServiceNow 全文検索プラットフォーム機能が使用され、デフォルトは IR_AND_OR_QUERY です。

    データタイプ：文字列
    表 : 135. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 137. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 138. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア すべてのフィールドと、識別された標準的な変更テンプレートに関連付けられた値。

    データタイプ: オブジェクト
    sys_id 変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列
    template 標準的な変更テンプレートに関する情報。

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

    template: {
  display_value: "String", 
  value: "String"
}
    template.display_value UI に表示するテンプレート情報。

    データタイプ：文字列
    template.value テンプレートsys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: {
        value: "92b8544047810200e90d87e8dee490b0",
        display_value: "92b8544047810200e90d87e8dee490b0"
      },
      template : {
        value: "1c8e02ec47410200e90d87e8dee49057", 
        display_value: "Add network switch to datacenter cabinet"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Standard change template to add network switch to cabinet",
        display_value: "Standard change template to add network switch to cabinet"
      },
    }, 
    { // next record found }, ... // and so on
  ]
}

    変更管理 - GET /sn_chg_rest/change/standard/template/{sys_id}

    指定されたsys_idで識別される標準的な変更テンプレートを取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/standard/template/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/standard/template/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 取得する標準的な変更テンプレートのSys_id。

    データタイプ：文字列

    テーブル:標準的な変更テンプレート [std_change_record_producer]
    表 : 140. クエリパラメーター
    名前 説明
    なし
    表 : 141. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 143. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 144. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア すべてのフィールドと、識別された標準的な変更テンプレートに関連付けられた値。

    データタイプ: オブジェクト
    sys_id 変更要求のSys_id。

    データタイプ：文字列
    template 標準的な変更テンプレートに関する情報。

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

    template: {
  display_value: "String", 
  value: "String"
}
    template.display_value UI に表示するテンプレート情報。

    データタイプ：文字列
    template.value テンプレートsys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template/92b8544047810200e90d87e8dee490b0" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  result: [
    {
      sys_id: "92b8544047810200e90d87e8dee490b0",
      template : {
        value: "1c8e02ec47410200e90d87e8dee49057", 
        display_value: "Add network switch to datacenter cabinet"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Standard change template to add network switch to cabinet",
        display_value: "Standard change template to add network switch to cabinet"
      },
    }, 
  ]
}

    変更管理 - GET /sn_chg_rest/change/worker/{sys_id}

    指定された非同期ワーカーの現在のステータス、情報、およびエラーを取得します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/worker/{sys_id}

    デフォルト URL: /api/sn_chg_rest/{change/worker/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 変更管理非同期ワーカーのSys_id。

    データタイプ：文字列

    テーブル:変更管理ワーカー [chg_mgt_worker]
    表 : 146. クエリパラメーター
    名前 説明
    なし
    表 : 147. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 149. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 150. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    メッセージ メッセージ情報。
    データタイプ: オブジェクト
    "messages": {
  "errorMessages": [Array],
  "infoMessages": [Array],
  "warningMessages": [Array]
}
    messages.errorMessages 要求の処理中にエラーメッセージが発生しました。例： 
    無効なCMDB_CI sys_idが指定されました

    データタイプ：アレイ
    messages.infoMessages 要求の処理中に検出された情報メッセージ。例： 
    CMDB_CI sys_id既に関連付けられています。

    データタイプ：アレイ
    messages.warningMessages 要求の処理中に検出された警告メッセージ。例： 
    無効なCMDB_CI sys_idが指定されました。

    データタイプ：アレイ
    payload ワーカー使用時にスケジューリングエンドポイントの成功した応答本文からsys_idされる一意のペイロード。
    "payload": {
  "spans": [Array]
}

    データタイプ: オブジェクト
    payload.spans スケジュールエンドポイントで指定された期間内にタイムスパンが利用可能な場合、ワーカー API は利用可能なタイムスパンをリストします。
    "payload": {
  "spans": [
   {
    "end": {Object}, 
    "start": {Object}
   }
  ]
}

    データタイプ：アレイ
    payload.spans.start 
    "start": {
  "display_value": "String",
  "value": "String"
}

    データタイプ: オブジェクト
    payload.spans.start.value 変更要求の実装開始が予定されている日時。

    データタイプ：文字列
    payload.spans.start.display_value 変更要求開始時間の値を表示します。

    時間形式:yyyy-mm-dd hh:mm:ss

    データタイプ：文字列
    payload.spans.end 
    "end": {
  "display_value": "String",
  "value": "String"
}

    データタイプ: オブジェクト
    payload.spans.end.value 変更要求の完了が予定されている日時。

    時間形式:yyyy-mm-dd hh:mm:ss

    データタイプ：文字列
    payload.spans.end.display_value 変更要求完了時間の値を表示します。

    データタイプ：文字列
    要求 元のエンドポイント要求。

    データタイプ：文字列
    状況 ワーカーの現在のステータスに関する情報。

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

    state: {
  display_value: "String", 
  value: Number
}
    state.display_value ワーカーの状態の表示値。これらの値は、 state.value パラメーターに直接関連しています。

    可能な値：

    • 完了
    • エラー
    • 対応中
    • 待機中

    データタイプ：文字列
    state.value ワーカーのステータスの数値。

    可能な値：

    • 1
    • 2
    • 3
    • 4

    データタイプ：数値
    type CMDB CI と変更要求の間の関連付けのタイプ。

    データタイプ：文字列
    ワーカー 関連付けられたワーカーに関する情報。

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

    "worker": {
  "link": "String",
  "sysId": "String"
}
    worker.link 関連付けられたワーカーのステータスとその他のワーカー関連情報を取得するための URL。

    データタイプ：文字列
    worker.sysId 変更要求に関連付けられたワーカーのSys_id。

    データタイプ：文字列
    <other_params> ignored_cmdb_ci_sys_idsなどのプロセス固有のその他のパラメーター。

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/worker/0644cd02dbec330084f07ffdbf9619c1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "worker": {
      "sysId": "0644cd02dbec330084f07ffdbf9619c1",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/0644cd02dbec330084f07ffdbf9619c1"
    },
    "request": "{\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "impacted",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

    変更管理 - PATCH /sn_chg_rest/change/{sys_id}

    指定されたsys_idによって識別される変更要求を、要求本文または URL のキーと値のペアで更新します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 変更する変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 152. クエリパラメーター
    名前 説明
    名前と値のペア 更新するフィールドを表す名前と値のペア。要求本文パラメーターは URL パラメーターを上書きします。ただし、必須パラメーターを URL に指定する必要があります。

    データタイプ：文字列
    encrypted_fields 暗号化するカンマ区切りフィールドのリスト。これらのフィールドは、関連付けられたレコードに格納される前に暗号化されます。指定すると、エンドポイントは setValue() メソッドを呼び出す代わりに GlideRecord setDisplayValue() メソッドを呼び出します。

    このため、このパラメーターを使用して、sys_idsや値を渡す代わりに、参照フィールドや選択フィールドなどの暗号化されていないフィールドの表示値を渡すこともできます。

    データタイプ：文字列
    表 : 153. 要求本文パラメーター (XML または JSON)
    名前 説明
    データ 関連する変更要求で更新するフィールドを表す名前と値のペア。たとえば、簡単な説明ファイルを更新するには、 --data "{\"short_description\": \"my short desc\" }" \のような名前と値のペアを入力します。

    データタイプ：文字列
    encrypted_fields 暗号化するカンマ区切りフィールドのリスト。これらのフィールドは、関連付けられたレコードに格納される前に暗号化されます。指定すると、エンドポイントは setValue() メソッドを呼び出す代わりに GlideRecord setDisplayValue() メソッドを呼び出します。

    このため、このパラメーターを使用して、sys_idsや値を渡す代わりに、参照フィールドや選択フィールドなどの暗号化されていないフィールドの表示値を渡すこともできます。

    データタイプ：文字列

    ヘッダー

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

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

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

    デフォルト： application/json
    表 : 155. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 156. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    result 更新された変更要求レコード。このオブジェクトの各要素は、変更要求 [change_request] テーブルのレコード内のフィールドに対応しています。

    すべての要素には、 value と display_value の名前と値のペアが含まれます。名前と値 display_value_internal ペアを含むものもあります。

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

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"short_desription\": \"Reboot the server at 6 am\" }" \
--user "username":"password"
    {
  "result":
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Reboot the server at 6 am",
        "value": "Reboot the server at 6 am"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "b0dbda5347c12200e0ef563dbb9a718f",
        "value": "b0dbda5347c12200e0ef563dbb9a718f"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
}

    cURL 要求

    次の例は、要求本文で暗号化フィールドを渡す方法を示しています。

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"encrypted_fields\":\"short_description,description\",
    \"short_description\":\"my short desc\",
    \"description\":\"my desc\"
}" \
--user "username":"password"

    cURL 要求

    次の例は、暗号化されたフィールドをクエリパラメーターとして渡す方法を示しています。

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"

    変更管理 - PATCH /sn_chg_rest/change/{sys_id}/approvals

    現在のユーザーが、指定された変更要求に対する変更要求承認レコードを承認または却下できるようにします。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/approvals

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}/approvals

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

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

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

    データタイプ：文字列
    sys_id 承認/却下が適用される変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 158. クエリパラメーター
    名前 説明
    なし
    表 : 159. 要求本文パラメーター (XML または JSON)
    名前 説明
    コメント stateが却下された場合は必須です。変更が却下された理由。

    データタイプ：文字列
    state 必須です。承認ステータス。

    例: --data "{\"state\": \"approved\"}"

    有効な値：
    • 承認済み
    • 却下

    データタイプ：文字列

    ヘッダー

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

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

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

    デフォルト： application/json
    表 : 161. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 162. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    400 要求が正しくありません。ユーザーが変更要求を承認または却下する権限を持たないなど、不適切な要求タイプを示します。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ: オブジェクト
    状況 変更要求の現在のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 承認/却下されている変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。
    可能な値：
    • 緊急
    • 通常
    • 標準

    データタイプ：文字列
    type.value 内部タイプ値。
    可能な値：
    • 緊急
    • 標準
    • standard

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/approvals" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"approved\"}" \
--user "username":"password"

    {
  result: [
    {
      sys_id: "0f4ac6c4b750230096c3e4f6ee11a9fe",
      state: {
        value: "-2", 
        display_value: "Scheduled"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, single parameter example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      }
    }
  ]
}

    変更管理 - PATCH /sn_chg_rest/change/{change_sys_id}/schedule/first_available

    最初に見つかった利用可能なタイムスロットを使用して、変更要求の計画開始時刻と終了時刻を更新します。

    必要なロール:sn_change_writer

    注:
    応答本文 worker.link プロパティにあるリンクを使用して、スケジュールステータスを表示します。
    関連項目：

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/schedule/first_available

    デフォルト URL: /api/sn_chg_rest/change/{change_sys_id}/schedule/first_available

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

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

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

    データタイプ：文字列
    change_sys_id 次の利用可能なタイムスロットで更新する変更要求のSys_id。選択した変更要求には構成アイテム (cmdb_ci) が必要です。

    データタイプ：文字列

    テーブル:変更要求 [change_request]
    表 : 164. クエリパラメーター
    名前 説明
    なし
    表 : 165. 要求本文パラメーター (XML または JSON)
    名前 説明
    duration_in_seconds 変更の期間 (秒)、つまり変更要求タスクの完了に必要な時間。

    データタイプ：整数
    planned_start_time オプション。変更要求の実装開始が予定されている日時 (UTC)。

    この時間以降に開始可能なタイムスロットを取得します。指定しない場合、システムは現在の時刻を開始時間として使用します。

    形式:yyyy-mm-dd hh:mm:ss

    データタイプ：文字列

    ヘッダー

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

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

    デフォルト： application/json
    表 : 167. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 168. ステータスコード
    ステータスコード 説明
    202 システムが要求を承認しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    考えられる問題:
    • duration_in_seconds本文パラメーター値が無効であるか、指定されていません。
    • 指定されたplanned_start_time本文パラメーター値が無効です。
    • 指定された変更要求には、関連する構成アイテム (cmdb_ci) がありません。
    • ユーザーには、変更要求のフィールドへの読み取りアクセス権がありません。
    403 禁止されました。ユーザーには、変更要求の開始予定日と終了予定日の値への書き込みアクセス権がありません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    考えられる問題:
    • 指定された情報に基づいて変更要求を見つけることができません。
    • ユーザーにはレコードへの読み取りアクセス権がありません。

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

    名前 説明
    エラー エンドポイント要求の処理中に発生したエラーに関する情報。

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

    "error": {
  "detail": "String",
  "message": "String",
  "status": "String"
}
    error.detail エラーに関する追加情報。

    データタイプ：文字列
    error.message エラーを特定するメッセージ。

    データタイプ：文字列
    メッセージ メッセージ情報。
    データタイプ: オブジェクト
    "messages": {
  "errorMessages": [Array],
  "infoMessages": [Array],
  "warningMessages": [Array]
}
    messages.errorMessages 要求の処理中にエラーメッセージが発生しました。

    データタイプ：アレイ
    messages.infoMessages 要求の処理中に検出された情報メッセージ。

    データタイプ：アレイ
    messages.warningMessages 要求の処理中に検出された警告メッセージ。

    データタイプ：アレイ
    要求 元のエンドポイント要求。

    データタイプ：文字列
    状況 ワーカーの現在のステータスに関する情報。

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

    state: {
  display_value: "String", 
  value: Number
}
    state.display_value ワーカーの状態の表示値。これらの値は、 state.value パラメーターに直接関連しています。

    可能な値：

    • 完了
    • エラー
    • 対応中
    • 待機中

    データタイプ：文字列
    state.value ワーカーのステータスの数値。

    可能な値：

    • 1
    • 2
    • 3
    • 4

    データタイプ：数値
    type 要求のタイプ。

    有効な値:スケジュール

    データタイプ：文字列
    ワーカー 関連付けられたワーカーに関する情報。

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

    "worker": {
  "link": "String",
  "sysId": "String"
}
    worker.link 変更要求スケジュールステータスを取得するためのリンク。GET /sn_chg_rest/change/worker/{sys_id} のsys_idを使用して結果を表示します。

    データタイプ：文字列
    worker.sysId 変更要求に関連付けられたワーカーのSys_id。

    データタイプ：文字列
    status エラーが発生した場合にのみ表示されます。エンドポイント処理のステータス。

    可能な値:失敗

    データタイプ：文字列

    変更要求スケジュールステータスを取得

    worker.linkで指定された値を使用して、変更レコードが利用可能な最初のタイムスロットに正常にスケジュールされているかどうかを判断します。値は次の形式です。

    https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>

    worker.link の詳細を使用して、指定されたsys_id を GET /sn_chg_rest/change/worker/{sys_id} で実行し、結果を表示します。

    応答本文にはステータスが含まれ、処理が完了すると結果が提供されます。

    利用可能なタイムスロットが見つかると、システムは最初の利用可能なスロットで変更要求を更新します。ステータスが [完了] になると、 messages.infoMessages は、最初に利用可能なタイムスロットが設定されたことを示します。

    応答本文には、 messages.infoMessages に対する次のいずれかのスケジュール応答値が指定されています。
    • 変更が更新されました: タイムスロットに対して要求された変更が更新されました。
    • 今から <number> 日後のスロットが見つかり ません – スケジュール期間で定義された日数内に指定された変更要求期間に利用可能なタイムスロットはありません。
      注:
      変更要求スケジュールのタイムスロットのデフォルト値は 90 日です。この値を変更するには、 change.conflict.next_available.schedule_window プロパティを変更します。詳細については、「 競合分析プロパティの構成」を参照してください。

    次の GET /sn_chg_rest/change/worker/{sys_id} の例は、worker.link の詳細で指定された ID を使用して提供される出力を示しています。結果は、処理が完了し、変更要求が最初に利用可能なタイムスロットに更新されたことを示しています。

    {
  "result": {
    "worker": {
      "sysId": "355c62e0a4c87010f87712198fe9cacf",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": [
        "Change has been updated"
      ]
    }
  }
}

    cURL 要求

    curl "https://instance.service-now.com/api/sn_chg_rest/change/87ae5e900a0a2c3e263e8304e727c646/schedule/first_available" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"duration_in_seconds\":\"10800\"}" \
--user "username":"password"

    結果には、GET /sn_chg_rest/change/worker/ エンドポイントで指定されたsys_idを実行するために使用できる worker.link の詳細が含まれます。

    {
  "result": {
    "worker": {
      "sysId": "355c62e0a4c87010f87712198fe9cacf",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

    変更管理 - PATCH /sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}

    指定されたsys_idsによって識別される変更要求タスクを、要求本文または URL のキーと値のペアで更新します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task/{task_sys_id}

    デフォルト URL: /api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}

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

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

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

    データタイプ：文字列
    change_sys_id タスクが関連付けられている変更要求のSys_id。指定されたタスクが、指定された変更要求に関連付けられているかどうかを検証します。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    task_sys_id 変更するタスクのSys_id。

    データタイプ：文字列

    テーブル:変更タスク [change_task]
    表 : 170. クエリパラメーター
    名前 説明
    キーと値のペア 更新するフィールドを表す名前と値のペア。要求本文パラメーターは URL パラメーターを上書きします。ただし、必須パラメーターを URL に指定する必要があります。

    データタイプ：文字列
    表 : 171. 要求本文パラメーター (XML または JSON)
    名前 説明
    データ 関連する変更要求で更新するフィールドを表す名前と値のペア。たとえば、簡単な説明ファイルを更新するには、 --data "{\"short_description\": \"my short desc\" }" \のような名前と値のペアを入力します。

    データタイプ：文字列

    ヘッダー

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

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

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

    デフォルト： application/json
    表 : 173. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 174. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア すべてのフィールド (キー) と、削除前に特定された変更要求タスクに関連付けられた値。

    データタイプ: オブジェクト
    sys_id 変更要求タスクのSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求タスクのSys_id。

    データタイプ：文字列
    sys_id.value 変更要求タスクのSys_id。

    データタイプ：文字列
    親 このタスクに関連付けられた変更要求の一意の識別子情報。

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

    parent: {
  display_value: "String", 
  value: "String"
}
    parent.display_value UI に表示するタスク情報。

    データタイプ：文字列
    parent.value 親タスクのSys_id。

    データタイプ：文字列
    __meta.ignoredFields コールで渡されたものの、基本レコードに存在しないかフィールドが読み取り専用であるために変更要求に適用されなかったキーと値のペア。

    データタイプ：アレイ

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5?short_description=Retire both nodes" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"
    {
  result: [
    {
      sys_id: {
        value: "12629ec4b750230096c3e4f6ee11a9d5",
        display_value: "12629ec4b750230096c3e4f6ee11a9d5"
      },
      parent: {
        value: "0f4ac6c4b750230096c3e4f6ee11a9fe", 
        display_value: "CHG0033046 "
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Retire both nodes",
        display_value: "Retire both nodes"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

    変更管理 - PATCH /sn_chg_rest/change/emergency/{sys_id}

    指定されたsys_idによって識別される緊急変更要求を、要求本文または URL のキーと値のペアで更新します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/emergency/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/emergency/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 変更する変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 176. クエリパラメーター
    名前 説明
    名前と値のペア 更新するフィールドを表す名前と値のペア。要求本文パラメーターは URL パラメーターを上書きします。ただし、必須パラメーターを URL に指定する必要があります。

    データタイプ：文字列
    表 : 177. 要求本文パラメーター (XML または JSON)
    名前 説明
    データ 関連する変更要求で更新するフィールドを表す名前と値のペア。たとえば、簡単な説明ファイルを更新するには、 --data "{\"short_description\": \"my short desc\" }" \のような名前と値のペアを入力します。

    データタイプ：文字列

    ヘッダー

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

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

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

    デフォルト： application/json
    表 : 179. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 180. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ：文字列
    状況 変更要求の現在のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「緊急」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「緊急」です。

    データタイプ：文字列
    __meta.ignoredFields コールで渡されたが、基本レコードに存在しないかフィールドが読み取り専用であるために変更要求に適用されなかった名前と値のペア。

    データタイプ：アレイ

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"no_such_field\": \"this will be ignored\", }" \
--user "username":"password"
    {
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",    },
      state: {
        value: "-4", 
        display_value: "Assess"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

    変更管理 - PATCH /sn_chg_rest/change/normal/{sys_id}

    指定されたsys_idによって識別される通常の変更要求を、要求本文または URL のパラメーターで更新します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/normal/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/normal/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 変更する変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 182. クエリパラメーター
    名前 説明
    名前と値のペア 更新するフィールドを表す名前と値のペア。要求本文パラメーターは URL パラメーターを上書きします。ただし、必須パラメーターを URL に指定する必要があります。

    データタイプ：文字列
    表 : 183. 要求本文パラメーター (XML または JSON)
    名前 説明
    データ 関連する変更要求で更新するフィールドを表す名前と値のペア。たとえば、簡単な説明ファイルを更新するには、 --data "{\"short_description\": \"my short desc\" }" \のような名前と値のペアを入力します。

    データタイプ：文字列

    ヘッダー

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

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

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

    デフォルト： application/json
    表 : 185. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 186. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ: オブジェクト
    状況 変更要求の現在のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「標準」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「標準」です。

    データタイプ：文字列
    __meta.ignoredFields コールで渡されたが、基本レコードに存在しないかフィールドが読み取り専用であるために変更要求に適用されなかった名前と値のペア。

    データタイプ：アレイ

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f?state=assess" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"

    {
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-4", 
        display_value: "Assess"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

    変更管理 - PATCH /sn_chg_rest/change/standard/{sys_id}

    指定されたsys_idによって識別される標準的な変更要求を、要求本文または URL のパラメーターで更新します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/standard/{sys_id}

    デフォルト URL: /api/sn_chg_rest/change/standard/{sys_id}

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

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

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

    データタイプ：文字列
    sys_id 変更する変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 188. クエリパラメーター
    名前 説明
    名前と値のペア 更新するフィールドを表す名前と値のペア。要求本文パラメーターは URL パラメーターを上書きします。ただし、必須パラメーターを URL に指定する必要があります。

    データタイプ：文字列
    表 : 189. 要求本文パラメーター (XML または JSON)
    名前 説明
    データ 関連する変更要求で更新するフィールドを表す名前と値のペア。たとえば、簡単な説明ファイルを更新するには、 --data "{\"short_description\": \"my short desc\" }" \のような名前と値のペアを入力します。

    データタイプ：文字列

    ヘッダー

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

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

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

    デフォルト： application/json
    表 : 191. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 192. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア すべてのフィールド (キー) と、識別された変更要求に関連付けられた値。

    データタイプ: オブジェクト
    状況 変更要求状況。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    データタイプ：文字列
    state.value 内部ステータス値。

    データタイプ：文字列
    sys_id 変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177?description=Reboot my email server" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"short_description\": \"my short desc\" }" \
--user "username":"password"

    {
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },

      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot my email server",
        display_value: "Reboot my email server"
      },
    } 
  ]
}

    変更管理 - PATCH /sn_chg_rest/change/standard/{sys_id}/risk

    リスク条件の評価に基づいて、指定された標準的な変更のリスクと影響度を計算します。

    変更リスクアセスメントプラグインがインストールされている場合、リスクアセスメントの完了後に累積最高リスクも計算されます。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/risk

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}/risk

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

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

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

    データタイプ：文字列
    sys_id 評価する標準的な変更のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 194. クエリパラメーター
    名前 説明
    なし
    表 : 195. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 197. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 198. ステータスコード
    ステータスコード 説明
    200 リスクアセスメントが正常に完了しました。
    400 リスクアセスメントに失敗しました。失敗のタイプの詳細はエラーデータに含まれています。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    impact 指定された標準的な変更に関連付けられた影響度。

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

    impact: {
  display_value: "String", 
  value: "String"
}
    impact.display_value UI に表示する影響度情報。

    データタイプ：文字列
    impact.value 内部影響度値。

    データタイプ：文字列
    名前と値のペア 標準的な変更レコード内の有効なすべてのフィールド。

    データタイプ: オブジェクト
    risk 指定された標準的な変更に対して計算されたリスク。

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

    risk: {
  display_value: "String", 
  value: "String"
}
    risk.display_value UI に表示するリスク情報。

    データタイプ：文字列
    risk.value 内部リスク値。

    データタイプ：文字列
    sys_id 標準的な変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 変更要求のSys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/1c87925347c12200e0ef563dbb9a7177/risk" \
--request PATCH \
--header "Accept:application/json" \
--user "username":"password"
    {
  sys_id: {
    value: "1c87925347c12200e0ef563dbb9a7177",
    display_value: "1c87925347c12200e0ef563dbb9a7177"
  },
  risk: {
    value: "4", 
    display_value: "Low"
  },
  impact: {
    value: "3",
    display_value: "3 - Low"
  }
  ..., // all valid fields in record
}

    変更管理 - POST /sn_chg_rest/change

    変更要求に基づいて変更要求レコードを作成します。1 回の呼び出しでの複数の変更要求の作成はサポートされていません。

    変更管理 - GET /sn_chg_rest/change/model または 変更管理 - GET /sn_chg_rest/change/model/{sys_id} エンドポイントを使用して、利用可能な変更モデルのリストを取得できます。

    変更要求を作成するときは、変更モデル (chg_model) または typeを設定します。chg_modelとtypeの両方が設定されている場合、タイプは単に変更の分類になります。これらの値の少なくとも 1 つを指定しない場合、デフォルト設定はリリースによって変更される可能性があります。これらの値のうち少なくとも 1 つを設定することを強くお勧めします。

    値は、クエリパラメーターまたは要求本文パラメーターのいずれかとして設定できます。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change

    デフォルト URL: /api/sn_chg_rest/change

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

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

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

    データタイプ：文字列
    表 : 200. クエリパラメーター
    名前 説明
    名前と値のペア 更新するフィールドを表す名前と値のペア。要求本文パラメーターは URL パラメーターを上書きします。ただし、必須パラメーターを URL に指定する必要があります。 代わりに、同じ値を要求本文パラメーターとして設定できます。
    注:
    変更要求を作成するときは、変更モデル (chg_model) または typeを設定します。chg_modelとtypeの両方が設定されている場合、タイプは単に変更の分類になります。これらの値の少なくとも 1 つを指定しない場合、デフォルト設定はリリースによって変更される可能性があります。これらの値のうち少なくとも 1 つを設定することを強くお勧めします。

    データタイプ：文字列
    chg_model 変更モデル [chg_model] テーブルにリストされている変更モデルの名前。

    次の形式で提供されます: chg_model=Normal。

    詳細については、「 変更モデル」を参照してください。

    注:
    変更モデル (chg_model) または type 値を指定しない場合、デフォルト設定はリリースによって変更される可能性があります。これらの値のうち少なくとも 1 つを設定することを強くお勧めします。

    データタイプ：文字列
    encrypted_fields 暗号化するカンマ区切りフィールドのリスト。これらのフィールドは、関連付けられたレコードに格納される前に暗号化されます。指定すると、エンドポイントは setValue() メソッドを呼び出す代わりに GlideRecord setDisplayValue() メソッドを呼び出します。

    このため、このパラメーターを使用して、sys_idsや値を渡す代わりに、参照フィールドや選択フィールドなどの暗号化されていないフィールドの表示値を渡すこともできます。

    データタイプ：文字列
    type 選択肢 [sys_choice] テーブルにリストされている変更要求タイプの名前。chg_modelも入力されている場合、このフィールドは変更カテゴリとしてのみ使用されます。

    type =Normal の形式で提供されます。

    詳細については、「 新しい変更要求タイプの追加」を参照してください。

    注:
    変更モデル (chg_model) または type 値を指定しない場合、デフォルト設定はリリースによって変更される可能性があります。これらの値のうち少なくとも 1 つを設定することを強くお勧めします。

    データタイプ：文字列
    表 : 201. 要求本文パラメーター (JSON)
    名前 説明
    オブジェクト 関連する変更要求で更新するフィールドを表す名前と値のペア。たとえば、簡単な説明ファイルを更新するには、 --data "{\"short_description\": \"my short desc\" }" \のような名前と値のペアを入力します。 代わりに、同じプロパティをクエリパラメーターとして設定できます。

    データタイプ：文字列
    Object.chg_model 変更モデル [chg_model] テーブルにリストされている変更モデルの名前。

    {"chg_model" : "クラウドインフラストラクチャ"} の形式の名前と値のペアとして指定されます

    詳細については、「 変更モデル」を参照してください。

    注:
    変更モデル (chg_model) または type 値を指定しない場合、デフォルト設定はリリースによって変更される可能性があります。これらの値のうち少なくとも 1 つを設定することを強くお勧めします。

    データタイプ：文字列
    Object.encrypted_fields 暗号化するカンマ区切りフィールドのリスト。これらのフィールドは、関連付けられたレコードに格納される前に暗号化されます。指定すると、エンドポイントは setValue() メソッドを呼び出す代わりに GlideRecord setDisplayValue() メソッドを呼び出します。

    このため、このパラメーターを使用して、sys_idsや値を渡す代わりに、参照フィールドや選択フィールドなどの暗号化されていないフィールドの表示値を渡すこともできます。

    データタイプ：文字列
    Object.type 選択肢 [sys_choice] テーブルにリストされている変更要求タイプの名前。chg_modelも入力されている場合、このフィールドは変更カテゴリとしてのみ使用されます。

    名前と値のペアとして次の形式で指定されます: {"type" : "emergency"}

    詳細については、「 新しい変更要求タイプの追加」を参照してください。

    注:
    変更モデル (chg_model) または type 値を指定しない場合、デフォルト設定はリリースによって変更される可能性があります。これらの値のうち少なくとも 1 つを設定することを強くお勧めします。

    データタイプ：文字列

    ヘッダー

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

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

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

    デフォルト： application/json
    表 : 203. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 204. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    result 新しい変更要求レコード。このオブジェクトの要素は、変更要求 [change_request] テーブルのレコード形式に対応しています。要求で指定されていない値はすべて、デフォルトに設定されているか、空または null です。

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

    cURL 要求

    次の例は、標準的な変更モデルと標準タイプに基づいて変更要求レコードを作成する方法を示しています。この例では、変更要求はモデルによって駆動され、[タイプ] フィールドは分類としてのみ使用されます。

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"chg_model\" : \"Standard\",
    \"description\" : \"Describes the change request.\",
    \"short_description\" : \"My change request\",
    \"type\" : \"Standard\"
}" \
--user "username":"password"

    結果は、レコードが値 CHG0030022 で変更要求 [change_request] テーブルに正常に追加されたことを示しています。

    {
  "result": 
    "upon_reject": {
      "display_value": "Cancel all future Tasks",
      "value": "cancel"
    },
    "sys_updated_on": {
      "display_value": "2022-12-08 17:18:57",
      "value": "2022-12-09 01:18:57",
      "display_value_internal": "2022-12-08 17:18:57"
    },
    "type": {
      "display_value": "Standard",
      "value": "standard"
    }
    "number": {
      "display_value": "CHG0030022",
      "value": "CHG0030022"
    },
    "is_bulk": {
      "display_value": "false",
      "value": false
    }
    "ci_class": {
      "display_value": "cmdb_ci",
      "value": "cmdb_ci"
    },
    "state": {
      "display_value": "New",
      "value": -5
    },
    "sys_created_by": {
      "display_value": "admin",
      "value": "admin"
    },
    "knowledge": {
      "display_value": "false",
      "value": false
    },
    "phase": {
      "display_value": "Requested",
      "value": "requested"
    }
    "impact": {
      "display_value": "3 - Low",
      "value": 3
    },
    "active": {
      "display_value": "true",
      "value": true
    },
    "priority": {
      "display_value": "4 - Low",
      "value": 4
    },
    "sys_domain_path": {
      "display_value": "/",
      "value": "/"
    },
    "production_system": {
      "display_value": "false",
      "value": false
    },
    "requested_by": {
      "display_value": "System Administrator",
      "value": "6816f79cc0a8016401c5a33be04be441"
    }
    "short_description": {
      "display_value": "My change request",
      "value": "My change request"
    },
    "sys_class_name": {
      "display_value": "Change Request",
      "value": "change_request"
    },
    "reassignment_count": {
      "display_value": "0",
      "value": 0
    },
    "variables": {
      "display_value": "variable_pool",
      "value": "variable_pool"
    },
    "sla_due": {
      "display_value": "UNKNOWN",
      "value": "",
      "display_value_internal": ""
    },
    "escalation": {
      "display_value": "Normal",
      "value": 0
    },
    "upon_approval": {
      "display_value": "Proceed to Next Task",
      "value": "proceed"
    },
    "conflict_status": {
      "display_value": "Not Run",
      "value": "Not Run"
    },
    "task_effective_number": {
      "display_value": "CHG0030022",
      "value": "CHG0030022"
    },
    "sys_updated_by": {
      "display_value": "admin",
      "value": "admin"
    },
    "opened_by": {
      "display_value": "System Administrator",
      "value": "6816f79cc0a8016401c5a33be04be441"
    },
    "sys_created_on": {
      "display_value": "2022-12-08 17:18:57",
      "value": "2022-12-09 01:18:57",
      "display_value_internal": "2022-12-08 17:18:57"
    },
    "sys_domain": {
      "display_value": "global",
      "value": "global"
    },
    "chg_model": {
      "display_value": "Standard",
      "value": "e55d0bfec343101035ae3f52c1d3ae49"
    },
    "opened_at": {
      "display_value": "2022-12-08 17:18:57",
      "value": "2022-12-09 01:18:57",
      "display_value_internal": "2022-12-08 17:18:57"
    },
    "description": {
      "display_value": "Describes the change request.",
      "value": "Describes the change request."
    },
    "sys_id": {
      "display_value": "2ac52dd77c6b1510f877be3b096e64fe",
      "value": "2ac52dd77c6b1510f877be3b096e64fe"
    },
    "cab_required": {
      "display_value": "false",
      "value": false
    },
    "urgency": {
      "display_value": "3 - Low",
      "value": 3
    },
    "scope": {
      "display_value": "Medium",
      "value": 3
    },
    "activity_due": {
      "display_value": "UNKNOWN",
      "value": "",
      "display_value_internal": ""
    },
    "approval": {
      "display_value": "Not Yet Requested",
      "value": "not requested"
    },
  }
}

    cURL 要求

    次の例は、要求本文で暗号化フィールドを渡す方法を示しています。

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"encrypted_fields\":\"short_description,description\",
    \"short_description\":\"my short desc\",
    \"description\":\"my desc\"
}" \
--user "username":"password"

    cURL 要求

    次の例は、暗号化されたフィールドをクエリパラメーターとして渡す方法を示しています。

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"

    変更管理 - POST /sn_chg_rest/change/{sys_id}/ci

    変更要求と 構成管理データベース (CMDB) 構成アイテム (CI) の間の関連付けを作成します。

    関連付けの作成は非同期に行われます。つまり、応答がすぐに提供され、ワーカーの詳細が含まれます。ワーカーは応答後に実際の作業を行います。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/ci

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}/ci

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

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

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

    データタイプ：文字列
    sys_id CMDB CI に関連付ける変更要求のSys_id。

    データタイプ：文字列
    表 : 206. クエリパラメーター
    名前 説明
    なし
    表 : 207. 要求本文パラメーター (XML または JSON)
    名前 説明
    association_type 必須です。CMDB CI と変更要求の間の関連付けのタイプ。

    有効な値：

    • 影響を受ける:変更要求の影響を受ける CI
    • impacted:変更要求によって影響を受けるサービス
    • オファリング:影響を受けるサービスオファリング

    データタイプ：文字列
    cmdb_ci_sys_ids 必須です。変更要求に関連付ける CMDB CI sys_idsのリスト。

    データタイプ:アレイまたはカンマ区切りの文字列
    refresh_impacted_services 影響を受ける CI のリストに基づいて影響を受けるサービスを設定するために association_type=影響を受ける ときに使用されるフラグ。

    有効な値：

    • true:影響を受ける CI のリストに基づいて影響を受けるサービスを入力します
    • false:影響を受けるサービスを自動的に設定しない

    データタイプ：ブーリアン

    デフォルト値：false

    ヘッダー

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

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

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

    デフォルト： application/json
    表 : 209. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 210. ステータスコード
    ステータスコード 説明
    202 承認済み。要求は処理のために承認されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。

    エラー応答には、問題のトラブルシューティングに役立つ関連メッセージが含まれています。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    メッセージ メッセージ情報。
    データタイプ: オブジェクト
    "messages": {
  "errorMessages": [Array],
  "infoMessages": [Array],
  "warningMessages": [Array]
}
    messages.errorMessages 要求の処理中にエラーメッセージが発生しました。例： 
    無効なCMDB_CI sys_idが指定されました

    データタイプ：アレイ
    messages.infoMessages 要求の処理中に検出された情報メッセージ。例： 
    CMDB_CI sys_id既に関連付けられています。

    データタイプ：アレイ
    messages.warningMessages 要求の処理中に検出された警告メッセージ。例： 
    無効なCMDB_CI sys_idが指定されました。

    データタイプ：アレイ
    要求 元のエンドポイント要求。

    データタイプ：文字列
    状況 ワーカーの現在のステータスに関する情報。
    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value ワーカーの状態の表示値。これらの値は、 state.value 要素に直接関連しています。

    可能な値：

    • 完了
    • エラー
    • 対応中
    • 待機中

    データタイプ：文字列
    state.value ワーカーのステータスの数値。

    可能な値：

    • 1
    • 2
    • 3
    • 4

    データタイプ：数値
    type CMDB CI と変更要求の間の関連付けのタイプ。

    データタイプ：文字列
    ワーカー 関連付けられたワーカーに関する情報。

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

    "worker": {
  "link": "String",
  "sysId": "String"
}
    worker.link 関連付けられたワーカーのステータスとその他のワーカー関連情報を取得するための URL。

    データタイプ：文字列
    worker.sysId 変更要求に関連付けられたワーカーのSys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{cmdb_ci_sys_ids:'caf043a3b7fb23000999e4f6ee11a9c0,06f043a3b7fb23000999e4f6ee11a9c1', association_type:'affected'}" \
--user "username":"password"

    {
  "result": {
    "worker": {
      "sysId": "f490f4c6dbac330084f07ffdbf961952",
      "link": "instance.service-now.com/api/sn_chg_rest/change/worker/f490f4c6dbac330084f07ffdbf961952"
    },
    "request": "{\"cmdb_ci_sys_ids\":[\"caf043a3b7fb23000999e4f6ee11a9c0\",\"06f043a3b7fb23000999e4f6ee11a9c1\"],\"association_type\":\"affected\",\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "affected",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

    変更管理 - POST /sn_chg_rest/change/{sys_id}/conflict

    指定された変更要求 (sys_id) の変更要求競合チェックプロセスを開始します。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/conflict

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}/conflict

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

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

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

    データタイプ：文字列
    sys_id 競合チェックプロセスを開始する変更管理要求のSys_id。競合チェックプロセスの詳細については、「 競合の検出」を参照してください。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 212. クエリパラメーター
    名前 説明
    なし
    表 : 213. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 215. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 216. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。解決できないエラーのため、要求を開始できませんでした。返されたメッセージには、追加の詳細が含まれる場合があります。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    result 変更要求競合チェックプロセスのSys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

    {
    result: "c0b5afe4b710230096c3e4f6ee11a93f"
}

    変更管理 - POST /sn_chg_rest/change/emergency

    デフォルトの緊急変更要求レコードに基づいて、1 つの緊急変更要求を作成します。1 回の呼び出しでの複数の緊急変更要求の作成はサポートされていません。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/emergency

    デフォルト URL: /api/sn_chg_rest/change/emergency

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

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

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

    データタイプ：文字列
    表 : 218. クエリパラメーター
    名前 説明
    キーと値のペア 要求の作成時を変更するフィールドのキーと値のペア。キーはテンプレート内のフィールド名で、値はフィールドに入力する情報です。
    変更できず、渡された場合に無視されるフィールド:
    • ビジネスルール
    • ACL で定義されている読み取り専用フィールド
    • 存在しないフィールド

    データタイプ：文字列
    表 : 219. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 221. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 222. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 緊急変更要求で作成されたフィールドの名前と値のペア。

    データタイプ: オブジェクト
    状況 削除前の変更要求のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    値は常に「新規」です。

    データタイプ：文字列
    state.value 内部ステータス値。

    値は常に「-5」です。

    データタイプ：文字列
    sys_id 新しく作成された緊急変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「緊急」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「緊急」です。

    データタイプ：文字列
    __meta.ignoredFields コールで渡されたものの、基本レコードに存在しないかフィールドが読み取り専用であるために変更要求に適用されなかったキーと値のペア。

    データタイプ：アレイ

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?no_such_field=something&description=test&short_description=Reboot server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
    {
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

    変更管理 - POST /sn_chg_rest/change/normal

    デフォルトの通常の変更要求レコードに基づいて、1 つの通常の変更要求を作成します。1 回の呼び出しでの複数の通常の変更要求の作成はサポートされていません。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/normal

    デフォルト URL: /api/sn_chg_rest/change/normal

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

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

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

    データタイプ：文字列
    表 : 224. クエリパラメーター
    名前 説明
    キーと値のペア 要求の作成時に変更するフィールド。キーはテンプレート内のフィールド名で、値はフィールドに入力する情報です。
    変更できず、渡された場合に無視されるフィールド:
    • ビジネスルール
    • ACL で定義されている読み取り専用フィールド
    • 存在しないフィールド

    データタイプ：文字列
    表 : 225. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 227. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 228. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 関連する変更要求のすべてのフィールドの値。

    データタイプ: オブジェクト
    状況 新しく作成された変更要求のステータス。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value UI に表示するステータス。

    値は常に「新規」です。

    データタイプ：文字列
    state.value 内部ステータス値。

    値は常に「-5」です。

    データタイプ：文字列
    sys_id 新しく作成された通常の変更要求のSys_id。

    データタイプ：文字列
    type 変更要求のタイプ。

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

    type: {
  display_value: "String",
  value: "String"
}
    type.display_value UI に表示するタイプを変更します。

    値は常に「標準」です。

    データタイプ：文字列
    type.value 内部タイプ値。

    値は常に「標準」です。

    データタイプ：文字列
    __meta.ignoredFields コールで渡されたものの、基本レコードに存在しないかフィールドが読み取り専用であるために変更要求に適用されなかったキーと値のペア。

    データタイプ：アレイ

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?no_such_field=something&description=test&short_description=Remove server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

    変更管理 - POST /sn_chg_rest/change/{sys_id}/refresh_impacted_services

    プライマリ CI に基づいて、影響を受けるサービス/構成アイテム (CI) 関連リストに入力します。

    プライマリ CI が変更要求フォームと影響を受ける CI 関連リストに表示されます。

    注:
    このエンドポイントのすべての作業アイテムは非同期で実行されます。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/refresh_impacted_services

    デフォルト URL: /api/sn_chg_rest/change/{sys_id}/refresh_impacted_services

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

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

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

    データタイプ：文字列
    sys_id 影響を受けるサービスのリフレッシュに使用する変更要求のSys_id。

    データタイプ：文字列
    表 : 230. クエリパラメーター
    名前 説明
    なし
    表 : 231. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

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

    デフォルト： application/json
    表 : 233. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 234. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    メッセージ メッセージ情報。
    データタイプ: オブジェクト
    "messages": {
  "errorMessages": [Array],
  "infoMessages": [Array],
  "warningMessages": [Array]
}
    messages.errorMessages 要求の処理中にエラーメッセージが発生しました。例： 
    無効なCMDB_CI sys_idが指定されました

    データタイプ：アレイ
    messages.infoMessages 要求の処理中に検出された情報メッセージ。例： 
    CMDB_CI sys_id既に関連付けられています。

    データタイプ：アレイ
    messages.warningMessages 要求の処理中に検出された警告メッセージ。例： 
    無効なCMDB_CI sys_idが指定されました。

    データタイプ：アレイ
    要求 元のエンドポイント要求。

    データタイプ：文字列
    状況 ワーカーの現在のステータスに関する情報。

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

    state: {
  display_value: "String", 
  value: "String"
}
    state.display_value ワーカーの状態の表示値。これらの値は、 state.value 要素に直接関連しています。

    可能な値：

    • 完了
    • エラー
    • 対応中
    • 待機中

    データタイプ：文字列
    state.value ワーカーのステータスの数値。

    可能な値：

    • 1
    • 2
    • 3
    • 4

    データタイプ：数値
    type CMDB CI と変更要求の間の関連付けのタイプ。

    データタイプ：文字列
    ワーカー 関連付けられたワーカーに関する情報。

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

    "worker": {
  "link": "String",
  "sysId": "String"
}
    worker.link 関連付けられたワーカーのステータスとその他のワーカー関連情報を取得するための URL。

    データタイプ：文字列
    worker.sysId 変更要求に関連付けられたワーカーのSys_id。

    データタイプ：文字列

    cURL 要求

    curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/refresh_impacted_services" \ 
--request POST \ 
--header "Accept:application/json" \
--header "Content-Type:application/json" \ 
--user "username":"password"
    { 
  result: { 
    worker: { 
      sysId: "aa31c308b75033000999e4f6ee11a9c2", 
      link: "http://instance.service-now.com/api/sn_chg_rest/change/worker/aa31c308b75033000999e4f6ee11a9c2" 
    }, 
    request: "", 
    state: { 
      value: 1, 
      display_value: "Waiting" 
    }, 
    type: "impacted", 
    messages: { 
      errorMessages: [], 
      warningMessages: [], 
      infoMessages: [] 
    } 
  } 
}

    変更管理 - POST /sn_chg_rest/change/standard/{standard_change_template_id}

    渡されたテンプレートsys_idで指定された既存の標準的な変更テンプレートに基づいて、1 つの標準的な変更要求を作成します。1 回の呼び出しでの複数の標準的な変更要求の作成はサポートされていません。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/standard/{standard_change_template_id}

    デフォルト URL: /api/sn_chg_rest/change/standard/{standard_change_template_id}

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

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

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

    データタイプ：文字列
    standard_change_template_id 新しい標準的な変更要求の基礎となる標準的な変更テンプレートのSys_id。

    データタイプ：文字列

    テーブル:標準的な変更テンプレート [std_change_record_producer]
    表 : 236. クエリパラメーター
    パラメーター 説明
    名前と値のペア 要求の作成時に変更する、指定された標準的な変更テンプレート内のフィールド。キーはテンプレート内のフィールド名で、値はフィールドに入力する情報です。
    変更できず、渡された場合に無視されるフィールド:
    • 説明
    • 切り戻し計画
    • テスト計画
    • 実装計画
    • ACL で定義されている読み取り専用フィールド
    • 指定された標準的な変更テンプレートに存在しないフィールド

    データタイプ：文字列
    表 : 237. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 239. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 240. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

    応答本文

    API は、応答本文でこれらの JSON または XML 要素を返します。

    表 : 241. 応答本文で返される要素
    要素 説明
    名前と値のペア 標準的な変更要求で作成されたフィールドの名前と値のペア。

    データタイプ: オブジェクト
    sys_id 新しく作成された標準的な変更要求のSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する標準的な変更要求のSys_id。

    データタイプ：文字列
    sys_id.value 標準的な変更要求のSys_id。

    データタイプ：文字列
    __meta.ignoredFields コールで渡されたものの、基本レコードに存在しないかフィールドが読み取り専用であるために変更要求に適用されなかったキーと値のペア。

    データタイプ：アレイ

    cURL 要求のサンプル

    curl "https://instance.servicenow.com" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

    変更管理 - POST /sn_chg_rest/change/{change_sys_id}/task

    デフォルトの変更要求タスク レコードに基づいて 1 つの変更要求タスクを作成し、指定された変更要求に関連付けます。1 回の呼び出しでの複数の変更要求タスクの作成はサポートされていません。

    URL 形式

    バージョニングされた URL: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task

    デフォルト URL: /api/sn_chg_rest/change/{change_sys_id}/task

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

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

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

    データタイプ：文字列
    change_sys_id このタスクを関連付ける変更要求のSys_id。

    データタイプ：文字列

    テーブル：変更要求 [change_request]
    表 : 243. クエリパラメーター
    名前 説明
    キーと値のペア 要求の作成時に変更するフィールド。キーはテンプレート内のフィールド名で、値はフィールドに入力する情報です。
    変更できず、渡された場合に無視されるフィールド:
    • ビジネスルール
    • ACL で定義されている読み取り専用フィールド
    • 存在しないフィールド

    データタイプ：文字列
    表 : 244. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 246. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 247. ステータスコード
    ステータスコード 説明
    200 要求が正常に完了しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。指定されたレコードが見つかりませんでした。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    名前 説明
    名前と値のペア 変更要求タスクで作成されたフィールドの名前と値のペア。

    データタイプ: オブジェクト
    親 タスクに関連付けられた変更要求に関する情報。

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

    parent: {
  display_value: "String", 
  value: "String"
}
    parent.display_value タスクに関連付けられた変更要求の UI に表示する情報。

    データタイプ：文字列
    parent.value タスクに関連付けられた変更要求のSys_id。

    データタイプ：文字列
    sys_id 新しく作成された変更要求タスクのSys_id情報。

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

    sys_id: {
  display_value: "String", 
  value: "String"
}
    sys_id.display_value UI に表示する変更要求タスクのSys_id。

    データタイプ：文字列
    sys_id.value 変更要求タスクのSys_id。

    データタイプ：文字列
    __meta.ignoredFields コールで渡されたものの、基本レコードに存在しないかフィールドが読み取り専用であるために変更要求に適用されなかったキーと値のペア。

    データタイプ：アレイ

    cURL 要求

    curl "https://instance.servicenow.com/api/now/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?short_description=Retire node&no_such_field=test" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

    {
  result: [
    {
      sys_id: {
        value: "12629ec4b750230096c3e4f6ee11a9d5",
        display_value: "12629ec4b750230096c3e4f6ee11a9d5"
      },
      parent: {
        value: "0f4ac6c4b750230096c3e4f6ee11a9fe ", 
        display_value: "CHG0033046 "
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Retire node",
        display_value: "Retire node"
      }
      __meta.ignoredFields": ["no_such_field"]
    }
  ]
}