List Covered Assets - CX Cloud API

{"type":"api","title":"List Covered Assets","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":{"summary":"List Covered Assets","operationId":"getCoverage","description":"Returns assets in a CX Cloud account that are covered by a Cisco service contract.","tags":["contract"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A CX Cloud customer identifier","schema":{"type":"string","example":"abc123def"},"$$ref":"#/components/parameters/customerId_param"},{"name":"contractNumber","in":"query","description":"A Cisco service contract number","schema":{"type":"string","example":"123456789"},"$$ref":"#/components/parameters/contractNumber_param"},{"name":"contractStatus","in":"query","description":"Status of the service contract","schema":{"type":"string","example":"ACTIVE","enum":["ACTIVE","OVERDUE","SIGNED"]},"$$ref":"#/components/parameters/contractStatus_param"},{"name":"coverageStartDate","in":"query","description":"Limits the results to assets where coverage starts on or after this date","schema":{"type":"string","example":"2025-03-31"},"$$ref":"#/components/parameters/coverageStartDate_param"},{"name":"coverageEndDate","in":"query","description":"Limits the results to assets where coverage ends on or before this date","schema":{"type":"string","example":"2026-12-31"},"$$ref":"#/components/parameters/coverageEndDate_param"},{"name":"coverageStatus","in":"query","description":"The contract coverage status for a specific piece of hardware","schema":{"type":"string","example":"ACTIVE","enum":["ACTIVE"]},"$$ref":"#/components/parameters/coverageStatus_param"},{"name":"serialNumber","in":"query","description":"A unique identifier for hardware","schema":{"type":"string","example":"AAA1234ZZZZ"},"$$ref":"#/components/parameters/serialNumber_param"},{"name":"serviceLevel","in":"query","description":"Alphanumeric code that denotes the purchased support service","schema":{"type":"string","example":"L1NBD"},"$$ref":"#/components/parameters/serviceLevel_param"},{"name":"productId","in":"query","description":"The alphanumeric unique identifier of a Cisco Product. The id is used by customers to order Cisco products.","schema":{"type":"string","example":"ISR4331/K9"},"$$ref":"#/components/parameters/productId_param"},{"name":"serviceLineStatus","in":"query","description":"The status of a specific line on a service contract","schema":{"type":"string","example":"ACTIVE","enum":["ACTIVE","OVERDUE","EXPIRED","TERMINATED","SIGNED"]},"$$ref":"#/components/parameters/serviceLineStatus_param"},{"name":"format","in":"query","description":"Output format of the API response","schema":{"type":"string","default":"JSON","enum":["JSON","CSV","TSV"]},"$$ref":"#/components/parameters/format_param"},{"name":"fields","in":"query","description":"Restricts API response to the specific fields.","schema":{"type":"string","example":"field1,field2"},"$$ref":"#/components/parameters/fields_param"},{"name":"page","in":"query","description":"The page to return in a paginated API response.","schema":{"type":"integer","minimum":1,"default":1},"$$ref":"#/components/parameters/page_param"},{"name":"rows","in":"query","description":"The size of the page in the API response.","schema":{"type":"integer","default":20},"$$ref":"#/components/parameters/rows_param"},{"name":"sort","in":"query","description":"The sort order (ASC or DESC) for a field in the API response. Can be specified multiple times for multi-field sorting. If order is not specified for a field, it defaults to ASC. Example with multi-field sorting: sort=field&sort=field2:DESC","schema":{"type":"array","items":{"type":"string"}},"explode":true,"$$ref":"#/components/parameters/sort_param"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Coverage schema","type":"object","properties":{"data":{"description":"Contains array of coverage","type":"array","items":{"properties":{"serialNumber":{"description":"A unique identifier for hardware","type":"string","nullable":true,"example":"AAA1234ZZZZ"},"customerId":{"description":"A CX Cloud customer identifier.","type":"string","example":"abc123def"},"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"},"contractNumber":{"description":"A Cisco service contract number","type":"string","nullable":true,"example":"123456789"},"parentContractInstanceId":{"description":"Instance ID within a network configuration of the parent item, under which a child item resides","type":"string","nullable":true,"example":"12345"},"contractStatus":{"description":"Status of the service contract","type":"string","nullable":true,"example":"ACTIVE","enum":["ACTIVE","OVERDUE","SIGNED"]},"coverageStatus":{"description":"The contract coverage status for a specific piece of hardware","type":"string","example":"ACTIVE","enum":["ACTIVE"]},"coverageStartDate":{"description":"Start date of the coverage. GMT date format YYYY-MM-DD","type":"string","nullable":true,"example":"2021-03-31"},"coverageEndDate":{"description":"End date of the coverage. GMT date format YYYY-MM-DD","type":"string","nullable":true,"example":"2021-03-31"},"contractStartDate":{"description":"Provides the service contract details from start date to current date. GMT date format YYYY-MM-DD","type":"string","nullable":true,"example":"2021-03-31"},"contractEndDate":{"description":"Lists the details of service contract from commencing to end date. GMT date format YYYY-MM-DD","type":"string","nullable":true,"example":"2024-03-30"},"serviceLevel":{"description":"Alphanumeric code that denotes the purchased support service","type":"string","nullable":true,"example":"L1NBD"},"serviceProgram":{"description":"A Cisco Services program","type":"string","nullable":true,"example":"CX LEVEL 2"},"warrantyStartDate":{"description":"Start date of the device warranty","type":"string","nullable":true,"example":"2021-03-31"},"warrantyEndDate":{"description":"The date warranty expires on a piece of purchased hardware","type":"string","nullable":true,"example":"2021-03-31"},"warrantyType":{"description":"Type of the device warranty","type":"string","nullable":true,"example":"Standard Warranty"},"billtoSiteId":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoSiteName":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoAddressLine1":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoAddressLine2":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoAddressLine3":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoAddressLine4":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoCity":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoState":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoPostalCode":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoProvince":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoCountry":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"serviceLineStatus":{"description":"The status of a specific line on a service contract","type":"string","nullable":true,"example":"ACTIVE","enum":["ACTIVE","OVERDUE","EXPIRED","TERMINATED","SIGNED"]},"installedatSiteName":{"description":"Name of a site where the product was installed","type":"string","nullable":true,"example":"CX CUSTOMER ONE"},"installedatSiteId":{"description":"Unique identifier of a site where the product was installed","type":"string","nullable":true,"example":"123456"},"installedatAddressLine1":{"description":"First address line of the installed-at site","type":"string","nullable":true,"example":"125 Main Street"},"installedatAddressLine2":{"description":"Second address line of the installed-at site","type":"string","nullable":true,"example":"Suite 100"},"installedatAddressLine3":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"installedatAddressLine4":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"installedatCity":{"description":"City name of the installed-at site","type":"string","nullable":true,"example":"SAN JOSE"},"installedatState":{"description":"State name of the installed-at site","type":"string","nullable":true,"example":"CA"},"installedatProvince":{"description":"Province name of the installed-at site","type":"string","nullable":true,"example":"PROVINCE"},"installedatPostalCode":{"description":"Postal code of the installed-at site","type":"string","nullable":true,"example":"95134"},"installedatCountry":{"description":"Country name of the installed-at site","type":"string","nullable":true,"example":"USA"},"orderShipDate":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"serviceable":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"slaType":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoAddressLine1":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoAddressLine2":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoAddressLine3":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoAddressLine4":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoCity":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoCountry":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoPostalCode":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoProvince":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoSiteId":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoSiteName":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"shiptoState":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"neInstanceId":{"description":"Identifier for a network element. A 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"},"billtoGuid":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"serviceLineId":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"lineCustomerName":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"billtoPartyId":{"description":"Unique identifier of an Entitled Party where the contract was billed to","type":"string","nullable":true,"example":"123456"},"installAtGuPartyId":{"description":"Unique identifier of a company where the product was installed","type":"string","nullable":true,"example":"123456"},"contractInstanceId":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"businessProcessName":{"description":"Business Process Names","type":"string","nullable":true,"example":"{\"title\": \"Coverage Details\", \"businessProcess\": [{\"pillarDesc\": \"HARDWARE REPLACEMENT\", \"businessProcessName\": \"Hardware Parts Replacement\", \"subBusinessProcessName\": \"8X5X Next Business Day\"}, {\"pillarDesc\": \"\", \"businessProcessName\": \"Minor Software Updates\", \"subBusinessProcessName\": \"\"}, {\"pillarDesc\": \"\", \"businessProcessName\": \"Major Software Updates\", \"subBusinessProcessName\": \"\"}, {\"pillarDesc\": \"TAC SUPPORT\", \"businessProcessName\": \"Remote Tech Support Access\", \"subBusinessProcessName\": \"TAC Access 24X7\"}]}"},"installGUName":{"description":"Install Global Ultimate (GU) Name","type":"string","nullable":true,"example":"CX CUSTOMER ONE"},"entitledParty":{"description":"Entitled Party ID","type":"string","nullable":true,"example":"123456"},"productFamily":{"description":"Grouping of similar Cisco products.","type":"string","nullable":true,"example":"Cisco Catalyst 9500 Series Switches"},"contractInstanceNumber":{"description":"The instance number in Cisco Commerce for an asset","type":"string","nullable":true,"example":"123456"},"ISPartner":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true},"APINAME":{"description":"Field not available in CX Cloud.","type":"string","nullable":true,"example":"null","deprecated":true}}}},"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/Coverage"}}},"headers":{"Cache-Control":{"description":"Cache Control Header","schema":{"type":"string"},"example":"no-cache","$$ref":"#/components/headers/CacheControl"},"TrackingID":{"description":"Tracking ID","schema":{"type":"string"},"example":"1234","$$ref":"#/components/headers/TrackingID"},"Date":{"description":"Timestamp the response was processed","schema":{"type":"string","format":"E, dd MMM yyyy HH:mm:ss z"},"example":"Fri, 27 Jun 2025 09:07:36 GMT","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/CoverageResponse"},"400":{"description":"Bad Request","$$ref":"#/components/responses/BadRequestResponse"},"401":{"description":"Unauthorized","$$ref":"#/components/responses/UnauthorizedResponse"},"403":{"description":"Forbidden","$$ref":"#/components/responses/ForbiddenResponse"},"404":{"description":"Not Found","$$ref":"#/components/responses/NotFoundResponse"},"500":{"description":"Internal Server Error","$$ref":"#/components/responses/InternalServerErrorResponse"}},"security":[{"Oauth2":["apis:read"]}],"__originalOperationId":"getCoverage","method":"get","path":"/contracts/coverage"}}