{"type":"model","meta":{"id":"/apps/pubhub/media/cx-cloud-apis/987ccbfd309f978191d5f9ff79fe93a2865583d0/cbe9e4eb-3b67-3d77-bde8-9a8275c07620","info":{"title":"CX Cloud API","version":"2.0.0","description":"APIs to access CX Cloud data","contact":{"name":"CX Cloud Community","url":"https://community.cisco.com/t5/cx-cloud/bd-p/CX-Cloud-Discussions"},"license":{"name":"Cisco API License","url":"https://developer.cisco.com/site/license/cisco-api-license/"},"termsOfService":"https://www.cisco.com/c/dam/en_us/about/doing_business/legal/seula/cx-cloud-seula.pdf"},"security":[{"Oauth2":["apis:read"]}],"tags":[{"name":"customer","description":"API operations to get customer details from entitled CX Cloud accounts"},{"name":"inventory","description":"API operations to get inventory details from entitled CX Cloud accounts"},{"name":"contract","description":"API operations to get contract details from entitled CX Cloud accounts"},{"name":"productAlert","description":"API operations to get alerts details from entitled CX Cloud accounts"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://apix.cisco.com/cs/api/v2","description":"Cisco API Console"}],"securitySchemes":{"Oauth2":{"type":"oauth2","description":"OAuth2 authentication with authorization code flow.","flows":{"authorizationCode":{"authorizationUrl":"https://id.cisco.com/oauth2/default/v1/token","tokenUrl":"https://id.cisco.com/oauth2/default/v1/token","scopes":{"apis:read":"Grants read access"}}}}}},"spec":{"description":"Hardware schema","type":"object","properties":{"data":{"description":"Contains array of hardware","type":"array","items":{"properties":{"customerId":{"description":"A CX Cloud customer identifier.","type":"string","example":"abc123def"},"neInstanceId":{"description":"Unique ID used to identify an instance of a network element. Network element is a manageable logical entity uniting one or more physical devices and allows distributed devices to be managed in a unified way using one management system.","type":"string","example":"NA,SERIAL,PID,NA"},"managedNeInstanceId":{"description":"Identifier for the managed network element. For single chassis devices, the managedNeInstanceId and neInstanceId are same. For multi-chassis devices, the managedNeInstanceId is the neInstanceId of the primary chassis and all the neInstanceIds will be share the same managedNeInstanceId.","type":"string","example":"NA,SERIAL,PID,NA"},"inventoryName":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"hwInstanceId":{"description":"Unique identifier of the physical hardware","type":"string","example":"SERIAL1,PID1,NA,NA,SERIAL2,PID2,NA"},"hwName":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"hwType":{"description":"Physical type of the hardware","type":"string","nullable":true,"example":"Chassis","enum":["Chassis","Module","Power Supply","Fan","Software"]},"productSubtype":{"description":"Further classification for hardware within a Product Type.","type":"string","nullable":true,"example":"Blade Server"},"slot":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"productFamily":{"description":"Grouping of similar Cisco products.","type":"string","nullable":true,"example":"Cisco Catalyst 9500 Series Switches"},"productId":{"description":"The alphanumeric unique identifier of a Cisco Product. The id is used by customers to order Cisco products","type":"string","nullable":true,"example":"ISR4331/K9"},"productType":{"description":"Broad classification of Cisco product that categorizes its function.","type":"string","nullable":true,"example":"Switches"},"swVersion":{"description":"A version of operating system installed on the Network Element","type":"string","nullable":true,"example":"17.9.1"},"serialNumber":{"description":"A unique identifier for hardware","type":"string","nullable":true,"example":"AAA1234ZZZZ"},"serialNumberStatus":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"hwRevision":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"tan":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"tanRevision":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"pcbNumber":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"installedMemory":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"installedFlash":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"collectedSerialNumber":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"collectedProductId":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"productName":{"description":"The name of a Cisco product.","type":"string","nullable":true,"example":"Cisco Catalyst 9300-24UX Switch"},"dimensionsFormat":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"dimensions":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"weight":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"formFactor":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"supportPage":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"visioStencilUrl":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"smallImageUrl":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"largeImageUrl":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"baseProductId":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"productReleaseDate":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"productDescription":{"description":"The description of a product.","type":"string","example":"Catalyst 9300 24-port mGig and UPOE, base switch"}}}},"pagination":{"description":"Pagination details","type":"object","properties":{"page":{"description":"Current page","type":"integer","format":"int32","example":1},"pages":{"description":"Total number of pages","type":"integer","format":"int32","example":3},"rows":{"description":"Number of records on each page","type":"integer","format":"int32","example":20},"total":{"description":"Total number of records","type":"integer","format":"int64","example":56}},"$$ref":"#/components/schemas/Pagination"}},"$$ref":"#/components/schemas/Hardware","title":"Hardware"}}