Get CI Details

This API is used to get CI details.

CI Details

Purpose To Get CI details based on Group Id.

API URL https://<API URL>:<API Port>/v2/inventory/hostname/{orgentityid}/{groupId}/{tasknumber}

Authentication type Basic/Token

Method Type GET

Example https://<API URL>:<API Port>/v2/inventory/hostname/1/1/Task1

Table 62 - Parameters required in Request body of API.


Column	Column type	Remarks
orgentityid	string	The Configuration name for the internal secret manager.
groupId	string	Unique identifier of group
tasknumber	string	Unique identifier of task number

Output:

{
 "Count": 1,
 "Result": [
 {
 "HostName": " XXXXXXXX ",
 "device_ci_name": " XXXXXXXX ",
 "device_management_ip": " XXXXXXXX ",
 "device_firmware_version": "",
 "device_type": "Access Point",
 "Col1": "Test-col1",
 "Col2": "Test-col1",
 "Col3": "Test-col1",
 "Col4": "Test-col1",
 "Col5": "Test-col1",
 "device_manufacturername": "HP",
 "device_model": "",
 "device_location": "",
 "device_subcategory": "",
 "device_componentcategory": "",
 "device_productname": "",
 "device_enviornment": "",
 "device_componentcriticality": "",
 "device_status": "Deployed"
 }
 ],
 "Status": "Success",
 "Message": "Success"
 }

Table 63 - Parameters Returned in Response of API


Column	Column type	Value	Remarks
Count	int	1	This field provide configuration name of number of entries
Status	string	Success/Fail	This field provide status
Message	string	Success/Fail	This field provides message
HostName	string	HostName	This filed provides hostname
device_ci_name	string	ciname	This field provides ci name
device_management_ip	string	management_ip	This field provides management IP
evice_firmware_version	string	version	This field provide firmware version
device_type	string	devicetype	This field provides device type
Col1	string		You can use it for any custom value
Col2	string		You can use it for any custom value
Col3	string		You can use it for any custom value
Col4	string		You can use it for any custom value
Col5	string		You can use it for any custom value
device_manufacturername	string		This field provides manufacturer name
device_model	string		This field provides model name
device_location	string		This field provides locations
device_subcategory	string		This field provides subcategory name
device_componentcategory	string		This field provides component category name
device_productname	string		This field provides product name
device_enviornment	string		This field provides device environment name
device_componentcriticality	string		This field provides component criticality
device_status	string		This field provides status