{"type":"api","title":"Inventory data for search keyword","meta":{"id":"/apps/pubhub/media/conc-2511/d77fe2fa1c66c5533550637c8fa49491e06b8c79/77098a86-496d-3923-960f-448e29c77e05","info":{"title":"ONC 3.1 API","version":"1.0.0-25.1.1","description":"Swagger documentation for CONC UI APIs","contact":{"name":"CONC UI API Support","url":"https://www.cisco.com","email":"support@cisco.com"},"license":{"name":"cisco.com","url":"cisco.com"}},"security":[],"tags":[{"name":"alarms","description":"Operations related to alarm management"},{"name":"alienImport","description":"Operations for importing alien data"},{"name":"health","description":"Operations related to Health check"},{"name":"highAvailability","description":"Operations for managing high availability"},{"name":"inventory","description":"Operations related to inventory management"},{"name":"links","description":"Operations for managing network links"},{"name":"logs","description":"Operations for managing system logs"},{"name":"nodes","description":"Operations for managing nodes"},{"name":"pmHistory","description":"Operations for managing performance monitoring history"},{"name":"serviceManager","description":"Operations for managing services"},{"name":"swimu","description":"Operations for managing software upgrades and backups"},{"name":"topology","description":"Operations for managing topology"}],"x-parser-conf":{"overview":{"markdownPath":"reference/2431/ui.md"},"serverConfig":"full","enableAuthEditing":true,"httpBasic":{"username":"api-user","password":"encrypted-password@123"}},"openapi":"3.0.0","securitySchemes":{"BearerAuth":{"description":"bearerAuthDetails","type":"http","scheme":"bearer","bearerFormat":"JWT"},"oAuthSample":{"description":"SecurityOAuth","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://api.example.com/oauth2/authorize","scopes":{"read_alarms":"read alarms in your account","write_alarms":"read alarms in your account","write":"write pmHistory","read":"read pmHistory"}}}}}},"spec":{"operationId":"networkInventorySearch","tags":["inventory"],"parameters":[{"in":"query","name":"keyword","required":true,"description":"Parameter to filter based on the keyword","schema":{"type":"string"},"example":"NCS"}],"description":"Get a list of all inventory data for a search keyword","summary":"Inventory data for search keyword","responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Attribute for Inventory Node Response","properties":{"nodeName":{"type":"string","description":"Attribute for Node Name"},"eqptType":{"type":"string","description":"Attribute for Equipment Type"},"adminState":{"type":"string","nullable":true,"description":"Attribute for Admin State"},"eqptState":{"type":"string","nullable":true,"description":"Attribute for Equipment State"},"actualEqptType":{"type":"string","nullable":true,"description":"Attribute for Actual Equipment Type"},"serialNumber":{"type":"string","nullable":true,"description":"Attribute for Serial Number"},"manufacturingDate":{"type":"string","nullable":true,"description":"Attribute for Manufacturing Date"},"pid":{"type":"string","nullable":true,"description":"Attribute for PID"},"HWpartNum":{"type":"string","nullable":true,"description":"Attribute for HW Part Number"},"VersionID":{"type":"string","description":"Attribute for Version ID"},"CLEICode":{"type":"string","nullable":true,"description":"Attribute for CLEI Code"},"SWRev":{"type":"string","nullable":true,"description":"Attribute for SW Revision"},"BootRomRev":{"type":"string","nullable":true,"description":"Attribute for Boot Rom Revision"},"isAncillary":{"type":"boolean","nullable":true,"description":"Attribute for Ancillary"},"parentDetails":{"type":"string","nullable":true,"description":"Attribute for Parent Details"},"UID":{"type":"string","description":"Attribute for UID"},"hasChildren":{"type":"boolean","description":"Attribute for Has Children"},"manufacturingID":{"type":"string","description":"Attribute for Manufacturing ID"},"siteName":{"type":"string","description":"Attribute for Site Name"}},"$$ref":"#/components/schemas/InventoryNodeResponse"}},"example":[{"actualEqptType":"NCS1010-SA","nodeName":"Shelf 1","adminState":"UNLOCKED","eqptState":"UNLOCKED","eqptType":"NCS1010-SA","serialNumber":"0CHANGEFPRR","pid":"NCS1010-SA","HWpartNum":"800-49891-01","CLEICode":"NOCLEICODE","versionID":null,"HWRev":"V00","SWRev":null,"BootRomRev":"24.3.1.26I","manufacturingDate":null,"siteName":"Site2","UID":"f369d19e-be3e-3518-be11-89fbaff6637b","hasChildren":true,"isAncillary":null,"parentDetails":null,"inventoryDTOType":"SHELF"}]}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"405":{"description":"Method Not Allowed"},"500":{"description":"Internal Server Error"}},"__originalOperationId":"networkInventorySearch","security":[],"method":"get","path":"/api/inventory/networksearch"}}