Business Critical Services(BCS) Operational Insights API

Contract

The contracts API resource provides insights into the contract status identified by your devices their serial numbers. These are the resources:

  • /contract/serials
  • /contract/serials/:serialNumber

The /contract/serials endpoint returns a list of JSON objects where each object represents an asset with a serial number.

A good use case for this API is to track which assets are no longer under warranty or covered by an active contract. Another interesting use is analyzing which assets are about to have their service contracts expired. When consumed by an ITSM, these are insights on which your operations team can take action.

Here is an example:

json
Copy{
 "items": [
   {
        "baseProductIdList": [
            {
                "baseProductId": "QSFP-100G-SM-SR="
            }
        ],
        "contractSiteAddress": "225 W. TASMAN DRIVE",
        "contractSiteCity": "SAN JOSE",
        "contractSiteCountry": "US",
        "contractSiteCustomerName": "CISCO SYSTEMS INC",
        "contractSiteStateProvince": "CA",
        "coveredProductLineEndDate": null,
        "isCovered": false,
        "orderableProductIdList": [
            {
                "itemDescription": "100GBASE CWDM4 Lite QSFP Transceiver, 2km over SMF, 10-60C",
                "itemPosition": "S",
                "itemType": "CARD",
                "orderableProductId": "QSFP-100G-SM-SR=",
                "pillarCode": "1,2"
            }
        ],
        "parentSerialNumber": "",
        "serialNumber": "INL23291758",
        "serviceContractNumber": "",
        "serviceLineDescription": "",
        "warrantyEndDate": "2020-11-15",
        "warrantyType": "WARR-1YR-LTD-HW",
        "warrantyTypeDescription": "http://www.cisco.com/go/warranty"
    },
    {
        "baseProductIdList": [
            {
                "baseProductId": ""
            }
        ],
        "contractSiteAddress": "2512 SUNNY BOULEVARD 100",
        "contractSiteCity": "DALLAS",
        "contractSiteCountry": "US",
        "contractSiteCustomerName": "Cisco BCS company",
        "contractSiteStateProvince": "TX",
        "coveredProductLineEndDate": "2023-12-31",
        "isCovered": true,
        "orderableProductIdList": [
            {
                "itemDescription": "XFP -10G MultiRate Full C Band Tuneable DWDM XFP, 50 Ghz, LC",
                "itemPosition": "S",
                "itemType": "",
                "orderableProductId": "ONS-XC-10G-C=",
                "pillarCode": "1,2"
            }
        ],
        "parentSerialNumber": "",
        "serialNumber": "AFG130140Q3",
        "serviceContractNumber": "940794",
        "serviceLineDescription": "SP Base Support With HW AR Level 1",
        "warrantyEndDate": "2017-08-09",
        "warrantyType": "WARR-5YR-HW-1YR-SW",
        "warrantyTypeDescription": "http://www.cisco.com/go/warranty"
    },
   ...
  }
 ]
}

In the previous example, there are two examples shown.

One is for a part with serial number INL23291758 and is not covered by any active service contract. We can also see the warranty expired 2020-11-15. The address information as known by Cisco is visible as well in the contractSite attributes. This is an insight that there are some assets that are not serviceable or replaceable when something should happen.

The second example is for serial number AFG130140Q3. The warranty of this part also expired in 2017 but it's currently covered by a service contract 940794 until 2023-12-31.

Both examples have a List of orderableProductIds. This describes which Product ID (PID) is associated to the serialNumber. The pillarCode field specifies the contract service line for the item specified by orderableProductId. pillarCode can have one of the following values:

  • 1: TAC Support
  • 2: Hardware replacement
  • 3: Software Support

A single service line can be associated to multiple pillars. In the previous example, you can see there is TAC Support and Hardware replacement support available for both assets.

Next