{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":485,"path":"api-reference/rest-apis/change-management-api.md","title":"Change Management API","bundle":null,"doc_type":null,"release":"australia","body":"\n# Change Management API\n\nThe Change Management API provides endpoints that enable third-party application integration with the ServiceNow Change Management process.\n\nBy integrating your application with the ServiceNow Change Management process, all change requests, regardless of where they are initiated, have a single source of truth, providing a single audit source.\n\nUse this REST API to integrate your change management process with external applications and when developing ServiceNow client-side applications.\n\nThis REST API enables integrators to:\n\n- Initiate a standard change request from a published standard change request template.\n- Create a change request of type emergency or normal.\n- Update any field that exists in the change request table for any change request.\n- Update any field that exists in the change task table and work tasks from creation through closure/cancellation.\n- Retrieve a specific change request, standard template, change request task, or change model.\n- Retrieve multiple change requests, standard templates, change request tasks using pagination.\n- Perform risk evaluation.\n- Refresh impacted services.\n- Generate and process any related approval activity associated with a change request.\n- Identify potential scheduling conflicts and identify periods where conflicts do not exist.\n- Delete change requests, change request tasks, and conflict checking processes.\n- Create a change request record based on a change model record.\n- Retrieves a list of available states for the specified change request, including the current state.\n\nThe Change Management API supports ITIL types and change models using Workflow Studio and Workflow. Change models deliver fit-for-purpose change. Types and models define transition criteria that must be met before the change request can progress to the next state. You can define this criteria using states, workflows, tools, and business rules.\n\n- Traditional ITIL types: Standard, Emergency, and Normal.\n- Change model states: New, Scheduled, Implement, Review, and Closed.\n\nYou can configure additional change models within your ServiceNow instance and then create change requests based on those change models using endpoints in this API. Use the [Change Management - GET /sn\\_chg\\_rest/change/model/\\{sys\\_id\\}](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) and [Change Management - GET /sn\\_chg\\_rest/change/model](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) endpoints to obtain the available change models in an instance. Then use the [Change Management - POST /sn\\_chg\\_rest/change](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) to create a change request based on a specified change model.\n\nFor information on configuring change models, see [Configure Change Management](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/it-service-management/configure-change-management.md).\n\nThe following roles are required to access the Change Management endpoints:\n\n- DELETE: change\\_manager or admin\n- GET: change\\_manager, itil, sn\\_change\\_read, or admin\n- PATCH/POST: change\\_manager, itil, or admin\n\nIn addition, administrators can set change properties to configure Change Management behavior. For a list of these properties and a description of their available functionality, see [Change Management properties](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/it-service-management/r_ChangeManagementProperties.md).\n\n**Parent Topic:**[REST API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/api-rest.md)\n\n## Change Management - DELETE /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/task/\\{task\\_sys\\_id\\}\n\nDeletes the change request task identified by the specified sys\\_ids.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{change_sys_id}/task/{task_sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nchange\\_sys\\_id\n\n\n\nSys\\_id of the change request to which the task is associated. Verifies that the task is actually associated to the specified change request.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
\n\ntask\\_sys\\_id\n\n\n\nSys\\_id of the change request task to delete.Data type: String\n\nTable: Change Tasks \\[change\\_task\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nAll fields \\(key\\) with their associated values for the identified change request task prior to the delete.Data type: Object\n\n
\n\nparent\n\n\n\nInformation for the change request to which this task was associated.Data type: Object\n\n```\nparent: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nparent.display\\_value\n\n\n\nSys\\_id of the parent task to display in a UI.Data type: String\n\n
\n\nparent.value\n\n\n\nSys\\_id of the parent task.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the deleted change request.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5\" \\\n--request DELETE \\\n--header \"Accept:application/json\" \\ \n--user \"username\":\"password\"\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"12629ec4b750230096c3e4f6ee11a9d5\",\n display_value: \"12629ec4b750230096c3e4f6ee11a9d5\"\n },\n parent: {\n value: \"0f4ac6c4b750230096c3e4f6ee11a9fe\", \n display_value: \"CHG0033046 \"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Retire both nodes\",\n display_value: \"Retire both nodes\"\n }\n }\n ]\n}\n```\n\n## Change Management - DELETE /sn\\_chg\\_rest/change/\\{sys\\_id\\}\n\nDeletes the change request associated with the specified sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request record to delete.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nChange request record that was deleted. Each element in this object corresponds to a field in the record of the Change Request \\[change\\_request\\] table.Data type: Object\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request DELETE \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n \"result\":\n {\n \"reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"parent\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"watch_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"proposed_change\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"upon_reject\": {\n \"display_value\": \"Cancel all future Tasks\",\n \"value\": \"cancel\"\n },\n \"sys_updated_on\": {\n \"display_value\": \"2015-07-06 11:59:27\",\n \"value\": \"2015-07-06 18:59:27\",\n \"display_value_internal\": \"2015-07-06 11:59:27\"\n },\n \"type\": {\n \"display_value\": \"Standard\",\n \"value\": \"standard\"\n },\n \"approval_history\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"skills\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"test_plan\": {\n \"display_value\": \"--Confirm that there are no monitoring alerts for the router\",\n \"value\": \"--Confirm that there are no monitoring alerts for the router\"\n },\n \"number\": {\n \"display_value\": \"CHG0000024\",\n \"value\": \"CHG0000024\"\n },\n \"is_bulk\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"cab_delegate\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"requested_by_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"ci_class\": {\n \"display_value\": \"cmdb_ci\",\n \"value\": \"cmdb_ci\"\n },\n \"state\": {\n \"display_value\": \"Closed\",\n \"value\": 3.0\n },\n \"sys_created_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"knowledge\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"order\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"phase\": {\n \"display_value\": \"Requested\",\n \"value\": \"requested\"\n },\n \"cmdb_ci\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"delivery_plan\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"impact\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3.0\n },\n \"contract\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"active\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"work_notes_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"priority\": {\n \"display_value\": \"4 - Low\",\n \"value\": 4.0\n },\n \"sys_domain_path\": {\n \"display_value\": \"/\",\n \"value\": \"/\"\n },\n \"cab_recommendation\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"production_system\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"rejection_goto\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"review_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"requested_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"business_duration\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"group_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"change_plan\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"approval_set\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"wf_activity\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"implementation_plan\": {\n \"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\",\n \"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\"\n },\n \"universal_request\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"end_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"short_description\": {\n \"display_value\": \"Reboot the server at 6 am\",\n \"value\": \"Reboot the server at 6 am\"\n },\n \"correlation_display\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"work_start\": {\n \"display_value\": \"2015-07-06 11:56:04\",\n \"value\": \"2015-07-06 18:56:04\",\n \"display_value_internal\": \"2015-07-06 11:56:04\"\n },\n \"delivery_task\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"outside_maintenance_schedule\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"additional_assignee_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"std_change_producer_version\": {\n \"display_value\": \"Clear BGP sessions on a Cisco router - 1\",\n \"value\": \"16c2273c47010200e90d87e8dee49006\"\n },\n \"sys_class_name\": {\n \"display_value\": \"Change Request\",\n \"value\": \"change_request\"\n },\n \"service_offering\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"closed_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"follow_up\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"review_status\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"reassignment_count\": {\n \"display_value\": \"2\",\n \"value\": 2.0\n },\n \"start_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"assigned_to\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"variables\": {\n \"display_value\": \"variable_pool\",\n \"value\": \"variable_pool\"\n },\n \"sla_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"comments_and_work_notes\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"escalation\": {\n \"display_value\": \"Normal\",\n \"value\": 0.0\n },\n \"upon_approval\": {\n \"display_value\": \"Proceed to Next Task\",\n \"value\": \"proceed\"\n },\n \"correlation_id\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"made_sla\": {\n \"display_value\": \"true\",\n \"value\": true\n },\n \"backout_plan\": {\n \"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\",\n \"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\"\n },\n \"conflict_status\": {\n \"display_value\": \"Not Run\",\n \"value\": \"Not Run\"\n },\n \"task_effective_number\": {\n \"display_value\": \"CHG0000024\",\n \"value\": \"CHG0000024\"\n },\n \"sys_updated_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"opened_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"user_input\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"sys_created_on\": {\n \"display_value\": \"2015-07-06 11:55:46\",\n \"value\": \"2015-07-06 18:55:46\",\n \"display_value_internal\": \"2015-07-06 11:55:46\"\n },\n \"on_hold_task\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"sys_domain\": {\n \"display_value\": \"global\",\n \"value\": \"global\"\n },\n \"route_reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"closed_at\": {\n \"display_value\": \"2015-07-06 11:56:23\",\n \"value\": \"2015-07-06 18:56:23\",\n \"display_value_internal\": \"2015-07-06 11:56:23\"\n },\n \"review_comments\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"business_service\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"time_worked\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"chg_model\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"expected_start\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"opened_at\": {\n \"display_value\": \"2015-06-09 11:55:46\",\n \"value\": \"2015-06-09 18:55:46\",\n \"display_value_internal\": \"2015-06-09 11:55:46\"\n },\n \"work_end\": {\n \"display_value\": \"2015-07-06 11:56:10\",\n \"value\": \"2015-07-06 18:56:10\",\n \"display_value_internal\": \"2015-07-06 11:56:10\"\n },\n \"phase_state\": {\n \"display_value\": \"Open\",\n \"value\": \"open\"\n },\n \"cab_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"work_notes\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"close_code\": {\n \"display_value\": \"Successful\",\n \"value\": \"successful\"\n },\n \"assignment_group\": {\n \"display_value\": \"Network\",\n \"value\": \"287ebd7da9fe198100f92cc8d1d2154e\"\n },\n \"description\": {\n \"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\",\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\"\n },\n \"on_hold_reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"calendar_duration\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"close_notes\": {\n \"display_value\": \"Completed without issues\",\n \"value\": \"Completed without issues\"\n },\n \"sys_id\": {\n \"display_value\": \"b0dbda5347c12200e0ef563dbb9a718f\",\n \"value\": \"b0dbda5347c12200e0ef563dbb9a718f\"\n },\n \"contact_type\": {\n \"display_value\": \"Phone\",\n \"value\": \"phone\"\n },\n \"cab_required\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"urgency\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3.0\n },\n \"scope\": {\n \"display_value\": \"Medium\",\n \"value\": 3.0\n },\n \"company\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"justification\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"activity_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"comments\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"approval\": {\n \"display_value\": \"Approved\",\n \"value\": \"approved\"\n },\n \"due_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"sys_mod_count\": {\n \"display_value\": \"10\",\n \"value\": 10.0\n },\n \"on_hold\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"sys_tags\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"conflict_last_run\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"risk_value\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"unauthorized\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"risk\": {\n \"display_value\": \"Moderate\",\n \"value\": 3.0\n },\n \"location\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"category\": {\n \"display_value\": \"Other\",\n \"value\": \"Other\"\n },\n \"risk_impact_analysis\": {\n \"display_value\": \"\",\n \"value\": \"\"\n }\n }\n}\n```\n\n## Change Management - DELETE /sn\\_chg\\_rest/change/\\{sys\\_id\\}/conflict\n\nCancels the running conflict checking process for the specified change request \\(sys\\_id\\).\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/conflict`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}/conflict`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request record for which to cancel the running conflict checking process.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|None| |\n\n|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad request. Cancel request failed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n|Name|Description|\n|----|-----------|\n|None||\n\n### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict\" \\\n--request DELETE \\\n--user \"username\":\"password\"\n\n```\n\n```\nNone\n```\n\n## Change Management - DELETE /sn\\_chg\\_rest/change/emergency/\\{sys\\_id\\}\n\nDeletes the emergency change request identified by the specified sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/emergency/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/emergency/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the emergency change request to delete.Data type: String\n\nTable: Change Request \\[ change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request prior to the delete.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in the UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Emergency\".\n\nData type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"emergency\".\n\nData type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request DELETE \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"b0dbda5347c12200e0ef563dbb9a718f\", \n display_value: \"b0dbda5347c12200e0ef563dbb9a718f\"\n },\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n type: {\n value: \"emergency\",\n display_value: \"Emergency\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Remove server\",\n display_value: \"Remove server\"\n },\n }, \n ]\n}\n```\n\n## Change Management - DELETE /sn\\_chg\\_rest/change/normal/\\{sys\\_id\\}\n\nDeletes the normal change request identified by the specified sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/normal/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/normal/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the normal change request to delete.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request prior to the delete.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in the UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in the UI.Value is always \"Normal\".\n\nData type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"normal\".\n\nData type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request DELETE \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: \"b0dbda5347c12200e0ef563dbb9a718f\",\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n type: {\n value: \"normal\",\n display_value: \"Normal\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Remove server\",\n display_value: \"Remove server\"\n },\n }, \n ]\n}\n\n```\n\n## Change Management - DELETE /sn\\_chg\\_rest/change/standard/\\{sys\\_id\\}\n\nDeletes the standard change request identified by the specified sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/standard/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/standard/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the standard change request to delete.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nAll fields \\(key\\) with their associated values for the identified change request.\n\n
\n\nstate\n\n\n\nState of the change request prior to the delete.Data type: Object\n\n ```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in the UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nUnique identifier of the change request.\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177\" \\\n--request DELETE \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: \"1c87925347c12200e0ef563dbb9a7177\",\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Add network switch to cabinet\",\n display_value: \"Add network switch to cabinet\"\n },\n }, \n ]\n}\n\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/ci/\\{cmdb\\_ci\\_sys\\_id\\}/schedule\n\nEnables retrieving available time slots by configuration item ID and duration, with an option to include planned start time.\n\nRole required: sn\\_change\\_writer.\n\n**Note:** Running this endpoint doesn't list the available start and end times. Use the link provided in the response body **worker.link** property to get the schedule data.\n\nSee also:\n\n- [GET /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/schedule](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md)\n- [PATCH /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/schedule/first\\_available](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md)\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/ci/{cmdb_ci_sys_id}/schedule`\n\nDefault URL: `/api/sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\ncmdb\\_ci\\_sys\\_id\n\n\n\nSys\\_id of the configuration item record. This endpoint doesn't require a change request.Data type: String\n\nTable: Configuration Items \\[cmdb\\_ci\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nduration\\_in\\_seconds\n\n\n\nDuration of change in seconds, that is, how much time is required to complete the change request task.Data type: Integer\n\n
\n\nplanned\\_start\\_time\n\n\n\nOptional. Date and time that the change request is planned to start implementation in UTC.Retrieve the available time slot start at or later than this time. If not provided, the system uses the current time as the start time.\n\nFormat: yyyy-mm-dd hh:mm:ss\n\nData type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n202\n\n\n\nSystem accepted the request.\n\n
\n\n400\n\n\n\nBad Request. A bad request type or malformed request was detected. Possible issues:\n\n- Can't find the cmdb\\_ci with the provided sys\\_id. The record either doesn't exist the or the user doesn't have read access to it.\n- The duration\\_in\\_seconds query parameter value wasn't provided.\n- Invalid duration\\_in\\_seconds or planned\\_start\\_time query parameter value provided.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nerror\n\n\n\nInformation on any errors encountered while processing the endpoint request. Data type: Object\n\n```\n\"error\": {\n \"detail\": \"String\",\n \"message\": \"String\",\n \"status\": \"String\"\n}\n```\n\n
\n\nerror.detail\n\n\n\nAdditional information about the error.Data type: String\n\n
\n\nerror.message\n\n\n\nMessage that identifies the error.Data type: String\n\n
\n\nmessages\n\n\n\nMessage information.Data type: Object\n\n```\n\"messages\": {\n \"errorMessages\": [Array],\n \"infoMessages\": [Array],\n \"warningMessages\": [Array]\n}\n```\n\n
\n\nmessages.errorMessages\n\n\n\nError messages encountered while processing the request. Data type: Array\n\n
\n\nmessages.infoMessages\n\n\n\nInformation messages encountered while processing the request. Data type: Array\n\n
\n\nmessages.warningMessages\n\n\n\nWarning messages encountered while processing the request. Data type: Array\n\n
\n\nrequest\n\n\n\nOriginal endpoint request.Data type: String\n\n
\n\nstate\n\n\n\nInformation on the current state of the worker.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: Number\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nDisplay value of the state of the worker. These values directly correlate to the **state.value** parameter.Possible values:\n\n- Complete\n- Error\n- In-Progress\n- Waiting\n\nData type: String\n\n
\n\nstate.value\n\n\n\nNumeric value of the state of the worker.Possible values:\n\n- 1\n- 2\n- 3\n- 4\n\nData type: Number\n\n
\n\ntype\n\n\n\nType of request.Valid value: schedule\n\nData type: String\n\n
\n\nworker\n\n\n\nInformation about the associated worker.Data type: Object\n\n```\n\"worker\": {\n \"link\": \"String\",\n \"sysId\": \"String\"\n}\n```\n\n
\n\nworker.link\n\n\n\nLink for retrieving time slot data. Use the sys\\_id in [GET /sn\\_chg\\_rest/change/worker/\\{sys\\_id\\}](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) to view results.Data type: String\n\n
\n\nworker.sysId\n\n\n\nSys\\_id of the worker associated with the change request.Data type: String\n\n
\n\nstatus\n\n\n\nOnly appears if an error is encountered. Status of the endpoint processing.Possible value: failure\n\nData type: String\n\n
### Get available time slots\n\nUse the value provided in the **worker.link** to get schedule window details. The value is in the following format:\n\n`https://instance.service-now.com/api/sn_chg_rest/change/worker/`\n\nUse the worker\\_sys\\_id in [GET /sn\\_chg\\_rest/change/worker/\\{sys\\_id\\}](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) to view results.\n\nThe response body contains the status and provides results when processing is complete.\n\nWorker response body parameter results vary depending on time slot availability.\n\n- If the provided time slot is available for the change request within the schedule time slot, the worker API lists the available time slots in the **payload.spans** property. The **payload.spans** property isn't listed in the results otherwise.\n- If there are no time slots available for change request duration provided within the defined scheduling time slot, the **messages.infoMessages** states the following: `D`\n\n **Note:** The change request scheduling time slot default value is 90 days. To change this value, modify the **change.conflict.next\\_available.schedule\\_window** property. For more information, see [Configure conflict analysis properties](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/it-service-management/configure-conflict-properties.md).\n\n\nThe following GET /sn\\_chg\\_rest/change/worker/\\{sys\\_id\\} example shows output provided using the ID provided in the worker.link detail. The results list open time spans available for the task duration.\n\n```\n{\n \"result\": {\n \"worker\": {\n \"sysId\": \"d7d1f2b4a444b010f87712198fe9caae\",\n \"link\": \"https://instance.service-now.com/api/sn_chg_rest/change/worker/d7d1f2b4a444b010f87712198fe9caae\"\n },\n \"request\": \"{\\\"cmdb_ci_sys_id\\\":\\\"82967cdd0ad3370236092104ce988d76\\\",\\\"planned_start_time\\\":\\\"\\\",\\\"duration_in_seconds\\\":10800,\\\"timezone\\\":\\\"America/Los_Angeles\\\"}\",\n \"state\": {\n \"value\": 3,\n \"display_value\": \"Complete\"\n },\n \"type\": \"schedule\",\n \"messages\": {\n \"errorMessages\": [],\n \"warningMessages\": [],\n \"infoMessages\": []\n },\n \"payload\": {\n \"spans\": [\n {\n \"start\": {\n \"value\": \"2021-05-15 08:00:00\",\n \"display_value\": \"2021-05-15 01:00:00\"\n },\n \"end\": {\n \"value\": \"2021-05-15 11:00:00\",\n \"display_value\": \"2021-05-15 04:00:00\"\n }\n },\n {\n \"start\": {\n \"value\": \"2021-05-22 08:00:00\",\n \"display_value\": \"2021-05-22 01:00:00\"\n },\n \"end\": {\n \"value\": \"2021-05-22 11:00:00\",\n \"display_value\": \"2021-05-22 04:00:00\"\n }\n },\n ...\n ]\n }\n }\n}\n```\n\n### cURL request\n\n```\ncurl \"https://instance.service-now.com/api/sn_chg_rest/change/ci//schedule?duration_in_seconds=10800\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\nResults include worker.link details you can use to run the provided sys\\_id in the GET /sn\\_chg\\_rest/change/worker/ endpoint.\n\n```\n{\n \"result\": {\n \"worker\": {\n \"sysId\": \"1049419c1b4c3010f58a6572604bcb7a\",\n \"link\": \"https://instance.service-now.com/api/sn_chg_rest/change/worker/1049419c1b4c3010f58a6572604bcb7a\"\n },\n \"request\": \"{\\\"cmdb_ci_sys_id\\\":\\\"\\\",\\\"planned_start_time\\\":\\\"\\\",\\\"duration_in_seconds\\\":10800,\\\"timezone\\\":\\\"America/Los_Angeles\\\"}\",\n \"state\": {\n \"value\": 1,\n \"display_value\": \"Waiting\"\n },\n \"type\": \"schedule\",\n \"messages\": {\n \"errorMessages\": [],\n \"warningMessages\": [],\n \"infoMessages\": []\n }\n }\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change\n\nRetrieves one or more change requests based on the specified criteria.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change`\n\nDefault URL: `/api/sn_chg_rest/change`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs to use to filter the result set. The name is the field on which the specified value is filtered. This parameter is mutually exclusive with **sysparm\\_query**. For example, instead of using `&sysparm_query=active=true`, you can simplify the calling statement by using `&active=true`. You can also use the display value when the field is a choice or reference type field, such as `&state=closed` instead of `&state=7`. To specify multiple key-value pairs, separate each with an ampersand, such as `&active=true&assigned_to=john.smith`. Data type: String\n\n
\n\norder\n\n\n\nField by which to sort the returned change requests.Data type: String\n\n Default: *name*\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_query\n\n\n\n[Encoded query](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_EncodedQueryStrings.md) used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: `sysparm_query=`. Column names, operators, and values are case-sensitive.\n\n- <col\\_name>: Name of the table column to filter on.\n- <operator>: Supports the following values:\n - `=`: <col\\_name> exactly matches <value>.\n - `!=`: <col\\_name> does not match <value>.\n - `LIKE`: <col\\_name> contains the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `STARTSWITH`: <col\\_name> starts with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `ENDSWITH`: <col\\_name> ends with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `^`: AND operator to add an additional query condition. Records included in the result set match both conditions.\n - `^OR`: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.\n- <value>: Value to filter on.\n\nFor more information about operators, see [Operators available for filters and queries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/r_OpAvailableFiltersQueries.md).\n\nQueries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.\n\n`sysparm_query=caller_id=javascript:gs.getUserID()^active=true`\n\nEncoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the `ORDERBY` and `ORDERBYDESC` clauses in **sysparm\\_query**.\n\nSyntax:\n\n- `ORDERBY`\n- `ORDERBYDESC`\n\nFor example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.\n\n`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory`\n\nBy default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property **glide.invalid\\_query.returns\\_no\\_rows** to `true` to instead return no rows on an invalid query.\n\n**Note:** The **glide.invalid\\_query.returns\\_no\\_rows** property controls the behavior of all queries across the instance, such as in lists, scripts \\(GlideRecord.query\\(\\)\\), and web service APIs.\n\nData type: String\n\n
\n\ntextSearch\n\n\n\nString to use to search all normal change request record fields. This search uses ServiceNow full text search platform functionality. For more information on ServiceNow search capabilities, see [Search administration](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/search-administration.md).Default: `IR_AND_OR_QUERY`\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nElement\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nList containing one or more change request record objects. Each object describes a change request. Each element in the change request object corresponds to a field in its associated record in the Change Request \\[change\\_request\\] table.All elements contain value and display\\_value name-value pairs. Date fields also contain display\\_value\\_internal name-value pairs.\n\nData type: Array\n\n
\n\naction\\_status\n\n\n\nCurrent action status of the associated change request.Possible values:\n\n- 1: Blocked internally\n- 2: Blocked by customer\n- 3: Blocked internally and by customer\n- 4: Needs attention\n\nData type: Number\n\n
\n\nactive\n\n\n\nFlag that indicates whether the change request is active.Possible values:\n\n- true: Change request is active\n- false: Change request isn't active\n\nData type: Boolean\n\nDefault: true\n\n
\n\nactivity\\_due\n\n\n\nDate and time for which the associated case is expected to be completed.Data type: String\n\n
\n\nadditional\\_assignee\\_list\n\n\n\nList of sys\\_ids of additional persons assigned to work on the change request.Data type: Array\n\n
\n\napproval\n\n\n\nType of approval process required.Data type: String\n\nDefault: not requested\n\n
\n\napproval\\_history\n\n\n\nMost recent approval history journal entry.Data type: String\n\n
\n\napproval\\_set\n\n\n\nDate and time that the associated action was approved.Data type: String\n\n
\n\nassigned\\_to\n\n\n\nSys\\_id of the user assigned to the change request.Data type: String\n\n
\n\nassignment\\_group\n\n\n\nSys\\_id of the group assigned to the change request.Data type: String\n\n
\n\nbackout\\_plan\n\n\n\nDescription of the plan to execute if the change must be reversed.Data type: String\n\n
\n\nbusiness\\_duration\n\n\n\nLength in scheduled work hours, work days, and work weeks that it took to complete the change.Data type: String\n\n
\n\nbusiness\\_service\n\n\n\nSys\\_id of the business service associated with the change request. Located in the Service \\[cmdb\\_ci\\_service\\] table.Data type: String\n\n
\n\ncab\\_date\n\n\n\nDate on which the Change Advisory Board \\(CAB\\) meets.Data type: String\n\n
\n\ncab\\_delegate\n\n\n\nSys\\_id of the user that can substitute for the CAB manager during a CAB meeting. Located in the User \\[sys\\_user\\] tableData type: String\n\n
\n\ncab\\_recommendation\n\n\n\nDescription of the CAB recommendations for the change request.Data type: String\n\nMaximum length: 4,000\n\n
\n\ncab\\_required\n\n\n\nFlag that indicates whether the CAB is required.Possible values:\n\n- true: Change Advisory Board is required.\n- false: Change Advisory Board isn't required.\n\nData type: Boolean\n\nDefault: false\n\n
\n\ncalendar\\_duration\n\n\n\nNot currently used by Change Management.Data type: String\n\n
\n\ncategory\n\n\n\nCategory of the change, for example hardware, network, or software.Data type: String\n\nDefault: Other\n\n
\n\nchange\\_plan\n\n\n\nActivities and roles for managing and controlling the change request.Data type: String\n\n
\n\nchg\\_model\n\n\n\nSys\\_id of the change model that the associated change request was based on. The Change Model defines the state flow, transitions, and process activities that must be completed for the change request.Data type: String\n\nTable: Change Model \\[chg\\_model\\]\n\n
\n\nclosed\\_at\n\n\n\nDate and time that the associated change request was closed.Data type: String\n\n
\n\nclosed\\_by\n\n\n\nSys\\_id of the person that closed the change request.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
\n\nclose\\_code\n\n\n\nCode assigned to the change request when it was closed. For example, Successful, Successful with issues, and Unsuccessful.Data type: String\n\n
\n\nclose\\_notes\n\n\n\nNotes that the person entered when closing the change request.Data type: String\n\n
\n\ncmdb\\_ci\n\n\n\nSys\\_id of the configuration item associated with the change request.Data type: String\n\nTable: Configuration Item \\[cmdb\\_ci\\]\n\n
\n\ncomments\n\n\n\nList of customer-facing work notes entered in the associated change request.Data type: Array\n\n
\n\ncomments\\_and\\_work\\_notes\n\n\n\nList of both internal and customer-facing work notes entered for the associated change request.Data type: Array\n\nMaximum length: 4,000\n\n
\n\ncompany\n\n\n\nSys\\_id of the company associated with the change request.Data type: String\n\nTable: Company \\[core\\_company\\]\n\n
\n\nconflict\\_last\\_run\n\n\n\nDate and time that the conflict detection script was last run on the change request.Data type: String\n\n
\n\nconflict\\_status\n\n\n\nCurrent conflict status as detected by the conflict detection script, such as Conflict and Not Run.Data type: String\n\nMaximum length: 40\n\nDefault: Not Run\n\n
\n\ncontact\\_type\n\n\n\nMethod in which the change request was initially requested.Possible values:\n\n- chat\n- email\n- phone\n- social\n- web\n\nData type: String\n\n
\n\ncontract\n\n\n\nSys\\_id of the contract associated with the change request.Data type: String\n\nTable: Contract \\[ast\\_contract\\]\n\n
\n\ncorrelation\\_display\n\n\n\nUser-friendly name for the **correlation\\_id**.Data type: String\n\nMaximum length: 100\n\n
\n\ncorrelation\\_id\n\n\n\nGlobally unique ID \\(GUID\\) of a matching change request record in a third-party system.Data type: String\n\nMaximum length: 100\n\n
\n\ndelivery\\_plan\n\n\n\nNo longer in use. Sys\\_id of the delivery plan associated with the change request.Data type: String\n\nTable: Execution Plan \\[sc\\_cat\\_item\\_delivery\\_plan\\]\n\n
\n\ndelivery\\_task\n\n\n\nNo longer in use. Sys\\_id of the delivery task associated with the change request.Data type: String\n\nTable: Execution Plan Task \\[sc\\_cat\\_item\\_delivery\\_task\\]\n\n
\n\ndescription\n\n\n\nDetailed description of the change request.Data type: String\n\nMaximum length: 4,000\n\n
\n\ndue\\_date\n\n\n\nTask due date. Not used by change request process.Data type: String\n\n
\n\nend\\_date\n\n\n\nDate and time when the change request is to be completed.Data type: String\n\n
\n\nescalation\n\n\n\nCurrent escalation level.Possible values:\n\n- 0: Normal\n- 1: Moderate\n- 2: High\n- 3: Overdue\n\nData type: Number \\(Integer\\)\n\nDefault: 0\n\n
\n\nexpected\\_start\n\n\n\nDate and time when the task is to start. Not used by the change request process.Data type: String\n\n
\n\nfollow\\_up\n\n\n\nDate and time when a user followed-up with the person requesting the change request.Data type: String\n\n
\n\ngroup\\_list\n\n\n\nList of sys\\_ids and names of the groups associated with the change request.Data type: Array\n\nMaximum length: 4,000\n\n
\n\nimpact\n\n\n\nImpact on the change request will have on the customer.Possible values:\n\n- 1: High\n- 2: Medium\n- 3: Low\n\nData type: Number \\(Integer\\)\n\nDefault: 3\n\n
\n\nimplementation\\_plan\n\n\n\nSequential steps to execute to implement this change. It also contains any dependencies between steps and assignee details for each step.Data type: String\n\nMaximum length: 4,000\n\n
\n\njustification\n\n\n\nBenefits of implementing this change and the impact if this change is not implemented.Data type: String\n\nMaximum length: 4,000\n\n
\n\nknowledge\n\n\n\nFlag that indicates whether there are any knowledge base \\(\\)KB\\) articles associated with the change request.Possible values:\n\n- true: Associated KB articles\n- false: No associated KB articles\n\nData type: Boolean\n\n
\n\nlocation\n\n\n\nSys\\_id and name of the location of the equipment referenced in the change request.Data type: String\n\nTable: Location \\[cmn\\_location\\]\n\n
\n\nmade\\_sla\n\n\n\nNo longer used. Flag that indicates whether the change request was implemented in alignment with the associated service level agreement.Data type: Boolean\n\n
\n\nneeds\\_attention\n\n\n\nFlag that indicates whether the change request needs attention.Possible values:\n\n- true: Change request needs additional attention.\n- false: Change request doesn't need additional attention.\n\nData type: Boolean\n\nDefault: false\n\n
\n\nnumber\n\n\n\nChange number assigned to the change request by the system, such as CHG0040007.Data type: String\n\n
\n\non\\_hold\n\n\n\nFlag that indicates whether the change request is currently on hold.Possible values:\n\n- true: On hold\n- false: Not on hold\n\nData type: Boolean\n\nDefault: false\n\n
\n\non\\_hold\\_reason\n\n\n\nIf the **on\\_hold** parameter is \"true\", description of the reason why the change request is being held up.Data type: String\n\nMaximum length: 4,000\n\n
\n\non\\_hold\\_task\n\n\n\nIf the **on\\_hold** parameter is \"true\", list of the sys\\_ids of the tasks that must be completed before the hold is released.Data type: String\n\nMaximum length: 4,000\n\n
\n\nopened\\_at\n\n\n\nDate and time that the change release was created.Data type: String\n\n
\n\nopened\\_by\n\n\n\nSys\\_id and name of the user that created the change release.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
\n\norder\n\n\n\nNot used by Change Management. Optional numeric field by which to order records, such as when retrieving them from a database.Data type: Number \\(Integer\\)\n\n
\n\noutside\\_maintenance\\_schedule\n\n\n\nFlag that indicates whether maintenance by an outside company has been schedule for the change request.Possible values:\n\n- true: Outside maintenance scheduled\n- false: No outside maintenance scheduled\n\nData type: Boolean\n\nDefault: false\n\n
\n\nparent\n\n\n\nSys\\_id and name of the parent task to this change request, if any.Data type: String\n\nTable: Task \\[task\\]\n\n
\n\nphase\n\n\n\nCurrent phase of the change request. This defines what the change is doing in greater detail.Possible values:\n\n- accept\n- build\n- plan\n- requested\n\nData type: String\n\n
\n\nphase\\_state\n\n\n\nChange\\_phase records that should be created for a change. They are dependent on the category, such that each type of change may have different change\\_phase records. The change\\_phase records provide an opportunity to control the approval process as each change\\_phase can have a schedule and a set of approvers.Possible values:\n\n- complete\n- on hold\n- open\n- rejected\n- requested\n- work in progress\n\nData type: String\n\n
\n\npriority\n\n\n\nPriority of the change request.Possible values:\n\n- 1: Critical\n- 2: High\n- 3: Moderate\n- 4: Low\n\nData type: Number \\(Integer\\)\n\nDefault: 4\n\n
\n\nproduction\\_system\n\n\n\nFlag that indicates whether the change request is for a ServiceNow instance that is in a production environment.Possible values:\n\n- true: Production environment\n- false: Non-production environment\n\nData type: Boolean\n\n
\n\nreason\n\n\n\nDescription of why the change request was initiated.Possible values:\n\n- Business requirements\n- Hardware upgrade\n- Legislation\n- Location change\n- Network requirements\n- New or removed CI\n- Other\n- Problem resolved\n- Product or service changed\n- Software upgrade\n- User requested\n\nData type: String\n\nMaximum length: 40\n\n
\n\nreassignment\\_count\n\n\n\nNumber of times that the change request has been reassigned to a new owner.Data type: Number \\(Integer\\)\n\nDefault: 0\n\n
\n\nrejection\\_goto\n\n\n\nSys\\_id of the task to perform if the change request is rejected.Data type: String\n\nTable: Task \\[task\\]\n\n
\n\nrequested\\_by\n\n\n\nSys\\_id of the user that requested the change.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
\n\nrequested\\_by\\_date\n\n\n\nDate and time when the change is requested to be implemented by.Data type: String\n\n
\n\nreview\\_comments\n\n\n\nComments entered when the change request was reviewed.Data type: String\n\nMaximum length: 4,000\n\n
\n\nreview\\_date\n\n\n\nDate that the change request was reviewed.Data type: String\n\n
\n\nreview\\_status\n\n\n\nCurrent status of the requested change request review.Data type: String\n\n
\n\nrisk\n\n\n\nLevel of risk associated with the change request.Valid values:\n\n- 1: High\n- 2: Moderate\n- 3: Low\n\nData type: Number\n\nDefault: 3\n\n
\n\nrisk\\_impact\\_analysis\n\n\n\nDescription of the risk and analysis of implementing the change request.Data type: String\n\nMaximum length: 4,000\n\n
\n\nroute\\_reason\n\n\n\nNot currently used by Change Management. Reason that the change request was transferred.Possible values:\n\n- 1: Transfer with Resolution\n- 9: Transfer without Resolutions\n\nData type: Number\n\n
\n\nscope\n\n\n\nSize of the change request.Possible values:\n\n- 1: Massive\n- 2: Large\n- 3: Medium\n- 4: Small\n- 5: Tiny\n\nData type: Number\n\nDefault: 3\n\n
\n\nservice\\_offering\n\n\n\nSys\\_id of the service offering associated with the change request. Service offerings uniquely define the level of service in terms of availability, scope, pricing, and packaging options.Data type: String\n\nTable: Offering \\[service\\_offering\\]\n\n
\n\nshort\\_description\n\n\n\nDescription of the change request.Data type: String\n\nMaximum length: 40\n\n
\n\nskills\n\n\n\nList of the sys\\_ids of all of the skills required to implement the change request.Data type: Array\n\nTable: Skill \\[cmn\\_skill\\]\n\n
\n\nsla\\_due\n\n\n\nNo longer in use. Date and time that the change request must be completed based on the associated service level agreement.Data type: String\n\n
\n\nsn\\_esign\\_document\n\n\n\nSys\\_id of any E-signed document attached to the change request.Data type: String\n\nTable: Attachment \\[sys\\_attachment\\]\n\n
\n\nsn\\_esign\\_esignature\\_configuration\n\n\n\nSys\\_id of the E-signed signature template used for the associated document.Data type: String\n\nTable: E-signature Template \\[sn\\_esign\\_configuration\\]\n\n
\n\nstart\\_date\n\n\n\nDate and time that the change request is planned to start implementation.Data type: String\n\n
\n\nstate\n\n\n\nCurrent state of the change request. Possible values are defined in the change model.Data type: Number \\(Integer\\)\n\nDefault: 1\n\n
\n\nstd\\_change\\_producer\\_version\n\n\n\nSys\\_id of the record producer and change proposal associated with the change request. It also includes the number and percentage of successful and unsuccessful change requests created from the proposal.Data type: String\n\nTable: Standard Change Template Version \\[std\\_change\\_producer\\_version\\]\n\n
\n\nsys\\_class\\_name\n\n\n\nName of the table in which the change request is located.Data type: String\n\n
\n\nsys\\_created\\_by\n\n\n\nName of the user that initially created the change request.Data type: String\n\nMaximum length: 40\n\n
\n\nsys\\_created\\_on\n\n\n\nDate and time that the associated change request record was originally created.Data type: String\n\n
\n\nsys\\_domain\n\n\n\nIf using domains in the instance, the name of the domain to which the change module record is associated.Data type: String\n\n
\n\nsys\\_domain\\_path\n\n\n\nIf using domains in the instance, the domain path in which the associated change module record resides.Data type: String\n\n
\n\nsys\\_id\n\n\n\nUnique identifier of the associated change request record.Data type: String\n\n
\n\nsys\\_mod\\_count\n\n\n\nNumber of updates to the case since it was initially created.Data type: Number \\(Integer\\)\n\n
\n\nsys\\_updated\\_by\n\n\n\nPerson that last updated the case.Data type: String\n\nMaximum length: 40\n\n
\n\nsys\\_updated\\_on\n\n\n\nDate and time when the case was last updated.Data type: String\n\n
\n\ntask\\_effective\\_number\n\n\n\nUniversal request number.Data type: String\n\nMaximum length: 40\n\n
\n\ntask\\_for\n\n\n\nNot used by Change Management. Sys\\_id of the user that the task was created for.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
\n\ntest\\_plan\n\n\n\nDescription of the associated test plan for the change.Data type: String\n\nMaximum length: 4,000\n\n
\n\ntime\\_worked\n\n\n\nTotal amount of time worked on the change request.Data type: String\n\n
\n\ntype\n\n\n\nChange request type.Possible values:\n\n- emergency\n- normal\n- standard\n\nData type: String\n\nMaximum length: 40\n\n
\n\nunauthorized\n\n\n\nFlag that indicates whether the change request is unauthorizedPossible values:\n\n- true: Unauthorized\n- false: Authorized\n\nData type: Boolean\n\n
\n\nuniversal\\_request\n\n\n\nSys\\_id of the Parent Universal request to which this change request is a part of.Data type: String\n\nTable: Task \\[task\\]\n\n
\n\nupon\\_approval\n\n\n\nAction to take if the change request is approved.Possible values:\n\n- do\\_nothing\n- proceed\n\nData type: String\n\nMaximum length: 40\n\nDefault: proceed\n\n
\n\nupon\\_reject\n\n\n\nAction to take if the change request is rejected.Possible values:\n\n- cancel\n- goto\n\nData type: String\n\nMaximum length: 40\n\nDefault: cancel\n\n
\n\nurgency\n\n\n\nUrgency of the change request.Possible values:\n\n- 1: High\n- 2: Medium\n- 3: Low\n\nData type: Number \\(Integer\\)\n\nDefault: 3\n\n
\n\nuser\\_input\n\n\n\nAdditional user input.Data type: String\n\nMaximum length: 4,000\n\n
\n\nvariables\n\n\n\nName-value pairs of variables associated with the change request.Data type: String\n\nMaximum length: 40\n\n
\n\nwatch\\_list\n\n\n\nList of sys\\_ids of the users who receive notifications about this change request when additional comments are added or if the state of a change request is changed to Resolved or Closed.Data type: Array\n\nTable: User \\[sys\\_user\\]\n\n
\n\nwf\\_activity\n\n\n\nSys\\_id of the workflow activity record associated with the change request.Data type: String\n\nTable: Workflow Activity \\[wf\\_activity\\]\n\n
\n\nwork\\_end\n\n\n\nDate and time work ended on the change request.Data type: String\n\n
\n\nwork\\_notes\n\n\n\nInformation about how to resolve the change request, or steps taken to resolve it.Data type: String\n\nMaximum length: 4,000\n\n
\n\nwork\\_notes\\_list\n\n\n\nList of sys\\_ids of the internal users who receive notifications about this change request when work notes are added. Data type: Array\n\nTable: User \\[sys\\_user\\]\n\n
\n\nwork\\_start\n\n\n\nDate and time that work started on the change request.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change?sysparm_query=active=true^ORDERBYnumber\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\nFor brevity, the results only contain a single change request record.\n\n```\n{\n \"result\": [\n {\n \"reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"parent\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"watch_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"proposed_change\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"upon_reject\": {\n \"display_value\": \"Cancel all future Tasks\",\n \"value\": \"cancel\"\n },\n \"sys_updated_on\": {\n \"display_value\": \"2015-07-06 11:59:27\",\n \"value\": \"2015-07-06 18:59:27\",\n \"display_value_internal\": \"2015-07-06 11:59:27\"\n },\n \"type\": {\n \"display_value\": \"Standard\",\n \"value\": \"standard\"\n },\n \"approval_history\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"skills\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"test_plan\": {\n \"display_value\": \"--Confirm that there are no monitoring alerts for the router\",\n \"value\": \"--Confirm that there are no monitoring alerts for the router\"\n },\n \"number\": {\n \"display_value\": \"CHG0000024\",\n \"value\": \"CHG0000024\"\n },\n \"is_bulk\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"cab_delegate\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"requested_by_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"ci_class\": {\n \"display_value\": \"cmdb_ci\",\n \"value\": \"cmdb_ci\"\n },\n \"state\": {\n \"display_value\": \"Closed\",\n \"value\": 3.0\n },\n \"sys_created_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"knowledge\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"order\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"phase\": {\n \"display_value\": \"Requested\",\n \"value\": \"requested\"\n },\n \"cmdb_ci\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"delivery_plan\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"impact\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3.0\n },\n \"contract\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"active\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"work_notes_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"priority\": {\n \"display_value\": \"4 - Low\",\n \"value\": 4.0\n },\n \"sys_domain_path\": {\n \"display_value\": \"/\",\n \"value\": \"/\"\n },\n \"cab_recommendation\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"production_system\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"rejection_goto\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"review_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"requested_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"business_duration\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"group_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"change_plan\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"approval_set\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"wf_activity\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"implementation_plan\": {\n \"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\",\n \"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\"\n },\n \"universal_request\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"end_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"short_description\": {\n \"display_value\": \"Clear BGP sessions on a Cisco router\",\n \"value\": \"Clear BGP sessions on a Cisco router\"\n },\n \"correlation_display\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"work_start\": {\n \"display_value\": \"2015-07-06 11:56:04\",\n \"value\": \"2015-07-06 18:56:04\",\n \"display_value_internal\": \"2015-07-06 11:56:04\"\n },\n \"delivery_task\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"outside_maintenance_schedule\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"additional_assignee_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"std_change_producer_version\": {\n \"display_value\": \"Clear BGP sessions on a Cisco router - 1\",\n \"value\": \"16c2273c47010200e90d87e8dee49006\"\n },\n \"sys_class_name\": {\n \"display_value\": \"Change Request\",\n \"value\": \"change_request\"\n },\n \"service_offering\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"closed_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"follow_up\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"review_status\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"reassignment_count\": {\n \"display_value\": \"2\",\n \"value\": 2.0\n },\n \"start_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"assigned_to\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"variables\": {\n \"display_value\": \"variable_pool\",\n \"value\": \"variable_pool\"\n },\n \"sla_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"comments_and_work_notes\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"escalation\": {\n \"display_value\": \"Normal\",\n \"value\": 0.0\n },\n \"upon_approval\": {\n \"display_value\": \"Proceed to Next Task\",\n \"value\": \"proceed\"\n },\n \"correlation_id\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"made_sla\": {\n \"display_value\": \"true\",\n \"value\": true\n },\n \"backout_plan\": {\n \"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\",\n \"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\"\n },\n \"conflict_status\": {\n \"display_value\": \"Not Run\",\n \"value\": \"Not Run\"\n },\n \"task_effective_number\": {\n \"display_value\": \"CHG0000024\",\n \"value\": \"CHG0000024\"\n },\n \"sys_updated_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"opened_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"user_input\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"sys_created_on\": {\n \"display_value\": \"2015-07-06 11:55:46\",\n \"value\": \"2015-07-06 18:55:46\",\n \"display_value_internal\": \"2015-07-06 11:55:46\"\n },\n \"on_hold_task\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"sys_domain\": {\n \"display_value\": \"global\",\n \"value\": \"global\"\n },\n \"route_reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"closed_at\": {\n \"display_value\": \"2015-07-06 11:56:23\",\n \"value\": \"2015-07-06 18:56:23\",\n \"display_value_internal\": \"2015-07-06 11:56:23\"\n },\n \"review_comments\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"business_service\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"time_worked\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"chg_model\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"expected_start\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"opened_at\": {\n \"display_value\": \"2015-06-09 11:55:46\",\n \"value\": \"2015-06-09 18:55:46\",\n \"display_value_internal\": \"2015-06-09 11:55:46\"\n },\n \"work_end\": {\n \"display_value\": \"2015-07-06 11:56:10\",\n \"value\": \"2015-07-06 18:56:10\",\n \"display_value_internal\": \"2015-07-06 11:56:10\"\n },\n \"phase_state\": {\n \"display_value\": \"Open\",\n \"value\": \"open\"\n },\n \"cab_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"work_notes\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"close_code\": {\n \"display_value\": \"Successful\",\n \"value\": \"successful\"\n },\n \"assignment_group\": {\n \"display_value\": \"Network\",\n \"value\": \"287ebd7da9fe198100f92cc8d1d2154e\"\n },\n \"description\": {\n \"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\",\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\"\n },\n \"on_hold_reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"calendar_duration\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"close_notes\": {\n \"display_value\": \"Completed without issues\",\n \"value\": \"Completed without issues\"\n },\n \"sys_id\": {\n \"display_value\": \"1766f1de47410200e90d87e8dee490f6\",\n \"value\": \"1766f1de47410200e90d87e8dee490f6\"\n },\n \"contact_type\": {\n \"display_value\": \"Phone\",\n \"value\": \"phone\"\n },\n \"cab_required\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"urgency\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3.0\n },\n \"scope\": {\n \"display_value\": \"Medium\",\n \"value\": 3.0\n },\n \"company\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"justification\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"activity_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"comments\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"approval\": {\n \"display_value\": \"Approved\",\n \"value\": \"approved\"\n },\n \"due_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"sys_mod_count\": {\n \"display_value\": \"10\",\n \"value\": 10.0\n },\n \"on_hold\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"sys_tags\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"conflict_last_run\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"risk_value\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"unauthorized\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"risk\": {\n \"display_value\": \"Moderate\",\n \"value\": 3.0\n },\n \"location\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"category\": {\n \"display_value\": \"Other\",\n \"value\": \"Other\"\n },\n \"risk_impact_analysis\": {\n \"display_value\": \"\",\n \"value\": \"\"\n }\n }\n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/nextstates\n\nRetrieves a list of available states for the specified change request, including the current state.\n\nIf available, it also provides how to transition to the next state based on the version of the implemented Change Management. If the changes are change model driven, the endpoint returns conditions which have passed or not. It also provides information on whether all conditions have passed for a given transition. This information is not available for type driven and legacy change requests.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{change_sys_id}/nextstates`\n\nDefault URL: `/api/sn_chg_rest/change/{change_sys_id}/nextstates`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nchange\\_sys\\_id\n\n\n\nSys\\_id of the change request. Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|404|Not found. The requested item wasn't found.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\navailable\\_states\n\n\n\nValues for the states that are available for the specified change request, including the current state.Data type: Array\n\n
\n\nstate\\_label\n\n\n\nKey-value pairs that associate labels with the available states.Data type: Object\n\n
\n\nstate\\_transitions\n\n\n\nInformation on what is required to transition to each available state. Each distinct available \"to state\" is in its own Array with each differing set of conditions for that to state being in its own Object.Data type: Array\n\n ```\n\"state_transitions\": [\n {\n \"automatic_transition\": Boolean,\n \"conditions\": [Array],\n \"display_value\": \"String\",\n \"from_state\": \"String\",\n \"sys_id\": \"String\",\n \"to_state\": \"String\",\n \"transition_available\": Boolean\n }\n]\n```\n\n
\n\nstate\\_transitions.automatic\\_transition\n\n\n\nFlag that indicates whether to automatically transition to this state.\n\n Valid values:\n\n- true: Change request automatically transitions to this state.\n- false: Change request does not automatically transition to this state.\n\n Data type: Boolean\n\n
\n\nstate\\_transitions.conditions\n\n\n\nList of the conditions associated with the state.Data type: Array of Objects\n\n ```\n\"conditions\": [\n {\n \"condition\": {Object},\n \"passed\": Boolean\n }\n]\n```\n\n
\n\nstate\\_transitions.conditions.condition\n\n\n\nValues of a specific condition.Data type: Object\n\n ```\n\"condition\": {\n \"description\": \"String\",\n \"name\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\n
\n\nstate\\_transitions.conditions.condition.description\n\n\n\nDescription of the condition.Data type: String\n\n
\n\nstate\\_transitions.conditions.condition.name\n\n\n\nName of the condition.Data type: String\n\n
\n\nstate\\_transitions.conditions.condition.sys\\_id\n\n\n\nSys\\_id of the condition.Data type: String\n\n
\n\nstate\\_transitions.conditions.passed\n\n\n\nFlag that indicates whether the change request met the associated condition.\n\n Valid values:\n\n- true: Met the condition.\n- false: Did not meet the condition.\n\n
\n\nstate\\_transitions.display\\_value\n\n\n\nDisplayed description of the state.Data type: String\n\n
\n\nstate\\_transitions.from\\_state\n\n\n\nValue of the state that the change request is transitioning from.Data type: String\n\n
\n\nstate\\_transitions.sys\\_id\n\n\n\nSys\\_id of the transition state.Data type: String\n\n
\n\nstate\\_transitions.to\\_state\n\n\n\nValue of the state that the change request is transitioning to.Data type: String\n\n
\n\nstate\\_transitions.transition\\_available\n\n\n\nFlag that indicates whether the change request can transition from its current state to this state.\n\n Valid values:\n\n- true: Can transition to this state.\n- false: Cannot transition to this state.\n\n
### cURL request\n\nThe following code example shows how to call this endpoint.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f\"/nextstates \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\nReturn results:\n\n```\n{\n \"result\": {\n \"available_states\": [ \"0\", \"4\", \"-1\" ], // State values\n \"state_transitions\": [\n [\n {\n \"sys_id\": \"7a0d2ccdc343101035ae3f52c1d3ae2e\", // sttrm_state_transition sys id\n \"display_value\": \"Implement to Review\",\n \"from_state\": \"-1\",\n \"to_state\": \"0\",\n \"transition_available\": false, // If true, can move to this state\n \"automatic_transition\": true, // If true, automatically moves to this state\n \"conditions\": [\n {\n \"passed\": false, // If true, change request met this condition\n \"condition\": {\n \"name\": \"No active Change Tasks\",\n \"description\": null,\n \"sys_id\": \"3c1d2ccdc343101035ae3f52c1d3aea4\"\n }\n }\n ]\n },\n {\n \"sys_id\": \"db401481c343101035ae3f52c1d3aedd\",\n \"display_value\": \"Implement to Review\",\n \"from_state\": \"-1\",\n \"to_state\": \"0\",\n \"transition_available\": true,\n \"automatic_transition\": false,\n \"conditions\": [\n {\n \"passed\": true,\n \"condition\": {\n \"name\": \"Not On hold\",\n \"description\": null,\n \"sys_id\": \"2132deb6c303101035ae3f52c1d3ae8c\"\n }\n }\n ]\n }\n ],\n [\n {\n \"sys_id\": \"5327c551c343101035ae3f52c1d3aeec\",\n \"display_value\": \"Implement to Canceled\",\n \"from_state\": \"-1\",\n \"to_state\": \"4\",\n \"transition_available\": true,\n \"automatic_transition\": false,\n \"conditions\": []\n }\n ]\n ],\n \"state_label\": { // state value to label pairs\n \"0\": \"Review\",\n \"4\": \"Canceled\",\n \"-1\": \"Implement\"\n }\n }\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/schedule\n\nEnables retrieving the available time slots for a change request.\n\nRole required: sn\\_change\\_writer.\n\n**Note:** Running this endpoint doesn't list the available start and end times. Use the link provided in the response body **worker.link** property to get the schedule data.\n\nSee also:\n\n- [GET /sn\\_chg\\_rest/change/ci/\\{cmdb\\_ci\\_sys\\_id\\}/schedule](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md)\n- [PATCH /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/schedule/first\\_available](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md)\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{change_sys_id}/schedule`\n\nDefault URL: `/api/sn_chg_rest/change/{change_sys_id}/schedule`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nchange\\_sys\\_id\n\n\n\nSys\\_id of the change request on which to find the next available time slot.The selected change request must have a configuration item \\(cmdb\\_ci\\) with planned start and planned end times.\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n202\n\n\n\nSystem accepted the request.\n\n
\n\n400\n\n\n\nBad Request. A bad request type or malformed request was detected. Possible issues:\n\n- The specified change request is missing the planned start and end times.\n- The specified change request doesn't have an associated configuration item \\(cmdb\\_ci\\).\n- User doesn't have read access to the fields of the change request.\n\n
\n\n404\n\n\n\nNot Found. The specified record couldn't be found. Possible issues:\n\n- System can't find the change request based on information provided.\n- User doesn't have read access to the record.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nerror\n\n\n\nInformation on any errors encountered while processing the endpoint request. Data type: Object\n\n ```\n\"error\": {\n \"detail\": \"String\",\n \"message\": \"String\",\n \"status\": \"String\"\n}\n```\n\n
\n\nerror.detail\n\n\n\nAdditional information about the error.Data type: String\n\n
\n\nerror.message\n\n\n\nMessage that identifies the error.Data type: String\n\n
\n\nmessages\n\n\n\nMessage information.Data type: Object\n\n```\n\"messages\": {\n \"errorMessages\": [Array],\n \"infoMessages\": [Array],\n \"warningMessages\": [Array]\n}\n```\n\n
\n\nmessages.errorMessages\n\n\n\nError messages encountered while processing the request. Data type: Array\n\n
\n\nmessages.infoMessages\n\n\n\nInformation messages encountered while processing the request. Data type: Array\n\n
\n\nmessages.warningMessages\n\n\n\nWarning messages encountered while processing the request. Data type: Array\n\n
\n\nrequest\n\n\n\nOriginal endpoint request.Data type: String\n\n
\n\nstate\n\n\n\nInformation on the current state of the worker.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: Number\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nDisplay value of the state of the worker. These values directly correlate to the **state.value** parameter.Possible values:\n\n- Complete\n- Error\n- In-Progress\n- Waiting\n\nData type: String\n\n
\n\nstate.value\n\n\n\nNumeric value of the state of the worker.Possible values:\n\n- 1\n- 2\n- 3\n- 4\n\nData type: Number\n\n
\n\ntype\n\n\n\nType of request.Valid value: schedule\n\nData type: String\n\n
\n\nworker\n\n\n\nInformation about the associated worker.Data type: Object\n\n```\n\"worker\": {\n \"link\": \"String\",\n \"sysId\": \"String\"\n}\n```\n\n
\n\nworker.link\n\n\n\nLink for retrieving time slot data. Use the sys\\_id in [GET /sn\\_chg\\_rest/change/worker/\\{sys\\_id\\}](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) to view results.Data type: String\n\n
\n\nworker.sysId\n\n\n\nSys\\_id of the worker associated with the change request.Data type: String\n\n
\n\nstatus\n\n\n\nOnly appears if an error is encountered. Status of the endpoint processing.Possible value: failure\n\nData type: String\n\n
### Get available time slots\n\nUse the value provided in the **worker.link** to get schedule window details. The value is in the following format:\n\n`https://instance.service-now.com/api/sn_chg_rest/change/worker/`\n\nUse the worker\\_sys\\_id in [GET /sn\\_chg\\_rest/change/worker/\\{worker\\_sys\\_id\\}](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) to view results.\n\nThe response body contains the status and provides results when processing is complete.\n\nWorker response body parameter results vary depending on time slot availability.\n\n- If the provided time slot is available for the change request within the schedule time slot, the worker API lists the available time slots in the **payload.spans** property. The **payload.spans** property isn't listed in the results otherwise.\n- If there are no time slots available for change request duration provided within the defined scheduling time slot, the **messages.infoMessages** states the following: `D`\n\n **Note:** The change request scheduling time slot default value is 90 days. To change this value, modify the **change.conflict.next\\_available.schedule\\_window** property. For more information, see [Configure conflict analysis properties](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/it-service-management/configure-conflict-properties.md).\n\n\nThe following GET /sn\\_chg\\_rest/change/worker/\\{sys\\_id\\} example shows output provided using the ID provided in the worker.link detail. The results list open time spans available for the task duration.\n\n```\n{\n \"result\": {\n \"worker\": {\n \"sysId\": \"9b3f62e0a4c87010f87712198fe9cad1\",\n \"link\": \"https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1\"\n },\n \"request\": \"{\\\"change_sys_id\\\":\\\"87ae5e900a0a2c3e263e8304e727c646\\\",\\\"timezone\\\":\\\"America/Los_Angeles\\\"}\",\n \"state\": {\n \"value\": 3,\n \"display_value\": \"Complete\"\n },\n \"type\": \"schedule\",\n \"messages\": {\n \"errorMessages\": [],\n \"warningMessages\": [],\n \"infoMessages\": []\n },\n \"payload\": {\n \"spans\": [\n {\n \"start\": {\n \"value\": \"2021-05-08 08:00:00\",\n \"display_value\": \"2021-05-08 01:00:00\"\n },\n \"end\": {\n \"value\": \"2021-05-08 11:00:00\",\n \"display_value\": \"2021-05-08 04:00:00\"\n }\n },\n {\n \"start\": {\n \"value\": \"2021-05-15 08:00:00\",\n \"display_value\": \"2021-05-15 01:00:00\"\n },\n \"end\": {\n \"value\": \"2021-05-15 11:00:00\",\n \"display_value\": \"2021-05-15 04:00:00\"\n }\n },\n ...\n ]\n }\n }\n}\n```\n\n### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/change/{change_sys_id}/schedule\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\nResults include worker.link details you can use to run the provided sys\\_id in the GET /sn\\_chg\\_rest/change/worker/ endpoint.\n\n```\n{\n \"result\": {\n \"worker\": {\n \"sysId\": \"9b3f62e0a4c87010f87712198fe9cad1\",\n \"link\": \"https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1\"\n },\n \"request\": \"{\\\"change_sys_id\\\":\\\"87ae5e900a0a2c3e263e8304e727c646\\\",\\\"timezone\\\":\\\"America/Los_Angeles\\\"}\",\n \"state\": {\n \"value\": 1,\n \"display_value\": \"Waiting\"\n },\n \"type\": \"schedule\",\n \"messages\": {\n \"errorMessages\": [],\n \"warningMessages\": [],\n \"infoMessages\": []\n }\n }\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/task\n\nRetrieves one or more tasks associated with a specified change request based on the specified criteria.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{change_sys_id}/task`\n\nDefault URL: `/api/sn_chg_rest/change/{change_sys_id}/task`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nchange\\_sys\\_id\n\n\n\nSys\\_id of the change request whose tasks are to be retrieved.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nkey-value pairs\n\n\n\nFields to modify when creating the request. The key is the field name within the template and the value is the information to populate in the field. Fields that cannot be modified and are ignored if passed in:\n\n- Business rules\n- Read-only fields as defined in ACLs\n- Fields that do not exist\n\nData type: String\n\n
\n\norder\n\n\n\nField by which to sort the returned change requests. Data type: String\n\n
\n\nsysparm\\_limit\n\n\n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. Data type: Number\n\nDefault: 500\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_query\n\n\n\n[Encoded query](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_EncodedQueryStrings.md) used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: `sysparm_query=`. Column names, operators, and values are case-sensitive.\n\n- <col\\_name>: Name of the table column to filter on.\n- <operator>: Supports the following values:\n - `=`: <col\\_name> exactly matches <value>.\n - `!=`: <col\\_name> does not match <value>.\n - `LIKE`: <col\\_name> contains the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `STARTSWITH`: <col\\_name> starts with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `ENDSWITH`: <col\\_name> ends with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `^`: AND operator to add an additional query condition. Records included in the result set match both conditions.\n - `^OR`: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.\n- <value>: Value to filter on.\n\nFor more information about operators, see [Operators available for filters and queries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/r_OpAvailableFiltersQueries.md).\n\nQueries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.\n\n`sysparm_query=caller_id=javascript:gs.getUserID()^active=true`\n\nEncoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the `ORDERBY` and `ORDERBYDESC` clauses in **sysparm\\_query**.\n\nSyntax:\n\n- `ORDERBY`\n- `ORDERBYDESC`\n\nFor example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.\n\n`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory`\n\nBy default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property **glide.invalid\\_query.returns\\_no\\_rows** to `true` to instead return no rows on an invalid query.\n\n**Note:** The **glide.invalid\\_query.returns\\_no\\_rows** property controls the behavior of all queries across the instance, such as in lists, scripts \\(GlideRecord.query\\(\\)\\), and web service APIs.\n\nData type: String\n\n
\n\ntextSearch\n\n\n\nString to use to search all change task record fields. This search uses ServiceNow full text search platform functionality and defaults to `IR_AND_OR_QUERY`.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nAll fields \\(key\\) with their associated values for the identified change request task prior to the delete.Data type: Object\n\n
\n\nparent\n\n\n\nInformation for the change request associated to the task.Data type: Object\n\n```\nparent: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nparent.display\\_value\n\n\n\nChange request information to display in a UI.Data type: String\n\n
\n\nparent.value\n\n\n\nSys\\_id of the change request associated to the task.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request task.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request task to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request task.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?sysparm_query=active=true^ORDERBYnumber\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user 'username':'password'\n\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"12629ec4b750230096c3e4f6ee11a9d5\",\n display_value: \"12629ec4b750230096c3e4f6ee11a9d5\"\n },\n parent: {\n value: \"0f4ac6c4b750230096c3e4f6ee11a9fe \", \n display_value: \"CHG0033046 \"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Retire node\",\n display_value: \"Retire node\"\n }\n }, \n { // next record found }, ... // and so on\n ]\n}\n\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/\\{sys\\_id\\}\n\nRetrieves the change request identified by the specified sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request record.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nElement\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nList containing one or more change request record objects. Each object describes a change request. Each element in the change request object corresponds to a field in its associated record in the Change Request \\[change\\_request\\] table.All elements contain value and display\\_value name-value pairs. Date fields also contain display\\_value\\_internal name-value pairs.\n\nData type: Array\n\n
\n\naction\\_status\n\n\n\nCurrent action status of the associated change request.Possible values:\n\n- 1: Blocked internally\n- 2: Blocked by customer\n- 3: Blocked internally and by customer\n- 4: Needs attention\n\nData type: Number\n\n
\n\nactive\n\n\n\nFlag that indicates whether the change request is active.Possible values:\n\n- true: Change request is active\n- false: Change request isn't active\n\nData type: Boolean\n\nDefault: true\n\n
\n\nactivity\\_due\n\n\n\nDate and time for which the associated case is expected to be completed.Data type: String\n\n
\n\nadditional\\_assignee\\_list\n\n\n\nList of sys\\_ids of additional persons assigned to work on the change request.Data type: Array\n\n
\n\napproval\n\n\n\nType of approval process required.Data type: String\n\nDefault: not requested\n\n
\n\napproval\\_history\n\n\n\nMost recent approval history journal entry.Data type: String\n\n
\n\napproval\\_set\n\n\n\nDate and time that the associated action was approved.Data type: String\n\n
\n\nassigned\\_to\n\n\n\nSys\\_id of the user assigned to the change request.Data type: String\n\n
\n\nassignment\\_group\n\n\n\nSys\\_id of the group assigned to the change request.Data type: String\n\n
\n\nbackout\\_plan\n\n\n\nDescription of the plan to execute if the change must be reversed.Data type: String\n\n
\n\nbusiness\\_duration\n\n\n\nLength in scheduled work hours, work days, and work weeks that it took to complete the change.Data type: String\n\n
\n\nbusiness\\_service\n\n\n\nSys\\_id of the business service associated with the change request. Located in the Service \\[cmdb\\_ci\\_service\\] table.Data type: String\n\n
\n\ncab\\_date\n\n\n\nDate on which the Change Advisory Board \\(CAB\\) meets.Data type: String\n\n
\n\ncab\\_delegate\n\n\n\nSys\\_id of the user that can substitute for the CAB manager during a CAB meeting. Located in the User \\[sys\\_user\\] tableData type: String\n\n
\n\ncab\\_recommendation\n\n\n\nDescription of the CAB recommendations for the change request.Data type: String\n\nMaximum length: 4,000\n\n
\n\ncab\\_required\n\n\n\nFlag that indicates whether the CAB is required.Possible values:\n\n- true: Change Advisory Board is required.\n- false: Change Advisory Board isn't required.\n\nData type: Boolean\n\nDefault: false\n\n
\n\ncalendar\\_duration\n\n\n\nNot currently used by Change Management.Data type: String\n\n
\n\ncategory\n\n\n\nCategory of the change, for example hardware, network, or software.Data type: String\n\nDefault: Other\n\n
\n\nchange\\_plan\n\n\n\nActivities and roles for managing and controlling the change request.Data type: String\n\n
\n\nchg\\_model\n\n\n\nSys\\_id of the change model that the associated change request was based on. The Change Model defines the state flow, transitions, and process activities that must be completed for the change request.Data type: String\n\nTable: Change Model \\[chg\\_model\\]\n\n
\n\nclosed\\_at\n\n\n\nDate and time that the associated change request was closed.Data type: String\n\n
\n\nclosed\\_by\n\n\n\nSys\\_id of the person that closed the change request.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
\n\nclose\\_code\n\n\n\nCode assigned to the change request when it was closed. For example, Successful, Successful with issues, and Unsuccessful.Data type: String\n\n
\n\nclose\\_notes\n\n\n\nNotes that the person entered when closing the change request.Data type: String\n\n
\n\ncmdb\\_ci\n\n\n\nSys\\_id of the configuration item associated with the change request.Data type: String\n\nTable: Configuration Item \\[cmdb\\_ci\\]\n\n
\n\ncomments\n\n\n\nList of customer-facing work notes entered in the associated change request.Data type: Array\n\n
\n\ncomments\\_and\\_work\\_notes\n\n\n\nList of both internal and customer-facing work notes entered for the associated change request.Data type: Array\n\nMaximum length: 4,000\n\n
\n\ncompany\n\n\n\nSys\\_id of the company associated with the change request.Data type: String\n\nTable: Company \\[core\\_company\\]\n\n
\n\nconflict\\_last\\_run\n\n\n\nDate and time that the conflict detection script was last run on the change request.Data type: String\n\n
\n\nconflict\\_status\n\n\n\nCurrent conflict status as detected by the conflict detection script, such as Conflict and Not Run.Data type: String\n\nMaximum length: 40\n\nDefault: Not Run\n\n
\n\ncontact\\_type\n\n\n\nMethod in which the change request was initially requested.Possible values:\n\n- chat\n- email\n- phone\n- social\n- web\n\nData type: String\n\n
\n\ncontract\n\n\n\nSys\\_id of the contract associated with the change request.Data type: String\n\nTable: Contract \\[ast\\_contract\\]\n\n
\n\ncorrelation\\_display\n\n\n\nUser-friendly name for the **correlation\\_id**.Data type: String\n\nMaximum length: 100\n\n
\n\ncorrelation\\_id\n\n\n\nGlobally unique ID \\(GUID\\) of a matching change request record in a third-party system.Data type: String\n\nMaximum length: 100\n\n
\n\ndelivery\\_plan\n\n\n\nNo longer in use. Sys\\_id of the delivery plan associated with the change request.Data type: String\n\nTable: Execution Plan \\[sc\\_cat\\_item\\_delivery\\_plan\\]\n\n
\n\ndelivery\\_task\n\n\n\nNo longer in use. Sys\\_id of the delivery task associated with the change request.Data type: String\n\nTable: Execution Plan Task \\[sc\\_cat\\_item\\_delivery\\_task\\]\n\n
\n\ndescription\n\n\n\nDetailed description of the change request.Data type: String\n\nMaximum length: 4,000\n\n
\n\ndue\\_date\n\n\n\nTask due date. Not used by change request process.Data type: String\n\n
\n\nend\\_date\n\n\n\nDate and time when the change request is to be completed.Data type: String\n\n
\n\nescalation\n\n\n\nCurrent escalation level.Possible values:\n\n- 0: Normal\n- 1: Moderate\n- 2: High\n- 3: Overdue\n\nData type: Number \\(Integer\\)\n\nDefault: 0\n\n
\n\nexpected\\_start\n\n\n\nDate and time when the task is to start. Not used by the change request process.Data type: String\n\n
\n\nfollow\\_up\n\n\n\nDate and time when a user followed-up with the person requesting the change request.Data type: String\n\n
\n\ngroup\\_list\n\n\n\nList of sys\\_ids and names of the groups associated with the change request.Data type: Array\n\nMaximum length: 4,000\n\n
\n\nimpact\n\n\n\nImpact on the change request will have on the customer.Possible values:\n\n- 1: High\n- 2: Medium\n- 3: Low\n\nData type: Number \\(Integer\\)\n\nDefault: 3\n\n
\n\nimplementation\\_plan\n\n\n\nSequential steps to execute to implement this change. It also contains any dependencies between steps and assignee details for each step.Data type: String\n\nMaximum length: 4,000\n\n
\n\njustification\n\n\n\nBenefits of implementing this change and the impact if this change is not implemented.Data type: String\n\nMaximum length: 4,000\n\n
\n\nknowledge\n\n\n\nFlag that indicates whether there are any knowledge base \\(\\)KB\\) articles associated with the change request.Possible values:\n\n- true: Associated KB articles\n- false: No associated KB articles\n\nData type: Boolean\n\n
\n\nlocation\n\n\n\nSys\\_id and name of the location of the equipment referenced in the change request.Data type: String\n\nTable: Location \\[cmn\\_location\\]\n\n
\n\nmade\\_sla\n\n\n\nNo longer used. Flag that indicates whether the change request was implemented in alignment with the associated service level agreement.Data type: Boolean\n\n
\n\nneeds\\_attention\n\n\n\nFlag that indicates whether the change request needs attention.Possible values:\n\n- true: Change request needs additional attention.\n- false: Change request doesn't need additional attention.\n\nData type: Boolean\n\nDefault: false\n\n
\n\nnumber\n\n\n\nChange number assigned to the change request by the system, such as CHG0040007.Data type: String\n\n
\n\non\\_hold\n\n\n\nFlag that indicates whether the change request is currently on hold.Possible values:\n\n- true: On hold\n- false: Not on hold\n\nData type: Boolean\n\nDefault: false\n\n
\n\non\\_hold\\_reason\n\n\n\nIf the **on\\_hold** parameter is \"true\", description of the reason why the change request is being held up.Data type: String\n\nMaximum length: 4,000\n\n
\n\non\\_hold\\_task\n\n\n\nIf the **on\\_hold** parameter is \"true\", list of the sys\\_ids of the tasks that must be completed before the hold is released.Data type: String\n\nMaximum length: 4,000\n\n
\n\nopened\\_at\n\n\n\nDate and time that the change release was created.Data type: String\n\n
\n\nopened\\_by\n\n\n\nSys\\_id and name of the user that created the change release.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
\n\norder\n\n\n\nNot used by Change Management. Optional numeric field by which to order records, such as when retrieving them from a database.Data type: Number \\(Integer\\)\n\n
\n\noutside\\_maintenance\\_schedule\n\n\n\nFlag that indicates whether maintenance by an outside company has been schedule for the change request.Possible values:\n\n- true: Outside maintenance scheduled\n- false: No outside maintenance scheduled\n\nData type: Boolean\n\nDefault: false\n\n
\n\nparent\n\n\n\nSys\\_id and name of the parent task to this change request, if any.Data type: String\n\nTable: Task \\[task\\]\n\n
\n\nphase\n\n\n\nCurrent phase of the change request. This defines what the change is doing in greater detail.Possible values:\n\n- accept\n- build\n- plan\n- requested\n\nData type: String\n\n
\n\nphase\\_state\n\n\n\nChange\\_phase records that should be created for a change. They are dependent on the category, such that each type of change may have different change\\_phase records. The change\\_phase records provide an opportunity to control the approval process as each change\\_phase can have a schedule and a set of approvers.Possible values:\n\n- complete\n- on hold\n- open\n- rejected\n- requested\n- work in progress\n\nData type: String\n\n
\n\npriority\n\n\n\nPriority of the change request.Possible values:\n\n- 1: Critical\n- 2: High\n- 3: Moderate\n- 4: Low\n\nData type: Number \\(Integer\\)\n\nDefault: 4\n\n
\n\nproduction\\_system\n\n\n\nFlag that indicates whether the change request is for a ServiceNow instance that is in a production environment.Possible values:\n\n- true: Production environment\n- false: Non-production environment\n\nData type: Boolean\n\n
\n\nreason\n\n\n\nDescription of why the change request was initiated.Possible values:\n\n- Business requirements\n- Hardware upgrade\n- Legislation\n- Location change\n- Network requirements\n- New or removed CI\n- Other\n- Problem resolved\n- Product or service changed\n- Software upgrade\n- User requested\n\nData type: String\n\nMaximum length: 40\n\n
\n\nreassignment\\_count\n\n\n\nNumber of times that the change request has been reassigned to a new owner.Data type: Number \\(Integer\\)\n\nDefault: 0\n\n
\n\nrejection\\_goto\n\n\n\nSys\\_id of the task to perform if the change request is rejected.Data type: String\n\nTable: Task \\[task\\]\n\n
\n\nrequested\\_by\n\n\n\nSys\\_id of the user that requested the change.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
\n\nrequested\\_by\\_date\n\n\n\nDate and time when the change is requested to be implemented by.Data type: String\n\n
\n\nreview\\_comments\n\n\n\nComments entered when the change request was reviewed.Data type: String\n\nMaximum length: 4,000\n\n
\n\nreview\\_date\n\n\n\nDate that the change request was reviewed.Data type: String\n\n
\n\nreview\\_status\n\n\n\nCurrent status of the requested change request review.Data type: String\n\n
\n\nrisk\n\n\n\nLevel of risk associated with the change request.Valid values:\n\n- 1: High\n- 2: Moderate\n- 3: Low\n\nData type: Number\n\nDefault: 3\n\n
\n\nrisk\\_impact\\_analysis\n\n\n\nDescription of the risk and analysis of implementing the change request.Data type: String\n\nMaximum length: 4,000\n\n
\n\nroute\\_reason\n\n\n\nNot currently used by Change Management. Reason that the change request was transferred.Possible values:\n\n- 1: Transfer with Resolution\n- 9: Transfer without Resolutions\n\nData type: Number\n\n
\n\nscope\n\n\n\nSize of the change request.Possible values:\n\n- 1: Massive\n- 2: Large\n- 3: Medium\n- 4: Small\n- 5: Tiny\n\nData type: Number\n\nDefault: 3\n\n
\n\nservice\\_offering\n\n\n\nSys\\_id of the service offering associated with the change request. Service offerings uniquely define the level of service in terms of availability, scope, pricing, and packaging options.Data type: String\n\nTable: Offering \\[service\\_offering\\]\n\n
\n\nshort\\_description\n\n\n\nDescription of the change request.Data type: String\n\nMaximum length: 40\n\n
\n\nskills\n\n\n\nList of the sys\\_ids of all of the skills required to implement the change request.Data type: Array\n\nTable: Skill \\[cmn\\_skill\\]\n\n
\n\nsla\\_due\n\n\n\nNo longer in use. Date and time that the change request must be completed based on the associated service level agreement.Data type: String\n\n
\n\nsn\\_esign\\_document\n\n\n\nSys\\_id of any E-signed document attached to the change request.Data type: String\n\nTable: Attachment \\[sys\\_attachment\\]\n\n
\n\nsn\\_esign\\_esignature\\_configuration\n\n\n\nSys\\_id of the E-signed signature template used for the associated document.Data type: String\n\nTable: E-signature Template \\[sn\\_esign\\_configuration\\]\n\n
\n\nstart\\_date\n\n\n\nDate and time that the change request is planned to start implementation.Data type: String\n\n
\n\nstate\n\n\n\nCurrent state of the change request. Possible values are defined in the change model.Data type: Number \\(Integer\\)\n\nDefault: 1\n\n
\n\nstd\\_change\\_producer\\_version\n\n\n\nSys\\_id of the record producer and change proposal associated with the change request. It also includes the number and percentage of successful and unsuccessful change requests created from the proposal.Data type: String\n\nTable: Standard Change Template Version \\[std\\_change\\_producer\\_version\\]\n\n
\n\nsys\\_class\\_name\n\n\n\nName of the table in which the change request is located.Data type: String\n\n
\n\nsys\\_created\\_by\n\n\n\nName of the user that initially created the change request.Data type: String\n\nMaximum length: 40\n\n
\n\nsys\\_created\\_on\n\n\n\nDate and time that the associated change request record was originally created.Data type: String\n\n
\n\nsys\\_domain\n\n\n\nIf using domains in the instance, the name of the domain to which the change module record is associated.Data type: String\n\n
\n\nsys\\_domain\\_path\n\n\n\nIf using domains in the instance, the domain path in which the associated change module record resides.Data type: String\n\n
\n\nsys\\_id\n\n\n\nUnique identifier of the associated change request record.Data type: String\n\n
\n\nsys\\_mod\\_count\n\n\n\nNumber of updates to the case since it was initially created.Data type: Number \\(Integer\\)\n\n
\n\nsys\\_updated\\_by\n\n\n\nPerson that last updated the case.Data type: String\n\nMaximum length: 40\n\n
\n\nsys\\_updated\\_on\n\n\n\nDate and time when the case was last updated.Data type: String\n\n
\n\ntask\\_effective\\_number\n\n\n\nUniversal request number.Data type: String\n\nMaximum length: 40\n\n
\n\ntask\\_for\n\n\n\nNot used by Change Management. Sys\\_id of the user that the task was created for.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n
\n\ntest\\_plan\n\n\n\nDescription of the associated test plan for the change.Data type: String\n\nMaximum length: 4,000\n\n
\n\ntime\\_worked\n\n\n\nTotal amount of time worked on the change request.Data type: String\n\n
\n\ntype\n\n\n\nChange request type.Possible values:\n\n- emergency\n- normal\n- standard\n\nData type: String\n\nMaximum length: 40\n\n
\n\nunauthorized\n\n\n\nFlag that indicates whether the change request is unauthorizedPossible values:\n\n- true: Unauthorized\n- false: Authorized\n\nData type: Boolean\n\n
\n\nuniversal\\_request\n\n\n\nSys\\_id of the Parent Universal request to which this change request is a part of.Data type: String\n\nTable: Task \\[task\\]\n\n
\n\nupon\\_approval\n\n\n\nAction to take if the change request is approved.Possible values:\n\n- do\\_nothing\n- proceed\n\nData type: String\n\nMaximum length: 40\n\nDefault: proceed\n\n
\n\nupon\\_reject\n\n\n\nAction to take if the change request is rejected.Possible values:\n\n- cancel\n- goto\n\nData type: String\n\nMaximum length: 40\n\nDefault: cancel\n\n
\n\nurgency\n\n\n\nUrgency of the change request.Possible values:\n\n- 1: High\n- 2: Medium\n- 3: Low\n\nData type: Number \\(Integer\\)\n\nDefault: 3\n\n
\n\nuser\\_input\n\n\n\nAdditional user input.Data type: String\n\nMaximum length: 4,000\n\n
\n\nvariables\n\n\n\nName-value pairs of variables associated with the change request.Data type: String\n\nMaximum length: 40\n\n
\n\nwatch\\_list\n\n\n\nList of sys\\_ids of the users who receive notifications about this change request when additional comments are added or if the state of a change request is changed to Resolved or Closed.Data type: Array\n\nTable: User \\[sys\\_user\\]\n\n
\n\nwf\\_activity\n\n\n\nSys\\_id of the workflow activity record associated with the change request.Data type: String\n\nTable: Workflow Activity \\[wf\\_activity\\]\n\n
\n\nwork\\_end\n\n\n\nDate and time work ended on the change request.Data type: String\n\n
\n\nwork\\_notes\n\n\n\nInformation about how to resolve the change request, or steps taken to resolve it.Data type: String\n\nMaximum length: 4,000\n\n
\n\nwork\\_notes\\_list\n\n\n\nList of sys\\_ids of the internal users who receive notifications about this change request when work notes are added. Data type: Array\n\nTable: User \\[sys\\_user\\]\n\n
\n\nwork\\_start\n\n\n\nDate and time that work started on the change request.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n \"result\":\n {\n \"reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"parent\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"watch_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"proposed_change\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"upon_reject\": {\n \"display_value\": \"Cancel all future Tasks\",\n \"value\": \"cancel\"\n },\n \"sys_updated_on\": {\n \"display_value\": \"2015-07-06 11:59:27\",\n \"value\": \"2015-07-06 18:59:27\",\n \"display_value_internal\": \"2015-07-06 11:59:27\"\n },\n \"type\": {\n \"display_value\": \"Standard\",\n \"value\": \"standard\"\n },\n \"approval_history\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"skills\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"test_plan\": {\n \"display_value\": \"--Confirm that there are no monitoring alerts for the router\",\n \"value\": \"--Confirm that there are no monitoring alerts for the router\"\n },\n \"number\": {\n \"display_value\": \"CHG0000024\",\n \"value\": \"CHG0000024\"\n },\n \"is_bulk\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"cab_delegate\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"requested_by_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"ci_class\": {\n \"display_value\": \"cmdb_ci\",\n \"value\": \"cmdb_ci\"\n },\n \"state\": {\n \"display_value\": \"Closed\",\n \"value\": 3.0\n },\n \"sys_created_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"knowledge\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"order\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"phase\": {\n \"display_value\": \"Requested\",\n \"value\": \"requested\"\n },\n \"cmdb_ci\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"delivery_plan\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"impact\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3.0\n },\n \"contract\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"active\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"work_notes_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"priority\": {\n \"display_value\": \"4 - Low\",\n \"value\": 4.0\n },\n \"sys_domain_path\": {\n \"display_value\": \"/\",\n \"value\": \"/\"\n },\n \"cab_recommendation\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"production_system\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"rejection_goto\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"review_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"requested_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"business_duration\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"group_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"change_plan\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"approval_set\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"wf_activity\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"implementation_plan\": {\n \"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\",\n \"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\"\n },\n \"universal_request\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"end_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"short_description\": {\n \"display_value\": \"Clear BGP sessions on a Cisco router\",\n \"value\": \"Clear BGP sessions on a Cisco router\"\n },\n \"correlation_display\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"work_start\": {\n \"display_value\": \"2015-07-06 11:56:04\",\n \"value\": \"2015-07-06 18:56:04\",\n \"display_value_internal\": \"2015-07-06 11:56:04\"\n },\n \"delivery_task\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"outside_maintenance_schedule\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"additional_assignee_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"std_change_producer_version\": {\n \"display_value\": \"Clear BGP sessions on a Cisco router - 1\",\n \"value\": \"16c2273c47010200e90d87e8dee49006\"\n },\n \"sys_class_name\": {\n \"display_value\": \"Change Request\",\n \"value\": \"change_request\"\n },\n \"service_offering\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"closed_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"follow_up\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"review_status\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"reassignment_count\": {\n \"display_value\": \"2\",\n \"value\": 2.0\n },\n \"start_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"assigned_to\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"variables\": {\n \"display_value\": \"variable_pool\",\n \"value\": \"variable_pool\"\n },\n \"sla_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"comments_and_work_notes\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"escalation\": {\n \"display_value\": \"Normal\",\n \"value\": 0.0\n },\n \"upon_approval\": {\n \"display_value\": \"Proceed to Next Task\",\n \"value\": \"proceed\"\n },\n \"correlation_id\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"made_sla\": {\n \"display_value\": \"true\",\n \"value\": true\n },\n \"backout_plan\": {\n \"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\",\n \"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\"\n },\n \"conflict_status\": {\n \"display_value\": \"Not Run\",\n \"value\": \"Not Run\"\n },\n \"task_effective_number\": {\n \"display_value\": \"CHG0000024\",\n \"value\": \"CHG0000024\"\n },\n \"sys_updated_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"opened_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"user_input\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"sys_created_on\": {\n \"display_value\": \"2015-07-06 11:55:46\",\n \"value\": \"2015-07-06 18:55:46\",\n \"display_value_internal\": \"2015-07-06 11:55:46\"\n },\n \"on_hold_task\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"sys_domain\": {\n \"display_value\": \"global\",\n \"value\": \"global\"\n },\n \"route_reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"closed_at\": {\n \"display_value\": \"2015-07-06 11:56:23\",\n \"value\": \"2015-07-06 18:56:23\",\n \"display_value_internal\": \"2015-07-06 11:56:23\"\n },\n \"review_comments\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"business_service\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"time_worked\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"chg_model\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"expected_start\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"opened_at\": {\n \"display_value\": \"2015-06-09 11:55:46\",\n \"value\": \"2015-06-09 18:55:46\",\n \"display_value_internal\": \"2015-06-09 11:55:46\"\n },\n \"work_end\": {\n \"display_value\": \"2015-07-06 11:56:10\",\n \"value\": \"2015-07-06 18:56:10\",\n \"display_value_internal\": \"2015-07-06 11:56:10\"\n },\n \"phase_state\": {\n \"display_value\": \"Open\",\n \"value\": \"open\"\n },\n \"cab_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"work_notes\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"close_code\": {\n \"display_value\": \"Successful\",\n \"value\": \"successful\"\n },\n \"assignment_group\": {\n \"display_value\": \"Network\",\n \"value\": \"287ebd7da9fe198100f92cc8d1d2154e\"\n },\n \"description\": {\n \"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\",\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\"\n },\n \"on_hold_reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"calendar_duration\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"close_notes\": {\n \"display_value\": \"Completed without issues\",\n \"value\": \"Completed without issues\"\n },\n \"sys_id\": {\n \"display_value\": \"1766f1de47410200e90d87e8dee490f6\",\n \"value\": \"1766f1de47410200e90d87e8dee490f6\"\n },\n \"contact_type\": {\n \"display_value\": \"Phone\",\n \"value\": \"phone\"\n },\n \"cab_required\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"urgency\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3.0\n },\n \"scope\": {\n \"display_value\": \"Medium\",\n \"value\": 3.0\n },\n \"company\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"justification\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"activity_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"comments\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"approval\": {\n \"display_value\": \"Approved\",\n \"value\": \"approved\"\n },\n \"due_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"sys_mod_count\": {\n \"display_value\": \"10\",\n \"value\": 10.0\n },\n \"on_hold\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"sys_tags\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"conflict_last_run\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"risk_value\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"unauthorized\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"risk\": {\n \"display_value\": \"Moderate\",\n \"value\": 3.0\n },\n \"location\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"category\": {\n \"display_value\": \"Other\",\n \"value\": \"Other\"\n },\n \"risk_impact_analysis\": {\n \"display_value\": \"\",\n \"value\": \"\"\n }\n }\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/\\{sys\\_id\\}/ci\n\nRetrieves multiple configuration items \\(CIs\\) associated to a specified change request based on the specified association type.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/ci`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}/ci`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request for which to return the associated CMDB CIs.Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nassociation\\_type\n\n\n\nRequired. Type of association between the CMDB CI and the change request. Valid values:\n\n- affected: CIs that are affected by the change request\n- impacted: Services impacted by the change request\n- offering: Impacted service offerings\n\nData type: String\n\n
\n\nname-value pairs\n\n\n\nName-value pairs to use to filter the result set. The name is the field on which the specified value is filtered. This parameter is mutually exclusive with **sysparm\\_query**. For example, instead of using `&sysparm_query=active=true`, you can simplify the calling statement by using `&active=true`. You can also use the display value when the field is a choice or reference type field, such as `&state=closed` instead of `&state=7`. To specify multiple key-value pairs, separate each with an ampersand, such as `&active=true&assigned_to=john.smith`. Data type: String\n\n
\n\nsysparm\\_limit\n\n\n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. Data type: Number\n\nDefault: 500\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_query\n\n\n\n[Encoded query](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_EncodedQueryStrings.md) used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: `sysparm_query=`. Column names, operators, and values are case-sensitive.\n\n- <col\\_name>: Name of the table column to filter on.\n- <operator>: Supports the following values:\n - `=`: <col\\_name> exactly matches <value>.\n - `!=`: <col\\_name> does not match <value>.\n - `LIKE`: <col\\_name> contains the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `STARTSWITH`: <col\\_name> starts with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `ENDSWITH`: <col\\_name> ends with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `^`: AND operator to add an additional query condition. Records included in the result set match both conditions.\n - `^OR`: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.\n- <value>: Value to filter on.\n\nFor more information about operators, see [Operators available for filters and queries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/r_OpAvailableFiltersQueries.md).\n\nQueries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.\n\n`sysparm_query=caller_id=javascript:gs.getUserID()^active=true`\n\nEncoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the `ORDERBY` and `ORDERBYDESC` clauses in **sysparm\\_query**.\n\nSyntax:\n\n- `ORDERBY`\n- `ORDERBYDESC`\n\nFor example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.\n\n`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory`\n\nBy default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property **glide.invalid\\_query.returns\\_no\\_rows** to `true` to instead return no rows on an invalid query.\n\n**Note:** The **glide.invalid\\_query.returns\\_no\\_rows** property controls the behavior of all queries across the instance, such as in lists, scripts \\(GlideRecord.query\\(\\)\\), and web service APIs.\n\nData type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n200\n\n\n\nSuccessful. The request was successfully processed.\n\n
\n\n400\n\n\n\nBad Request. A bad request type or malformed request was detected. The error response contains pertinent messages to help troubleshoot the problem.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nci\\_item\\|cmdb\\_ci\\_service\n\n\n\nEither the ci\\_item or cmdb\\_ci\\_service variables, depending upon the association type.Data type: Array\n\n```\nci_item|cmdb_ci_service : {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nci\\_item\\|cmdb\\_ci\\_service.value\n\n\n\nSys\\_id of the ci\\_item or cmdb\\_ci\\_service.Data type: String\n\n
\n\nci\\_item\\|cmdb\\_ci\\_service.display\\_value\n\n\n\nDisplay value of the ci\\_item or cmdb\\_ci\\_service.Data type: String\n\n
\n\nsys\\_id\n\n\n\nChange request sys\\_id information.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\n<record\\_fields>\n\n\n\nAll valid fields in the ci\\_item or cmdb\\_ci\\_service record; table based on association type.Data type: Object\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci?association_type=affected\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user 'username':'password'\n\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"92b8544047810200e90d87e8dee490b0\",\n display_value: \"92b8544047810200e90d87e8dee490b0\"\n },\n ci_item|cmdb_ci_service : {\n value: \"3a27d4370a0a0bb4006316812bf45439\", \n display_value: \"PS Apache01\"\n },\n ..., // all valid fields in record, table based on association type\n }, \n { // next record found }, ... // and so on\n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/\\{sys\\_id\\}/conflict\n\nRetrieves the status of the currently running change request conflict checking process or the results of the last completed conflict checking process for the specified change request.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/conflict`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}/conflict`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request for which to return the status of the running/completed conflict checking process.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Current status of the conflict checking process; including conflicts if any are detected.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nconflicts\n\n\n\nList of conflicts found for the change request. An empty object indicates that no conflicts were detected.Data type: Array\n\n
\n\njob\\_status\n\n\n\nStatus of the actual conflict checking job.Data type: String\n\n
\n\nlast\\_run\n\n\n\nDate and time the last conflict checking process started.Data type: String\n\n
\n\nrecord\\_count\n\n\n\nNumber of records checked.Data type: String\n\n
\n\nstatus\n\n\n\nOutcome of the conflict checking process, such as \"Conflict\" or \"Not run\". **Note:** Even if the change request does not have any conflicts, this field is set to \"Conflict.\" However, the **conflicts** object is empty.\n\n Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\nSuccessful response - no conflicts\n\n```\n{\n result: {\n status: \"Conflict\",\n last_run\": \"2018-08-30 12:58:05\",\n record_count: \"1\",\n job_status: \"2\",\n conflicts: []\n }\n}\n```\n\n### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\nSuccessful response - with conflicts\n\n```\n{\n result: {\n status: \"Conflict\",\n last_run\": \"2018-08-30 12:58:05\",\n record_count: \"1\",\n job_status: \"2\",\n conflicts: [\n {\n change: {\n display_value: \"CHG0030001\",\n value: \"afbffb24b758230096c3e4f6ee11a972\"\n },\n type: {\n display_value: \"Not In Maintenance Window\",\n value: \"not_in_maintenance_window\"\n }\n ..., // all valid fields in record, example below\n }\n ]\n }\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/emergency\n\nRetrieves one or more emergency change requests based on the specified criteria.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/emergency`\n\nDefault URL: `/api/sn_chg_rest/change/emergency`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\norder\n\n\n\nField by which to sort the returned change requests. Data type: String\n\nDefault: *number*\n\n
\n\nsysparm\\_limit\n\n\n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. Data type: Number\n\nDefault: 500\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_query\n\n\n\n[Encoded query](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_EncodedQueryStrings.md) used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: `sysparm_query=`. Column names, operators, and values are case-sensitive.\n\n- <col\\_name>: Name of the table column to filter on.\n- <operator>: Supports the following values:\n - `=`: <col\\_name> exactly matches <value>.\n - `!=`: <col\\_name> does not match <value>.\n - `LIKE`: <col\\_name> contains the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `STARTSWITH`: <col\\_name> starts with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `ENDSWITH`: <col\\_name> ends with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `^`: AND operator to add an additional query condition. Records included in the result set match both conditions.\n - `^OR`: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.\n- <value>: Value to filter on.\n\nFor more information about operators, see [Operators available for filters and queries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/r_OpAvailableFiltersQueries.md).\n\nQueries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.\n\n`sysparm_query=caller_id=javascript:gs.getUserID()^active=true`\n\nEncoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the `ORDERBY` and `ORDERBYDESC` clauses in **sysparm\\_query**.\n\nSyntax:\n\n- `ORDERBY`\n- `ORDERBYDESC`\n\nFor example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.\n\n`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory`\n\nBy default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property **glide.invalid\\_query.returns\\_no\\_rows** to `true` to instead return no rows on an invalid query.\n\n**Note:** The **glide.invalid\\_query.returns\\_no\\_rows** property controls the behavior of all queries across the instance, such as in lists, scripts \\(GlideRecord.query\\(\\)\\), and web service APIs.\n\nData type: String\n\n
\n\nkey-value pairs\n\n\n\nName-value pairs to use to filter the result set. The name is the field on which the specified value is filtered. This parameter is mutually exclusive with **sysparm\\_query**. For example, instead of using `&sysparm_query=active=true`, you can simplify the calling statement by using `&active=true`. You can also use the display value when the field is a choice or reference type field, such as `&state=closed` instead of `&state=7`. To specify multiple key-value pairs, separate each with an ampersand, such as `&active=true&assigned_to=john.smith`. Data type: String\n\n
\n\ntextSearch\n\n\n\nString to use to search all emergency change request record fields. This search uses ServiceNow full text search platform functionality and defaults to `IR_AND_OR_QUERY`.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Emergency\".\n\nData type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"emergency\".\n\nData type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?sysparm_query=active=true^ORDERBYnumber\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"1c87925347c12200e0ef563dbb9a7177\",\n display_value: \"1c87925347c12200e0ef563dbb9a7177\"\n },\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n type: {\n value: \"emergency\",\n display_value: \"Emergency\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Reboot server\",\n display_value: \"Reboot server\"\n },\n }, \n { // next record found }, ... // and so on\n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/emergency/\\{sys\\_id\\}\n\nRetrieves the emergency change request identified by the specified sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/emergency/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/emergency/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the emergency change request to retrieve.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Emergency\".\n\nData type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"emergency\".\n\nData type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"b0dbda5347c12200e0ef563dbb9a718f\", \n display_value: \"b0dbda5347c12200e0ef563dbb9a718f\"\n },\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n type: {\n value: \"emergency\",\n display_value: \"Emergency\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Reboot server\",\n display_value: \"Reboot server\"\n },\n },\n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/model\n\nRetrieves one or more change models based on the specified criteria.\n\nUse this endpoint to find a change model that best fits the change request that you are trying to create. For additional information, see Change Models.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/model`\n\nDefault URL: `/api/sn_chg_rest/change/model`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs to use to filter the result set. The name is the field on which the specified value is filtered. This parameter is mutually exclusive with **sysparm\\_query**. For example, instead of using `&sysparm_query=active=true`, you can simplify the calling statement by using `&active=true`. You can also use the display value when the field is a choice or reference type field, such as `&state=closed` instead of `&state=7`. To specify multiple key-value pairs, separate each with an ampersand, such as `&active=true&assigned_to=john.smith`. Data type: String\n\n
\n\norder\n\n\n\nField by which to sort the returned change models.Data type: String\n\nDefault: *name*\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_query\n\n\n\n[Encoded query](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_EncodedQueryStrings.md) used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: `sysparm_query=`. Column names, operators, and values are case-sensitive.\n\n- <col\\_name>: Name of the table column to filter on.\n- <operator>: Supports the following values:\n - `=`: <col\\_name> exactly matches <value>.\n - `!=`: <col\\_name> does not match <value>.\n - `LIKE`: <col\\_name> contains the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `STARTSWITH`: <col\\_name> starts with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `ENDSWITH`: <col\\_name> ends with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `^`: AND operator to add an additional query condition. Records included in the result set match both conditions.\n - `^OR`: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.\n- <value>: Value to filter on.\n\nFor more information about operators, see [Operators available for filters and queries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/r_OpAvailableFiltersQueries.md).\n\nQueries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.\n\n`sysparm_query=caller_id=javascript:gs.getUserID()^active=true`\n\nEncoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the `ORDERBY` and `ORDERBYDESC` clauses in **sysparm\\_query**.\n\nSyntax:\n\n- `ORDERBY`\n- `ORDERBYDESC`\n\nFor example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.\n\n`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory`\n\nBy default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property **glide.invalid\\_query.returns\\_no\\_rows** to `true` to instead return no rows on an invalid query.\n\n**Note:** The **glide.invalid\\_query.returns\\_no\\_rows** property controls the behavior of all queries across the instance, such as in lists, scripts \\(GlideRecord.query\\(\\)\\), and web service APIs.\n\nData type: String\n\n
\n\ntextSearch\n\n\n\nString to use to search all change model record fields. This search uses ServiceNow full text search platform functionality. For more information on ServiceNow search capabilities, see [Search administration](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/search-administration.md).Data type: String\n\nDefault: `IR_AND_OR_QUERY`\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nList containing one or more change model record objects. Each object describes a change model. Each element in the change model object corresponds to a field in its associated record in the Change Model \\[chg\\_model\\] table.All elements contain value and display\\_value name-value pairs. Some contain display\\_value\\_internal name-value pairs.\n\nData type: Array\n\n
\n\nresult.active\n\n\n\nFlag that indicates whether the associated change model record is active and available within the instance.Valid values:\n\n- true: Change model is active.\n- false: Change model isn't active.\n\nData type: Boolean\n\nDefault: true\n\n
\n\nresult.available\\_in\\_ui\n\n\n\nFlag that indicates whether the associated change model record is available within the user interface.Valid values:\n\n- true: Change model is available in the user interface.\n- false: Change model isn't available in the user interface.\n\nData type: Boolean\n\nDefault: true\n\n
\n\nresult.color\n\n\n\nColor of the associated change model on the change request landing page.Data type: String\n\nDefault: \\#cbcbcb\n\n
\n\nresult.default\\_change\\_model\n\n\n\nFlag that indicates whether the associated change model record is the default change model.Valid values:\n\n- true: Default\n- false: Not the default\n\nData type: Boolean\n\nDefault: false\n\n
\n\nresult.description\n\n\n\nShort description of the purpose of the change model.Data type: String\n\nMaximum length: 4,000\n\n
\n\nresult.name\n\n\n\nName of the change model.Data type: String\n\nMaximum length: 200\n\n
\n\nresult.record\\_preset\n\n\n\nName-value pairs of the fields that should automatically be populated, with their associated values, when a new change request record is created. Values are separated by caret symbols.For example:\n\n`\"type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ\"`\n\nData type: String\n\n
\n\nresult.state\\_field\n\n\n\nChoice list field from which to collect choices, based on the provided in **table\\_name**. For change models, this is always set to \"state\".Data type: String\n\n
\n\nresult.sys\\_class\\_name\n\n\n\nChange module table name. Always Change Model/chg\\_model.Data type: String\n\n
\n\nresult.sys\\_created\\_by\n\n\n\nName of the user that initially created the associated change module record. Data type: String\n\n
\n\nresult.sys\\_created\\_on\n\n\n\nDate and time that the change module record was originally created.Data type: String\n\n
\n\nresult.sys\\_domain\n\n\n\nIf using domains in the instance, the name of the domain to which the change module record is associated.Data type: String\n\n
\n\nresult.sys\\_domain\\_path\n\n\n\nIf using domains in the instance, the domain path in which the associated change module record resides.Data type: String\n\n
\n\nresult.sys\\_id\n\n\n\nUnique identifier of the associated change model record.Data type: String\n\n
\n\nresult.sys\\_mod\\_count\n\n\n\nNumber of times that the associated change model record has been modified.Data type: Number\n\n
\n\nresult.sys\\_name\n\n\n\nName of the change model. Always the same as the **name** parameter.Data type: String\n\n
\n\nresult.sys\\_tags\n\n\n\nSystem tags associated with the change model record.Data type: String\n\n
\n\nresult.sys\\_updated\\_by\n\n\n\nName of the user that last updated the associated change model record.Data type: String\n\nMaximum length: 40\n\n
\n\nresult.sys\\_updated\\_on\n\n\n\nDate and time the associated change model record was last updated.Data type: String\n\n
\n\nresult.table\\_name\n\n\n\nTable that defines the Choice list field from which to collect choices. For change models this is always set to \"change\\_request\".Data type: String\n\nMaximum length: 80\n\n
### cURL request\n\nThis example shows a request for obtaining all change model records.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/model \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\nFor brevity, this response only shows a single change model object.\n\n```\n{\n \"result\": [\n {\n \"record_preset\": {\n \"display_value\": \"type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ\",\n \"value\": \"type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ\"\n },\n \"color\": {\n \"display_value\": \"#488df4\",\n \"value\": \"#488df4\"\n },\n \"default_change_model\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"sys_mod_count\": {\n \"display_value\": \"6\",\n \"value\": 6.0\n },\n \"description\": {\n \"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\",\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\"\n },\n \"active\": {\n \"display_value\": \"true\",\n \"value\": true\n },\n \"sys_updated_on\": {\n \"display_value\": \"2020-10-02 06:24:24\",\n \"value\": \"2020-10-02 13:24:24\",\n \"display_value_internal\": \"2020-10-02 06:24:24\"\n },\n \"sys_tags\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"table_name\": {\n \"display_value\": \"change_request\",\n \"value\": \"change_request\"\n },\n \"sys_class_name\": {\n \"display_value\": \"Change Model\",\n \"value\": \"chg_model\"\n },\n \"sys_id\": {\n \"display_value\": \"7840d2515323101034d1ddeeff7b12a6\",\n \"value\": \"7840d2515323101034d1ddeeff7b12a6\"\n },\n \"sys_updated_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"available_in_ui\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"state_field\": {\n \"display_value\": \"state\",\n \"value\": \"state\"\n },\n \"sys_created_on\": {\n \"display_value\": \"2020-09-28 07:33:25\",\n \"value\": \"2020-09-28 14:33:25\",\n \"display_value_internal\": \"2020-09-28 07:33:25\"\n },\n \"name\": {\n \"display_value\": \"Change Registration\",\n \"value\": \"Change Registration\"\n },\n \"sys_name\": {\n \"display_value\": \"Change Registration\",\n \"value\": \"Change Registration\"\n },\n \"sys_created_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n }\n }\n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/model/\\{sys\\_id\\}\n\nRetrieves the change model identified by the specified sys\\_id.\n\nYou can then use this change model to create the desired change request. For additional information on change models, see Change Models.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/model/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/model/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change model record to retrieve from the Change Model \\[chg\\_model\\] table.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nRequested change model record object. Each element in this object corresponds to a field in the record in the Change Model \\[chg\\_model\\] table.All elements contain **value** and **display\\_value** name-value pairs. Some contain **display\\_value\\_internal** name-value pairs.\n\nData type: Object\n\n
\n\nresult.active\n\n\n\nFlag that indicates whether the associated change model record is active and available within the instance.Valid values:\n\n- true: Change model is active.\n- false: Change model isn't active.\n\nData type: Boolean\n\nDefault: true\n\n
\n\nresult.available\\_in\\_ui\n\n\n\nFlag that indicates whether the associated change model record is available within the user interface.Valid values:\n\n- true: Change model is available in the user interface.\n- false: Change model isn't available in the user interface.\n\nData type: Boolean\n\nDefault: true\n\n
\n\nresult.color\n\n\n\nColor of the associated change model on the change request landing page.Data type: String\n\nDefault: \\#cbcbcb\n\n
\n\nresult.default\\_change\\_model\n\n\n\nFlag that indicates whether the associated change model record is the default change model.Valid values:\n\n- true: Default\n- false: Not the default\n\nData type: Boolean\n\nDefault: false\n\n
\n\nresult.description\n\n\n\nShort description of the purpose of the change model.Data type: String\n\nMaximum length: 4,000\n\n
\n\nresult.name\n\n\n\nName of the change model.Data type: String\n\nMaximum length: 200\n\n
\n\nresult.record\\_preset\n\n\n\nName-value pairs of the fields that should automatically be populated, with their associated values, when a new change request record is created. Values are separated by caret symbols.For example:\n\n`\"type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ\"`\n\nData type: String\n\n
\n\nresult.state\\_field\n\n\n\nChoice list field from which to collect choices, based on the provided in **table\\_name**. For change models, this is always set to \"state\".Data type: String\n\n
\n\nresult.sys\\_class\\_name\n\n\n\nChange module table name. Always Change Model/chg\\_model.Data type: String\n\n
\n\nresult.sys\\_created\\_by\n\n\n\nName of the user that initially created the associated change module record. Data type: String\n\n
\n\nresult.sys\\_created\\_on\n\n\n\nDate and time that the change module record was originally created.Data type: String\n\n
\n\nresult.sys\\_domain\n\n\n\nIf using domains in the instance, the name of the domain to which the change module record is associated.Data type: String\n\n
\n\nresult.sys\\_domain\\_path\n\n\n\nIf using domains in the instance, the domain path in which the associated change module record resides.Data type: String\n\n
\n\nresult.sys\\_id\n\n\n\nUnique identifier of the associated change model record.Data type: String\n\n
\n\nresult.sys\\_mod\\_count\n\n\n\nNumber of times that the associated change model record has been modified.Data type: Number\n\n
\n\nresult.sys\\_name\n\n\n\nName of the change model. Always the same as the **name** parameter.Data type: String\n\n
\n\nresult.sys\\_tags\n\n\n\nSystem tags associated with the change model record.Data type: String\n\n
\n\nresult.sys\\_updated\\_by\n\n\n\nName of the user that last updated the associated change model record.Data type: String\n\nMaximum length: 40\n\n
\n\nresult.sys\\_updated\\_on\n\n\n\nDate and time the associated change model record was last updated.Data type: String\n\n
\n\nresult.table\\_name\n\n\n\nTable that defines the Choice list field from which to collect choices. For change models this is always set to \"change\\_request\".Data type: String\n\nMaximum length: 80\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/model/c0efda5347c12200e0ef563dbb9a81e3\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n \"result\": {\n \"record_preset\": {\n \"display_value\": \"type=emergency^EQ\",\n \"value\": \"type=emergency^EQ\"\n },\n \"color\": {\n \"display_value\": \"#ea3423\",\n \"value\": \"#ea3423\"\n },\n \"default_change_model\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"sys_mod_count\": {\n \"display_value\": \"2\",\n \"value\": 2.0\n },\n \"description\": {\n \"display_value\": \"ITIL Mode 1 Emergency Change\",\n \"value\": \"ITIL Mode 1 Emergency Change\"\n },\n \"active\": {\n \"display_value\": \"true\",\n \"value\": true\n },\n \"sys_updated_on\": {\n \"display_value\": \"2020-09-28 08:53:12\",\n \"value\": \"2020-09-28 15:53:12\",\n \"display_value_internal\": \"2020-09-28 08:53:12\"\n },\n \"sys_tags\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"table_name\": {\n \"display_value\": \"change_request\",\n \"value\": \"change_request\"\n },\n \"sys_class_name\": {\n \"display_value\": \"Change Model\",\n \"value\": \"chg_model\"\n },\n \"sys_id\": {\n \"display_value\": \"c0efda5347c12200e0ef563dbb9a81e3\",\n \"value\": \"c0efda5347c12200e0ef563dbb9a81e3\"\n },\n \"sys_updated_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"available_in_ui\": {\n \"display_value\": \"true\",\n \"value\": true\n },\n \"state_field\": {\n \"display_value\": \"state\",\n \"value\": \"state\"\n },\n \"sys_created_on\": {\n \"display_value\": \"2020-09-04 09:16:03\",\n \"value\": \"2020-09-04 16:16:03\",\n \"display_value_internal\": \"2020-09-04 09:16:03\"\n },\n \"name\": {\n \"display_value\": \"Emergency\",\n \"value\": \"Emergency\"\n },\n \"sys_name\": {\n \"display_value\": \"Emergency\",\n \"value\": \"Emergency\"\n },\n \"sys_created_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n }\n }\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/normal\n\nRetrieves one or more normal change requests based on the specified criteria.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/normal`\n\nDefault URL: `/api/sn_chg_rest/change/normal`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs to use to filter the result set. The name is the field on which the specified value is filtered. This parameter is mutually exclusive with **sysparm\\_query**. For example, instead of using `&sysparm_query=active=true`, you can simplify the calling statement by using `&active=true`. You can also use the display value when the field is a choice or reference type field, such as `&state=closed` instead of `&state=7`. To specify multiple key-value pairs, separate each with an ampersand, such as `&active=true&assigned_to=john.smith`. Data type: String\n\n
\n\norder\n\n\n\nField by which to sort the returned change requests. Data type: String\n\n
\n\nsysparm\\_limit\n\n\n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. Data type: Number\n\nDefault: 500\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_query\n\n\n\n[Encoded query](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_EncodedQueryStrings.md) used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: `sysparm_query=`. Column names, operators, and values are case-sensitive.\n\n- <col\\_name>: Name of the table column to filter on.\n- <operator>: Supports the following values:\n - `=`: <col\\_name> exactly matches <value>.\n - `!=`: <col\\_name> does not match <value>.\n - `LIKE`: <col\\_name> contains the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `STARTSWITH`: <col\\_name> starts with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `ENDSWITH`: <col\\_name> ends with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `^`: AND operator to add an additional query condition. Records included in the result set match both conditions.\n - `^OR`: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.\n- <value>: Value to filter on.\n\nFor more information about operators, see [Operators available for filters and queries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/r_OpAvailableFiltersQueries.md).\n\nQueries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.\n\n`sysparm_query=caller_id=javascript:gs.getUserID()^active=true`\n\nEncoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the `ORDERBY` and `ORDERBYDESC` clauses in **sysparm\\_query**.\n\nSyntax:\n\n- `ORDERBY`\n- `ORDERBYDESC`\n\nFor example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.\n\n`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory`\n\nBy default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property **glide.invalid\\_query.returns\\_no\\_rows** to `true` to instead return no rows on an invalid query.\n\n**Note:** The **glide.invalid\\_query.returns\\_no\\_rows** property controls the behavior of all queries across the instance, such as in lists, scripts \\(GlideRecord.query\\(\\)\\), and web service APIs.\n\nData type: String\n\n
\n\ntextSearch\n\n\n\nString to use to search all normal change request record fields. This search uses ServiceNow full text search platform functionality and defaults to `IR_AND_OR_QUERY`.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request prior to the delete.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Normal\".\n\nData type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"normal\".\n\nData type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?sysparm_query=active=true^ORDERBYnumber\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"1c87925347c12200e0ef563dbb9a7177\",\n display_value: \"1c87925347c12200e0ef563dbb9a7177\"\n },\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n type: {\n value: \"normal\",\n display_value: \"Normal\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Add network switch to cabinet\",\n display_value: \"Add network switch to cabinet\"\n },\n },\n { // next record found }, ... // and so on\n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/normal/\\{sys\\_id\\}\n\nRetrieves the normal change request identified by the specified sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/normal/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/normal/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the normal change request to retrieve.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request prior to the delete.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Normal\".\n\nData type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"normal\".\n\nData type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: \"b0dbda5347c12200e0ef563dbb9a718f\",\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n type: {\n value: \"normal\",\n display_value: \"Normal\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Add network switch to cabinet\",\n display_value: \"Add network switch to cabinet\"\n },\n },\n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/standard\n\nRetrieves one or more standard change requests based on the specified criteria.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/standard`\n\nDefault URL: `/api/sn_chg_rest/change/standard`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs to use to filter the result set. The name is the field on which the specified value is filtered. This parameter is mutually exclusive with **sysparm\\_query**. For example, instead of using `&sysparm_query=active=true`, you can simplify the calling statement by using `&active=true`. You can also use the display value when the field is a choice or reference type field, such as `&state=closed` instead of `&state=7`. To specify multiple key-value pairs, separate each with an ampersand, such as `&active=true&assigned_to=john.smith`. Data type: String\n\n
\n\norder\n\n\n\nField by which to sort the returned change requests. Data type: String\n\n
\n\nsysparm\\_limit\n\n\n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. Data type: String\n\n Default: 500\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_query\n\n\n\n[Encoded query](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_EncodedQueryStrings.md) used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: `sysparm_query=`. Column names, operators, and values are case-sensitive.\n\n- <col\\_name>: Name of the table column to filter on.\n- <operator>: Supports the following values:\n - `=`: <col\\_name> exactly matches <value>.\n - `!=`: <col\\_name> does not match <value>.\n - `LIKE`: <col\\_name> contains the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `STARTSWITH`: <col\\_name> starts with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `ENDSWITH`: <col\\_name> ends with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `^`: AND operator to add an additional query condition. Records included in the result set match both conditions.\n - `^OR`: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.\n- <value>: Value to filter on.\n\nFor more information about operators, see [Operators available for filters and queries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/r_OpAvailableFiltersQueries.md).\n\nQueries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.\n\n`sysparm_query=caller_id=javascript:gs.getUserID()^active=true`\n\nEncoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the `ORDERBY` and `ORDERBYDESC` clauses in **sysparm\\_query**.\n\nSyntax:\n\n- `ORDERBY`\n- `ORDERBYDESC`\n\nFor example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.\n\n`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory`\n\nBy default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property **glide.invalid\\_query.returns\\_no\\_rows** to `true` to instead return no rows on an invalid query.\n\n**Note:** The **glide.invalid\\_query.returns\\_no\\_rows** property controls the behavior of all queries across the instance, such as in lists, scripts \\(GlideRecord.query\\(\\)\\), and web service APIs.\n\nData type: String\n\n
\n\ntextSearch\n\n\n\nString to use to search all standard change request record fields. This search uses ServiceNow full text search platform functionality and defaults to `IR_AND_OR_QUERY`.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nAll fields \\(key\\) with their associated values for the identified change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request prior to the delete.Data type: Object\n\n ```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request.Data type: Object\n\n ```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n ```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Standard\".\n\n Data type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"standard\".\n\n Data type: String\n\n
### Sample cURL request\n\n```\ncurl \"https://instance.service-now.com/api/sn_chg_rest/v1/change/standard?sysparm_query=active=true^ORDERBYnumber\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"1c87925347c12200e0ef563dbb9a7177\",\n display_value: \"1c87925347c12200e0ef563dbb9a7177\"\n },\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n type: {\n value: \"standard\",\n display_value: \"Standard\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Add network switch to cabinet\",\n display_value: \"Add network switch to cabinet\"\n },\n }, \n { // next record found }, ... // and so on\n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/standard/\\{sys\\_id\\}\n\nRetrieves the standard change request identified by the specified sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/standard/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/standard/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the standard change request to retrieve.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nAll fields \\(key\\) with their associated values for the identified change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request prior to the delete.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"1c87925347c12200e0ef563dbb9a7177\",\n display_value: \"1c87925347c12200e0ef563dbb9a7177\"\n },\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Add network switch to cabinet\",\n display_value: \"Add network switch to cabinet\"\n },\n }, \n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/standard/template\n\nRetrieves one or more standard change templates based on the specified criteria.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/standard/template`\n\nDefault URL: `/api/sn_chg_rest/change/standard/template`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs to use to filter the result set. The name is the field on which the specified value is filtered. This parameter is mutually exclusive with **sysparm\\_query**. For example, instead of using `&sysparm_query=active=true`, you can simplify the calling statement by using `&active=true`. You can also use the display value when the field is a choice or reference type field, such as `&state=closed` instead of `&state=7`. To specify multiple key-value pairs, separate each with an ampersand, such as `&active=true&assigned_to=john.smith`. Data type: String\n\n
\n\norder\n\n\n\nField by which to sort the returned standard change templates. Data type: String\n\nDefault: Number\n\n
\n\nsysparm\\_limit\n\n\n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval. Data type: Number\n\nDefault: 500\n\n
\n\nsysparm\\_offset\n\n\n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDon't pass a negative number in the **sysparm\\_offset** parameter.Data type: Number\n\nDefault: 0\n\n
\n\nsysparm\\_query\n\n\n\n[Encoded query](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_EncodedQueryStrings.md) used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: `sysparm_query=`. Column names, operators, and values are case-sensitive.\n\n- <col\\_name>: Name of the table column to filter on.\n- <operator>: Supports the following values:\n - `=`: <col\\_name> exactly matches <value>.\n - `!=`: <col\\_name> does not match <value>.\n - `LIKE`: <col\\_name> contains the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `STARTSWITH`: <col\\_name> starts with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `ENDSWITH`: <col\\_name> ends with the specified string <value>. Only works for <col\\_name> fields whose data type is string.\n - `^`: AND operator to add an additional query condition. Records included in the result set match both conditions.\n - `^OR`: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.\n- <value>: Value to filter on.\n\nFor more information about operators, see [Operators available for filters and queries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/r_OpAvailableFiltersQueries.md).\n\nQueries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.\n\n`sysparm_query=caller_id=javascript:gs.getUserID()^active=true`\n\nEncoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the `ORDERBY` and `ORDERBYDESC` clauses in **sysparm\\_query**.\n\nSyntax:\n\n- `ORDERBY`\n- `ORDERBYDESC`\n\nFor example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.\n\n`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory`\n\nBy default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property **glide.invalid\\_query.returns\\_no\\_rows** to `true` to instead return no rows on an invalid query.\n\n**Note:** The **glide.invalid\\_query.returns\\_no\\_rows** property controls the behavior of all queries across the instance, such as in lists, scripts \\(GlideRecord.query\\(\\)\\), and web service APIs.\n\nData type: String\n\n
\n\ntextSearch\n\n\n\nString to use to search all standard change request record fields. This search uses ServiceNow full text search platform functionality and defaults to `IR_AND_OR_QUERY`.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nAll fields with their associated values for the identified standard change template.Data type: Object\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request.Data type: Object\n\n ```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntemplate\n\n\n\nInformation about the standard change template.Data type: Object\n\n ```\ntemplate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\ntemplate.display\\_value\n\n\n\nTemplate information to display in the UI.Data type: String\n\n
\n\ntemplate.value\n\n\n\nTemplate sys\\_id.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template?sysparm_query=active=true^ORDERBYnumber\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"92b8544047810200e90d87e8dee490b0\",\n display_value: \"92b8544047810200e90d87e8dee490b0\"\n },\n template : {\n value: \"1c8e02ec47410200e90d87e8dee49057\", \n display_value: \"Add network switch to datacenter cabinet\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Standard change template to add network switch to cabinet\",\n display_value: \"Standard change template to add network switch to cabinet\"\n },\n }, \n { // next record found }, ... // and so on\n ]\n}\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/standard/template/\\{sys\\_id\\}\n\nRetrieves the standard change template identified by the specified sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/standard/template/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/standard/template/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the standard change template to retrieve.Data type: String\n\nTable: Standard Change Template \\[std\\_change\\_record\\_producer\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nAll fields with their associated values for the identified standard change template.Data type: Object\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntemplate\n\n\n\nInformation about the standard change template.Data type: Object\n\n```\ntemplate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\ntemplate.display\\_value\n\n\n\nTemplate information to display in a UI.Data type: String\n\n
\n\ntemplate.value\n\n\n\nTemplate sys\\_id.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template/92b8544047810200e90d87e8dee490b0\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n result: [\n {\n sys_id: \"92b8544047810200e90d87e8dee490b0\",\n template : {\n value: \"1c8e02ec47410200e90d87e8dee49057\", \n display_value: \"Add network switch to datacenter cabinet\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Standard change template to add network switch to cabinet\",\n display_value: \"Standard change template to add network switch to cabinet\"\n },\n }, \n ]\n}\n\n```\n\n## Change Management - GET /sn\\_chg\\_rest/change/worker/\\{sys\\_id\\}\n\nRetrieves the current status, information, and errors for the specified asynchronous worker.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/worker/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/{change/worker/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change management asynchronous worker.Data type: String\n\nTable: Change Management Worker \\[chg\\_mgt\\_worker\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nmessages\n\n\n\nMessage information.Data type: Object\n\n```\n\"messages\": {\n \"errorMessages\": [Array],\n \"infoMessages\": [Array],\n \"warningMessages\": [Array]\n}\n```\n\n
\n\nmessages.errorMessages\n\n\n\nError messages encountered while processing the request. For example: ```\nInvalid CMDB_CI sys_id provided\n```\n\nData type: Array\n\n
\n\nmessages.infoMessages\n\n\n\nInformation messages encountered while processing the request. For example: ```\nCMDB_CI sys_id already associated to provided.\n```\n\nData type: Array\n\n
\n\nmessages.warningMessages\n\n\n\nWarning messages encountered while processing the request. For example: ```\nInvalid CMDB_CI sys_id provided.\n```\n\nData type: Array\n\n
\n\npayload\n\n\n\nUnique payload provided when using a worker sys\\_id from the successful response body of a scheduling endpoint.- [GET /ci/\\{cmdb\\_ci\\_sys\\_id\\}/schedule](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md)\n- [GET /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/schedule](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md)\n\n```\n\"payload\": {\n \"spans\": [Array]\n}\n```\n\nData type: Object\n\n
\n\npayload.spans\n\n\n\nIf a timespan is available within the duration provided in the schedule endpoint, the worker API lists the available time spans.```\n\"payload\": {\n \"spans\": [\n {\n \"end\": {Object}, \n \"start\": {Object}\n }\n ]\n}\n```\n\nData type: Array\n\n
\n\npayload.spans.start\n\n\n\n```\n\"start\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n Data type: Object\n\n
\n\npayload.spans.start.value\n\n\n\nDate and time that the change request is planned to start implementation.Data type: String\n\n
\n\npayload.spans.start.display\\_value\n\n\n\nDisplays the value of the change request start time.Time format: yyyy-mm-dd hh:mm:ss\n\nData type: String\n\n
\n\npayload.spans.end\n\n\n\n```\n\"end\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n Data type: Object\n\n
\n\npayload.spans.end.value\n\n\n\nDate and time that the change request is planned for completion.Time format: yyyy-mm-dd hh:mm:ss\n\nData type: String\n\n
\n\npayload.spans.end.display\\_value\n\n\n\nDisplays the value of the change request completion time.Data type: String\n\n
\n\nrequest\n\n\n\nOriginal endpoint request.Data type: String\n\n
\n\nstate\n\n\n\nInformation on the current state of the worker.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: Number\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nDisplay value of the state of the worker. These values directly correlate to the **state.value** parameter.Possible values:\n\n- Complete\n- Error\n- In-Progress\n- Waiting\n\nData type: String\n\n
\n\nstate.value\n\n\n\nNumeric value of the state of the worker.Possible values:\n\n- 1\n- 2\n- 3\n- 4\n\nData type: Number\n\n
\n\ntype\n\n\n\nType of association between the CMDB CI and the change request. Data type: String\n\n
\n\nworker\n\n\n\nInformation about the associated worker.Data type: Object\n\n```\n\"worker\": {\n \"link\": \"String\",\n \"sysId\": \"String\"\n}\n```\n\n
\n\nworker.link\n\n\n\nURL to retrieve the status of the associated worker and other worker pertinent information.Data type: String\n\n
\n\nworker.sysId\n\n\n\nSys\\_id of the worker associated with the change request.Data type: String\n\n
\n\n<other\\_params>\n\n\n\nOther parameters that are process-specific, such as **ignored\\_cmdb\\_ci\\_sys\\_ids**.\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/worker/0644cd02dbec330084f07ffdbf9619c1\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\": {\n \"worker\": {\n \"sysId\": \"0644cd02dbec330084f07ffdbf9619c1\",\n \"link\": \"https://instance.service-now.com/api/sn_chg_rest/change/worker/0644cd02dbec330084f07ffdbf9619c1\"\n },\n \"request\": \"{\\\"task\\\":\\\"c286d61347c12200e0ef563dbb9a71df\\\"}\",\n \"state\": {\n \"value\": 3,\n \"display_value\": \"Complete\"\n },\n \"type\": \"impacted\",\n \"messages\": {\n \"errorMessages\": [],\n \"warningMessages\": [],\n \"infoMessages\": []\n }\n }\n}\n```\n\n## Change Management - PATCH /sn\\_chg\\_rest/change/\\{sys\\_id\\}\n\nUpdates the change request identified by the specified sys\\_id with the key-value pairs in the request body or URL.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request to modify.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs representing the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL. Data type: String\n\n
\n\nencrypted\\_fields\n\n\n\nList of comma-separated fields to encrypt. These fields are encrypted before they are stored in the associated record. When specified, the endpoint calls the GlideRecord setDisplayValue\\(\\) method, instead of calling the setValue\\(\\) method.Because of this, you can also use this parameter to pass display values for non-encrypted fields, such as reference or choice fields, instead of passing sys\\_ids or values.\n\nData type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\ndata\n\n\n\nName-value pairs representing the field\\(s\\) to update in the associated change request. For example, to update the short description file, enter a name-value pair similar to the following: `--data \"{\\\"short_description\\\": \\\"my short desc\\\" }\" \\`. Data type: String\n\n
\n\nencrypted\\_fields\n\n\n\nList of comma-separated fields to encrypt. These fields are encrypted before they are stored in the associated record. When specified, the endpoint calls the GlideRecord setDisplayValue\\(\\) method, instead of calling the setValue\\(\\) method.Because of this, you can also use this parameter to pass display values for non-encrypted fields, such as reference or choice fields, instead of passing sys\\_ids or values.\n\nData type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nUpdated change request record. Each element in this object corresponds to a field in the record in the Change Request \\[change\\_request\\] table.All elements contain **value** and **display\\_value** name-value pairs. Some contain **display\\_value\\_internal** name-value pairs.\n\nData type: Object\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request PATCH \\\n--header \"Accept: application/json\" \\\n--header \"Content-Type: application/json\" \\\n--data \"{\\\"short_desription\\\": \\\"Reboot the server at 6 am\\\" }\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n \"result\":\n {\n \"reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"parent\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"watch_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"proposed_change\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"upon_reject\": {\n \"display_value\": \"Cancel all future Tasks\",\n \"value\": \"cancel\"\n },\n \"sys_updated_on\": {\n \"display_value\": \"2015-07-06 11:59:27\",\n \"value\": \"2015-07-06 18:59:27\",\n \"display_value_internal\": \"2015-07-06 11:59:27\"\n },\n \"type\": {\n \"display_value\": \"Standard\",\n \"value\": \"standard\"\n },\n \"approval_history\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"skills\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"test_plan\": {\n \"display_value\": \"--Confirm that there are no monitoring alerts for the router\",\n \"value\": \"--Confirm that there are no monitoring alerts for the router\"\n },\n \"number\": {\n \"display_value\": \"CHG0000024\",\n \"value\": \"CHG0000024\"\n },\n \"is_bulk\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"cab_delegate\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"requested_by_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"ci_class\": {\n \"display_value\": \"cmdb_ci\",\n \"value\": \"cmdb_ci\"\n },\n \"state\": {\n \"display_value\": \"Closed\",\n \"value\": 3.0\n },\n \"sys_created_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"knowledge\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"order\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"phase\": {\n \"display_value\": \"Requested\",\n \"value\": \"requested\"\n },\n \"cmdb_ci\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"delivery_plan\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"impact\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3.0\n },\n \"contract\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"active\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"work_notes_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"priority\": {\n \"display_value\": \"4 - Low\",\n \"value\": 4.0\n },\n \"sys_domain_path\": {\n \"display_value\": \"/\",\n \"value\": \"/\"\n },\n \"cab_recommendation\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"production_system\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"rejection_goto\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"review_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"requested_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"business_duration\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"group_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"change_plan\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"approval_set\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"wf_activity\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"implementation_plan\": {\n \"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\",\n \"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\"\n },\n \"universal_request\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"end_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"short_description\": {\n \"display_value\": \"Reboot the server at 6 am\",\n \"value\": \"Reboot the server at 6 am\"\n },\n \"correlation_display\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"work_start\": {\n \"display_value\": \"2015-07-06 11:56:04\",\n \"value\": \"2015-07-06 18:56:04\",\n \"display_value_internal\": \"2015-07-06 11:56:04\"\n },\n \"delivery_task\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"outside_maintenance_schedule\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"additional_assignee_list\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"std_change_producer_version\": {\n \"display_value\": \"Clear BGP sessions on a Cisco router - 1\",\n \"value\": \"16c2273c47010200e90d87e8dee49006\"\n },\n \"sys_class_name\": {\n \"display_value\": \"Change Request\",\n \"value\": \"change_request\"\n },\n \"service_offering\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"closed_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"follow_up\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"review_status\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"reassignment_count\": {\n \"display_value\": \"2\",\n \"value\": 2.0\n },\n \"start_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"assigned_to\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"variables\": {\n \"display_value\": \"variable_pool\",\n \"value\": \"variable_pool\"\n },\n \"sla_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"comments_and_work_notes\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"escalation\": {\n \"display_value\": \"Normal\",\n \"value\": 0.0\n },\n \"upon_approval\": {\n \"display_value\": \"Proceed to Next Task\",\n \"value\": \"proceed\"\n },\n \"correlation_id\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"made_sla\": {\n \"display_value\": \"true\",\n \"value\": true\n },\n \"backout_plan\": {\n \"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\",\n \"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\"\n },\n \"conflict_status\": {\n \"display_value\": \"Not Run\",\n \"value\": \"Not Run\"\n },\n \"task_effective_number\": {\n \"display_value\": \"CHG0000024\",\n \"value\": \"CHG0000024\"\n },\n \"sys_updated_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"opened_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"user_input\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"sys_created_on\": {\n \"display_value\": \"2015-07-06 11:55:46\",\n \"value\": \"2015-07-06 18:55:46\",\n \"display_value_internal\": \"2015-07-06 11:55:46\"\n },\n \"on_hold_task\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"sys_domain\": {\n \"display_value\": \"global\",\n \"value\": \"global\"\n },\n \"route_reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"closed_at\": {\n \"display_value\": \"2015-07-06 11:56:23\",\n \"value\": \"2015-07-06 18:56:23\",\n \"display_value_internal\": \"2015-07-06 11:56:23\"\n },\n \"review_comments\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"business_service\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"time_worked\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"chg_model\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"expected_start\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"opened_at\": {\n \"display_value\": \"2015-06-09 11:55:46\",\n \"value\": \"2015-06-09 18:55:46\",\n \"display_value_internal\": \"2015-06-09 11:55:46\"\n },\n \"work_end\": {\n \"display_value\": \"2015-07-06 11:56:10\",\n \"value\": \"2015-07-06 18:56:10\",\n \"display_value_internal\": \"2015-07-06 11:56:10\"\n },\n \"phase_state\": {\n \"display_value\": \"Open\",\n \"value\": \"open\"\n },\n \"cab_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"work_notes\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"close_code\": {\n \"display_value\": \"Successful\",\n \"value\": \"successful\"\n },\n \"assignment_group\": {\n \"display_value\": \"Network\",\n \"value\": \"287ebd7da9fe198100f92cc8d1d2154e\"\n },\n \"description\": {\n \"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\",\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\"\n },\n \"on_hold_reason\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"calendar_duration\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"close_notes\": {\n \"display_value\": \"Completed without issues\",\n \"value\": \"Completed without issues\"\n },\n \"sys_id\": {\n \"display_value\": \"b0dbda5347c12200e0ef563dbb9a718f\",\n \"value\": \"b0dbda5347c12200e0ef563dbb9a718f\"\n },\n \"contact_type\": {\n \"display_value\": \"Phone\",\n \"value\": \"phone\"\n },\n \"cab_required\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"urgency\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3.0\n },\n \"scope\": {\n \"display_value\": \"Medium\",\n \"value\": 3.0\n },\n \"company\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"justification\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"activity_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"comments\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"approval\": {\n \"display_value\": \"Approved\",\n \"value\": \"approved\"\n },\n \"due_date\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"sys_mod_count\": {\n \"display_value\": \"10\",\n \"value\": 10.0\n },\n \"on_hold\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"sys_tags\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"conflict_last_run\": {\n \"display_value\": \"\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"risk_value\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"unauthorized\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"risk\": {\n \"display_value\": \"Moderate\",\n \"value\": 3.0\n },\n \"location\": {\n \"display_value\": \"\",\n \"value\": \"\"\n },\n \"category\": {\n \"display_value\": \"Other\",\n \"value\": \"Other\"\n },\n \"risk_impact_analysis\": {\n \"display_value\": \"\",\n \"value\": \"\"\n }\n }\n}\n```\n\n### cURL request\n\nThe following example shows how to pass encrypted fields in the request body.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request PATCH \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\n \\\"encrypted_fields\\\":\\\"short_description,description\\\",\n \\\"short_description\\\":\\\"my short desc\\\",\n \\\"description\\\":\\\"my desc\\\"\n}\" \\\n--user \"username\":\"password\"\n```\n\n### cURL request\n\nThe following example shows how to pass encrypted fields as query parameters.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc\" \\\n--request PATCH \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{}\" \\\n--user \"username\":\"password\"\n```\n\n## Change Management - PATCH /sn\\_chg\\_rest/change/\\{sys\\_id\\}/approvals\n\nAllows the current user to approve or reject a change request approval record for the specified change request.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/approvals`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}/approvals`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request for which the approval/rejection applies.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ncomments\n\n\n\nRequired if **state** is `rejected`. Reason that the change was rejected.Data type: String\n\n
\n\nstate\n\n\n\nRequired. Approval state. For example: `--data \"{\\\"state\\\": \\\"approved\\\"}\"`\n\nValid values:\n\n- approved\n- rejected\n\nData type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|400|Bad request. Indicates a bad request type such as the user not having the authority to approve or reject the change request.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: Object\n\n
\n\nstate\n\n\n\nCurrent state of the change request.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request being approved/rejected.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Possible values:\n\n- Emergency\n- Normal\n- Standard\n\nData type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Possible values:\n\n- emergency\n- normal\n- standard\n\nData type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/approvals\" \\\n--request POST \\\n--header \"Accept: application/json\" \\\n--header \"Content-Type: application/json\" \\\n--data \"{\\\"state\\\": \\\"approved\\\"}\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: \"0f4ac6c4b750230096c3e4f6ee11a9fe\",\n state: {\n value: \"-2\", \n display_value: \"Scheduled\"\n },\n type: {\n value: \"normal\",\n display_value: \"Normal\"\n },\n ..., // all valid fields in record, single parameter example below\n short_description: {\n value: \"Remove server\",\n display_value: \"Remove server\"\n }\n }\n ]\n}\n```\n\n## Change Management - PATCH /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/schedule/first\\_available\n\nUpdates the planned start and end times of a change request using the first available time slot found.\n\nRole required: sn\\_change\\_writer.\n\n**Note:** Use the link provided in the response body **worker.link** property to view the schedule status.\n\nSee also:\n\n- [GET /sn\\_chg\\_rest/change/ci/\\{cmdb\\_ci\\_sys\\_id\\}/schedule](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md)\n- [GET /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/schedule](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md)\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{change_sys_id}/schedule/first_available`\n\nDefault URL: `/api/sn_chg_rest/change/{change_sys_id}/schedule/first_available`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nchange\\_sys\\_id\n\n\n\nSys\\_id of the change request on which to update with the next available time slot. The selected change request must have a configuration item \\(cmdb\\_ci\\).Data type: String\n\nTable: Change Requests \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nduration\\_in\\_seconds\n\n\n\nDuration of change in seconds, that is, how much time is required to complete the change request task.Data type: Integer\n\n
\n\nplanned\\_start\\_time\n\n\n\nOptional. Date and time that the change request is planned to start implementation in UTC.Retrieve the available time slot start at or later than this time. If not provided, the system uses the current time as the start time.\n\nFormat: yyyy-mm-dd hh:mm:ss\n\nData type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n202\n\n\n\nSystem accepted the request.\n\n
\n\n400\n\n\n\nBad Request. A bad request type or malformed request was detected. Possible issues:\n\n- The duration\\_in\\_seconds body parameter value is invalid or was not provided.\n- Invalid planned\\_start\\_time body parameter value provided.\n- The specified change request doesn't have an associated configuration item \\(cmdb\\_ci\\).\n- User doesn't have read access to the fields of the change request.\n\n
\n\n403\n\n\n\nForbidden. User does not have write access to the planned start and end date values of the change request.\n\n
\n\n404\n\n\n\nNot Found. The specified record couldn't be found. Possible issues:\n\n- System can't find the change request based on information provided.\n- User doesn't have read access to the record.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nerror\n\n\n\nInformation on any errors encountered while processing the endpoint request. Data type: Object\n\n```\n\"error\": {\n \"detail\": \"String\",\n \"message\": \"String\",\n \"status\": \"String\"\n}\n```\n\n
\n\nerror.detail\n\n\n\nAdditional information about the error.Data type: String\n\n
\n\nerror.message\n\n\n\nMessage that identifies the error.Data type: String\n\n
\n\nmessages\n\n\n\nMessage information.Data type: Object\n\n```\n\"messages\": {\n \"errorMessages\": [Array],\n \"infoMessages\": [Array],\n \"warningMessages\": [Array]\n}\n```\n\n
\n\nmessages.errorMessages\n\n\n\nError messages encountered while processing the request. Data type: Array\n\n
\n\nmessages.infoMessages\n\n\n\nInformation messages encountered while processing the request. Data type: Array\n\n
\n\nmessages.warningMessages\n\n\n\nWarning messages encountered while processing the request. Data type: Array\n\n
\n\nrequest\n\n\n\nOriginal endpoint request.Data type: String\n\n
\n\nstate\n\n\n\nInformation on the current state of the worker.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: Number\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nDisplay value of the state of the worker. These values directly correlate to the **state.value** parameter.Possible values:\n\n- Complete\n- Error\n- In-Progress\n- Waiting\n\nData type: String\n\n
\n\nstate.value\n\n\n\nNumeric value of the state of the worker.Possible values:\n\n- 1\n- 2\n- 3\n- 4\n\nData type: Number\n\n
\n\ntype\n\n\n\nType of request.Valid value: schedule\n\nData type: String\n\n
\n\nworker\n\n\n\nInformation about the associated worker.Data type: Object\n\n```\n\"worker\": {\n \"link\": \"String\",\n \"sysId\": \"String\"\n}\n```\n\n
\n\nworker.link\n\n\n\nLink for retrieving change request schedule status. Use the sys\\_id in [GET /sn\\_chg\\_rest/change/worker/\\{sys\\_id\\}](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) to view results.Data type: String\n\n
\n\nworker.sysId\n\n\n\nSys\\_id of the worker associated with the change request.Data type: String\n\n
\n\nstatus\n\n\n\nOnly appears if an error is encountered. Status of the endpoint processing.Possible value: failure\n\nData type: String\n\n
### Get change request schedule status\n\nUse the value provided in the **worker.link** to determine if the change record has been successfully scheduled for the first available time slot. The value is in the following format:\n\n`https://instance.service-now.com/api/sn_chg_rest/change/worker/`\n\nUse the worker.link details to run the provided sys\\_id in [GET /sn\\_chg\\_rest/change/worker/\\{sys\\_id\\}](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) to view results.\n\nThe response body contains the status and provides results when processing is complete.\n\nIf an available time slot is found, the system updates the change request with the first available slot. When the state is complete, the **messages.infoMessages** reveals that the first available time slot has been set.\n\nOne of the following scheduling response values for **messages.infoMessages** are provided in the response body:\n\n- `Change has been updated` – Change requested has been updated for time slot.\n- `No slots found for days from now` – No time slots available for change request duration provided within the number of days defined in the schedule window.\n\n **Note:** The change request scheduling time slot default value is 90 days. To change this value, modify the **change.conflict.next\\_available.schedule\\_window** property. For more information, see [Configure conflict analysis properties](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/it-service-management/configure-conflict-properties.md).\n\n\nThe following GET /sn\\_chg\\_rest/change/worker/\\{sys\\_id\\} example shows output provided using the ID provided in the worker.link detail. The results indicate that processing is complete and the change request has been updated with the first available time slot.\n\n```\n{\n \"result\": {\n \"worker\": {\n \"sysId\": \"355c62e0a4c87010f87712198fe9cacf\",\n \"link\": \"https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf\"\n },\n \"request\": \"{\\\"change_sys_id\\\":\\\"87ae5e900a0a2c3e263e8304e727c646\\\",\\\"duration_in_seconds\\\":10800,\\\"timezone\\\":\\\"America/Los_Angeles\\\"}\",\n \"state\": {\n \"value\": 3,\n \"display_value\": \"Complete\"\n },\n \"type\": \"schedule\",\n \"messages\": {\n \"errorMessages\": [],\n \"warningMessages\": [],\n \"infoMessages\": [\n \"Change has been updated\"\n ]\n }\n }\n}\n```\n\n### cURL request\n\n```\ncurl \"https://instance.service-now.com/api/sn_chg_rest/change/87ae5e900a0a2c3e263e8304e727c646/schedule/first_available\" \\\n--request PATCH \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\\\"duration_in_seconds\\\":\\\"10800\\\"}\" \\\n--user \"username\":\"password\"\n\n```\n\nResults include worker.link details you can use to run the provided sys\\_id in the GET /sn\\_chg\\_rest/change/worker/ endpoint.\n\n```\n{\n \"result\": {\n \"worker\": {\n \"sysId\": \"355c62e0a4c87010f87712198fe9cacf\",\n \"link\": \"https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf\"\n },\n \"request\": \"{\\\"change_sys_id\\\":\\\"87ae5e900a0a2c3e263e8304e727c646\\\",\\\"duration_in_seconds\\\":10800,\\\"timezone\\\":\\\"America/Los_Angeles\\\"}\",\n \"state\": {\n \"value\": 1,\n \"display_value\": \"Waiting\"\n },\n \"type\": \"schedule\",\n \"messages\": {\n \"errorMessages\": [],\n \"warningMessages\": [],\n \"infoMessages\": []\n }\n }\n}\n```\n\n## Change Management - PATCH /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/task/\\{task\\_sys\\_id\\}\n\nUpdates the change request task identified by the specified sys\\_ids with the key-value pairs in the request body or the URL.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{change_sys_id}/task/{task_sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nchange\\_sys\\_id\n\n\n\nSys\\_id of the change request to which the task is associated. Verifies whether the specified task is associated with the specified change request.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
\n\ntask\\_sys\\_id\n\n\n\nSys\\_id of the task to modify.Data type: String\n\nTable: Change Task \\[change\\_task\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nkey-value pairs\n\n\n\nName-value pairs representing the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\ndata\n\n\n\nName-value pairs representing the field\\(s\\) to update in the associated change request. For example, to update the short description file, enter a name-value pair similar to the following: `--data \"{\\\"short_description\\\": \\\"my short desc\\\" }\" \\`. Data type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nAll fields \\(key\\) with their associated values for the identified change request task prior to the delete.Data type: Object\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request task.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request task to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request task.Data type: String\n\n
\n\nparent\n\n\n\nUnique identifier information for the change request associated to this task.Data type: Object\n\n```\nparent: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nparent.display\\_value\n\n\n\nTask information to display in a UI.Data type: String\n\n
\n\nparent.value\n\n\n\nSys\\_id of the parent task.Data type: String\n\n
\n\n\\_\\_meta.ignoredFields\n\n\n\nKey-value pairs that were passed in the call, but weren't applied to the change request as they either don't exist in the base record or the fields are read-only. Data type: Array\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5?short_description=Retire both nodes\" \\\n--request PATCH \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type: application/json\" \\\n--data \"{\\\"state\\\": \\\"assess\\\", \\\"no_such_field\\\": \\\"this will be ignored\\\" }\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"12629ec4b750230096c3e4f6ee11a9d5\",\n display_value: \"12629ec4b750230096c3e4f6ee11a9d5\"\n },\n parent: {\n value: \"0f4ac6c4b750230096c3e4f6ee11a9fe\", \n display_value: \"CHG0033046 \"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Retire both nodes\",\n display_value: \"Retire both nodes\"\n }\n __meta: {\n ignoredFields: [\"no_such_field\"]\n }\n }\n ]\n}\n```\n\n## Change Management - PATCH /sn\\_chg\\_rest/change/emergency/\\{sys\\_id\\}\n\nUpdates the emergency change request identified by the specified sys\\_id with the key-value pairs in the request body or the URL.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/emergency/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/emergency/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request to modify.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs representing the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\ndata\n\n\n\nName-value pairs representing the field\\(s\\) to update in the associated change request. For example, to update the short description file, enter a name-value pair similar to the following: `--data \"{\\\"short_description\\\": \\\"my short desc\\\" }\" \\`. Data type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: String\n\n
\n\nstate\n\n\n\nCurrent state of the change request.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Emergency\".\n\nData type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"emergency\".\n\nData type: String\n\n
\n\n\\_\\_meta.ignoredFields\n\n\n\nName-value pairs that were passed in the call, but were not applied to the change request as they either do not exist in the base record or the fields are read-only.Data type: Array\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f\" \\\n--request PATCH \\\n--header \"Accept: application/json\" \\\n--header \"Content-Type: application/json\" \\\n--data \"{\\\"no_such_field\\\": \\\"this will be ignored\\\", }\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n result: [\n {\n sys_id: \"b0dbda5347c12200e0ef563dbb9a718f\", },\n state: {\n value: \"-4\", \n display_value: \"Assess\"\n },\n type: {\n value: \"emergency\",\n display_value: \"Emergency\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Reboot server\",\n display_value: \"Reboot server\"\n }\n __meta: {\n ignoredFields: [\"no_such_field\"]\n }\n }\n ]\n}\n```\n\n## Change Management - PATCH /sn\\_chg\\_rest/change/normal/\\{sys\\_id\\}\n\nUpdates the normal change request identified by the specified sys\\_id with the parameters in the request body or the URL.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/normal/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/normal/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request to modify.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs representing the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\ndata\n\n\n\nName-value pairs representing the field\\(s\\) to update in the associated change request. For example, to update the short description file, enter a name-value pair similar to the following: `--data \"{\\\"short_description\\\": \\\"my short desc\\\" }\" \\`. Data type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: Object\n\n
\n\nstate\n\n\n\nCurrent state of the change request.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Normal\".\n\nData type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"normal\".\n\nData type: String\n\n
\n\n\\_\\_meta.ignoredFields\n\n\n\nName-value pairs that were passed in the call, but were not applied to the change request as they either do not exist in the base record or the fields are read-only.Data type: Array\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f?state=assess\" \\\n--request PATCH \\\n--header \"Accept: application/json\" \\\n--header \"Content-Type: application/json\" \\\n--data \"{\\\"state\\\": \\\"assess\\\", \\\"no_such_field\\\": \\\"this will be ignored\\\" }\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: \"b0dbda5347c12200e0ef563dbb9a718f\",\n state: {\n value: \"-4\", \n display_value: \"Assess\"\n },\n type: {\n value: \"normal\",\n display_value: \"Normal\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Remove server\",\n display_value: \"Remove server\"\n }\n __meta: {\n ignoredFields: [\"no_such_field\"]\n }\n }\n ]\n}\n```\n\n## Change Management - PATCH /sn\\_chg\\_rest/change/standard/\\{sys\\_id\\}\n\nUpdates the standard change request identified by the specified sys\\_id with the parameters in the request body or in the URL.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/standard/{sys_id}`\n\nDefault URL: `/api/sn_chg_rest/change/standard/{sys_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request to modify.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs representing the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\ndata\n\n\n\nName-value pairs representing the field\\(s\\) to update in the associated change request. For example, to update the short description file, enter a name-value pair similar to the following: `--data \"{\\\"short_description\\\": \\\"my short desc\\\" }\" \\`. Data type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nAll fields \\(key\\) with their associated values for the identified change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request.Data type: Object\n\n```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI.Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the change request.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to disply in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177?description=Reboot my email server\" \\\n--request PATCH \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\\\"short_description\\\": \\\"my short desc\\\" }\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"1c87925347c12200e0ef563dbb9a7177\",\n display_value: \"1c87925347c12200e0ef563dbb9a7177\"\n },\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Reboot my email server\",\n display_value: \"Reboot my email server\"\n },\n } \n ]\n}\n```\n\n## Change Management - PATCH /sn\\_chg\\_rest/change/standard/\\{sys\\_id\\}/risk\n\nCalculates the risk and impact of the specified standard change based on an evaluation of the risk conditions.\n\nIf the Change Risk Assessment plugin is installed, it also calculates the cumulative highest risk once the risk assessment is complete.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/risk`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}/risk`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the standard change to evaluate.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Risk assessment completed successfully.|\n|400|Risk assessment failed. Details of the type of failure are included in the error data.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not found. The requested item wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nimpact\n\n\n\nImpact associated with the specified standard change.Data type: Object\n\n```\nimpact: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nimpact.display\\_value\n\n\n\nImpact information to display in a UI.Data type: String\n\n
\n\nimpact.value\n\n\n\nInternal impact value.Data type: String\n\n
\n\nname-value pairs\n\n\n\nAll valid fields within the standard change record.Data type: Object\n\n
\n\nrisk\n\n\n\nRisk calculated for the specified standard change.Data type: Object\n\n```\nrisk: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nrisk.display\\_value\n\n\n\nRisk information to display in a UI.Data type: String\n\n
\n\nrisk.value\n\n\n\nInternal risk value.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information for the standard change request.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/1c87925347c12200e0ef563dbb9a7177/risk\" \\\n--request PATCH \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n sys_id: {\n value: \"1c87925347c12200e0ef563dbb9a7177\",\n display_value: \"1c87925347c12200e0ef563dbb9a7177\"\n },\n risk: {\n value: \"4\", \n display_value: \"Low\"\n },\n impact: {\n value: \"3\",\n display_value: \"3 - Low\"\n }\n ..., // all valid fields in record\n}\n```\n\n## Change Management - POST /sn\\_chg\\_rest/change\n\nCreates a change request record based on the change request. Creating multiple change requests within a single call isn’t supported.\n\nYou can obtain the list of available change models using the [Change Management - GET /sn\\_chg\\_rest/change/model](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) or [Change Management - GET /sn\\_chg\\_rest/change/model/\\{sys\\_id\\}](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/change-management-api.md) endpoints.\n\nWhen creating a change request, set the change model \\(**chg\\_model**\\) or **type**. If both **chg\\_model**and **type** are set, the type is simply a categorization of the change. Not providing at least one of these values results in a default setting that is subject to change by release. It is strongly advised to set at least one of these values.\n\nValues can be set either as a query parameter or request body parameter.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change`\n\nDefault URL: `/api/sn_chg_rest/change`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs representing the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL. The same values can be set as request body parameters instead.**Note:** When creating a change request, set the change model \\(**chg\\_model**\\) or **type**. If both **chg\\_model**and **type** are set, the type is simply a categorization of the change. Not providing at least one of these values results in a default setting that is subject to change by release. It is strongly advised to set at least one of these values.\n\nData type: String\n\n
\n\nchg\\_model\n\n\n\nName of a change model listed in the Change Model \\[chg\\_model\\] table. Provided in the following format: `chg_model=Normal`.\n\nFor more information, see Change models.\n\n**Note:** Not providing either the change model \\(**chg\\_model**\\) or **type** value results in a default setting that is subject to change by release. It is strongly advised to set at least one of these values.\n\nData type: String\n\n
\n\nencrypted\\_fields\n\n\n\nList of comma-separated fields to encrypt. These fields are encrypted before they are stored in the associated record. When specified, the endpoint calls the GlideRecord setDisplayValue\\(\\) method, instead of calling the setValue\\(\\) method.Because of this, you can also use this parameter to pass display values for non-encrypted fields, such as reference or choice fields, instead of passing sys\\_ids or values.\n\nData type: String\n\n
\n\ntype\n\n\n\nName of the change request type listed in the Choices \\[sys\\_choice\\] table. If the **chg\\_model** is also populated, this field is only used as a change categorization. Provided in the following format: `type=Normal`.\n\nFor more information, see [Add a new change request type](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/it-service-management/t_AddNewChangeType.md).\n\n**Note:** Not providing either the change model \\(**chg\\_model**\\) or **type** value results in a default setting that is subject to change by release. It is strongly advised to set at least one of these values.\n\nData type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nObject\n\n\n\nName-value pairs representing the field\\(s\\) to update in the associated change request. For example, to update the short description file, enter a name-value pair similar to the following: `--data \"{\\\"short_description\\\": \\\"my short desc\\\" }\" \\`. The same properties can be set as query parameters instead.Data type: String\n\n
\n\nObject.chg\\_model\n\n\n\nName of a change model listed in the Change Model \\[chg\\_model\\] table. Provided as a name-value pair in the following format: `{\"chg_model\" : \"Cloud Infrastructure\"}`\n\nFor more information, see Change models.\n\n**Note:** Not providing either the change model \\(**chg\\_model**\\) or **type** value results in a default setting that is subject to change by release. It is strongly advised to set at least one of these values.\n\nData type: String\n\n
\n\nObject.encrypted\\_fields\n\n\n\nList of comma-separated fields to encrypt. These fields are encrypted before they are stored in the associated record. When specified, the endpoint calls the GlideRecord setDisplayValue\\(\\) method, instead of calling the setValue\\(\\) method.Because of this, you can also use this parameter to pass display values for non-encrypted fields, such as reference or choice fields, instead of passing sys\\_ids or values.\n\nData type: String\n\n
\n\nObject.type\n\n\n\nName of the change request type listed in the Choices \\[sys\\_choice\\] table. If the **chg\\_model** is also populated, this field is only used as a change categorization. Provided as a name-value pair in the following format: `{\"type\" : \"emergency\"}`\n\nFor more information, see [Add a new change request type](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/it-service-management/t_AddNewChangeType.md).\n\n**Note:** Not providing either the change model \\(**chg\\_model**\\) or **type** value results in a default setting that is subject to change by release. It is strongly advised to set at least one of these values.\n\nData type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nNew change request record. The elements of this object correspond to the record format in the Change Request \\[change\\_request\\] table. All values that are not specified in the request are set to their defaults or are empty/null.Data type: Object\n\n
### cURL request\n\nThe following example shows how to create a change request record based on the Standard change model and Standard type. In this example, the Change Request is driven by the model and the type field is only used as a categorization.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\n \\\"chg_model\\\" : \\\"Standard\\\",\n \\\"description\\\" : \\\"Describes the change request.\\\",\n \\\"short_description\\\" : \\\"My change request\\\",\n \\\"type\\\" : \\\"Standard\\\"\n}\" \\\n--user \"username\":\"password\"\n```\n\nResults show that the record was successfully added to the Change Request \\[change\\_request\\] table with the value `CHG0030022`.\n\n```\n{\n \"result\": \n \"upon_reject\": {\n \"display_value\": \"Cancel all future Tasks\",\n \"value\": \"cancel\"\n },\n \"sys_updated_on\": {\n \"display_value\": \"2022-12-08 17:18:57\",\n \"value\": \"2022-12-09 01:18:57\",\n \"display_value_internal\": \"2022-12-08 17:18:57\"\n },\n \"type\": {\n \"display_value\": \"Standard\",\n \"value\": \"standard\"\n }\n \"number\": {\n \"display_value\": \"CHG0030022\",\n \"value\": \"CHG0030022\"\n },\n \"is_bulk\": {\n \"display_value\": \"false\",\n \"value\": false\n }\n \"ci_class\": {\n \"display_value\": \"cmdb_ci\",\n \"value\": \"cmdb_ci\"\n },\n \"state\": {\n \"display_value\": \"New\",\n \"value\": -5\n },\n \"sys_created_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"knowledge\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"phase\": {\n \"display_value\": \"Requested\",\n \"value\": \"requested\"\n }\n \"impact\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3\n },\n \"active\": {\n \"display_value\": \"true\",\n \"value\": true\n },\n \"priority\": {\n \"display_value\": \"4 - Low\",\n \"value\": 4\n },\n \"sys_domain_path\": {\n \"display_value\": \"/\",\n \"value\": \"/\"\n },\n \"production_system\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"requested_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n }\n \"short_description\": {\n \"display_value\": \"My change request\",\n \"value\": \"My change request\"\n },\n \"sys_class_name\": {\n \"display_value\": \"Change Request\",\n \"value\": \"change_request\"\n },\n \"reassignment_count\": {\n \"display_value\": \"0\",\n \"value\": 0\n },\n \"variables\": {\n \"display_value\": \"variable_pool\",\n \"value\": \"variable_pool\"\n },\n \"sla_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"escalation\": {\n \"display_value\": \"Normal\",\n \"value\": 0\n },\n \"upon_approval\": {\n \"display_value\": \"Proceed to Next Task\",\n \"value\": \"proceed\"\n },\n \"conflict_status\": {\n \"display_value\": \"Not Run\",\n \"value\": \"Not Run\"\n },\n \"task_effective_number\": {\n \"display_value\": \"CHG0030022\",\n \"value\": \"CHG0030022\"\n },\n \"sys_updated_by\": {\n \"display_value\": \"admin\",\n \"value\": \"admin\"\n },\n \"opened_by\": {\n \"display_value\": \"System Administrator\",\n \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n },\n \"sys_created_on\": {\n \"display_value\": \"2022-12-08 17:18:57\",\n \"value\": \"2022-12-09 01:18:57\",\n \"display_value_internal\": \"2022-12-08 17:18:57\"\n },\n \"sys_domain\": {\n \"display_value\": \"global\",\n \"value\": \"global\"\n },\n \"chg_model\": {\n \"display_value\": \"Standard\",\n \"value\": \"e55d0bfec343101035ae3f52c1d3ae49\"\n },\n \"opened_at\": {\n \"display_value\": \"2022-12-08 17:18:57\",\n \"value\": \"2022-12-09 01:18:57\",\n \"display_value_internal\": \"2022-12-08 17:18:57\"\n },\n \"description\": {\n \"display_value\": \"Describes the change request.\",\n \"value\": \"Describes the change request.\"\n },\n \"sys_id\": {\n \"display_value\": \"2ac52dd77c6b1510f877be3b096e64fe\",\n \"value\": \"2ac52dd77c6b1510f877be3b096e64fe\"\n },\n \"cab_required\": {\n \"display_value\": \"false\",\n \"value\": false\n },\n \"urgency\": {\n \"display_value\": \"3 - Low\",\n \"value\": 3\n },\n \"scope\": {\n \"display_value\": \"Medium\",\n \"value\": 3\n },\n \"activity_due\": {\n \"display_value\": \"UNKNOWN\",\n \"value\": \"\",\n \"display_value_internal\": \"\"\n },\n \"approval\": {\n \"display_value\": \"Not Yet Requested\",\n \"value\": \"not requested\"\n },\n }\n}\n```\n\n### cURL request\n\nThe following example shows how to pass encrypted fields in the request body.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{\n \\\"encrypted_fields\\\":\\\"short_description,description\\\",\n \\\"short_description\\\":\\\"my short desc\\\",\n \\\"description\\\":\\\"my desc\\\"\n}\" \\\n--user \"username\":\"password\"\n```\n\n### cURL request\n\nThe following example shows how to pass encrypted fields as query parameters.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{}\" \\\n--user \"username\":\"password\"\n```\n\n## Change Management - POST /sn\\_chg\\_rest/change/\\{sys\\_id\\}/ci\n\nCreates the association between a change request and Configuration Management Database \\(CMDB\\) configuration items \\(CI\\).\n\nThe creation of the association is done asynchronously, which means that a response is provided immediately and contains details for the worker. The worker does the actual work after the response.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/ci`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}/ci`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request to associate with the CMDB CI.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nassociation\\_type\n\n\n\nRequired. Type of association between the CMDB CI and the change request. Valid values:\n\n - affected: CIs that are affected by the change request\n- impacted: Services impacted by the change request\n- offering: Impacted service offerings\n\n Data type: String\n\n
\n\ncmdb\\_ci\\_sys\\_ids\n\n\n\nRequired. List of CMDB CI sys\\_ids to associate to the change request.Data type: Array or comma-separated string\n\n
\n\nrefresh\\_impacted\\_services\n\n\n\nFlag used when `association_type=affected` to populate impacted services based on the list of affected CIs.Valid values:\n\n - true: Populate impacted services based on the list of affected CIs\n- false: Do not automatically populate impacted services\n\n Data type: Boolean\n\n Default: false\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nStatus code\n\n\n\nDescription\n\n
\n\n202\n\n\n\nAccepted. The request was accepted for processing.\n\n
\n\n400\n\n\n\nBad Request. A bad request type or malformed request was detected. The error response contains pertinent messages to help troubleshoot the problem.\n\n
\n\n401\n\n\n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n
\n\n404\n\n\n\nNot found. The requested item wasn't found.\n\n
\n\n500\n\n\n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n
### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nmessages\n\n\n\nMessage information.Data type: Object\n\n```\n\"messages\": {\n \"errorMessages\": [Array],\n \"infoMessages\": [Array],\n \"warningMessages\": [Array]\n}\n```\n\n
\n\nmessages.errorMessages\n\n\n\nError messages encountered while processing the request. For example: ```\nInvalid CMDB_CI sys_id provided\n```\n\n Data type: Array\n\n
\n\nmessages.infoMessages\n\n\n\nInformation messages encountered while processing the request. For example: ```\nCMDB_CI sys_id already associated to provided.\n```\n\n Data type: Array\n\n
\n\nmessages.warningMessages\n\n\n\nWarning messages encountered while processing the request. For example: ```\nInvalid CMDB_CI sys_id provided.\n```\n\n Data type: Array\n\n
\n\nrequest\n\n\n\nOriginal endpoint request.Data type: String\n\n
\n\nstate\n\n\n\nInformation on the current state of the worker.```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nDisplay value of the state of the worker. These values directly correlate to the **state.value** element.Possible values:\n\n - Complete\n- Error\n- In-Progress\n- Waiting\n\n Data type: String\n\n
\n\nstate.value\n\n\n\nNumeric value of the state of the worker.Possible values:\n\n - 1\n- 2\n- 3\n- 4\n\n Data type: Number\n\n
\n\ntype\n\n\n\nType of association between the CMDB CI and the change request. Data type: String\n\n
\n\nworker\n\n\n\nInformation about the associated worker.Data type: Object\n\n ```\n\"worker\": {\n \"link\": \"String\",\n \"sysId\": \"String\"\n}\n```\n\n
\n\nworker.link\n\n\n\nURL to retrieve the status of the associated worker and other worker pertinent information.Data type: String\n\n
\n\nworker.sysId\n\n\n\nSys\\_id of the worker associated with the change request.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\\n--data \"{cmdb_ci_sys_ids:'caf043a3b7fb23000999e4f6ee11a9c0,06f043a3b7fb23000999e4f6ee11a9c1', association_type:'affected'}\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n \"result\": {\n \"worker\": {\n \"sysId\": \"f490f4c6dbac330084f07ffdbf961952\",\n \"link\": \"instance.service-now.com/api/sn_chg_rest/change/worker/f490f4c6dbac330084f07ffdbf961952\"\n },\n \"request\": \"{\\\"cmdb_ci_sys_ids\\\":[\\\"caf043a3b7fb23000999e4f6ee11a9c0\\\",\\\"06f043a3b7fb23000999e4f6ee11a9c1\\\"],\\\"association_type\\\":\\\"affected\\\",\\\"task\\\":\\\"c286d61347c12200e0ef563dbb9a71df\\\"}\",\n \"state\": {\n \"value\": 1,\n \"display_value\": \"Waiting\"\n },\n \"type\": \"affected\",\n \"messages\": {\n \"errorMessages\": [],\n \"warningMessages\": [],\n \"infoMessages\": []\n }\n }\n}\n```\n\n## Change Management - POST /sn\\_chg\\_rest/change/\\{sys\\_id\\}/conflict\n\nStarts a change request conflict checking process for the specified change request \\(sys\\_id\\).\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/conflict`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}/conflict`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change management request for which to start the conflict checking process. For additional information on the conflict checking process, see [Conflict detection](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/it-service-management/c_ConflictDetection.md).Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Request was unable to start due to unresolvable errors. The returned message may provide additional details.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not found. The requested item wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nresult\n\n\n\nSys\\_id of the change request conflict checking process.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: \"c0b5afe4b710230096c3e4f6ee11a93f\"\n}\n```\n\n## Change Management - POST /sn\\_chg\\_rest/change/emergency\n\nCreates one emergency change request based on the default emergency change request record. Multiple emergency change request creations within a single call is not supported.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/emergency`\n\nDefault URL: `/api/sn_chg_rest/change/emergency`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nkey-value pairs\n\n\n\nKey-value pairs of fields to modify when creating the request. The key is the field name within the template and the value is the information to populate in the field.Fields that cannot be modified and are ignored if passed in:\n\n- Business rules\n- Read-only fields as defined in ACLs\n- Fields that do not exist\n\n Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs of the fields that were created in the emergency change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the change request prior to the delete.Data type: Object\n\n ```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI. Value is always \"New\".\n\n Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value. Value is always \"-5\".\n\n Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the newly created emergency change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n ```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Emergency\".\n\n Data type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"emergency\".\n\n Data type: String\n\n
\n\n\\_\\_meta.ignoredFields\n\n\n\nKey-value pairs that were passed in the call, but weren't applied to the change request as they either don't exist in the base record or the fields are read-only. Data type: Array\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?no_such_field=something&description=test&short_description=Reboot server\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\n```\n{\n result: [\n {\n sys_id: \"b0dbda5347c12200e0ef563dbb9a718f\",\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n type: {\n value: \"emergency\",\n display_value: \"Emergency\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Reboot server\",\n display_value: \"Reboot server\"\n }\n __meta: {\n ignoredFields: [\"no_such_field\"]\n }\n }\n ]\n}\n```\n\n## Change Management - POST /sn\\_chg\\_rest/change/normal\n\nCreates one normal change request based on the default normal change request record. Multiple normal change request creations within a single call is not supported.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/normal`\n\nDefault URL: `/api/sn_chg_rest/change/normal`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nkey-value pairs\n\n\n\nFields to modify when creating the request. The key is the field name within the template and the value is the information to populate in the field.Fields that cannot be modified and are ignored if passed in:\n\n- Business rules\n- Read-only fields as defined in ACLs\n- Fields that do not exist\n\n Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nValues for all fields in the associated change request.Data type: Object\n\n
\n\nstate\n\n\n\nState of the newly created change request.Data type: Object\n\n ```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nState to display in a UI. Value is always \"New\".\n\n Data type: String\n\n
\n\nstate.value\n\n\n\nInternal state value. Value is always \"-5\".\n\n Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the newly created normal change request.Data type: String\n\n
\n\ntype\n\n\n\nType of change request.Data type: Object\n\n ```\ntype: {\n display_value: \"String\",\n value: \"String\"\n}\n```\n\n
\n\ntype.display\\_value\n\n\n\nChange type to display in a UI.Value is always \"Normal\".\n\n Data type: String\n\n
\n\ntype.value\n\n\n\nInternal type value.Value is always \"normal\".\n\n Data type: String\n\n
\n\n\\_\\_meta.ignoredFields\n\n\n\nKey-value pairs that were passed in the call, but weren't applied to the change request as they either don't exist in the base record or the fields are read-only. Data type: Array\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?no_such_field=something&description=test&short_description=Remove server\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: \"b0dbda5347c12200e0ef563dbb9a718f\",\n state: {\n value: \"-5\", \n display_value: \"New\"\n },\n type: {\n value: \"normal\",\n display_value: \"Normal\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Remove server\",\n display_value: \"Remove server\"\n }\n __meta: {\n ignoredFields: [\"no_such_field\"]\n }\n }\n ]\n}\n```\n\n## Change Management - POST /sn\\_chg\\_rest/change/\\{sys\\_id\\}/refresh\\_impacted\\_services\n\nPopulates the impacted services/configuration items \\(CIs\\) related list based on the primary CI.\n\nThe primary CI appears on the change request form and affected CI related list.\n\n**Note:** All work items for this endpoint are performed asynchronously.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/refresh_impacted_services`\n\nDefault URL: `/api/sn_chg_rest/change/{sys_id}/refresh_impacted_services`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the change request to use to refresh the impacted services.Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nmessages\n\n\n\nMessage information.Data type: Object\n\n```\n\"messages\": {\n \"errorMessages\": [Array],\n \"infoMessages\": [Array],\n \"warningMessages\": [Array]\n}\n```\n\n
\n\nmessages.errorMessages\n\n\n\nError messages encountered while processing the request. For example: ```\nInvalid CMDB_CI sys_id provided\n```\n\n Data type: Array\n\n
\n\nmessages.infoMessages\n\n\n\nInformation messages encountered while processing the request. For example: ```\nCMDB_CI sys_id already associated to provided.\n```\n\n Data type: Array\n\n
\n\nmessages.warningMessages\n\n\n\nWarning messages encountered while processing the request. For example: ```\nInvalid CMDB_CI sys_id provided.\n```\n\n Data type: Array\n\n
\n\nrequest\n\n\n\nOriginal endpoint request.Data type: String\n\n
\n\nstate\n\n\n\nInformation on the current state of the worker.Data type: Object\n\n ```\nstate: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nstate.display\\_value\n\n\n\nDisplay value of the state of the worker. These values directly correlate to the **state.value** element.Possible values:\n\n - Complete\n- Error\n- In-Progress\n- Waiting\n\n Data type: String\n\n
\n\nstate.value\n\n\n\nNumeric value of the state of the worker.Possible values:\n\n - 1\n- 2\n- 3\n- 4\n\n Data type: Number\n\n
\n\ntype\n\n\n\nType of association between the CMDB CI and the change request. Data type: String\n\n
\n\nworker\n\n\n\nInformation about the associated worker.Data type: Object\n\n ```\n\"worker\": {\n \"link\": \"String\",\n \"sysId\": \"String\"\n}\n```\n\n
\n\nworker.link\n\n\n\nURL to retrieve the status of the associated worker and other worker pertinent information.Data type: String\n\n
\n\nworker.sysId\n\n\n\nSys\\_id of the worker associated with the change request.Data type: String\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/refresh_impacted_services\" \\ \n--request POST \\ \n--header \"Accept:application/json\" \\\n--header \"Content-Type:application/json\" \\ \n--user \"username\":\"password\"\n```\n\n```\n{ \n result: { \n worker: { \n sysId: \"aa31c308b75033000999e4f6ee11a9c2\", \n link: \"http://instance.service-now.com/api/sn_chg_rest/change/worker/aa31c308b75033000999e4f6ee11a9c2\" \n }, \n request: \"\", \n state: { \n value: 1, \n display_value: \"Waiting\" \n }, \n type: \"impacted\", \n messages: { \n errorMessages: [], \n warningMessages: [], \n infoMessages: [] \n } \n } \n} \n```\n\n## Change Management - POST /sn\\_chg\\_rest/change/standard/\\{standard\\_change\\_template\\_id\\}\n\nCreates one standard change request based on an existing standard change template as specified by the passed-in template sys\\_id. Multiple standard change request creations within a single call is not supported.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/standard/{standard_change_template_id}`\n\nDefault URL: `/api/sn_chg_rest/change/standard/{standard_change_template_id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nParameter\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nstandard\\_change\\_template\\_id\n\n\n\nSys\\_id of the standard change template on which to base the new standard change request.Data type: String\n\nTable: Standard Change Template \\[std\\_change\\_record\\_producer\\]\n\n
\n
\n\nParameter\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nFields within the specified standard change template to modify when creating the request. The key is the field name within the template and the value is the information to populate in the field.Fields that cannot be modified and are ignored if passed in:\n\n- Description\n- Backout plan\n- Test plan\n- Implementation plan\n- Read-only fields as defined in ACLs\n- Fields that do not exist in the specified standard change template\n\nData type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body\n\nThe API returns these JSON or XML elements in the response body.\n\n\n
\n\nElement\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs of the fields that were created in the standard change request.Data type: Object\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information of the newly created standard change request.Data type: Object\n\n```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the standard change request to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the standard change request.Data type: String\n\n
\n\n\\_\\_meta.ignoredFields\n\n\n\nKey-value pairs that were passed in the call, but weren't applied to the change request as they either don't exist in the base record or the fields are read-only. Data type: Array\n\n
### Sample cURL request\n\n```\ncurl \"https://instance.servicenow.com\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"1c87925347c12200e0ef563dbb9a7177\",\n display_value: \"1c87925347c12200e0ef563dbb9a7177\"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Add network switch to cabinet\",\n display_value: \"Add network switch to cabinet\"\n }\n __meta: {\n ignoredFields: [\"no_such_field\"]\n }\n }\n ]\n}\n```\n\n## Change Management - POST /sn\\_chg\\_rest/change/\\{change\\_sys\\_id\\}/task\n\nCreates one change request task based on the default change request task record and associates it with the specified change request. Multiple change request task creations within a single call is not supported.\n\n### URL format\n\nVersioned URL: `/api/sn_chg_rest/{api_version}/change/{change_sys_id}/task`\n\nDefault URL: `/api/sn_chg_rest/change/{change_sys_id}/task`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n
\n\nchange\\_sys\\_id\n\n\n\nSys\\_id of the change request to which to associate this task.Data type: String\n\nTable: Change Request \\[change\\_request\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\nkey-value pairs\n\n\n\nFields to modify when creating the request. The key is the field name within the template and the value is the information to populate in the field. Fields that cannot be modified and are ignored if passed in:\n\n- Business rules\n- Read-only fields as defined in ACLs\n- Fields that do not exist\n\n Data type: String\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Request completed successfully.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|401|Unauthorized. The user credentials are incorrect or have not been passed.|\n|404|Not Found. The specified record couldn't be found.|\n|500|Internal Server Error. A logic error on the server-side code occurred.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nname-value pairs\n\n\n\nName-value pairs of the fields that were created in the change request task.Data type: Object\n\n
\n\nparent\n\n\n\nInformation for the change request associated to the task.Data type: Object\n\n ```\nparent: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nparent.display\\_value\n\n\n\nInformation to display in the UI for the change request associated to the task.Data type: String\n\n
\n\nparent.value\n\n\n\nSys\\_id of the change request associated to the task.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id information of the newly created change request task.Data type: Object\n\n ```\nsys_id: {\n display_value: \"String\", \n value: \"String\"\n}\n```\n\n
\n\nsys\\_id.display\\_value\n\n\n\nSys\\_id of the change request task to display in a UI.Data type: String\n\n
\n\nsys\\_id.value\n\n\n\nSys\\_id of the change request task.Data type: String\n\n
\n\n\\_\\_meta.ignoredFields\n\n\n\nKey-value pairs that were passed in the call, but weren't applied to the change request as they either don't exist in the base record or the fields are read-only. Data type: Array\n\n
### cURL request\n\n```\ncurl \"https://instance.servicenow.com/api/now/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?short_description=Retire node&no_such_field=test\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n\n```\n\n```\n{\n result: [\n {\n sys_id: {\n value: \"12629ec4b750230096c3e4f6ee11a9d5\",\n display_value: \"12629ec4b750230096c3e4f6ee11a9d5\"\n },\n parent: {\n value: \"0f4ac6c4b750230096c3e4f6ee11a9fe \", \n display_value: \"CHG0033046 \"\n },\n ..., // all valid fields in record, example below\n short_description: {\n value: \"Retire node\",\n display_value: \"Retire node\"\n }\n __meta.ignoredFields\": [\"no_such_field\"]\n }\n ]\n}\n```\n\n"}}