Change Management API

parent: {
  display_value: "String", 
  value: "String"
}

sys_id: {
  display_value: "String", 
  value: "String"
}

state: {
  display_value: "String", 
  value: "String"
}

sys_id: {
  display_value: "String", 
  value: "String"
}

type: {
  display_value: "String",
  value: "String"
}

state: {
  display_value: "String", 
  value: "String"
}

type: {
  display_value: "String",
  value: "String"
}

</td></tr><tr><td>

state.display\_value

</td><td>

State to display in the UI.Data type: String

</td></tr><tr><td>

state.value

</td><td>

Internal state value.Data type: String

</td></tr><tr><td>

sys\_id

</td><td>

Unique identifier of the change request.

</td></tr></tbody>
</table>

### cURL request

## Change Management - GET /sn\_chg\_rest/change/ci/\{cmdb\_ci\_sys\_id\}/schedule

Enables retrieving available time slots by configuration item ID and duration, with an option to include planned start time.

Role required: sn\_change\_writer.

**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.

See also:

-   [GET /sn\_chg\_rest/change/\{change\_sys\_id\}/schedule](change-management-api.md)
-   [PATCH /sn\_chg\_rest/change/\{change\_sys\_id\}/schedule/first\_available](change-management-api.md)

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/ci/{cmdb_ci_sys_id}/schedule`

Default URL: `/api/sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

cmdb\_ci\_sys\_id

</td><td>

Sys\_id of the configuration item record. This endpoint doesn't require a change request.Data type: String

Table: Configuration Items \[cmdb\_ci\]

</td></tr></tbody>
</table>

<table id="table_fd4_yhf_jpb" class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

duration\_in\_seconds

</td><td>

Duration of change in seconds, that is, how much time is required to complete the change request task.Data type: Integer

</td></tr><tr><td>

planned\_start\_time

</td><td>

Optional. 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.

Format: yyyy-mm-dd hh:mm:ss

Data type: String

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

<table><thead><tr><th>

Status code

</th><th>

Description

</th></tr></thead><tbody><tr><td>

202

</td><td>

System accepted the request.

</td></tr><tr><td>

400

</td><td>

Bad Request. A bad request type or malformed request was detected. Possible issues:

-   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.
-   The duration\_in\_seconds query parameter value wasn't provided.
-   Invalid duration\_in\_seconds or planned\_start\_time query parameter value provided.

</td></tr></tbody>
</table>

### Response body parameters \(JSON or XML\)

<table id="table_is2_n4s_jpb"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr id="row-result-error-cmdb"><td>

error

</td><td>

Information on any errors encountered while processing the endpoint request. Data type: Object

</td></tr><tr id="row-result-error_detail-cmdb"><td>

error.detail

</td><td>

Additional information about the error.Data type: String

</td></tr><tr id="row-result-error_message-cmdb"><td>

error.message

</td><td>

Message that identifies the error.Data type: String

</td></tr><tr><td>

messages

</td><td>

Message information.Data type: Object

</td></tr><tr><td>

messages.errorMessages

</td><td>

Error messages encountered while processing the request. Data type: Array

</td></tr><tr><td>

messages.infoMessages

</td><td>

Information messages encountered while processing the request. Data type: Array

</td></tr><tr><td>

messages.warningMessages

</td><td>

Warning messages encountered while processing the request. Data type: Array

</td></tr><tr><td>

request

</td><td>

Original endpoint request.Data type: String

</td></tr><tr><td>

state

</td><td>

Information on the current state of the worker.Data type: Object

</td></tr><tr><td>

state.display\_value

</td><td><p>Display value of the state of the worker. These values directly correlate to the <strong>state.value</strong> parameter.Possible values:</p>
<ul>
<li>Complete</li>
<li>Error</li>
<li>In-Progress</li>
<li>Waiting</li>
</ul>
<p>Data type: String</p></td></tr><tr><td>

state.value

</td><td>

Numeric value of the state of the worker.Possible values:

-   1
-   2
-   3
-   4

Data type: Number

</td></tr><tr><td>

type

</td><td>

Type of request.Valid value: schedule

Data type: String

</td></tr><tr><td>

worker

</td><td>

Information about the associated worker.Data type: Object

</td></tr><tr><td>

worker.link

</td><td>

Link for retrieving time slot data. Use the sys\_id in <a href="./">GET /sn_chg_rest/change/worker/\{sys_id\}</a> to view results.Data type: String

</td></tr><tr><td>

worker.sysId

</td><td>

Sys\_id of the worker associated with the change request.Data type: String

</td></tr><tr><td>

status

</td><td>

Only appears if an error is encountered. Status of the endpoint processing.Possible value: failure

Data type: String

</td></tr></tbody>
</table>

### Get available time slots

Use the value provided in the **worker.link** to get schedule window details. The value is in the following format:

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

Use the worker\_sys\_id in [GET /sn\_chg\_rest/change/worker/\{sys\_id\}](change-management-api.md) to view results.

The response body contains the status and provides results when processing is complete.

Worker response body parameter results vary depending on time slot availability.

-   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.
-   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`

    **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](../../it-service-management/change-management/configure-conflict-properties.md).


The 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.

### cURL request

</td></tr><tr><td>

state\_transitions.conditions.condition

</td><td>

Values of a specific condition.Data type: Object

 ```
"condition": {
  "description": "String",
  "name": "String",
  "sys_id": "String"
}

</td></tr><tr id="row-result-error_detail-cmdb"><td>

error.detail

</td><td>

Additional information about the error.Data type: String

</td></tr><tr id="row-result-error_message-cmdb"><td>

error.message

</td><td>

Message that identifies the error.Data type: String

</td></tr><tr><td>

messages

</td><td>

Message information.Data type: Object

</td></tr><tr><td>

messages.errorMessages

</td><td>

Error messages encountered while processing the request. Data type: Array

</td></tr><tr><td>

messages.infoMessages

</td><td>

Information messages encountered while processing the request. Data type: Array

</td></tr><tr><td>

messages.warningMessages

</td><td>

Warning messages encountered while processing the request. Data type: Array

</td></tr><tr><td>

request

</td><td>

Original endpoint request.Data type: String

</td></tr><tr><td>

state

</td><td>

Information on the current state of the worker.Data type: Object

</td></tr><tr><td>

state.display\_value

</td><td><p>Display value of the state of the worker. These values directly correlate to the <strong>state.value</strong> parameter.Possible values:</p>
<ul>
<li>Complete</li>
<li>Error</li>
<li>In-Progress</li>
<li>Waiting</li>
</ul>
<p>Data type: String</p></td></tr><tr><td>

state.value

</td><td>

Numeric value of the state of the worker.Possible values:

-   1
-   2
-   3
-   4

Data type: Number

</td></tr><tr><td>

type

</td><td>

Type of request.Valid value: schedule

Data type: String

</td></tr><tr><td>

worker

</td><td>

Information about the associated worker.Data type: Object

</td></tr><tr><td>

worker.link

</td><td>

Link for retrieving time slot data. Use the sys\_id in <a href="./">GET /sn_chg_rest/change/worker/\{sys_id\}</a> to view results.Data type: String

</td></tr><tr><td>

worker.sysId

</td><td>

Sys\_id of the worker associated with the change request.Data type: String

</td></tr><tr><td>

status

</td><td>

Only appears if an error is encountered. Status of the endpoint processing.Possible value: failure

Data type: String

</td></tr></tbody>
</table>

### Get available time slots

Use the value provided in the **worker.link** to get schedule window details. The value is in the following format:

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

Use the worker\_sys\_id in [GET /sn\_chg\_rest/change/worker/\{worker\_sys\_id\}](change-management-api.md) to view results.

The response body contains the status and provides results when processing is complete.

Worker response body parameter results vary depending on time slot availability.

-   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.
-   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`

    **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](../../it-service-management/change-management/configure-conflict-properties.md).


The 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.

### cURL request

Results include worker.link details you can use to run the provided sys\_id in the GET /sn\_chg\_rest/change/worker/ endpoint.

## Change Management - GET /sn\_chg\_rest/change/\{change\_sys\_id\}/task

Retrieves one or more tasks associated with a specified change request based on the specified criteria.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/{change_sys_id}/task`

Default URL: `/api/sn_chg_rest/change/{change_sys_id}/task`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

change\_sys\_id

</td><td>

Sys\_id of the change request whose tasks are to be retrieved.Data type: String

Table: Change Request \[change\_request\]

</td></tr></tbody>
</table>

<table id="table_tnj_bxm_ylb" class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

key-value pairs

</td><td>

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:

-   Business rules
-   Read-only fields as defined in ACLs
-   Fields that do not exist

Data type: String

</td></tr><tr><td>

order

</td><td>

Field by which to sort the returned change requests. Data type: String

</td></tr><tr><td>

sysparm\_limit

</td><td><p>Maximum number of records to return. For requests that exceed this number of records, use the <strong>sysparm_offset</strong> parameter to paginate record retrieval. Data type: Number</p>
<p>Default: 500</p></td></tr><tr><td>

sysparm\_offset

</td><td><p>Starting 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, <strong>sysparm_offset</strong> is set to "0". To simply page through all available records, use <code>sysparm_offset=sysparm_offset+sysparm_limit</code>, until you reach the end of all records.</p>
<p>Don't pass a negative number in the <strong>sysparm_offset</strong> parameter.Data type: Number</p>
<p>Default: 0</p></td></tr><tr><td>

sysparm\_query

</td><td><p><a href="../../../platform-user-interface/c_EncodedQueryStrings/">Encoded query</a> used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: <code>sysparm_query=&lt;col_name&gt;&lt;operator&gt;&lt;value&gt;</code>. Column names, operators, and values are case-sensitive.</p>
<ul>
<li>&lt;col_name&gt;: Name of the table column to filter on.</li>
<li>&lt;operator&gt;: Supports the following values:</li>
<li><code>=</code>: &lt;col_name&gt; exactly matches &lt;value&gt;.</li>
<li><code>!=</code>: &lt;col_name&gt; does not match &lt;value&gt;.</li>
<li><code>LIKE</code>: &lt;col_name&gt; contains the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>STARTSWITH</code>: &lt;col_name&gt; starts with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>ENDSWITH</code>: &lt;col_name&gt; ends with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>^</code>: AND operator to add an additional query condition. Records included in the result set match both conditions.</li>
<li><code>^OR</code>: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.</li>
<li>&lt;value&gt;: Value to filter on.</li>
</ul>
<p>For more information about operators, see <a href="../../../platform-user-interface/r_OpAvailableFiltersQueries/">Operators available for filters and queries</a>.</p>
<p>Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.</p>
<p><code>sysparm_query=caller_id=javascript:gs.getUserID()^active=true</code></p>
<p>Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the <code>ORDERBY</code> and <code>ORDERBYDESC</code> clauses in <strong>sysparm_query</strong>.</p>
<p>Syntax:</p>
<ul>
<li><code>ORDERBY&lt;col_name&gt;</code></li>
<li><code>ORDERBYDESC&lt;col_name&gt;</code></li>
</ul>
<p>For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.</p>
<p><code>sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory</code></p>
<p>By 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 <strong>glide.invalid_query.returns_no_rows</strong> to <code>true</code> to instead return no rows on an invalid query.</p>
<p><strong>Note:</strong> The <strong>glide.invalid_query.returns_no_rows</strong> property controls the behavior of all queries across the instance, such as in lists, scripts (GlideRecord.query()), and web service APIs.</p>
<p>Data type: String</p></td></tr><tr><td>

textSearch

</td><td>

String 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

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not Found. The specified record couldn't be found.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

All fields \(key\) with their associated values for the identified change request task prior to the delete.Data type: Object

</td></tr><tr><td>

parent

</td><td>

Information for the change request associated to the task.Data type: Object

</td></tr><tr><td>

parent.display\_value

</td><td>

Change request information to display in a UI.Data type: String

</td></tr><tr><td>

parent.value

</td><td>

Sys\_id of the change request associated to the task.Data type: String

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id information for the change request task.Data type: Object

</td></tr><tr><td>

sys\_id.display\_value

</td><td>

Sys\_id of the change request task to display in a UI.Data type: String

</td></tr><tr><td>

sys\_id.value

</td><td>

Sys\_id of the change request task.Data type: String

</td></tr></tbody>
</table>

### cURL request

## Change Management - GET /sn\_chg\_rest/change/\{sys\_id\}

Retrieves the change request identified by the specified sys\_id.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}`

Default URL: `/api/sn_chg_rest/change/{sys_id}`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of the change request record.Data type: String

Table: Change Request \[change\_request\]

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not Found. The specified record couldn't be found.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Element

</th><th>

Description

</th></tr></thead><tbody><tr><td>

result

</td><td>

List 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.

Data type: Array

</td></tr><tr><td>

action\_status

</td><td id="action_status-entry-chg_req">

Current action status of the associated change request.Possible values:

-   1: Blocked internally
-   2: Blocked by customer
-   3: Blocked internally and by customer
-   4: Needs attention

Data type: Number

</td></tr><tr><td>

active

</td><td id="active-entry-chg_req">

Flag that indicates whether the change request is active.Possible values:

-   true: Change request is active
-   false: Change request isn't active

Data type: Boolean

Default: true

</td></tr><tr><td>

activity\_due

</td><td id="activity_due-entry-chg_req">

Date and time for which the associated case is expected to be completed.Data type: String

</td></tr><tr><td>

additional\_assignee\_list

</td><td id="add_assignee_list-entry-chg_req">

List of sys\_ids of additional persons assigned to work on the change request.Data type: Array

</td></tr><tr><td>

approval

</td><td id="approval-entry-chg_req">

Type of approval process required.Data type: String

Default: not requested

</td></tr><tr><td>

approval\_history

</td><td id="approval_history-entry-chg_req">

Most recent approval history journal entry.Data type: String

</td></tr><tr><td>

approval\_set

</td><td id="approval_set-entry-chg_req">

Date and time that the associated action was approved.Data type: String

</td></tr><tr><td>

assigned\_to

</td><td id="assigned_to-entry-chg_req">

Sys\_id of the user assigned to the change request.Data type: String

</td></tr><tr><td>

assignment\_group

</td><td id="assign_group-entry-chg_req">

Sys\_id of the group assigned to the change request.Data type: String

</td></tr><tr><td>

backout\_plan

</td><td id="backout_plan-entry-chg_req">

Description of the plan to execute if the change must be reversed.Data type: String

</td></tr><tr><td>

business\_duration

</td><td id="business_dur-entry-chg_req">

Length in scheduled work hours, work days, and work weeks that it took to complete the change.Data type: String

</td></tr><tr><td>

business\_service

</td><td id="business_service-entry-chg_req">

Sys\_id of the business service associated with the change request. Located in the Service \[cmdb\_ci\_service\] table.Data type: String

</td></tr><tr><td>

cab\_date

</td><td id="cab_date-entry-chg_req">

Date on which the Change Advisory Board \(CAB\) meets.Data type: String

</td></tr><tr><td>

cab\_delegate

</td><td id="cab_delegate-entry-chg_req">

Sys\_id of the user that can substitute for the CAB manager during a CAB meeting. Located in the User \[sys\_user\] tableData type: String

</td></tr><tr><td>

cab\_recommendation

</td><td id="cab_rec-entry-chg_req">

Description of the CAB recommendations for the change request.Data type: String

Maximum length: 4,000

</td></tr><tr><td>

cab\_required

</td><td id="cab_req-entry-chg_req">

Flag that indicates whether the CAB is required.Possible values:

-   true: Change Advisory Board is required.
-   false: Change Advisory Board isn't required.

Data type: Boolean

Default: false

</td></tr><tr><td>

calendar\_duration

</td><td id="cal_dur-entry-chg_req">

Not currently used by Change Management.Data type: String

</td></tr><tr><td>

category

</td><td id="category-entry-chg_req">

Category of the change, for example hardware, network, or software.Data type: String

Default: Other

</td></tr><tr><td>

change\_plan

</td><td id="change_plan-entry-chg_req">

Activities and roles for managing and controlling the change request.Data type: String

</td></tr><tr><td>

chg\_model

</td><td id="chg_model-entry-chg_req">

Sys\_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

Table: Change Model \[chg\_model\]

</td></tr><tr><td>

closed\_at

</td><td id="closed_at-entry-chg_req">

Date and time that the associated change request was closed.Data type: String

</td></tr><tr><td>

closed\_by

</td><td id="closed_by-entry-chg_req">

Sys\_id of the person that closed the change request.Data type: String

Table: User \[sys\_user\]

</td></tr><tr><td>

close\_code

</td><td id="close_code-entry-chg_req">

Code assigned to the change request when it was closed. For example, Successful, Successful with issues, and Unsuccessful.Data type: String

</td></tr><tr><td>

close\_notes

</td><td id="close_notes-entry-chg_req">

Notes that the person entered when closing the change request.Data type: String

</td></tr><tr><td>

cmdb\_ci

</td><td id="cmdb_ci-entry-chg_req">

Sys\_id of the configuration item associated with the change request.Data type: String

Table: Configuration Item \[cmdb\_ci\]

</td></tr><tr><td>

comments

</td><td id="comments-entry-chg_req">

List of customer-facing work notes entered in the associated change request.Data type: Array

</td></tr><tr><td>

comments\_and\_work\_notes

</td><td id="comments_work_notes-entry-chg_req">

List of both internal and customer-facing work notes entered for the associated change request.Data type: Array

Maximum length: 4,000

</td></tr><tr><td>

company

</td><td id="company-entry-chg_req">

Sys\_id of the company associated with the change request.Data type: String

Table: Company \[core\_company\]

</td></tr><tr><td>

conflict\_last\_run

</td><td id="conflict_last_run-entry-chg_req">

Date and time that the conflict detection script was last run on the change request.Data type: String

</td></tr><tr><td>

conflict\_status

</td><td id="conflict_status-entry-chg_req">

Current conflict status as detected by the conflict detection script, such as Conflict and Not Run.Data type: String

Maximum length: 40

Default: Not Run

</td></tr><tr><td>

contact\_type

</td><td id="contact_type-entry-chg_req">

Method in which the change request was initially requested.Possible values:

-   chat
-   email
-   phone
-   social
-   web

Data type: String

</td></tr><tr><td>

contract

</td><td id="contract-entry-chg_req">

Sys\_id of the contract associated with the change request.Data type: String

Table: Contract \[ast\_contract\]

</td></tr><tr><td>

correlation\_display

</td><td id="corr_display-entry-chg_req"><p>User-friendly name for the <strong>correlation_id</strong>.Data type: String</p>
<p>Maximum length: 100</p></td></tr><tr><td>

correlation\_id

</td><td id="corr_id-entry-chg_req">

Globally unique ID \(GUID\) of a matching change request record in a third-party system.Data type: String

Maximum length: 100

</td></tr><tr><td>

delivery\_plan

</td><td id="delivery_plan-entry-chg_req">

No longer in use. Sys\_id of the delivery plan associated with the change request.Data type: String

Table: Execution Plan \[sc\_cat\_item\_delivery\_plan\]

</td></tr><tr><td>

delivery\_task

</td><td id="delivery_task-entry-chg_req">

No longer in use. Sys\_id of the delivery task associated with the change request.Data type: String

Table: Execution Plan Task \[sc\_cat\_item\_delivery\_task\]

</td></tr><tr><td>

description

</td><td id="description-entry-chg_req">

Detailed description of the change request.Data type: String

Maximum length: 4,000

</td></tr><tr><td>

due\_date

</td><td>

Task due date. Not used by change request process.Data type: String

</td></tr><tr><td>

end\_date

</td><td id="end_date-entry-chg_req">

Date and time when the change request is to be completed.Data type: String

</td></tr><tr><td>

escalation

</td><td id="escalation-entry-chg_req">

Current escalation level.Possible values:

-   0: Normal
-   1: Moderate
-   2: High
-   3: Overdue

Data type: Number \(Integer\)

Default: 0

</td></tr><tr><td>

expected\_start

</td><td id="expected_start-entry-chg_req">

Date and time when the task is to start. Not used by the change request process.Data type: String

</td></tr><tr><td>

follow\_up

</td><td id="follow_up-entry-chg_req">

Date and time when a user followed-up with the person requesting the change request.Data type: String

</td></tr><tr><td>

group\_list

</td><td id="group_list-entry-chg_req">

List of sys\_ids and names of the groups associated with the change request.Data type: Array

Maximum length: 4,000

</td></tr><tr><td>

impact

</td><td id="impact-entry-chg_req">

Impact on the change request will have on the customer.Possible values:

-   1: High
-   2: Medium
-   3: Low

Data type: Number \(Integer\)

Default: 3

</td></tr><tr><td>

implementation\_plan

</td><td id="imp_plan-entry-chg_req">

Sequential steps to execute to implement this change. It also contains any dependencies between steps and assignee details for each step.Data type: String

Maximum length: 4,000

</td></tr><tr><td>

justification

</td><td id="justification-entry-chg_req">

Benefits of implementing this change and the impact if this change is not implemented.Data type: String

Maximum length: 4,000

</td></tr><tr><td>

knowledge

</td><td id="knowledge-entry-chg_req">

Flag that indicates whether there are any knowledge base \(\)KB\) articles associated with the change request.Possible values:

-   true: Associated KB articles
-   false: No associated KB articles

Data type: Boolean

</td></tr><tr><td>

location

</td><td id="location-entry-chg_req">

Sys\_id and name of the location of the equipment referenced in the change request.Data type: String

Table: Location \[cmn\_location\]

</td></tr><tr><td>

made\_sla

</td><td id="made_sla-entry-chg_req">

No longer used. Flag that indicates whether the change request was implemented in alignment with the associated service level agreement.Data type: Boolean

</td></tr><tr><td>

needs\_attention

</td><td id="needs_attention-entry-chg_req">

Flag that indicates whether the change request needs attention.Possible values:

-   true: Change request needs additional attention.
-   false: Change request doesn't need additional attention.

Data type: Boolean

Default: false

</td></tr><tr><td>

number

</td><td id="number-entry-chg_req">

Change number assigned to the change request by the system, such as CHG0040007.Data type: String

</td></tr><tr><td>

on\_hold

</td><td id="on_hold-entry-chg_req">

Flag that indicates whether the change request is currently on hold.Possible values:

-   true: On hold
-   false: Not on hold

Data type: Boolean

Default: false

</td></tr><tr><td>

on\_hold\_reason

</td><td id="on_hold_reason-entry-chg_req"><p>If the <strong>on_hold</strong> parameter is "true", description of the reason why the change request is being held up.Data type: String</p>
<p>Maximum length: 4,000</p></td></tr><tr><td>

on\_hold\_task

</td><td id="on_hold_task-entry-chg_req"><p>If the <strong>on_hold</strong> parameter is "true", list of the sys_ids of the tasks that must be completed before the hold is released.Data type: String</p>
<p>Maximum length: 4,000</p></td></tr><tr><td>

opened\_at

</td><td id="opened_at-entry-chg_req">

Date and time that the change release was created.Data type: String

</td></tr><tr><td>

opened\_by

</td><td id="opened_by-entry-chg_req">

Sys\_id and name of the user that created the change release.Data type: String

Table: User \[sys\_user\]

</td></tr><tr><td>

order

</td><td id="order-entry-chg_req">

Not used by Change Management. Optional numeric field by which to order records, such as when retrieving them from a database.Data type: Number \(Integer\)

</td></tr><tr><td>

outside\_maintenance\_schedule

</td><td id="outside_maint_sched-entry-chg_req">

Flag that indicates whether maintenance by an outside company has been schedule for the change request.Possible values:

-   true: Outside maintenance scheduled
-   false: No outside maintenance scheduled

Data type: Boolean

Default: false

</td></tr><tr><td>

parent

</td><td id="parent-entry-chg_req">

Sys\_id and name of the parent task to this change request, if any.Data type: String

Table: Task \[task\]

</td></tr><tr><td>

phase

</td><td id="phase-entry-chg_req">

Current phase of the change request. This defines what the change is doing in greater detail.Possible values:

-   accept
-   build
-   plan
-   requested

Data type: String

</td></tr><tr><td>

phase\_state

</td><td id="phase_state-entry-chg_req">

Change\_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:

-   complete
-   on hold
-   open
-   rejected
-   requested
-   work in progress

Data type: String

</td></tr><tr><td>

priority

</td><td id="priority-entry-chg_req">

Priority of the change request.Possible values:

-   1: Critical
-   2: High
-   3: Moderate
-   4: Low

Data type: Number \(Integer\)

Default: 4

</td></tr><tr><td>

production\_system

</td><td id="prod_system-entry-chg_req">

Flag that indicates whether the change request is for a ServiceNow instance that is in a production environment.Possible values:

-   true: Production environment
-   false: Non-production environment

Data type: Boolean

</td></tr><tr><td>

reason

</td><td id="reason-entry-chg_req">

Description of why the change request was initiated.Possible values:

-   Business requirements
-   Hardware upgrade
-   Legislation
-   Location change
-   Network requirements
-   New or removed CI
-   Other
-   Problem resolved
-   Product or service changed
-   Software upgrade
-   User requested

Data type: String

Maximum length: 40

</td></tr><tr><td>

reassignment\_count

</td><td id="reassign_count-entry-chg_req">

Number of times that the change request has been reassigned to a new owner.Data type: Number \(Integer\)

Default: 0

</td></tr><tr><td>

rejection\_goto

</td><td id="rejection_goto-entry-chg_req">

Sys\_id of the task to perform if the change request is rejected.Data type: String

Table: Task \[task\]

</td></tr><tr><td>

requested\_by

</td><td id="requested_by-entry-chg_req">

Sys\_id of the user that requested the change.Data type: String

Table: User \[sys\_user\]

</td></tr><tr><td>

requested\_by\_date

</td><td id="requested_by_date-entry-chg_req">

Date and time when the change is requested to be implemented by.Data type: String

</td></tr><tr><td>

review\_comments

</td><td id="review_comments-entry-chg_req">

Comments entered when the change request was reviewed.Data type: String

Maximum length: 4,000

</td></tr><tr><td>

review\_date

</td><td id="review_date-entry-chg_req">

Date that the change request was reviewed.Data type: String

</td></tr><tr><td>

review\_status

</td><td id="review_status-entry-chg_req">

Current status of the requested change request review.Data type: String

</td></tr><tr><td>

risk

</td><td id="risk-entry-chg_req">

Level of risk associated with the change request.Valid values:

-   1: High
-   2: Moderate
-   3: Low

Data type: Number

Default: 3

</td></tr><tr><td>

risk\_impact\_analysis

</td><td id="risk_impact_analysis-entry-chg_req">

Description of the risk and analysis of implementing the change request.Data type: String

Maximum length: 4,000

</td></tr><tr><td>

route\_reason

</td><td id="route_reason-entry-chg_req">

Not currently used by Change Management. Reason that the change request was transferred.Possible values:

-   1: Transfer with Resolution
-   9: Transfer without Resolutions

Data type: Number

</td></tr><tr><td>

scope

</td><td id="scope-entry-chg_req">

Size of the change request.Possible values:

-   1: Massive
-   2: Large
-   3: Medium
-   4: Small
-   5: Tiny

Data type: Number

Default: 3

</td></tr><tr><td>

service\_offering

</td><td id="sevice_offering-entry-chg_req">

Sys\_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

Table: Offering \[service\_offering\]

</td></tr><tr><td>

short\_description

</td><td id="short_desc-entry-chg_req">

Description of the change request.Data type: String

Maximum length: 40

</td></tr><tr><td>

skills

</td><td id="skills-entry-chg_req">

List of the sys\_ids of all of the skills required to implement the change request.Data type: Array

Table: Skill \[cmn\_skill\]

</td></tr><tr><td>

sla\_due

</td><td id="sla_due-entry-chg_req">

No longer in use. Date and time that the change request must be completed based on the associated service level agreement.Data type: String

</td></tr><tr><td>

sn\_esign\_document

</td><td>

Sys\_id of any E-signed document attached to the change request.Data type: String

Table: Attachment \[sys\_attachment\]

</td></tr><tr><td>

sn\_esign\_esignature\_configuration

</td><td>

Sys\_id of the E-signed signature template used for the associated document.Data type: String

Table: E-signature Template \[sn\_esign\_configuration\]

</td></tr><tr><td>

start\_date

</td><td id="start_date-entry-chg_req">

Date and time that the change request is planned to start implementation.Data type: String

</td></tr><tr><td>

state

</td><td id="state-entry-chg_req">

Current state of the change request. Possible values are defined in the change model.Data type: Number \(Integer\)

Default: 1

</td></tr><tr><td>

std\_change\_producer\_version

</td><td id="std_chg_prodversion-entry-chg_req">

Sys\_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

Table: Standard Change Template Version \[std\_change\_producer\_version\]

</td></tr><tr><td>

sys\_class\_name

</td><td id="sys_class_name-entry-chg_req">

Name of the table in which the change request is located.Data type: String

</td></tr><tr><td>

sys\_created\_by

</td><td id="sys_create_by-entry-chg_req">

Name of the user that initially created the change request.Data type: String

Maximum length: 40

</td></tr><tr><td>

sys\_created\_on

</td><td id="sys_created_on-entry-chg_req">

Date and time that the associated change request record was originally created.Data type: String

</td></tr><tr><td>

sys\_domain

</td><td id="sys_domain-entry-chg_req">

If using domains in the instance, the name of the domain to which the change module record is associated.Data type: String

</td></tr><tr><td>

sys\_domain\_path

</td><td id="sys_domain_path-entry-chg_req">

If using domains in the instance, the domain path in which the associated change module record resides.Data type: String

</td></tr><tr><td>

sys\_id

</td><td id="sys_id-entry-chg_req">

Unique identifier of the associated change request record.Data type: String

</td></tr><tr id="casetable-sys_mod_count-row"><td>

sys\_mod\_count

</td><td id="sys_mod_count-entry-chg_req">

Number of updates to the case since it was initially created.Data type: Number \(Integer\)

</td></tr><tr id="casetable-sys_updated_by-row"><td>

sys\_updated\_by

</td><td id="sys_updated_by-entry-chg_req">

Person that last updated the case.Data type: String

Maximum length: 40

</td></tr><tr id="casetable-sys_updated_on-row"><td>

sys\_updated\_on

</td><td id="sys_updated_on-entry-chg_req">

Date and time when the case was last updated.Data type: String

</td></tr><tr><td>

task\_effective\_number

</td><td id="task_eff_number-entry-chg_req">

Universal request number.Data type: String

Maximum length: 40

</td></tr><tr><td>

task\_for

</td><td id="task_for-entry-chg_req">

Not used by Change Management. Sys\_id of the user that the task was created for.Data type: String

Table: User \[sys\_user\]

</td></tr><tr><td>

test\_plan

</td><td id="test_plan-entry-chg_req">

Description of the associated test plan for the change.Data type: String

Maximum length: 4,000

</td></tr><tr id="casetable-time_worked-row"><td>

time\_worked

</td><td id="time_worked-entry-chg_req">

Total amount of time worked on the change request.Data type: String

</td></tr><tr><td>

type

</td><td id="type-entry-chg_req">

Change request type.Possible values:

-   emergency
-   normal
-   standard

Data type: String

Maximum length: 40

</td></tr><tr><td>

unauthorized

</td><td id="unauthorized-entry-chg_req">

Flag that indicates whether the change request is unauthorizedPossible values:

-   true: Unauthorized
-   false: Authorized

Data type: Boolean

</td></tr><tr><td>

universal\_request

</td><td id="universal_request-entry-chg_req">

Sys\_id of the Parent Universal request to which this change request is a part of.Data type: String

Table: Task \[task\]

</td></tr><tr id="casetable-upon_approval-row"><td>

upon\_approval

</td><td id="upon_approval-entry-chg_req">

Action to take if the change request is approved.Possible values:

-   do\_nothing
-   proceed

Data type: String

Maximum length: 40

Default: proceed

</td></tr><tr id="casetable-upon_reject-row"><td>

upon\_reject

</td><td id="upon_reject-entry-chg_req">

Action to take if the change request is rejected.Possible values:

-   cancel
-   goto

Data type: String

Maximum length: 40

Default: cancel

</td></tr><tr id="casetable-urgency-row"><td>

urgency

</td><td id="urgency-entry-chg_req">

Urgency of the change request.Possible values:

-   1: High
-   2: Medium
-   3: Low

Data type: Number \(Integer\)

Default: 3

</td></tr><tr id="casetable-user_input-row"><td>

user\_input

</td><td id="user_input-entry-chg_req">

Additional user input.Data type: String

Maximum length: 4,000

</td></tr><tr id="casetable-variables-row"><td>

variables

</td><td id="variables-entry-chg_req">

Name-value pairs of variables associated with the change request.Data type: String

Maximum length: 40

</td></tr><tr id="casetable-watch_list-row"><td>

watch\_list

</td><td id="watch_list-entry-chg_req">

List 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

Table: User \[sys\_user\]

</td></tr><tr id="casetable-wf_activity-row"><td>

wf\_activity

</td><td id="wf_activity-entry-chg_req">

Sys\_id of the workflow activity record associated with the change request.Data type: String

Table: Workflow Activity \[wf\_activity\]

</td></tr><tr id="casetable-work_end-row"><td>

work\_end

</td><td id="work_end-entry-chg_req">

Date and time work ended on the change request.Data type: String

</td></tr><tr id="casetable-work_notes-row"><td>

work\_notes

</td><td id="work_notes-entry-chg_req">

Information about how to resolve the change request, or steps taken to resolve it.Data type: String

Maximum length: 4,000

</td></tr><tr id="casetable-work_notes_list-row"><td>

work\_notes\_list

</td><td id="work_notes_list-entry-chg_req">

List of sys\_ids of the internal users who receive notifications about this change request when work notes are added. Data type: Array

Table: User \[sys\_user\]

</td></tr><tr id="casetable-work_start-row"><td>

work\_start

</td><td id="work_start-entry-chg_req">

Date and time that work started on the change request.Data type: String

</td></tr></tbody>
</table>

### cURL request

## Change Management - GET /sn\_chg\_rest/change/\{sys\_id\}/ci

Retrieves multiple configuration items \(CIs\) associated to a specified change request based on the specified association type.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/ci`

Default URL: `/api/sn_chg_rest/change/{sys_id}/ci`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of the change request for which to return the associated CMDB CIs.Data type: String

</td></tr></tbody>
</table>

<table class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

association\_type

</td><td>

Required. Type of association between the CMDB CI and the change request. Valid values:

-   affected: CIs that are affected by the change request
-   impacted: Services impacted by the change request
-   offering: Impacted service offerings

Data type: String

</td></tr><tr><td>

name-value pairs

</td><td>Name-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 <strong>sysparm_query</strong>. For example, instead of using <code>&amp;sysparm_query=active=true</code>, you can simplify the calling statement by using <code>&amp;active=true</code>. You can also use the display value when the field is a choice or reference type field, such as <code>&amp;state=closed</code> instead of <code>&amp;state=7</code>. To specify multiple key-value pairs, separate each with an ampersand, such as <code>&amp;active=true&amp;assigned_to=john.smith</code>. Data type: String</td></tr><tr><td>

sysparm\_limit

</td><td><p>Maximum number of records to return. For requests that exceed this number of records, use the <strong>sysparm_offset</strong> parameter to paginate record retrieval. Data type: Number</p>
<p>Default: 500</p></td></tr><tr><td>

sysparm\_offset

</td><td><p>Starting 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, <strong>sysparm_offset</strong> is set to "0". To simply page through all available records, use <code>sysparm_offset=sysparm_offset+sysparm_limit</code>, until you reach the end of all records.</p>
<p>Don't pass a negative number in the <strong>sysparm_offset</strong> parameter.Data type: Number</p>
<p>Default: 0</p></td></tr><tr><td>

sysparm\_query

</td><td><p><a href="../../../platform-user-interface/c_EncodedQueryStrings/">Encoded query</a> used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: <code>sysparm_query=&lt;col_name&gt;&lt;operator&gt;&lt;value&gt;</code>. Column names, operators, and values are case-sensitive.</p>
<ul>
<li>&lt;col_name&gt;: Name of the table column to filter on.</li>
<li>&lt;operator&gt;: Supports the following values:</li>
<li><code>=</code>: &lt;col_name&gt; exactly matches &lt;value&gt;.</li>
<li><code>!=</code>: &lt;col_name&gt; does not match &lt;value&gt;.</li>
<li><code>LIKE</code>: &lt;col_name&gt; contains the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>STARTSWITH</code>: &lt;col_name&gt; starts with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>ENDSWITH</code>: &lt;col_name&gt; ends with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>^</code>: AND operator to add an additional query condition. Records included in the result set match both conditions.</li>
<li><code>^OR</code>: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.</li>
<li>&lt;value&gt;: Value to filter on.</li>
</ul>
<p>For more information about operators, see <a href="../../../platform-user-interface/r_OpAvailableFiltersQueries/">Operators available for filters and queries</a>.</p>
<p>Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.</p>
<p><code>sysparm_query=caller_id=javascript:gs.getUserID()^active=true</code></p>
<p>Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the <code>ORDERBY</code> and <code>ORDERBYDESC</code> clauses in <strong>sysparm_query</strong>.</p>
<p>Syntax:</p>
<ul>
<li><code>ORDERBY&lt;col_name&gt;</code></li>
<li><code>ORDERBYDESC&lt;col_name&gt;</code></li>
</ul>
<p>For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.</p>
<p><code>sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory</code></p>
<p>By 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 <strong>glide.invalid_query.returns_no_rows</strong> to <code>true</code> to instead return no rows on an invalid query.</p>
<p><strong>Note:</strong> The <strong>glide.invalid_query.returns_no_rows</strong> property controls the behavior of all queries across the instance, such as in lists, scripts (GlideRecord.query()), and web service APIs.</p>
<p>Data type: String</p></td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

<table><thead><tr><th>

Status code

</th><th>

Description

</th></tr></thead><tbody><tr><td>

200

</td><td id="entry-200-status-code">

Successful. The request was successfully processed.

</td></tr><tr><td>

400

</td><td>

Bad Request. A bad request type or malformed request was detected. The error response contains pertinent messages to help troubleshoot the problem.

</td></tr><tr><td>

401

</td><td id="entry-401-status-code">

Unauthorized. The user credentials are incorrect or have not been passed.

</td></tr><tr><td>

500

</td><td id="entry-500-status-code">

Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

</td></tr></tbody>
</table>

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

ci\_item\|cmdb\_ci\_service

</td><td>

Either the ci\_item or cmdb\_ci\_service variables, depending upon the association type.Data type: Array

</td></tr><tr><td>

ci\_item\|cmdb\_ci\_service.value

</td><td>

Sys\_id of the ci\_item or cmdb\_ci\_service.Data type: String

</td></tr><tr><td>

ci\_item\|cmdb\_ci\_service.display\_value

</td><td>

Display value of the ci\_item or cmdb\_ci\_service.Data type: String

</td></tr><tr><td>

sys\_id

</td><td>

Change request sys\_id information.Data type: Object

</td></tr><tr><td>

sys\_id.value

</td><td>

Sys\_id of the change request.Data type: String

</td></tr><tr><td>

sys\_id.display\_value

</td><td>

Sys\_id of the change request to display in a UI.Data type: String

</td></tr><tr><td>

&lt;record\_fields&gt;

</td><td>

All valid fields in the ci\_item or cmdb\_ci\_service record; table based on association type.Data type: Object

</td></tr></tbody>
</table>

### cURL request

## Change Management - GET /sn\_chg\_rest/change/\{sys\_id\}/conflict

Retrieves 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.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/conflict`

Default URL: `/api/sn_chg_rest/change/{sys_id}/conflict`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of the change request for which to return the status of the running/completed conflict checking process.Data type: String

Table: Change Request \[change\_request\]

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Current status of the conflict checking process; including conflicts if any are detected.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not Found. The specified record couldn't be found.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

conflicts

</td><td>

List of conflicts found for the change request. An empty object indicates that no conflicts were detected.Data type: Array

</td></tr><tr><td>

job\_status

</td><td>

Status of the actual conflict checking job.Data type: String

</td></tr><tr><td>

last\_run

</td><td>

Date and time the last conflict checking process started.Data type: String

</td></tr><tr><td>

record\_count

</td><td>

Number of records checked.Data type: String

</td></tr><tr><td>

status

</td><td><p>Outcome of the conflict checking process, such as "Conflict" or "Not run". <strong>Note:</strong> Even if the change request does not have any conflicts, this field is set to "Conflict." However, the <strong>conflicts</strong> object is empty.</p>
<p>Data type: String</p></td></tr></tbody>
</table>

### cURL request

Successful response - no conflicts

### cURL request

Successful response - with conflicts

## Change Management - GET /sn\_chg\_rest/change/emergency

Retrieves one or more emergency change requests based on the specified criteria.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/emergency`

Default URL: `/api/sn_chg_rest/change/emergency`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr></tbody>
</table>

<table class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

order

</td><td>

Field by which to sort the returned change requests. Data type: String

Default: *number*

</td></tr><tr><td>

sysparm\_limit

</td><td><p>Maximum number of records to return. For requests that exceed this number of records, use the <strong>sysparm_offset</strong> parameter to paginate record retrieval. Data type: Number</p>
<p>Default: 500</p></td></tr><tr><td>

sysparm\_offset

</td><td><p>Starting 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, <strong>sysparm_offset</strong> is set to "0". To simply page through all available records, use <code>sysparm_offset=sysparm_offset+sysparm_limit</code>, until you reach the end of all records.</p>
<p>Don't pass a negative number in the <strong>sysparm_offset</strong> parameter.Data type: Number</p>
<p>Default: 0</p></td></tr><tr><td>

sysparm\_query

</td><td><p><a href="../../../platform-user-interface/c_EncodedQueryStrings/">Encoded query</a> used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: <code>sysparm_query=&lt;col_name&gt;&lt;operator&gt;&lt;value&gt;</code>. Column names, operators, and values are case-sensitive.</p>
<ul>
<li>&lt;col_name&gt;: Name of the table column to filter on.</li>
<li>&lt;operator&gt;: Supports the following values:</li>
<li><code>=</code>: &lt;col_name&gt; exactly matches &lt;value&gt;.</li>
<li><code>!=</code>: &lt;col_name&gt; does not match &lt;value&gt;.</li>
<li><code>LIKE</code>: &lt;col_name&gt; contains the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>STARTSWITH</code>: &lt;col_name&gt; starts with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>ENDSWITH</code>: &lt;col_name&gt; ends with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>^</code>: AND operator to add an additional query condition. Records included in the result set match both conditions.</li>
<li><code>^OR</code>: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.</li>
<li>&lt;value&gt;: Value to filter on.</li>
</ul>
<p>For more information about operators, see <a href="../../../platform-user-interface/r_OpAvailableFiltersQueries/">Operators available for filters and queries</a>.</p>
<p>Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.</p>
<p><code>sysparm_query=caller_id=javascript:gs.getUserID()^active=true</code></p>
<p>Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the <code>ORDERBY</code> and <code>ORDERBYDESC</code> clauses in <strong>sysparm_query</strong>.</p>
<p>Syntax:</p>
<ul>
<li><code>ORDERBY&lt;col_name&gt;</code></li>
<li><code>ORDERBYDESC&lt;col_name&gt;</code></li>
</ul>
<p>For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.</p>
<p><code>sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory</code></p>
<p>By 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 <strong>glide.invalid_query.returns_no_rows</strong> to <code>true</code> to instead return no rows on an invalid query.</p>
<p><strong>Note:</strong> The <strong>glide.invalid_query.returns_no_rows</strong> property controls the behavior of all queries across the instance, such as in lists, scripts (GlideRecord.query()), and web service APIs.</p>
<p>Data type: String</p></td></tr><tr><td>

key-value pairs

</td><td>Name-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 <strong>sysparm_query</strong>. For example, instead of using <code>&amp;sysparm_query=active=true</code>, you can simplify the calling statement by using <code>&amp;active=true</code>. You can also use the display value when the field is a choice or reference type field, such as <code>&amp;state=closed</code> instead of <code>&amp;state=7</code>. To specify multiple key-value pairs, separate each with an ampersand, such as <code>&amp;active=true&amp;assigned_to=john.smith</code>. Data type: String</td></tr><tr><td>

textSearch

</td><td>

String 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

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

Values for all fields in the associated change request.Data type: Object

</td></tr><tr><td>

state

</td><td>

State of the change request.Data type: Object

</td></tr><tr><td>

state.display\_value

</td><td>

State to display in a UI.Data type: String

</td></tr><tr><td>

state.value

</td><td>

Internal state value.Data type: String

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id information for the change request.Data type: Object

</td></tr><tr><td>

sys\_id.display\_value

</td><td>

Sys\_id of the change request to display in a UI.Data type: String

</td></tr><tr><td>

sys\_id.value

</td><td>

Sys\_id of the change request.Data type: String

</td></tr><tr><td>

type

</td><td>

Type of change request.Data type: Object

</td></tr><tr><td>

type.display\_value

</td><td>

Change type to display in a UI.Value is always "Emergency".

Data type: String

</td></tr><tr><td>

type.value

</td><td>

Internal type value.Value is always "emergency".

Data type: String

</td></tr></tbody>
</table>

### cURL request

## Change Management - GET /sn\_chg\_rest/change/emergency/\{sys\_id\}

Retrieves the emergency change request identified by the specified sys\_id.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/emergency/{sys_id}`

Default URL: `/api/sn_chg_rest/change/emergency/{sys_id}`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of the emergency change request to retrieve.Data type: String

Table: Change Request \[change\_request\]

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not Found. The specified record couldn't be found.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

Values for all fields in the associated change request.Data type: Object

</td></tr><tr><td>

state

</td><td>

State of the change request.Data type: Object

</td></tr><tr><td>

state.display\_value

</td><td>

State to display in a UI.Data type: String

</td></tr><tr><td>

state.value

</td><td>

Internal state value.Data type: String

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id information for the change request.Data type: Object

</td></tr><tr><td>

sys\_id.display\_value

</td><td>

Sys\_id of the change request to display in a UI.Data type: String

</td></tr><tr><td>

sys\_id.value

</td><td>

Sys\_id of the change request.Data type: String

</td></tr><tr><td>

type

</td><td>

Type of change request.Data type: Object

</td></tr><tr><td>

type.display\_value

</td><td>

Change type to display in a UI.Value is always "Emergency".

Data type: String

</td></tr><tr><td>

type.value

</td><td>

Internal type value.Value is always "emergency".

Data type: String

</td></tr></tbody>
</table>

### cURL request

## Change Management - GET /sn\_chg\_rest/change/model

Retrieves one or more change models based on the specified criteria.

Use 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.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/model`

Default URL: `/api/sn_chg_rest/change/model`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr></tbody>
</table>

<table class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>Name-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 <strong>sysparm_query</strong>. For example, instead of using <code>&amp;sysparm_query=active=true</code>, you can simplify the calling statement by using <code>&amp;active=true</code>. You can also use the display value when the field is a choice or reference type field, such as <code>&amp;state=closed</code> instead of <code>&amp;state=7</code>. To specify multiple key-value pairs, separate each with an ampersand, such as <code>&amp;active=true&amp;assigned_to=john.smith</code>. Data type: String</td></tr><tr><td>

order

</td><td>

Field by which to sort the returned change models.Data type: String

Default: *name*

</td></tr><tr><td>

sysparm\_offset

</td><td id="sysparm_offset-entry-RESTAPI"><p>Starting 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, <strong>sysparm_offset</strong> is set to "0". To simply page through all available records, use <code>sysparm_offset=sysparm_offset+sysparm_limit</code>, until you reach the end of all records.</p>
<p>Don't pass a negative number in the <strong>sysparm_offset</strong> parameter.Data type: Number</p>
<p>Default: 0</p></td></tr><tr><td>

sysparm\_query

</td><td id="sysparm-query-RESTAPI"><p><a href="../../../platform-user-interface/c_EncodedQueryStrings/">Encoded query</a> used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: <code>sysparm_query=&lt;col_name&gt;&lt;operator&gt;&lt;value&gt;</code>. Column names, operators, and values are case-sensitive.</p>
<ul>
<li>&lt;col_name&gt;: Name of the table column to filter on.</li>
<li>&lt;operator&gt;: Supports the following values:</li>
<li><code>=</code>: &lt;col_name&gt; exactly matches &lt;value&gt;.</li>
<li><code>!=</code>: &lt;col_name&gt; does not match &lt;value&gt;.</li>
<li><code>LIKE</code>: &lt;col_name&gt; contains the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>STARTSWITH</code>: &lt;col_name&gt; starts with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>ENDSWITH</code>: &lt;col_name&gt; ends with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>^</code>: AND operator to add an additional query condition. Records included in the result set match both conditions.</li>
<li><code>^OR</code>: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.</li>
<li>&lt;value&gt;: Value to filter on.</li>
</ul>
<p>For more information about operators, see <a href="../../../platform-user-interface/r_OpAvailableFiltersQueries/">Operators available for filters and queries</a>.</p>
<p>Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.</p>
<p><code>sysparm_query=caller_id=javascript:gs.getUserID()^active=true</code></p>
<p>Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the <code>ORDERBY</code> and <code>ORDERBYDESC</code> clauses in <strong>sysparm_query</strong>.</p>
<p>Syntax:</p>
<ul>
<li><code>ORDERBY&lt;col_name&gt;</code></li>
<li><code>ORDERBYDESC&lt;col_name&gt;</code></li>
</ul>
<p>For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.</p>
<p><code>sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory</code></p>
<p>By 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 <strong>glide.invalid_query.returns_no_rows</strong> to <code>true</code> to instead return no rows on an invalid query.</p>
<p><strong>Note:</strong> The <strong>glide.invalid_query.returns_no_rows</strong> property controls the behavior of all queries across the instance, such as in lists, scripts (GlideRecord.query()), and web service APIs.</p>
<p>Data type: String</p></td></tr><tr><td>

textSearch

</td><td>

String 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 <a href="../../../platform-administration/search-administration/search-administration/">Search administration</a>.Data type: String

Default: `IR_AND_OR_QUERY`

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

result

</td><td>

List 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.

Data type: Array

</td></tr><tr><td>

result.active

</td><td>

Flag that indicates whether the associated change model record is active and available within the instance.Valid values:

-   true: Change model is active.
-   false: Change model isn't active.

Data type: Boolean

Default: true

</td></tr><tr><td>

result.available\_in\_ui

</td><td>

Flag that indicates whether the associated change model record is available within the user interface.Valid values:

-   true: Change model is available in the user interface.
-   false: Change model isn't available in the user interface.

Data type: Boolean

Default: true

</td></tr><tr><td>

result.color

</td><td>

Color of the associated change model on the change request landing page.Data type: String

Default: \#cbcbcb

</td></tr><tr><td>

result.default\_change\_model

</td><td>

Flag that indicates whether the associated change model record is the default change model.Valid values:

-   true: Default
-   false: Not the default

Data type: Boolean

Default: false

</td></tr><tr><td>

result.description

</td><td>

Short description of the purpose of the change model.Data type: String

Maximum length: 4,000

</td></tr><tr><td>

result.name

</td><td>

Name of the change model.Data type: String

Maximum length: 200

</td></tr><tr><td>

result.record\_preset

</td><td>

Name-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:

`"type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ"`

Data type: String

</td></tr><tr><td>

result.state\_field

</td><td>Choice list field from which to collect choices, based on the provided in <strong>table_name</strong>. For change models, this is always set to "state".Data type: String</td></tr><tr><td>

result.sys\_class\_name

</td><td>

Change module table name. Always Change Model/chg\_model.Data type: String

</td></tr><tr><td>

result.sys\_created\_by

</td><td>

Name of the user that initially created the associated change module record. Data type: String

</td></tr><tr><td>

result.sys\_created\_on

</td><td>

Date and time that the change module record was originally created.Data type: String

</td></tr><tr><td>

result.sys\_domain

</td><td>

If using domains in the instance, the name of the domain to which the change module record is associated.Data type: String

</td></tr><tr><td>

result.sys\_domain\_path

</td><td>

If using domains in the instance, the domain path in which the associated change module record resides.Data type: String

</td></tr><tr><td>

result.sys\_id

</td><td>

Unique identifier of the associated change model record.Data type: String

</td></tr><tr><td>

result.sys\_mod\_count

</td><td>

Number of times that the associated change model record has been modified.Data type: Number

</td></tr><tr><td>

result.sys\_name

</td><td>Name of the change model. Always the same as the <strong>name</strong> parameter.Data type: String</td></tr><tr><td>

result.sys\_tags

</td><td>

System tags associated with the change model record.Data type: String

</td></tr><tr><td>

result.sys\_updated\_by

</td><td>

Name of the user that last updated the associated change model record.Data type: String

Maximum length: 40

</td></tr><tr><td>

result.sys\_updated\_on

</td><td>

Date and time the associated change model record was last updated.Data type: String

</td></tr><tr><td>

result.table\_name

</td><td>

Table that defines the Choice list field from which to collect choices. For change models this is always set to "change\_request".Data type: String

Maximum length: 80

</td></tr></tbody>
</table>

### cURL request

This example shows a request for obtaining all change model records.

For brevity, this response only shows a single change model object.

## Change Management - GET /sn\_chg\_rest/change/model/\{sys\_id\}

Retrieves the change model identified by the specified sys\_id.

You can then use this change model to create the desired change request. For additional information on change models, see Change Models.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/model/{sys_id}`

Default URL: `/api/sn_chg_rest/change/model/{sys_id}`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of the change model record to retrieve from the Change Model \[chg\_model\] table.Data type: String

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not Found. The specified record couldn't be found.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

result

</td><td><p>Requested 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 <strong>value</strong> and <strong>display_value</strong> name-value pairs. Some contain <strong>display_value_internal</strong> name-value pairs.</p>
<p>Data type: Object</p></td></tr><tr><td>

result.active

</td><td>

Flag that indicates whether the associated change model record is active and available within the instance.Valid values:

-   true: Change model is active.
-   false: Change model isn't active.

Data type: Boolean

Default: true

</td></tr><tr><td>

result.available\_in\_ui

</td><td>

Flag that indicates whether the associated change model record is available within the user interface.Valid values:

-   true: Change model is available in the user interface.
-   false: Change model isn't available in the user interface.

Data type: Boolean

Default: true

</td></tr><tr><td>

result.color

</td><td>

Color of the associated change model on the change request landing page.Data type: String

Default: \#cbcbcb

</td></tr><tr><td>

result.default\_change\_model

</td><td>

Flag that indicates whether the associated change model record is the default change model.Valid values:

-   true: Default
-   false: Not the default

Data type: Boolean

Default: false

</td></tr><tr><td>

result.description

</td><td>

Short description of the purpose of the change model.Data type: String

Maximum length: 4,000

</td></tr><tr><td>

result.name

</td><td>

Name of the change model.Data type: String

Maximum length: 200

</td></tr><tr><td>

result.record\_preset

</td><td>

Name-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:

`"type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ"`

Data type: String

</td></tr><tr><td>

result.state\_field

</td><td>Choice list field from which to collect choices, based on the provided in <strong>table_name</strong>. For change models, this is always set to "state".Data type: String</td></tr><tr><td>

result.sys\_class\_name

</td><td>

Change module table name. Always Change Model/chg\_model.Data type: String

</td></tr><tr><td>

result.sys\_created\_by

</td><td>

Name of the user that initially created the associated change module record. Data type: String

</td></tr><tr><td>

result.sys\_created\_on

</td><td>

Date and time that the change module record was originally created.Data type: String

</td></tr><tr><td>

result.sys\_domain

</td><td>

If using domains in the instance, the name of the domain to which the change module record is associated.Data type: String

</td></tr><tr><td>

result.sys\_domain\_path

</td><td>

If using domains in the instance, the domain path in which the associated change module record resides.Data type: String

</td></tr><tr><td>

result.sys\_id

</td><td>

Unique identifier of the associated change model record.Data type: String

</td></tr><tr><td>

result.sys\_mod\_count

</td><td>

Number of times that the associated change model record has been modified.Data type: Number

</td></tr><tr><td>

result.sys\_name

</td><td>Name of the change model. Always the same as the <strong>name</strong> parameter.Data type: String</td></tr><tr><td>

result.sys\_tags

</td><td>

System tags associated with the change model record.Data type: String

</td></tr><tr><td>

result.sys\_updated\_by

</td><td>

Name of the user that last updated the associated change model record.Data type: String

Maximum length: 40

</td></tr><tr><td>

result.sys\_updated\_on

</td><td>

Date and time the associated change model record was last updated.Data type: String

</td></tr><tr><td>

result.table\_name

</td><td>

Table that defines the Choice list field from which to collect choices. For change models this is always set to "change\_request".Data type: String

Maximum length: 80

</td></tr></tbody>
</table>

### cURL request

## Change Management - GET /sn\_chg\_rest/change/normal

Retrieves one or more normal change requests based on the specified criteria.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/normal`

Default URL: `/api/sn_chg_rest/change/normal`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr></tbody>
</table>

<table class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>Name-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 <strong>sysparm_query</strong>. For example, instead of using <code>&amp;sysparm_query=active=true</code>, you can simplify the calling statement by using <code>&amp;active=true</code>. You can also use the display value when the field is a choice or reference type field, such as <code>&amp;state=closed</code> instead of <code>&amp;state=7</code>. To specify multiple key-value pairs, separate each with an ampersand, such as <code>&amp;active=true&amp;assigned_to=john.smith</code>. Data type: String</td></tr><tr><td>

order

</td><td>

Field by which to sort the returned change requests. Data type: String

</td></tr><tr><td>

sysparm\_limit

</td><td><p>Maximum number of records to return. For requests that exceed this number of records, use the <strong>sysparm_offset</strong> parameter to paginate record retrieval. Data type: Number</p>
<p>Default: 500</p></td></tr><tr><td>

sysparm\_offset

</td><td><p>Starting 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, <strong>sysparm_offset</strong> is set to "0". To simply page through all available records, use <code>sysparm_offset=sysparm_offset+sysparm_limit</code>, until you reach the end of all records.</p>
<p>Don't pass a negative number in the <strong>sysparm_offset</strong> parameter.Data type: Number</p>
<p>Default: 0</p></td></tr><tr><td>

sysparm\_query

</td><td><p><a href="../../../platform-user-interface/c_EncodedQueryStrings/">Encoded query</a> used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: <code>sysparm_query=&lt;col_name&gt;&lt;operator&gt;&lt;value&gt;</code>. Column names, operators, and values are case-sensitive.</p>
<ul>
<li>&lt;col_name&gt;: Name of the table column to filter on.</li>
<li>&lt;operator&gt;: Supports the following values:</li>
<li><code>=</code>: &lt;col_name&gt; exactly matches &lt;value&gt;.</li>
<li><code>!=</code>: &lt;col_name&gt; does not match &lt;value&gt;.</li>
<li><code>LIKE</code>: &lt;col_name&gt; contains the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>STARTSWITH</code>: &lt;col_name&gt; starts with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>ENDSWITH</code>: &lt;col_name&gt; ends with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>^</code>: AND operator to add an additional query condition. Records included in the result set match both conditions.</li>
<li><code>^OR</code>: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.</li>
<li>&lt;value&gt;: Value to filter on.</li>
</ul>
<p>For more information about operators, see <a href="../../../platform-user-interface/r_OpAvailableFiltersQueries/">Operators available for filters and queries</a>.</p>
<p>Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.</p>
<p><code>sysparm_query=caller_id=javascript:gs.getUserID()^active=true</code></p>
<p>Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the <code>ORDERBY</code> and <code>ORDERBYDESC</code> clauses in <strong>sysparm_query</strong>.</p>
<p>Syntax:</p>
<ul>
<li><code>ORDERBY&lt;col_name&gt;</code></li>
<li><code>ORDERBYDESC&lt;col_name&gt;</code></li>
</ul>
<p>For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.</p>
<p><code>sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory</code></p>
<p>By 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 <strong>glide.invalid_query.returns_no_rows</strong> to <code>true</code> to instead return no rows on an invalid query.</p>
<p><strong>Note:</strong> The <strong>glide.invalid_query.returns_no_rows</strong> property controls the behavior of all queries across the instance, such as in lists, scripts (GlideRecord.query()), and web service APIs.</p>
<p>Data type: String</p></td></tr><tr><td>

textSearch

</td><td>

String 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

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

Values for all fields in the associated change request.Data type: Object

</td></tr><tr><td>

state

</td><td>

State of the change request prior to the delete.Data type: Object

</td></tr><tr><td>

state.display\_value

</td><td>

State to display in a UI.Data type: String

</td></tr><tr><td>

state.value

</td><td>

Internal state value.Data type: String

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id information for the change request.Data type: Object

</td></tr><tr><td>

sys\_id.display\_value

</td><td>

Sys\_id of the change request to display in a UI.Data type: String

</td></tr><tr><td>

sys\_id.value

</td><td>

Sys\_id of the change request.Data type: String

</td></tr><tr><td>

type

</td><td>

Type of change request.Data type: Object

</td></tr><tr><td>

type.display\_value

</td><td>

Change type to display in a UI.Value is always "Normal".

Data type: String

</td></tr><tr><td>

type.value

</td><td>

Internal type value.Value is always "normal".

Data type: String

</td></tr></tbody>
</table>

### cURL request

## Change Management - GET /sn\_chg\_rest/change/normal/\{sys\_id\}

Retrieves the normal change request identified by the specified sys\_id.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/normal/{sys_id}`

Default URL: `/api/sn_chg_rest/change/normal/{sys_id}`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of the normal change request to retrieve.Data type: String

Table: Change Request \[change\_request\]

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not Found. The specified record couldn't be found.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

Values for all fields in the associated change request.Data type: Object

</td></tr><tr><td>

state

</td><td>

State of the change request prior to the delete.Data type: Object

</td></tr><tr><td>

state.display\_value

</td><td>

State to display in a UI.Data type: String

</td></tr><tr><td>

state.value

</td><td>

Internal state value.Data type: String

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of the change request.Data type: String

</td></tr><tr><td>

type

</td><td>

Type of change request.Data type: Object

</td></tr><tr><td>

type.display\_value

</td><td>

Change type to display in a UI.Value is always "Normal".

Data type: String

</td></tr><tr><td>

type.value

</td><td>

Internal type value.Value is always "normal".

Data type: String

</td></tr></tbody>
</table>

### cURL request

## Change Management - GET /sn\_chg\_rest/change/standard

Retrieves one or more standard change requests based on the specified criteria.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/standard`

Default URL: `/api/sn_chg_rest/change/standard`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr></tbody>
</table>

<table class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>Name-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 <strong>sysparm_query</strong>. For example, instead of using <code>&amp;sysparm_query=active=true</code>, you can simplify the calling statement by using <code>&amp;active=true</code>. You can also use the display value when the field is a choice or reference type field, such as <code>&amp;state=closed</code> instead of <code>&amp;state=7</code>. To specify multiple key-value pairs, separate each with an ampersand, such as <code>&amp;active=true&amp;assigned_to=john.smith</code>. Data type: String</td></tr><tr><td>

order

</td><td>

Field by which to sort the returned change requests. Data type: String

</td></tr><tr><td>

sysparm\_limit

</td><td><p>Maximum number of records to return. For requests that exceed this number of records, use the <strong>sysparm_offset</strong> parameter to paginate record retrieval. Data type: String</p>
<p>Default: 500</p></td></tr><tr><td>

sysparm\_offset

</td><td><p>Starting 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, <strong>sysparm_offset</strong> is set to "0". To simply page through all available records, use <code>sysparm_offset=sysparm_offset+sysparm_limit</code>, until you reach the end of all records.</p>
<p>Don't pass a negative number in the <strong>sysparm_offset</strong> parameter.Data type: Number</p>
<p>Default: 0</p></td></tr><tr><td>

sysparm\_query

</td><td><p><a href="../../../platform-user-interface/c_EncodedQueryStrings/">Encoded query</a> used to filter the result set. You can use a UI filter to obtain a properly encoded query.Syntax: <code>sysparm_query=&lt;col_name&gt;&lt;operator&gt;&lt;value&gt;</code>. Column names, operators, and values are case-sensitive.</p>
<ul>
<li>&lt;col_name&gt;: Name of the table column to filter on.</li>
<li>&lt;operator&gt;: Supports the following values:</li>
<li><code>=</code>: &lt;col_name&gt; exactly matches &lt;value&gt;.</li>
<li><code>!=</code>: &lt;col_name&gt; does not match &lt;value&gt;.</li>
<li><code>LIKE</code>: &lt;col_name&gt; contains the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>STARTSWITH</code>: &lt;col_name&gt; starts with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>ENDSWITH</code>: &lt;col_name&gt; ends with the specified string &lt;value&gt;. Only works for &lt;col_name&gt; fields whose data type is string.</li>
<li><code>^</code>: AND operator to add an additional query condition. Records included in the result set match both conditions.</li>
<li><code>^OR</code>: OR operator to add an additional query condition. Records included in the result set match at least one of the conditions.</li>
<li>&lt;value&gt;: Value to filter on.</li>
</ul>
<p>For more information about operators, see <a href="../../../platform-user-interface/r_OpAvailableFiltersQueries/">Operators available for filters and queries</a>.</p>
<p>Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active.</p>
<p><code>sysparm_query=caller_id=javascript:gs.getUserID()^active=true</code></p>
<p>Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the <code>ORDERBY</code> and <code>ORDERBYDESC</code> clauses in <strong>sysparm_query</strong>.</p>
<p>Syntax:</p>
<ul>
<li><code>ORDERBY&lt;col_name&gt;</code></li>
<li><code>ORDERBYDESC&lt;col_name&gt;</code></li>
</ul>
<p>For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category.</p>
<p><code>sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory</code></p>
<p>By 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 <strong>glide.invalid_query.returns_no_rows</strong> to <code>true</code> to instead return no rows on an invalid query.</p>
<p><strong>Note:</strong> The <strong>glide.invalid_query.returns_no_rows</strong> property controls the behavior of all queries across the instance, such as in lists, scripts (GlideRecord.query()), and web service APIs.</p>
<p>Data type: String</p></td></tr><tr><td>

textSearch

</td><td>

String 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

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

All fields \(key\) with their associated values for the identified change request.Data type: Object

</td></tr><tr><td>

state

</td><td>

State of the change request prior to the delete.Data type: Object

 ```
state: {
  display_value: "String", 
  value: "String"
}

</td></tr><tr><td>

sys\_id.display\_value

</td><td>

Sys\_id of the change request to display in a UI.Data type: String

</td></tr><tr><td>

sys\_id.value

</td><td>

Sys\_id of the change request.Data type: String

</td></tr><tr><td>

type

</td><td>

Type of change request.Data type: Object

 ```
type: {
  display_value: "String",
  value: "String"
}

state: {
  display_value: "String", 
  value: "String"
}

sys_id: {
  display_value: "String", 
  value: "String"
}

</td></tr><tr><td>

sys\_id.display\_value

</td><td>

Sys\_id of the change request to display in a UI.Data type: String

</td></tr><tr><td>

sys\_id.value

</td><td>

Sys\_id of the change request.Data type: String

</td></tr><tr><td>

template

</td><td>

Information about the standard change template.Data type: Object

 ```
template: {
  display_value: "String", 
  value: "String"
}

template: {
  display_value: "String", 
  value: "String"
}

"messages": {
  "errorMessages": [Array],
  "infoMessages": [Array],
  "warningMessages": [Array]
}

Invalid CMDB_CI sys_id provided

CMDB_CI sys_id already associated to provided.

Invalid CMDB_CI sys_id provided.

"payload": {
  "spans": [Array]
}

"payload": {
  "spans": [
   {
    "end": {Object}, 
    "start": {Object}
   }
  ]
}

"start": {
  "display_value": "String",
  "value": "String"
}

"end": {
  "display_value": "String",
  "value": "String"
}

state: {
  display_value: "String", 
  value: Number
}

"worker": {
  "link": "String",
  "sysId": "String"
}

state: {
  display_value: "String", 
  value: "String"
}

type: {
  display_value: "String",
  value: "String"
}

"error": {
  "detail": "String",
  "message": "String",
  "status": "String"
}

"messages": {
  "errorMessages": [Array],
  "infoMessages": [Array],
  "warningMessages": [Array]
}

state: {
  display_value: "String", 
  value: Number
}

"worker": {
  "link": "String",
  "sysId": "String"
}

sys_id: {
  display_value: "String", 
  value: "String"
}

parent: {
  display_value: "String", 
  value: "String"
}

state: {
  display_value: "String", 
  value: "String"
}

type: {
  display_value: "String",
  value: "String"
}

state: {
  display_value: "String", 
  value: "String"
}

type: {
  display_value: "String",
  value: "String"
}

state: {
  display_value: "String", 
  value: "String"
}

sys_id: {
  display_value: "String", 
  value: "String"
}

impact: {
  display_value: "String", 
  value: "String"
}

risk: {
  display_value: "String", 
  value: "String"
}

sys_id: {
  display_value: "String", 
  value: "String"
}

"messages": {
  "errorMessages": [Array],
  "infoMessages": [Array],
  "warningMessages": [Array]
}

Invalid CMDB_CI sys_id provided

CMDB_CI sys_id already associated to provided.

Invalid CMDB_CI sys_id provided.

state: {
  display_value: "String", 
  value: "String"
}

</td></tr><tr><td>

worker.link

</td><td>

URL to retrieve the status of the associated worker and other worker pertinent information.Data type: String

</td></tr><tr><td>

worker.sysId

</td><td>

Sys\_id of the worker associated with the change request.Data type: String

</td></tr></tbody>
</table>

### cURL request

## Change Management - POST /sn\_chg\_rest/change/\{sys\_id\}/conflict

Starts a change request conflict checking process for the specified change request \(sys\_id\).

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/conflict`

Default URL: `/api/sn_chg_rest/change/{sys_id}/conflict`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of the change management request for which to start the conflict checking process. For additional information on the conflict checking process, see <a href="../../../it-service-management/change-management/c_ConflictDetection/">Conflict detection</a>.Data type: String

Table: Change Request \[change\_request\]

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|400|Bad Request. Request was unable to start due to unresolvable errors. The returned message may provide additional details.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not found. The requested item wasn't found.|
|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

result

</td><td>

Sys\_id of the change request conflict checking process.Data type: String

</td></tr></tbody>
</table>

### cURL request

## Change Management - POST /sn\_chg\_rest/change/emergency

Creates one emergency change request based on the default emergency change request record. Multiple emergency change request creations within a single call is not supported.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/emergency`

Default URL: `/api/sn_chg_rest/change/emergency`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr></tbody>
</table>

<table class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

key-value pairs

</td><td>

Key-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:

-   Business rules
-   Read-only fields as defined in ACLs
-   Fields that do not exist

 Data type: String

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

Name-value pairs of the fields that were created in the emergency change request.Data type: Object

</td></tr><tr><td>

state

</td><td>

State of the change request prior to the delete.Data type: Object

 ```
state: {
  display_value: "String", 
  value: "String"
}

</td></tr><tr><td>

type.display\_value

</td><td>

Change type to display in a UI.Value is always "Emergency".

 Data type: String

</td></tr><tr><td>

type.value

</td><td>

Internal type value.Value is always "emergency".

 Data type: String

</td></tr><tr><td>

\_\_meta.ignoredFields

</td><td>

Key-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

</td></tr></tbody>
</table>

### cURL request

## Change Management - POST /sn\_chg\_rest/change/normal

Creates one normal change request based on the default normal change request record. Multiple normal change request creations within a single call is not supported.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/normal`

Default URL: `/api/sn_chg_rest/change/normal`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr></tbody>
</table>

<table class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

key-value pairs

</td><td>

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:

-   Business rules
-   Read-only fields as defined in ACLs
-   Fields that do not exist

 Data type: String

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

Values for all fields in the associated change request.Data type: Object

</td></tr><tr><td>

state

</td><td>

State of the newly created change request.Data type: Object

 ```
state: {
  display_value: "String", 
  value: "String"
}

</td></tr><tr><td>

type.display\_value

</td><td>

Change type to display in a UI.Value is always "Normal".

 Data type: String

</td></tr><tr><td>

type.value

</td><td>

Internal type value.Value is always "normal".

 Data type: String

</td></tr><tr><td>

\_\_meta.ignoredFields

</td><td>

Key-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

</td></tr></tbody>
</table>

### cURL request

## Change Management - POST /sn\_chg\_rest/change/\{sys\_id\}/refresh\_impacted\_services

Populates the impacted services/configuration items \(CIs\) related list based on the primary CI.

The primary CI appears on the change request form and affected CI related list.

**Note:** All work items for this endpoint are performed asynchronously.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/{sys_id}/refresh_impacted_services`

Default URL: `/api/sn_chg_rest/change/{sys_id}/refresh_impacted_services`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of the change request to use to refresh the impacted services.Data type: String

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr><tr><td>

Content-Type

</td><td id="content_type-entry-RESTAPI">Data format of the request body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not Found. The specified record couldn't be found.|
|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

messages

</td><td>

Message information.Data type: Object

</td></tr><tr><td>

messages.errorMessages

</td><td>

Error messages encountered while processing the request. For example:

 Data type: Array

</td></tr><tr><td>

messages.infoMessages

</td><td>

Information messages encountered while processing the request. For example:

 Data type: Array

</td></tr><tr><td>

messages.warningMessages

</td><td>

Warning messages encountered while processing the request. For example:

 Data type: Array

</td></tr><tr><td>

request

</td><td>

Original endpoint request.Data type: String

</td></tr><tr><td>

state

</td><td>

Information on the current state of the worker.Data type: Object

 ```
state: {
  display_value: "String", 
  value: "String"
}

</td></tr><tr><td>

worker.link

</td><td>

URL to retrieve the status of the associated worker and other worker pertinent information.Data type: String

</td></tr><tr><td>

worker.sysId

</td><td>

Sys\_id of the worker associated with the change request.Data type: String

</td></tr></tbody>
</table>

### cURL request

## Change Management - POST /sn\_chg\_rest/change/standard/\{standard\_change\_template\_id\}

Creates 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.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/standard/{standard_change_template_id}`

Default URL: `/api/sn_chg_rest/change/standard/{standard_change_template_id}`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table id="table_o5l_xk2_xlb" class="rest_api_request_parameters"><thead><tr><th>

Parameter

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

standard\_change\_template\_id

</td><td>

Sys\_id of the standard change template on which to base the new standard change request.Data type: String

Table: Standard Change Template \[std\_change\_record\_producer\]

</td></tr></tbody>
</table>

<table id="table_i2g_hl2_xlb" class="rest_api_request_parameters"><thead><tr><th>

Parameter

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

Fields 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:

-   Description
-   Backout plan
-   Test plan
-   Implementation plan
-   Read-only fields as defined in ACLs
-   Fields that do not exist in the specified standard change template

Data type: String

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table id="table_ajc_wm2_xlb" class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not Found. The specified record couldn't be found.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body

The API returns these JSON or XML elements in the response body.

<table id="table_mc1_pr1_tx"><thead><tr><th>

Element

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

Name-value pairs of the fields that were created in the standard change request.Data type: Object

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id information of the newly created standard change request.Data type: Object

</td></tr><tr><td>

sys\_id.display\_value

</td><td>

Sys\_id of the standard change request to display in a UI.Data type: String

</td></tr><tr><td>

sys\_id.value

</td><td>

Sys\_id of the standard change request.Data type: String

</td></tr><tr><td>

\_\_meta.ignoredFields

</td><td>

Key-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

</td></tr></tbody>
</table>

### Sample cURL request

## Change Management - POST /sn\_chg\_rest/change/\{change\_sys\_id\}/task

Creates 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.

### URL format

Versioned URL: `/api/sn_chg_rest/{api_version}/change/{change_sys_id}/task`

Default URL: `/api/sn_chg_rest/change/{change_sys_id}/task`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. 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

</td></tr><tr><td>

change\_sys\_id

</td><td>

Sys\_id of the change request to which to associate this task.Data type: String

Table: Change Request \[change\_request\]

</td></tr></tbody>
</table>

<table class="rest_api_query_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

key-value pairs

</td><td>

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:

-   Business rules
-   Read-only fields as defined in ACLs
-   Fields that do not exist

 Data type: String

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The 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](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Request completed successfully.|
|400|Bad Request. A bad request type or malformed request was detected.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not Found. The specified record couldn't be found.|
|500|Internal Server Error. A logic error on the server-side code occurred.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

name-value pairs

</td><td>

Name-value pairs of the fields that were created in the change request task.Data type: Object

</td></tr><tr><td>

parent

</td><td>

Information for the change request associated to the task.Data type: Object

 ```
parent: {
  display_value: "String", 
  value: "String"
}

</td></tr><tr><td>

sys\_id.display\_value

</td><td>

Sys\_id of the change request task to display in a UI.Data type: String

</td></tr><tr><td>

sys\_id.value

</td><td>

Sys\_id of the change request task.Data type: String

</td></tr><tr><td>

\_\_meta.ignoredFields

</td><td>

Key-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

</td></tr></tbody>
</table>

### cURL request