{"type":"api","title":"Refresh inventory","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/1c070d4e-8870-3df3-a541-e46a890a47cb","info":{"title":"Crosswork Workflow Manager Solutions - Inventory","description":"The Crosswork Workflow Manager Solutions Inventory API is a comprehensive inventory collection service that enables users to retrieve, query, and refresh network device information. It serves as a centralized repository for device metadata, connectivity details, software versions, and product information across multiple vendor platforms.\n\nThe CWMS Inventory fetchs the device related details like hostname, IP, Product details, Package versions as well as provide list of product types to be supported.\n\nIt will fetch device product details as well as include filters parameters to get specific device related details.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"version":"7.2.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/CWM-SOLUTIONS/inventory-api.overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://crosswork-ip:12345/crosswork/cwms/inventory/v1"}],"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and JWT token.","name":"Authorization","in":"header"}}},"spec":{"tags":["Inventory"],"summary":"Refresh inventory","description":"Fetch invenotry details for provided list of device uuids.","operationId":"refreshInventory","requestBody":{"description":"Refresh Device Uuid","x-codegen-request-body-name":"request","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"array","description":"Array of device UUIDs to refresh","example":["c1b3b2c0-1234-5678-9abc-def012345678"],"items":{"type":"string"}}},"description":"RakDeviceDoc represents a device refresh request with device UUIDs","$$ref":"#/components/schemas/rest.RakDeviceDoc"}}},"required":true},"responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Array of device refresh responses showing different status codes","items":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","example":202},"message":{"type":"string","description":"Response message","example":"Inventory refresh initiated successfully"},"status":{"type":"string","description":"Response status","example":"success"},"uuid":{"type":"string","description":"Device UUID","example":"c1b3b2c0-1234-5678-9abc-def012345678"}},"description":"RakDeviceDataRespDoc represents a single device refresh response","$$ref":"#/components/schemas/rest.RakDeviceDataResp"}}},"description":"RakDeviceDataRespList207 represents the /refresh API response with multiple device results","$$ref":"#/components/schemas/rest.RakDeviceDataRespList207"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","example":400},"message":{"type":"string","description":"Error message describing the bad request","example":"invalid request to API"},"status":{"type":"string","description":"Response status","example":"fail"}},"description":"RakDeviceDataResp400 represents a 400 Bad Request response example","$$ref":"#/components/schemas/rest.RakDeviceDataResp400"}}}},"401":{"description":"Unauthorized","content":{}},"403":{"description":"Forbidden","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","example":500},"message":{"type":"string","description":"Error message describing the internal server error","example":"Internal server error"},"status":{"type":"string","description":"Response status","example":"fail"}},"description":"RakDeviceDataResp500 represents a 500 Internal Server Error response example","$$ref":"#/components/schemas/rest.RakDeviceDataResp500"}}}}},"__originalOperationId":"refreshInventory","method":"post","path":"/refresh"}}