Develop > Developer Reference > Using APIs > Universal CMDB REST API > Reference > Update CI

Update CI

This call updates the details of a CI.

URL

/dataModel/ci/{id}

Method

PUT

Headers

Required: 

Authorization: Bearer <token>

Note <token> is the token that is returned by the Authentication call.

Example: 

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0Njc5ODQ5MTcsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.Ph8WHtzvpvfuH1j0CtwHqyBhX1uLlfhr0eQQ7m0_gT0

Request type

JSON

Response type

JSON

URL Parameters

Path Parameters

Required:

{id}: [ucmdb_id]

Data Types:

[ucmdb_id]

The string that represents the UCMDB ID of a configuration item.

Payload 

{
  "ucmdbId": [ucmdb_id],
  "type": [ucmdb_cit],
  "properties": {
    "<ucmdb_cit_prop>": [ucmdb_cit_prop_value],
    …
  }
}

Note  

  • The …(three dots) denotes that there can be 0 or more values.
  • You have to specify only the properties that you want to update. Do not specify all properties of the CI.
  • You cannot update the type or the ID of the CI.

Data Types:

[ucmdb_id]

The string that represents the UCMDB ID of a CI.

[ucmdb_cit]

The string that represents the name of a valid CI Type from the UCMDB.

[ucmdb_cit_prop_value]

The property value, which can be integer, string, Boolean, long, double, ISO8601 date, or a list of values depending on the CIT property data type.

Custom fields:

<ucmdb_cit_prop>

The valid property name of the CI Type. You can get the name and the list of all properties of a CI Type from the CI Type Manager.

Example: 

{
  "ucmdbId": "4dc01bee04c76cc0ac4bb069f46e8b56",
  "type": "node",
  "properties": {
    "root_candidatefordeletetime": "2016-07-31T08:41:54.189Z",
    "data_operationisnew": "false",
    "root_class": "node",
    "display_label": "test2",
    "data_operationstate": "0:Normal",
    "data_allow_auto_discovery": "true",
  }
}

Success response

Status: 200

Response: 

{
     "addedCis": list of [ucmdb_id]
     "removedCis": list of [ucmdb_id],
     "updatedCis": list of [ucmdb_id],
     "ignoredCis": list of [ucmdb_id]
}

Data Types:

[ucmdb_id]

The string that represents the UCMDB ID of a CI.

Example:

Code: 200

Content: 

{
    "addedCis": [],
    "removedCis": [],
    "updatedCis": [
        "4b8416a13e686092b2a2e142ecceff46"
    ],
    "ignoredCis": []
}

Error response

Status: 404 or 400

Content: 

{
  error: [string]
}

Example:

Code: 404

Content: 

{
   error: The following error has occurred:  The CI with the specified id was not found. Please consult logs for more details
}

Note

The user that the token belongs to must have the required permissions for updating the data inside UCMDB through the SDK.

Note When updating a CI using the PUT method, the client should know that reconciliation engine attributes are not required. Reconciliation attributes are required just for CI creation.

Send Help Center feedback