Get All CI

API CI
Purpose To fetch all the CI.
API URL https://<API URL>:<API Port>/v1/ci/orgentityid/{orgentityid}?startdate={startdate}&enddate={enddate}
Authentication type Basic/Token
Method Type Get
Input Params in Query String:

You can pass the following filters in the URL and query params to get desired data:

  • orgentityid (URL)
  • startdate (query params)
  • enddate (query params)

Parameters Required in API

Column Column type Remarks
orgentityid string The organization entity ID.
startdate string It defines the beginning of the time window used to calculate the count of tickets that were resolved. The startdate in the format YYYY-MM-DD hh:mm:ss.
enddate string It specifies the end of the date range for counting resolved tickets. The enddate in the format YYYY-MM-DD hh:mm:ss.
Note:

If no dates are provided, data from the past year is considered. If only the start date is given, the end date defaults to today. If only the end date is given, the start date defaults to one year before it.

Output:

{ 
"Count": 1, 
"Result": 
[ 
{ 
"ServiceId": null, 
"DataSourceId": null, 
"ToolCIId": null, 
"ToolCIName": "myCIName", 
"ToolCICategory": "myCategory", 
"ToolCIType": "myType", 
"Col1": null, 
"Col2": null, 
"COl3": null, 
"Col4": null, 
"Col5": null, 
"Col6": null, 
"Col7": null, 
"Col8": null, 
"Col9": null, 
"Col10": null, 
"Col11": null, 
"Col12": null, 
"Col13": null, 
"Col14": null, 
"Col15": null, 
"SupportGroup": "mySupportGroup", 
"SnowSysId": null, 
"Hostname": "myHost", 
"ManagementIP": "myManagementIP", 
"Application": null, 
"Status": "myStatus", 
"SubStatus": null, 
"SubCategory": "mySubcategory", 
"ManufacturerName": "myManufacturerName", 
"ProductName": "myProductName", 
"Model": "myModel", 
"Enviornment": null, 
"Location": "myLocation", 
"LocationMiradore": null, 
"SerialNumber": "mySerialNumber", 
"Vendor": "myVendor", 
"ComponentCriticality": null, 
"ComponentCategory": null, 
"Function": null, 
"OS": null, 
"BusinessUnit": null, 
"Country": null, 
"Continent": null, 
"DistributionReferenceNumber": null, 
"Region": null, 
"Role": null, 
"FirmwareVersion": null, 
"TftpIP": null, 
"DeviceCreated": "May 16 2025 12:00AM", 
"IsBackupEnable": null, 
"ProductId": null, 
"SoftwareVersion": "myVersion", 
"LastSoftwareVersion": null, 
"LastPatched": "May 14 2025 12:00AM", 
"NetworkType": null, 
"NetworkCategory": null 
} 
] 
}

Parameters Returned in Response of API

Column type Value Column Remarks
Count string Total count of the CI. Count of CI
Result JSON All CI details Provides all CI fetched.
Status string Success/Fail This field provides status.
Message String Success Request status info.