---
sourceDocument: Yokohama API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CI Lifecycle Management API

# CI Lifecycle Management API {#ariaid-title1}

* Release version: Yokohama
* 
* Updated January 30, 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 30 minutes to read

The CI Lifecycle Management API provides endpoints to manipulate
configuration item (CI) operational states and apply CI actions.
The API interfaces adhere to restrictions and allowances specified by not allowed CI actions,
compatible CI actions, and not allowed operational transitions. If an interface attempts a
restricted operation, the operation is blocked, an error is logged, and a task is created if
appropriate.

## CI Lifecycle Management - DELETE /now/cilifecyclemgmt/actions {#ariaid-title2}

Removes a configuration item (CI) action for a list of CIs.

### URL format {#cilifecyclemgmt-DELETE-actions__section_fcm_jph_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/actions

Default URL:
/api/now/cilifecyclemgmt/actions  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-DELETE-actions__entry__2}{#cilifecyclemgmt-DELETE-actions__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 1. Path parameters]

{#cilifecyclemgmt-DELETE-actions__entry__6}{#cilifecyclemgmt-DELETE-actions__requestor-id-query-param-desc-entry}

| Name | Description |
|-|-|
| actionName | Required. Configuration item action name. Data type: String |
| requestorId | Required. Sys_id of a workflow context, or an operator user ID returned from the [CI Lifecycle Management - POST /now/cilifecyclemgmt/operators](https://www.servicenow.com/docs/0iuuVAVRN2Ff8GvgWIL8CA#cilifecyclemgmt-POST-operators "Registers an operator for a non-workflow user.") endpoint. Operator user IDs are located in the CI State Registered Users \[statemgmt_register_users\] table. Data type: String |
| sysIds | Required. Comma-separated list of CI sys_ids. Data type: String |
[Table 2. Query parameters]

{#cilifecyclemgmt-DELETE-actions__entry__14}

| Name | Description |
|-|-|
| None |   |
[Table 3. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-DELETE-actions__entry__18}{#cilifecyclemgmt-DELETE-actions__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 4. Request headers]

{#cilifecyclemgmt-DELETE-actions__entry__22}

| Header | Description |
|-|-|
| None |   |
[Table 5. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-DELETE-actions__table_od5_2wf_mmb__entry__2}{#cilifecyclemgmt-DELETE-actions__status-codes-200-desc-entry}{#cilifecyclemgmt-DELETE-actions__entry-401-status-code}{#cilifecyclemgmt-DELETE-actions__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 6. Status codes]

{#cilifecyclemgmt-DELETE-actions__table_od5_2wf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-DELETE-actions__entry__34}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-DELETE-actions__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.result | Flag indicating whether the CI action was successfully removed. Possible values: * true: CI action was removed. * false: CI action was not removed. {#cilifecyclemgmt-DELETE-actions__ul_psg_lsh_dmb} Data type: String |
[ ]

### cURL request

Remove a CI action from two CIs.

    curl --request DELETE \
    'https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33' \
    --header 'Accept: application/json' \
    --user "username":"password"

The response body confirms that the CI action was removed from the CIs.

    {
      "result": {
        "result": true
      }
    }

## CI Lifecycle Management - DELETE /now/cilifecyclemgmt/operators/{req_id} {#ariaid-title3}

Unregisters an operator for non-workflow users.

### URL format {#cilifecyclemgmt-DELETE-operators__section_xyw_syh_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/operators/{req_id}

Default URL:
/api/now/cilifecyclemgmt/operators/{req_id}  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-DELETE-operators__entry__2}{#cilifecyclemgmt-DELETE-operators__version-not_optional-RESTAPI}{#cilifecyclemgmt-DELETE-operators__req-id-data-type-p}

| Parameter | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| req_id | Sys_id of a workflow context, or an operator user ID returned from the [CI Lifecycle Management - POST /now/cilifecyclemgmt/operators](https://www.servicenow.com/docs/0iuuVAVRN2Ff8GvgWIL8CA#cilifecyclemgmt-POST-operators "Registers an operator for a non-workflow user.") endpoint. Operator user IDs are located in the CI State Registered Users \[statemgmt_register_users\] table.{#cilifecyclemgmt-DELETE-operators__req-id-table-p} Data type: String |
[Table 7. Path parameters]

{#cilifecyclemgmt-DELETE-operators__entry__8}

| Name | Description |
|-|-|
| None |   |
[Table 8. Query parameters]

{#cilifecyclemgmt-DELETE-operators__entry__12}

| Name | Description |
|-|-|
| None |   |
[Table 9. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-DELETE-operators__entry__16}{#cilifecyclemgmt-DELETE-operators__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 10. Request headers]

{#cilifecyclemgmt-DELETE-operators__entry__20}

| Header | Description |
|-|-|
| None |   |
[Table 11. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-DELETE-operators__table_hsj_2wf_mmb__entry__2}{#cilifecyclemgmt-DELETE-operators__status-codes-200-desc-entry}{#cilifecyclemgmt-DELETE-operators__entry-401-status-code}{#cilifecyclemgmt-DELETE-operators__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 12. Status codes]

{#cilifecyclemgmt-DELETE-operators__table_hsj_2wf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-DELETE-operators__table_kkt_tlk_lmb__entry__2}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-DELETE-operators__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.result | Flag indicating whether the operator was successfully unregistered. Possible values: * true: Operator was successfully unregistered. * false: Operator was not successfully unregistered. {#cilifecyclemgmt-DELETE-operators__ul_mkt_tlk_lmb} Data type: String |
[ ]

{#cilifecyclemgmt-DELETE-operators__table_kkt_tlk_lmb}  

### cURL request

Unregister an operator by user ID.

    curl --request DELETE \
    "https://instance.service-now.com/api/now/cilifecyclemgmt/operators/3cf1b3cc30121010f877773aa7167c6e" \
    --header "Accept: application/json" \
    --user "username":"password"

The response body verifies that the operator was unregistered.

    {
      "result": {
        "result": true
      }
    }

## CI Lifecycle Management - GET /now/cilifecyclemgmt/actions/{sys_id} {#ariaid-title4}

Returns a list of active configuration item (CI) actions for the specified
CI.

### URL format {#cilifecyclemgmt-GET-actions__section_m1y_5xm_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}

Default URL:
/api/now/cilifecyclemgmt/actions/{sys_id}  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-GET-actions__entry__2}{#cilifecyclemgmt-GET-actions__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| sys_id | Sys_id of the CI for which to return associated CI actions. Data type: String |
[Table 13. Path parameters]

{#cilifecyclemgmt-GET-actions__entry__8}

| Name | Description |
|-|-|
| None |   |
[Table 14. Query parameters]

{#cilifecyclemgmt-GET-actions__entry__12}

| Name | Description |
|-|-|
| None |   |
[Table 15. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-actions__entry__16}{#cilifecyclemgmt-GET-actions__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 16. Request headers]

{#cilifecyclemgmt-GET-actions__entry__20}

| Header | Description |
|-|-|
| None |   |
[Table 17. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-actions__table_lrs_cwf_mmb__entry__2}{#cilifecyclemgmt-GET-actions__status-codes-200-desc-entry}{#cilifecyclemgmt-GET-actions__entry-401-status-code}{#cilifecyclemgmt-GET-actions__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.ciActions parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 18. Status codes]

{#cilifecyclemgmt-GET-actions__table_lrs_cwf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-GET-actions__entry__32}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.ciActions | Comma-separated list of active CI actions for the CI, or `no_active_action` if none were found. Data type: String |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-GET-actions__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.result | Flag indicating whether the list of active CI actions was returned for all specified CIs. Possible values: * true: List of active CI actions was returned. * false: List of active CI actions was not returned. {#cilifecyclemgmt-GET-actions__ul_psg_lsh_dmb} Data type: String |
[ ]

### cURL request

    curl --request GET \
    'https://instance.service-now.com/api/now/cilifecyclemgmt/actions/00a9a80d3790200044e0bfc8bcbe5d1c' \
    --header 'Accept: application/json' \
    --user "username":"password"

The response body shows that no CI actions are active for the specified CI.

    {
      "result": {
        "ciActions": [
          "no_active_action"
        ],
        "result": true
      }
    }

## CI Lifecycle Management - GET /now/cilifecyclemgmt/compatActions {#ariaid-title5}

Determines whether two specified configuration item (CI) actions are
compatible.

### URL format {#cilifecyclemgmt-GET-compatAction__section_rgg_g2n_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/compatActions

Default URL:
/api/now/cilifecyclemgmt/compatActions  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-GET-compatAction__entry__2}{#cilifecyclemgmt-GET-compatAction__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 19. Path parameters]

{#cilifecyclemgmt-GET-compatAction__entry__6}

| Name | Description |
|-|-|
| actionName | Required. Name of CI action to compare. Data type: String |
| otherActionName | Required. Name of CI action to compare. Data type: String |
[Table 20. Query parameters]

{#cilifecyclemgmt-GET-compatAction__entry__12}

| Name | Description |
|-|-|
| None |   |
[Table 21. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-compatAction__entry__16}{#cilifecyclemgmt-GET-compatAction__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 22. Request headers]

{#cilifecyclemgmt-GET-compatAction__entry__20}

| Header | Description |
|-|-|
| None |   |
[Table 23. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-compatAction__table_vz1_cwf_mmb__entry__2}{#cilifecyclemgmt-GET-compatAction__status-codes-200-desc-entry}{#cilifecyclemgmt-GET-compatAction__entry-401-status-code}{#cilifecyclemgmt-GET-compatAction__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 24. Status codes]

{#cilifecyclemgmt-GET-compatAction__table_vz1_cwf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-GET-compatAction__entry__32}

| Name | Description |
|-|-|
| result | Flag indicating whether the two specified CI actions are compatible. Possible values: * true: CI actions are compatible. * false: CI actions are not compatible. {#cilifecyclemgmt-GET-compatAction__ul_hsp_chn_dmb} Data type: String |
[ ]

### cURL request

Check compatibility of Patching and Provisioning CI actions.

    curl --request GET \
    'https://instance.service-now.com/api/now/cilifecyclemgmt/compatActions?actionName=Patching&otherActionName=Provisioning' \
    --header 'Accept: application/json' \
    --user "username":"password"

The response body confirms that the two CI actions are compatible.

    {
      "result": true
    }

## CI Lifecycle Management - GET /now/cilifecyclemgmt/leases/{sys_id}/expired {#ariaid-title6}

Determines whether the lease has expired for the requestor of a configuration item (CI)
action applied to the specified CI.

### URL format {#cilifecyclemgmt-GET-leases-expired__section_kgl_mjn_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}/expired

Default URL:
/api/now/cilifecyclemgmt/leases/{sys_id}/expired  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-GET-leases-expired__entry__2}{#cilifecyclemgmt-GET-leases-expired__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| sys_id | Sys_id of the CI that is the target of the applied CI action. Data type: String |
[Table 25. Path parameters]

{#cilifecyclemgmt-GET-leases-expired__entry__8}{#cilifecyclemgmt-GET-leases-expired__requestor-id-query-param-desc-entry}

| Name | Description |
|-|-|
| actionName | Required. Name of the CI action applied to the specified CI. Data type: String |
| requestorId | Required. Sys_id of a workflow context, or an operator user ID returned from the [CI Lifecycle Management - POST /now/cilifecyclemgmt/operators](https://www.servicenow.com/docs/0iuuVAVRN2Ff8GvgWIL8CA#cilifecyclemgmt-POST-operators "Registers an operator for a non-workflow user.") endpoint. Operator user IDs are located in the CI State Registered Users \[statemgmt_register_users\] table. Data type: String |
[Table 26. Query parameters]

{#cilifecyclemgmt-GET-leases-expired__entry__14}

| Name | Description |
|-|-|
| None |   |
[Table 27. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-leases-expired__entry__18}{#cilifecyclemgmt-GET-leases-expired__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 28. Request headers]

{#cilifecyclemgmt-GET-leases-expired__entry__22}

| Header | Description |
|-|-|
| None |   |
[Table 29. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-leases-expired__table_hwr_bwf_mmb__entry__2}{#cilifecyclemgmt-GET-leases-expired__status-codes-200-desc-entry}{#cilifecyclemgmt-GET-leases-expired__entry-401-status-code}{#cilifecyclemgmt-GET-leases-expired__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 30. Status codes]

{#cilifecyclemgmt-GET-leases-expired__table_hwr_bwf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-GET-leases-expired__entry__34}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-GET-leases-expired__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.result | Flag indicating whether the lease for the requestor of the applied CI action has expired. Possible values: * true: Requestor's lease has expired. * false: Requestor's lease has not expired. {#cilifecyclemgmt-GET-leases-expired__ul_hsp_chn_dmb} Data type: String |
[ ]

### cURL request

    curl --request GET \
    'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/00a9a80d3790200044e0bfc8bcbe5d1c/expired?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a' \
    --header 'Accept: application/json' \
    --user "username":"password"

The response body shows that the lease for the requestor of the applied CI action has not
expired.

    {
      "result": {
        "result": false
      }
    }

## CI Lifecycle Management - GET /now/cilifecyclemgmt/notAllowedAction {#ariaid-title7}

Determines whether a specified configuration item (CI) action is not allowed for a CI
of a specified class when in a specified operational state.

### URL format {#cilifecyclemgmt-GET-notAllowedAct__section_wbv_pln_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/notAllowedAction

Default URL:
/api/now/cilifecyclemgmt/notAllowedAction  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-GET-notAllowedAct__entry__2}{#cilifecyclemgmt-GET-notAllowedAct__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 31. Path parameters]

{#cilifecyclemgmt-GET-notAllowedAct__entry__6}

| Name | Description |
|-|-|
| actionName | Required. Name of the CI action to check. Data type: String |
| ciClass | Required. CI class. Data type: String |
| opsLabel | Required. Operational state to check. Data type: String |
[Table 32. Query parameters]

{#cilifecyclemgmt-GET-notAllowedAct__entry__14}

| Name | Description |
|-|-|
| None |   |
[Table 33. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-notAllowedAct__entry__18}{#cilifecyclemgmt-GET-notAllowedAct__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 34. Request headers]

{#cilifecyclemgmt-GET-notAllowedAct__entry__22}

| Header | Description |
|-|-|
| None |   |
[Table 35. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-notAllowedAct__table_qqg_bwf_mmb__entry__2}{#cilifecyclemgmt-GET-notAllowedAct__status-codes-200-desc-entry}{#cilifecyclemgmt-GET-notAllowedAct__entry-401-status-code}{#cilifecyclemgmt-GET-notAllowedAct__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 36. Status codes]

{#cilifecyclemgmt-GET-notAllowedAct__table_qqg_bwf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-GET-notAllowedAct__entry__34}

| Name | Description |
|-|-|
| result | Flag indicating whether the CI action is restricted (not allowed) for CIs of the specified type when in the specified operational state. Possible values: * true: CI action is restricted (not allowed). * false: CI action is unrestricted (allowed). {#cilifecyclemgmt-GET-notAllowedAct__ul_hsp_chn_dmb} Data type: String |
[ ]

### cURL request

Check whether the Patching CI action is restricted (not allowed) for computers in the DR
Standby operational state.

    curl --request GET \
    "https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedAction?actionName=Patching&ciClass=cmdb_ci_computer&opsLabel=DR+Standby" \
    --header "Accept: application/json" \
    --user "username":"password"

The response body confirms that this action is restricted (not allowed) for the specified
CI class when in the specified operational state.

    {
      "result": true
    }

## CI Lifecycle Management - GET /now/cilifecyclemgmt/notAllowedOpsTransition {#ariaid-title8}

Determines whether a configuration item (CI) from a specified class can transition from
a specified operational state to a second specified operational state.

### URL format {#cilifecyclemgmt-GET-notAllowedOps__section_dmp_44n_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition

Default URL:
/api/now/cilifecyclemgmt/notAllowedOpsTransition  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-GET-notAllowedOps__entry__2}{#cilifecyclemgmt-GET-notAllowedOps__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 37. Path parameters]

{#cilifecyclemgmt-GET-notAllowedOps__entry__6}

| Name | Description |
|-|-|
| ciClass | Required. CI class to check transition restrictions for. Data type: String |
| opsLabel | Required. Label of current CI operational state. Data type: String |
| transitionOpsLabel | Required. Label of operational state that is the target of the transition. Data type: String |
[Table 38. Query parameters]

{#cilifecyclemgmt-GET-notAllowedOps__entry__14}

| Name | Description |
|-|-|
| None |   |
[Table 39. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-notAllowedOps__entry__18}{#cilifecyclemgmt-GET-notAllowedOps__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 40. Request headers]

{#cilifecyclemgmt-GET-notAllowedOps__entry__22}

| Header | Description |
|-|-|
| None |   |
[Table 41. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-notAllowedOps__table_clt_1wf_mmb__entry__2}{#cilifecyclemgmt-GET-notAllowedOps__status-codes-200-desc-entry}{#cilifecyclemgmt-GET-notAllowedOps__entry-401-status-code}{#cilifecyclemgmt-GET-notAllowedOps__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 42. Status codes]

{#cilifecyclemgmt-GET-notAllowedOps__table_clt_1wf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-GET-notAllowedOps__entry__34}

| Name | Description |
|-|-|
| result | Flag indicating whether the specified operational state transition is restricted (not allowed) for the specified CI class. Possible values: * true: Operational state transition is restricted (not allowed). * false: Operational state transition is unrestricted (allowed). {#cilifecyclemgmt-GET-notAllowedOps__ul_hsp_chn_dmb} Data type: String |
[ ]

### cURL request

Check whether transition from Retired operational state to DR Standby operational state is
restricted (not allowed) for Linux server CIs.

    curl --request GET \
    "https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedOpsTransition?ciClass=cmdb_ci_computer&opsLabel=Retired&transitionOpsLabel=DR+Standby" \
    --header "Accept: application/json" \
    --user "username":"password"

The response body shows that the specified operational state transition is unrestricted
(allowed) for this CI class.

    {
      "result": false
    }

## CI Lifecycle Management - GET /now/cilifecyclemgmt/requestors/{req_id}/valid {#ariaid-title9}

Determines whether the specified active workflow user or registered user is a valid
requestor.

### URL format {#cilifecyclemgmt-GET-req-valid__section_gdl_3d4_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/requestors/{req_id}/valid

Default URL:
/api/now/cilifecyclemgmt/requestors/{req_id}/valid  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-GET-req-valid__entry__2}{#cilifecyclemgmt-GET-req-valid__version-not_optional-RESTAPI}{#cilifecyclemgmt-GET-req-valid__req-id-data-type-p}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| req_id | Sys_id of a workflow context, or an operator user ID returned from the [CI Lifecycle Management - POST /now/cilifecyclemgmt/operators](https://www.servicenow.com/docs/0iuuVAVRN2Ff8GvgWIL8CA#cilifecyclemgmt-POST-operators "Registers an operator for a non-workflow user.") endpoint. Operator user IDs are located in the CI State Registered Users \[statemgmt_register_users\] table.{#cilifecyclemgmt-GET-req-valid__req-id-table-p} Data type: String |
[Table 43. Path parameters]

{#cilifecyclemgmt-GET-req-valid__entry__8}

| Name | Description |
|-|-|
| None |   |
[Table 44. Query parameters]

{#cilifecyclemgmt-GET-req-valid__entry__12}

| Name | Description |
|-|-|
| None |   |
[Table 45. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-req-valid__entry__16}{#cilifecyclemgmt-GET-req-valid__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 46. Request headers]

{#cilifecyclemgmt-GET-req-valid__entry__20}

| Header | Description |
|-|-|
| None |   |
[Table 47. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-req-valid__table_mbj_1wf_mmb__entry__2}{#cilifecyclemgmt-GET-req-valid__status-codes-200-desc-entry}{#cilifecyclemgmt-GET-req-valid__entry-401-status-code}{#cilifecyclemgmt-GET-req-valid__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 48. Status codes]

{#cilifecyclemgmt-GET-req-valid__table_mbj_1wf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-GET-req-valid__entry__32}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-GET-req-valid__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.result | Flag indicating whether the specified active workflow user or registered user is a valid requestor. Possible values: * true: Valid requestor. * false: Invalid requestor. {#cilifecyclemgmt-GET-req-valid__ul_hsp_chn_dmb} Data type: String |
[ ]

### cURL request

    curl --request GET \
    'https://instance.service-now.com/api/now/cilifecyclemgmt/requestors/4cab9b95301a9010f877773aa7167ca9/valid' \
    --header 'Accept: application/json' \
    --user "username":"password"

    {
      "result": {
        "result": true
      }
    }

## CI Lifecycle Management - GET /now/cilifecyclemgmt/statuses/{sys_id} {#ariaid-title10}

Returns the current operational state for the specified configuration item
(CI).

### URL format {#cilifecyclemgmt-GET-statuses__section_bgd_bf4_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}

Default URL:
/api/now/cilifecyclemgmt/statuses/{sys_id}  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-GET-statuses__entry__2}{#cilifecyclemgmt-GET-statuses__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| sys_id | Sys_id of the CI. Data type: String |
[Table 49. Path parameters]

{#cilifecyclemgmt-GET-statuses__entry__8}

| Name | Description |
|-|-|
| None |   |
[Table 50. Query parameters]

{#cilifecyclemgmt-GET-statuses__entry__12}

| Name | Description |
|-|-|
| None |   |
[Table 51. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-statuses__entry__16}{#cilifecyclemgmt-GET-statuses__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 52. Request headers]

{#cilifecyclemgmt-GET-statuses__entry__20}

| Header | Description |
|-|-|
| None |   |
[Table 53. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-GET-statuses__table_pdp_yvf_mmb__entry__2}{#cilifecyclemgmt-GET-statuses__status-codes-200-desc-entry}{#cilifecyclemgmt-GET-statuses__entry-401-status-code}{#cilifecyclemgmt-GET-statuses__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 54. Status codes]

{#cilifecyclemgmt-GET-statuses__table_pdp_yvf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-GET-statuses__entry__32}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-GET-statuses__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.operationalStates | Operational state for the specified CI or `unknown` if no state is specified. Data type: String |
[ ]

### cURL request

    curl --request GET 'https://instance.service-now.com/api/now/cilifecyclemgmt/statuses/aac0b1213784200044e0bfc8bcbe5de3' \
    --header 'Accept: application/json' \
    --user "username":"password"

    {
      "result": {
        "operationalState": "Repair in Progress",
        "result": true
      }
    }

## CI Lifecycle Management - PATCH /now/cilifecyclemgmt/leases/{sys_id} {#ariaid-title11}

Extends the specified configuration item (CI) action's lease expiration time for the
specified user.
If the previous lease has expired, the new lease time starts immediately.

### URL format {#cilifecyclemgmt-PATCH-leases__section_c22_hp4_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}

Default URL:
/api/now/cilifecyclemgmt/leases/{sys_id}  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-PATCH-leases__entry__2}{#cilifecyclemgmt-PATCH-leases__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| sys_id | Sys_id of the CI for which to extend the lease. Data type: String |
[Table 55. Path parameters]

{#cilifecyclemgmt-PATCH-leases__entry__8}{#cilifecyclemgmt-PATCH-leases__requestor-id-query-param-desc-entry}

| Name | Description |
|-|-|
| actionName | Required. Name of the associated CI action. Data type: String |
| leaseTime | Required. Time duration for which the lease is valid for the CI action specified in actionName. Data type: String Format: HH:MM:SS |
| requestorId | Required. Sys_id of a workflow context, or an operator user ID returned from the [CI Lifecycle Management - POST /now/cilifecyclemgmt/operators](https://www.servicenow.com/docs/0iuuVAVRN2Ff8GvgWIL8CA#cilifecyclemgmt-POST-operators "Registers an operator for a non-workflow user.") endpoint. Operator user IDs are located in the CI State Registered Users \[statemgmt_register_users\] table. Data type: String |
[Table 56. Query parameters]

{#cilifecyclemgmt-PATCH-leases__entry__16}

| Name | Description |
|-|-|
| None |   |
[Table 57. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-PATCH-leases__entry__20}{#cilifecyclemgmt-PATCH-leases__accept-RESTAPI}{#cilifecyclemgmt-PATCH-leases__content_type-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
| Content-Type | Data format of the request body. Supported types: application/json or application/xml. Default: application/json |
[Table 58. Request headers]

{#cilifecyclemgmt-PATCH-leases__entry__26}

| Header | Description |
|-|-|
| None |   |
[Table 59. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-PATCH-leases__table_rwq_xvf_mmb__entry__2}{#cilifecyclemgmt-PATCH-leases__status-codes-200-desc-entry}{#cilifecyclemgmt-PATCH-leases__entry-401-status-code}{#cilifecyclemgmt-PATCH-leases__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 60. Status codes]

{#cilifecyclemgmt-PATCH-leases__table_rwq_xvf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-PATCH-leases__entry__38}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-PATCH-leases__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.result | Flag indicating whether the lease time was extended. Possible values: * true: Lease time was extended. * false: Lease time was not extended. {#cilifecyclemgmt-PATCH-leases__ul_hsp_chn_dmb} Data type: String |
[ ]

### cURL request

Extend the duration of a Patching CI action requestor lease by 24 hours.

    curl --request PATCH 'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/affd3c8437201000deeabfc8bcbe5dc3?actionName=Patching&leaseTime=24:00:00&requestorId=e7c3402d305a9010f877773aa7167c2a' \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --user "username":"password"

    {
      "result": {
        "result": true
      }
    }

## CI Lifecycle Management - POST /now/cilifecyclemgmt/actions {#ariaid-title12}

Adds a specified configuration item (CI) action to a specified list of CIs.

### URL format {#cilifecyclemgmt-POST-actions__section_lmz_dv4_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/actions

Default URL:
/api/now/cilifecyclemgmt/actions  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-POST-actions__entry__2}{#cilifecyclemgmt-POST-actions__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 61. Path parameters]

{#cilifecyclemgmt-POST-actions__entry__6}{#cilifecyclemgmt-POST-actions__requestor-id-query-param-desc-entry}

| Name | Description |
|-|-|
| actionName | Required. Name of the CI action to add to the list. Data type: String |
| leaseTime | Time duration for which the lease is valid for specified CI action. Data type: String Format: HH:MM:SS |
| oldActionNames | Comma-separated list of old CI actions that all CIs should be in. Data type: String |
| requestorId | Required. Sys_id of a workflow context, or an operator user ID returned from the [CI Lifecycle Management - POST /now/cilifecyclemgmt/operators](https://www.servicenow.com/docs/0iuuVAVRN2Ff8GvgWIL8CA#cilifecyclemgmt-POST-operators "Registers an operator for a non-workflow user.") endpoint. Operator user IDs are located in the CI State Registered Users \[statemgmt_register_users\] table. Data type: String |
| sysIds | Required. Comma-separated list of CI sys_ids to which to add the CI action. Data type: String |
[Table 62. Query parameters]

{#cilifecyclemgmt-POST-actions__entry__18}

| Name | Description |
|-|-|
| None |   |
[Table 63. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-POST-actions__entry__22}{#cilifecyclemgmt-POST-actions__accept-RESTAPI}{#cilifecyclemgmt-POST-actions__content_type-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
| Content-Type | Data format of the request body. Supported types: application/json or application/xml. Default: application/json |
[Table 64. Request headers]

{#cilifecyclemgmt-POST-actions__entry__28}

| Header | Description |
|-|-|
| None |   |
[Table 65. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-POST-actions__table_wj1_xvf_mmb__entry__2}{#cilifecyclemgmt-POST-actions__status-codes-200-desc-entry}{#cilifecyclemgmt-POST-actions__entry-401-status-code}{#cilifecyclemgmt-POST-actions__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 66. Status codes]

{#cilifecyclemgmt-POST-actions__table_wj1_xvf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-POST-actions__entry__40}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-POST-actions__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.result | Flag indicating whether the CI action was set for all CIs in the list. Possible values: * true: CI actions were set. * false: CI actions were not set. {#cilifecyclemgmt-POST-actions__ul_hsp_chn_dmb} Data type: String |
[ ]

### cURL request

Add a Patching CI action to two CIs.

    curl --request POST \
    "https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password"

    {
      "result": {
        "result": true
      }
    }

## CI Lifecycle Management - POST /now/cilifecyclemgmt/operators {#ariaid-title13}

Registers an operator for a non-workflow user.

### URL format {#cilifecyclemgmt-POST-operators__section_b3l_kv4_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/operators

Default URL:
/api/now/cilifecyclemgmt/operators  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-POST-operators__entry__2}{#cilifecyclemgmt-POST-operators__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 67. Path parameters]

{#cilifecyclemgmt-POST-operators__entry__6}

| Name | Description |
|-|-|
| None |   |
[Table 68. Query parameters]

{#cilifecyclemgmt-POST-operators__entry__10}

| Name | Description |
|-|-|
| None |   |
[Table 69. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-POST-operators__entry__14}{#cilifecyclemgmt-POST-operators__accept-RESTAPI}{#cilifecyclemgmt-POST-operators__content_type-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
| Content-Type | Data format of the request body. Supported types: application/json or application/xml. Default: application/json |
[Table 70. Request headers]

{#cilifecyclemgmt-POST-operators__entry__20}

| Header | Description |
|-|-|
| None |   |
[Table 71. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-POST-operators__table_oj2_wvf_mmb__entry__2}{#cilifecyclemgmt-POST-operators__status-codes-200-desc-entry}{#cilifecyclemgmt-POST-operators__entry-401-status-code}{#cilifecyclemgmt-POST-operators__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 72. Status codes]

{#cilifecyclemgmt-POST-operators__table_oj2_wvf_mmb}

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-POST-operators__entry__32}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-POST-operators__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.requestorId | GUID for the registered operator. Use this value to set CI actions and operational states. Data type: String |
| result.result | Flag indicating whether the operator was successfully registered. Possible values: * true: Operator was successfully registered. * false: Operator was not successfully registered. {#cilifecyclemgmt-POST-operators__ul_hsp_chn_dmb} Data type: String |
[ ]

### cURL request

    curl --request POST \
    "https://instance.service-now.com/api/now/cilifecyclemgmt/operators" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password"

    {
      "result": {
        "result": true,
        "requestorId": "6f992b8430121010f877773aa7167c42"
      }
    }

## CI Lifecycle Management - POST /now/cilifecyclemgmt/statuses {#ariaid-title14}

Sets the operational state for a specified list of configuration items
(CIs).

### URL format {#cilifecyclemgmt-POST-statuses__section_shp_tw4_dmb}

Versioned URL:
/api/now/{api_version}/cilifecyclemgmt/statuses

Default URL:
/api/now/cilifecyclemgmt/statuses  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#cilifecyclemgmt-POST-statuses__entry__2}{#cilifecyclemgmt-POST-statuses__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 73. Path parameters]

{#cilifecyclemgmt-POST-statuses__entry__6}{#cilifecyclemgmt-POST-statuses__requestor-id-query-param-desc-entry}

| Name | Description |
|-|-|
| oldOpsLabels | Comma-separated list of old CI operational states in which all CIs should be included. Data type: String |
| opsLabel | Required. Label of the operational state to set for the specified CIs. Data type: String |
| requestorId | Required. Sys_id of a workflow context, or an operator user ID returned from the [CI Lifecycle Management - POST /now/cilifecyclemgmt/operators](https://www.servicenow.com/docs/0iuuVAVRN2Ff8GvgWIL8CA#cilifecyclemgmt-POST-operators "Registers an operator for a non-workflow user.") endpoint. Operator user IDs are located in the CI State Registered Users \[statemgmt_register_users\] table. Data type: String |
| sysIds | Required. Comma-separated list of sys_ids of CIs for which the operational state is to be set. Data type: String |
[Table 74. Query parameters]

{#cilifecyclemgmt-POST-statuses__entry__16}

| Name | Description |
|-|-|
| None |   |
[Table 75. Request body parameters (XML or JSON)]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-POST-statuses__entry__20}{#cilifecyclemgmt-POST-statuses__accept-RESTAPI}{#cilifecyclemgmt-POST-statuses__content_type-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
| Content-Type | Data format of the request body. Supported types: application/json or application/xml. Default: application/json |
[Table 76. Request headers]

{#cilifecyclemgmt-POST-statuses__entry__26}

| Header | Description |
|-|-|
| None |   |
[Table 77. Response headers]

### 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](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#cilifecyclemgmt-POST-statuses__entry__30}{#cilifecyclemgmt-POST-statuses__status-codes-200-desc-entry}{#cilifecyclemgmt-POST-statuses__entry-401-status-code}{#cilifecyclemgmt-POST-statuses__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 78. Status codes]

### Response body parameters (JSON or XML)

{#cilifecyclemgmt-POST-statuses__entry__38}

| Name | Description |
|-|-|
| result | Object encapsulating the result of the request. Data type: Object "result": { "errors": [Array], "result": "String" } |
| result.errors | List of objects in which each object represents an error encountered while processing the request. Data type: Array "errors": [ { "error": "String", "message": "String" } ] |
| result.errors.error | Identifier for a state management error encountered while processing the request. Possible values: * CI_ACTION_ALREADY_SET * CI_ACTION_NOT_SET * DUPLICATE_CI_ACTION_RECORD * DUPLICATE_OPS_STATE_RECORD * DUPLICATE_SYS_ID * INCOMPATIBLE_CI_ACTION * INVALID_CI_ACTION * INVALID_DELETE * INVALID_INPUT_PARAMETERS * INVALID_LEASETIME * INVALID_OPS_STATE * INVALID_OPS_STATE_TRANSITION * INVALID_REQUESTOR * INVALID_REQUESTOR_FOR_CI * INVALID_SYS_ID * MUTEX_UNAVAILABLE * NOT_ALLOWED_CI_ACTION * OPS_STATE_NOT_SET * UNPRIORITIZED_OPS_STATE * UNSUPPORTED_SYS_ID {#cilifecyclemgmt-POST-statuses__ul_ghk_2fk_lmb} Data type: String |
| result.errors.message | Message providing details on the associated error. Data type: String |
| result.result | Flag indicating whether the desired state was set for all CIs included in the request. Possible values: * true: Operational state set. * false: Operational state not set. {#cilifecyclemgmt-POST-statuses__ul_hsp_chn_dmb} Data type: String |
[ ]

### cURL request

Set the `Repair in Progress` operational state for two CIs.

    curl --request POST \
    "https://instance.service-now.com/api/now/cilifecyclemgmt/statuses?opsLabel=Repair%20in%20Progress&requestorId=23d58bc030121010f877773aa7167c83&sysIds=affd3c8437201000deeabfc8bcbe5dc3,aac0b1213784200044e0bfc8bcbe5de3" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password"

The response body shows that the desired operational state was set for both CIs specified
in the request.

    {
      "result": {
        "result": true
      }
    }