Skip to main content

POST Relate an Asset/CI

URL: http://{{server-url}}/api/v1/problem/{{problem-Id}}/relation/bulk/create

Example: http://{{server-url}}/api/v1/problem/1/relation/bulk/create

You can relate a problem with the required Asset(s) or CI(s) by calling the above endpoint with the problem ID. You have to pass the following key-values:

note
  • You can establish relationships with multiple assets/CIs.
  • However, archived or in-stage assets/CIs cannot be related.
  • If any assets/CIs included in the API are unavailable, archived, or in stage, a partial relationship cannot be created.
  • This API is available from version 8.7.2 onwards.

Header

KeyDescription
AuthorizationBearer {access token obtained after authorization} or API Key
Content-Typeapplication/json

Body

KeyValue TypeDescription
destinationModelStringEnter the module with which the change request must be linked. Possible values are:

- hardware= asset_hardware

- cmdb=cmdb

- Software= asset_software

- nonit=asset_non_it

destination NamesStringName of the Asset or CI.
typeStringRelation type.

For example:

{
"destinationModel": "asset_hardware",
"destinationNames": [
"AST-2","AST-1"
],
"type": "related"
}

Asset Example (Request & Response)

Request

curl --location 'http://172.16.11.148/api/v1/problem/1/relation/bulk/create' \
--header 'Authorization: Bearer eyJraWQiOiJmbG90by1rZXktaWQiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJqZXJyeUBtb3RhZGF0YS5jb20iLCJ1c2VyX25hbWUiOiJ1dWlkMzYtZmM4Mjc3NWItZjM1Ni00MWM4LWIyMGMtN2Q3MWE2MjI4MzFkIiwiaXNzIjoiaHR0cDovLzE3Mi4xNi4xMS4xNDgvYXBpIiwibG9naW5fc291cmNlIjoiTk9STUFMX0xPR0lOIiwiY2xpZW50X2lkIjoiUG9zdG1hbi1jbGllbnQiLCJhdWQiOiJQb3N0bWFuLWNsaWVudCIsImxvZ2luX3Nzb19pZCI6MCwibmJmIjoxNzcwNzIxMTQ5LCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJzY29wZSI6WyJvdGhlci1hcGktc2NvcGUiXSwiZXhwIjoxNzcwODkzOTQ5LCJsb2dpbl9tc3BfcG9ydGFsX2lkIjowLCJpYXQiOjE3NzA3MjExNDksImp0aSI6ImViNTY5ODA0LWFlZTMtNGRmMS04MGJjLWU5ODJkZGQxOWQ5NSIsInRlbmFudElkZW50aWZpZXIiOiJhcG9sbyJ9.rca4U4WWUXwrCW6zPbN4JIBoyTQPtJj0EloSdwNvobw2qEG9ScX2Qsuq8H9iEDJCus0m-2DgHZk8SgB4LWhuACoX_NHpODvBIaXntfnXfmtV5tvOrt01zJ9vBhQ9w8JHH6o_YkcoB4JsXB8lYRYCxmBXMV33msCIHkJICTUS_SR4jD2RvXnHESDDmOYH5IT0OQq18NWrEJRZi9SfykiUtkNfSneGYF-0y0H_zm0bo0kiHK6Mmz_aByvUkRzBtGSZrH22C4dZl9osn2vh0ELR32EDHuZy19i2T3cAEvtVP_Cr3Oq43UzA2RBkKKHDV2UucRofiDgw_w1vIb9rqGmRPA' \
--header 'Content-Type: application/json' \
--data '{
"destinationModel": "asset_hardware",
"destinationNames": [
"AST-1"
],
"type": "related"
}'

Response

{
"successIds": [
1
],
"failerIds": null
}

CI Example (Request & Response)

Request

curl --location 'http://172.16.11.148/api/v1/problem/1/relation/bulk/create' \
--header 'Authorization: Bearer eyJraWQiOiJmbG90by1rZXktaWQiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJqZXJyeUBtb3RhZGF0YS5jb20iLCJ1c2VyX25hbWUiOiJ1dWlkMzYtZmM4Mjc3NWItZjM1Ni00MWM4LWIyMGMtN2Q3MWE2MjI4MzFkIiwiaXNzIjoiaHR0cDovLzE3Mi4xNi4xMS4xNDgvYXBpIiwibG9naW5fc291cmNlIjoiTk9STUFMX0xPR0lOIiwiY2xpZW50X2lkIjoiUG9zdG1hbi1jbGllbnQiLCJhdWQiOiJQb3N0bWFuLWNsaWVudCIsImxvZ2luX3Nzb19pZCI6MCwibmJmIjoxNzcwNzIxMTQ5LCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJzY29wZSI6WyJvdGhlci1hcGktc2NvcGUiXSwiZXhwIjoxNzcwODkzOTQ5LCJsb2dpbl9tc3BfcG9ydGFsX2lkIjowLCJpYXQiOjE3NzA3MjExNDksImp0aSI6ImViNTY5ODA0LWFlZTMtNGRmMS04MGJjLWU5ODJkZGQxOWQ5NSIsInRlbmFudElkZW50aWZpZXIiOiJhcG9sbyJ9.rca4U4WWUXwrCW6zPbN4JIBoyTQPtJj0EloSdwNvobw2qEG9ScX2Qsuq8H9iEDJCus0m-2DgHZk8SgB4LWhuACoX_NHpODvBIaXntfnXfmtV5tvOrt01zJ9vBhQ9w8JHH6o_YkcoB4JsXB8lYRYCxmBXMV33msCIHkJICTUS_SR4jD2RvXnHESDDmOYH5IT0OQq18NWrEJRZi9SfykiUtkNfSneGYF-0y0H_zm0bo0kiHK6Mmz_aByvUkRzBtGSZrH22C4dZl9osn2vh0ELR32EDHuZy19i2T3cAEvtVP_Cr3Oq43UzA2RBkKKHDV2UucRofiDgw_w1vIb9rqGmRPA' \
--header 'Content-Type: application/json' \
--data '{
"destinationModel": "cmdb",
"destinationNames": [
"CI-1"
],
"type": "related"
}'

Response

{
"successIds": [
3
],
"failerIds": null
}