Save CI

Table 1. API: Save CI Record with CI Relationship
Element Description
API Saveci
Description

This API Create new CI record in HCL BigFix CLM database. Objectid, objecttype, requestnumber and itemnumber are mandatory parameters for a CI record.

* Refer Accessibility Matrix for permission.

Method POST
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/ci
Body Parameters
{
"objectId":"testVM_new",
"objectType":"VM",
"requestNumber":"1",
"itemnumber":"1",
“ciRelatedIDs”:”1,2",
"parentobjectId":"testVMs",
"parentObjectType":"VM"
}
  • Minimum mandatory fields for Insert
{
"objectId":"testVMsonal_new",
"objectType":"VM",
"requestNumber":"1",
"itemnumber":"1",
}
  • Objectid (Mandatory): Unique Id of resource.
  • Objecttype: (Mandatory): Type of resource.
  • ciRelatedIDs :(Optional): If a user wants to establish a relationship of a saved CI with an existing CI, then the user needs to provide CI ids separated with comma (1,2,3) in Json.
  • parentobjectId :(Optional): Name of object to make a parent of added CI.
  • parentObjectType:(Optional): Type of object.
Header
  • Authorization Key: The initial step that needs to be performed before consuming HCL BigFix CLM APIs is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
  • Content-type: application/json
Response

A Sample Response:

{
"ciId": "287"
}
Response Parameters
  • CiId