Get ALL CIs

Table 1. API: Get All CI Details
Element Description
API Getallcidetails
Description

This API returns all records of CI of an organization.

* Refer Accessibility Matrix for permission.

Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/ci?queryParams= {"filter":"ObjectId='TESTVM1'","sortby":"","sortorder":"","pagenumber":"1","pagesize":"20000" }
URL Parameters (test in curly {} braces)
  • queryParams (Optional): It is used for filtering and sorting of records. It has three properties, which are as follows:
  • Filter: To filter records based on column name received from output. E.g., Filter="keyname='keyvalue'"
  • Sort Order: To define sorting order either ASC (Ascending) or DESC (descending). E.g., Sortorder="ASC".
  • Page Number: To get the records for related page number. Eg. Pagenumber="1”
  • Page Size: To get the number of records on selected page. Eg. Pagesize="10”
For e.g.
{"filter": "cityName=’Virginia’","sortorder": "desc", "pagenumber" : "1", "pagesize" : "10"}
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
{
"totalRecords": 1,
"records": [
{
"ciId": 225,
"objectId": "TestVM",
"platformEntityId": "ARM-2C38BDC3-1695-4175-B6EC-BFCA0F89F341",
"objectStatus": "NEW",
"userName": "",
"requestNumber": 0,
"itemNumber": 1,
"platformName": "ARM",
"userEntityID": "",
"userEmail": "",
"objectType": "VM",
"displayName": "",
"resourceGroup": "",
"primaryIP": "",
"machineName": "",
"vmDisplayName": "",
"actualDiskJSON": "",
"tierName": "",
"storageName": "",
"regionName": "",
"elbName": "",
"recoveryValut": "",
"policyName": "",
"locationName": "",
"isAvailabilitySet": "",
"availabilitySet": "",
"provisionDate": "02/22/2022",
"templateType": "",
"decommisionDate": "03/16/2022",
"size": "",
"privateDNS": "",
"publicDNS": "",
"servicePlanId": "",
"networkName": "",
"primarySubnet": "",
"leasePeriod": "",
"powerStatus": "",
"memoryInMB": "",
"ipAddress": "",
"computerName": "",
"osDiskSize": "",
"dataDisk1Size": "",
"dataDisk2Size": "",
"dataDisk3Size": "",
"dataDisk4Size": "",
"dataDisk5Size": "",
"numberOfCPCU": "",
"customField1": "test",
"customField2": "",
"customField3": "",
"customField4": "",
"customField5": "",
"customField6": "",
"customField7": "",
"customField8": "",
"customField9": "",
"customField10": "",
"isBackup": " ",
"isEnableMonitoring": " ",
"diskType": "",
"isImported": "N",
"keyPair": "",
"dataCenterName": "",
"clusterName": "",
"hostName": "",
"os": "",
"primaryDefault": "",
"backupIP": "",
"backupDefault": "",
"backupSubnet": "",
"machineStatus": "4",
"vpcName": "",
"securityGroup": "",
"cloudName": "",
"tags": "",
"networkDetails": "",
"objectJson": "",
"customField11": "",
"customField12": "",
"customField13": "",
"customField14": "",
"customField15": "",
"customField16": "",
"customField17": "",
"customField18": "",
"customField19": "",
"customField20": ""
}
]
}
Response Parameters
  • totalRecords
  • records –json of all columns of CI.

"ciId": 225,

"objectId": "TestVM",

"platformEntityId": "ARM-2C38BDC3-1695-4175-B6EC-BFCA0F89F341",

"objectStatus": "NEW",

"userName": "",

"requestNumber": 0,

"itemNumber": 1,

"platformName": "ARM",

"userEntityID": "",

"userEmail": "",

"objectType": "VM",

"displayName": "",

"resourceGroup": "",

"primaryIP": "",

"machineName": "",

"vmDisplayName": "",

"actualDiskJSON": "",

"tierName": "",

"storageName": "",

"regionName": "",

"elbName": "",

"recoveryValut": "",

"policyName": "",

"locationName": "",

"isAvailabilitySet": "",

"availabilitySet": "",

"provisionDate": "02/22/2022",

"templateType": "",

"decommisionDate": "03/16/2022",

"size": "",

"privateDNS": "",

"publicDNS": "",

"servicePlanId": "",

"networkName": "",

"primarySubnet": "",

"leasePeriod": "",

"powerStatus": "",

"memoryInMB": "",

"ipAddress": "",

"computerName": "",

"osDiskSize": "",

"dataDisk1Size": "",

"dataDisk2Size": "",

"dataDisk3Size": "",

"dataDisk4Size": "",

"dataDisk5Size": "",

"numberOfCPCU": "",

"customField1": "test",

"customField2": "",

"customField3": "",

"customField4": "",

"customField5": "",

"customField6": "",

"customField7 "",

"customField8

"customField9

"customField10

"isBackup

"isEnableMonitoring

"diskType

"isImported

"keyPair

"dataCenterName

"clusterName

"hostName

"os

"primaryDefault

"backupIP

"backupDefault

"backupSubnet

"machineStatus

"vpcName

"securityGroup

"cloudName

"tags"

"networkDetails

"objectJson

"customField11

"customField12

"customField13

"customField14

"customField15

"customField16

"customField17

"customField18

customField19

customField20