Get devices manufacturer, vendor and series information - Crosswork Network Controller 7.2 APIs

{"type":"api","title":"Get devices manufacturer, vendor and series information","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":["Devices"],"summary":"Get devices manufacturer, vendor and series information","description":"Get devices manufacturer, vendor and series information","operationId":"fetchProductDetails","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"vendors":{"type":"array","description":"List of vendors with their products","items":{"type":"object","properties":{"software_types":{"type":"array","description":"List of software types available from this vendor","items":{"type":"object","properties":{"products":{"type":"array","description":"List of products for this software type","items":{"type":"object","properties":{"product_family":{"type":"string","description":"Product family","example":"Catalyst"},"product_series":{"type":"string","description":"Product series","example":"Catalyst 8200"},"product_series_short":{"type":"string","description":"Product series short code","example":"C8200"},"product_short_name":{"type":"string","description":"Product short name","example":"C8200"},"product_type":{"type":"string","description":"Product type","example":"Router"}},"description":"RakProductDoc represents a single product with details","$$ref":"#/components/schemas/rest.RakProductDoc"}},"software_type":{"type":"string","description":"Software type","example":"IOS-XE"}},"description":"RakProductSoftwareDoc represents a software type with available products","$$ref":"#/components/schemas/rest.RakProductSoftwareDoc"}},"vendor":{"type":"string","description":"Vendor name","example":"Cisco"}},"description":"RakProductVendorDoc represents a vendor with software types","$$ref":"#/components/schemas/rest.RakProductVendorDoc"}}},"description":"RakProductInfoDoc represents product information hierarchy for /info/products endpoint","$$ref":"#/components/schemas/rest.RakProductInfoDoc"}}}},"401":{"description":"Unauthorized","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code","example":404},"message":{"type":"string","description":"Error message describing the not found error","example":"Not found"},"status":{"type":"string","description":"Response status","example":"fail"},"uuid":{"type":"string","description":"Device UUID that was not found","example":"c1b3b2c0-1234-5678-9abc-def012345678"}},"description":"RakDeviceDataResp404 represents a 404 Not Found response example","$$ref":"#/components/schemas/rest.RakDeviceDataResp404"}}}},"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":"fetchProductDetails","method":"get","path":"/info/products"}}