{"type":"api","title":"Get all devices","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/7c48b645-9c1b-3c59-9c5a-150c8b12ee59","info":{"title":"Inventory APIs","description":"APIs exposed by Inventory service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.2.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/inventory-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/inventory/v1/networkelement","description":"Generated server url"}]},"spec":{"tags":["Inventory"],"summary":"Get all devices","description":"Detailed description of all the devices.","operationId":"getDevices","parameters":[{"name":"page","in":"query","required":false,"description":"page number","schema":{"type":"string","example":"\u003e=0"}},{"name":"size","in":"query","required":false,"description":"number of records to return per page","schema":{"type":"string","example":"100-1000"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"DeviceDetailsDTO","properties":{"deviceName":{"type":"string","description":"deviceName"},"deviceAddress":{"type":"string","description":"deviceAddress"},"productFamily":{"type":"string","description":"productFamily"},"productType":{"type":"string","description":"productType"},"owningEntityID":{"type":"string","description":"owningEntityID"},"neID":{"type":"string","description":"neID"},"lifeCycleState":{"type":"string","description":"lifeCycleState"},"inventoryCollectionTime":{"type":"string","description":"inventoryCollectionTime"},"softwareType":{"type":"string","description":"softwareType"},"softwareVersion":{"type":"string","description":"softwareVersion"},"creationTime":{"type":"string","description":"creationTime"},"adminStatus":{"type":"string","description":"adminStatus"},"inventoryCollectionStatus":{"type":"string","description":"inventoryCollectionStatus"},"serialNumber":{"type":"string","description":"serialNumber"},"model":{"type":"string","description":"model"},"uuid":{"type":"string","description":"uuid"}},"$$ref":"#/components/schemas/DeviceDetailsDTO"}},"examples":{"example":{"summary":"Sample Response","value":[{"deviceName":"ncs5508-124.28","deviceAddress":"10.104.124.28","productFamily":"Routers","productType":"Cisco NCS 5508","owningEntityID":"443443_10.104.124.28","neID":"446446","lifeCycleState":"MANAGED_AND_SYNCHRONIZED","inventoryCollectionTime":"August 31, 2025 4:35:34 PM UTC","softwareType":"IOSXR","softwareVersion":"25.3.1.36I","creationTime":"July 28, 2025 10:00:13 AM UTC","adminStatus":"Managed","inventoryCollectionStatus":"Completed","serialNumber":"FGE21151V6V","model":"73-17789-02","uuid":"14aa9525-7d40-453f-8b95-c80e3e366e97"}],"$$ref":"#/components/examples/DeviceDetailsQueryResponse"}}}}},"206":{"description":"Partial Content. Server successfully fulfilled a range request. Response will have records falling in items range passed in headers.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"DeviceDetailsDTO","properties":{"deviceName":{"type":"string","description":"deviceName"},"deviceAddress":{"type":"string","description":"deviceAddress"},"productFamily":{"type":"string","description":"productFamily"},"productType":{"type":"string","description":"productType"},"owningEntityID":{"type":"string","description":"owningEntityID"},"neID":{"type":"string","description":"neID"},"lifeCycleState":{"type":"string","description":"lifeCycleState"},"inventoryCollectionTime":{"type":"string","description":"inventoryCollectionTime"},"softwareType":{"type":"string","description":"softwareType"},"softwareVersion":{"type":"string","description":"softwareVersion"},"creationTime":{"type":"string","description":"creationTime"},"adminStatus":{"type":"string","description":"adminStatus"},"inventoryCollectionStatus":{"type":"string","description":"inventoryCollectionStatus"},"serialNumber":{"type":"string","description":"serialNumber"},"model":{"type":"string","description":"model"},"uuid":{"type":"string","description":"uuid"}},"$$ref":"#/components/schemas/DeviceDetailsDTO"}},"examples":{"example":{"summary":"Sample Response","value":[{"deviceName":"ncs5508-124.28","deviceAddress":"10.104.124.28","productFamily":"Routers","productType":"Cisco NCS 5508","owningEntityID":"443443_10.104.124.28","neID":"446446","lifeCycleState":"MANAGED_AND_SYNCHRONIZED","inventoryCollectionTime":"August 31, 2025 4:35:34 PM UTC","softwareType":"IOSXR","softwareVersion":"25.3.1.36I","creationTime":"July 28, 2025 10:00:13 AM UTC","adminStatus":"Managed","inventoryCollectionStatus":"Completed","serialNumber":"FGE21151V6V","model":"73-17789-02","uuid":"14aa9525-7d40-453f-8b95-c80e3e366e97"}],"$$ref":"#/components/examples/DeviceDetailsQueryResponse"}}}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"__originalOperationId":"getDevices","method":"get","path":"/devicedetails/query"}}