The PSS API Services provide the ability to obtain information from a variety of areas (inventory information, contract information, and various types of alerts). The following services provide the PSS API Services:
There are some API parameters that may have an API response of Not Available, or -, or may be blank (with XML tags only). This type of response for some of the attributes may be due to the non-availability of the data in the collection that was processed by the Partner Support Service application. Use cases explore specific mandatory and optional parameters.
Consistency of the response to show Not Available, or -, or to be blank and have no data in the API responses is a known limitation and planned to be fixed in the future releases of the PSS API.
Due to limitation of some of the features supported in this release, the following attributes will not be shown in the response of alert APIs:
These attributes are placeholders for future releases.
The InventoryService consists of the following API calls:
The Inventory Service APIs only retrieve the latest inventory collection information.
The following use cases regarding specific mandatory and optional parameters are explored below:
This operation accepts all the mandatory parameters (pageStart, customerId, and inventoryId). The deviceIds parameter is optional.
This operation will return (in addition to what is returned by getCustomerInventoryDetails) a new section at the beginning of the response called 'pages'. This section has four parts:
| Parameter | Required | Type | Description |
|---|---|---|---|
| customerId | Yes | string | This parameter is returned in the API service call getCustomersInventoryIds. customerId is an id used by Cisco to uniquely identify the company. |
| inventoryID | Yes | string | This parameter is returned in the API service call getCustomersInventoryIds. inventoryId identifies the inventory whose data will be accessed for the chassis & card level details. |
| deviceIds | Optional | string | The deviceIds input can be zero or more. When not providing the deviceIds, the api will return a full collection of data for that given InventoryID, for that given CustomerId, of that given PartyGUID; all the devices collected for that inventory will be returned. |
| pageStart | Yes | string | The number of pages to be returned. The first time this API is called, this value should always be 1. |
pages
| Parameter | Type | Length | Description |
|---|---|---|---|
| pageSize | string | 5 | The chunk size for each response returned. |
| pageCurrent | string | 5 | The current page being returned. |
| pageTotal | string | 5 | The total number of pages which can be returned. |
| pidCount | string | 6 | The total number of PIDs returned by this request. |
DeviceDetail
| Parameter | Type | Length | Description |
|---|---|---|---|
| deviceId | string | 22 | Device id of the device contained in a specific customer inventory. |
| hostName | string | 255 | Hostname of the device. |
| ipAddress | string | 64 | IP address of the device. |
| originalSerialNumber | string | 50 | Serial number of the device noted on the purchase order. |
| validatedSerialNumber | string | 50 | Actual number physically found on the device. |
| productId | string | 255 | Refers to the validated product id of the device. |
| productDescription | string | 4000 | Product description of the device. |
| productFamily | string | 255 | Product family the device belongs to. |
| productName | string | 255 | Product name of the device. |
| productModel | string | 255 | Product model of the device. |
| elementType | string | 150 | Element type of the device. |
| originalInventoryDate | date | DATE | Date the original inventory was performed. |
| lastInventoryDate | date | DATE | Date the last inventory was performed. |
| baseProductId | string | 255 | Base product id of the device. |
| installedMemory | string | 20 | Amount of memory the device has installed. |
| hardWareVersion | string | 20 | Hardware version of the device. |
| softwareVersion | string | 50 | Software version of the device. |
| softwareType | string | 50 | OS type of the software. |
| flashMemory | string | 50 | Amount of flash memory the device has installed. |
| manufacturer | string | 255 | Original Manufacturer of device |
| c3instanceid | string | 4000 | Unique association between PID and SN |
| shipDate | string | 21 | Ship Date of device |
| osVersion | string | 255 | Operating System version of the device. |
| bootVersion | string | 50 | The version of the boot code installed on the device. |
| featureSet | string | 255 | Specific feature set associated with the software version (e.g. IP STRING Base With Crypto etc.) |
| categoryName | string | 255 | The name of the category of the Cisco device. For example, Routers, Switches, LAN switches, and so on.. |
| categoryShortName | string | 255 | The short name of the category of the Cisco device. |
| itemType | string | 50 | Classification of the item as chassis/card/CCM/IPPhone/UCS etc. |
| snmpLocation | string | 4000 | SNMP configured location of the device that is available from the inventory upload. |
| shipToAddress | string | 1276 | It is the address the device was shipped to. |
| installAtAddress | string | 1276 | Address where device is installed. This information comes from the C3 database. |
| billToName | string | 360 | Entity that is billed for the service coverage. |
| systemContact | string | 30 | System contact person as obtained via SNMP. |
| selectionType | string | DEVICE or CARD |
Type of selection. |
ExceptionDetail
| Parameter | Type | Length | Description |
|---|---|---|---|
| exception | string | 4000 | Exceptions reported during inventory collection. If no data is available the parameter will return a "-" response. |
CardDetail
| Parameter | Type | Length | Description |
|---|---|---|---|
| cardId | string | 22 | API calls the ID of the card contained inside the device. |
| deviceId | string | 22 | Device ID of the device. |
| productId | string | 255 | Base product ID of the card. |
| productDescription | string | 4000 | Product description of the card. |
| productFamily | string | 255 | Product family the card belongs to. |
| fruFlag | string | 22 | fruFlag: 1: Card is field replaceable unit. fruFlag: 2: Card is not field replaceable unit. fruFlag: 0: When element is Chassis or in Case of card data is not populated. |
| originalSerialNumber | string | 50 | Original manufacturer's serial number for the card |
| validatedSerialNumber | string | 50 | Serial number that someone validated to be on the card. |
| slotNumber | string | 20 | Slot number where the card is plugged. |
| firmwareVersionNumber | string | 255 | Card's firmware version number. |
| hardwareVersionNumber | string | 255 | Card's hardware version number. |
| softwareVersion | string | 50 | Card's software version number. |
| manufacturer | string | 255 | Original Manufacturer of device. |
| c3instanceid | string | 4000 | Unique association between PID and SN. |
| shipDate | string | 21 | Ship Date of device. |
| cardType | string | 50 | The type of card associated with a device. e.g. Module |
| baseProductId | string | 255 | Base product ID of the device. |
| exception | string | 4000 | Exceptions reported during inventory collection. If no data is available the parameter will return a "-" response. |
| selectionType | string | DEVICE or CARD |
Type of the item. |
| categoryName | string | 255 | The name of the category of the Cisco device. For example, Routers, Switches, LAN switches, and so on. |
| categoryShortName | string | 255 | The short name of the category of the Cisco device. |
| itemType | string | 50 | Classification of the item as chassis/card/CCM/IPPhone/UCS etc. |
responseTimestamp
| Parameter | Type | Length | Description |
|---|---|---|---|
| date | DATE | Time stamp that indicates when this service call was performed. |
message See Message Format section for more details.
| Parameter | Type | Length | Description |
|---|---|---|---|
| messageType | string | 255 | Indicates the type of message being displayed. |
| messageDetail | string | 255 | States the details of the message. |
Table 1-1 provides the list of field names as described in the API and its equivalent name as described in the Offline reports.
| Field in API | Field in Offline Report |
|---|---|
| baseProductId | Product ID |
| categoryShortName | Category |
| elementType | Device Type |
| flashMemory | InstalledFlash |
| lastInventoryDate | Collected Inventory Date |
| originalSerialNumber | Serial Number (Collected) |
| productId | — |
| productName | Vendor/Model |
| systemContact | sysContact |
| validatedSerialNumber | Serial Number |
‹soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inv="http://www.cisco.com/InventoryService"›
‹soapenv:Header/›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailRequestInput›
‹inv:customerId›8587390007‹/inv:customerId›
‹inv:inventoryId›118537‹/inv:inventoryId›
‹!--Zero or more repetitions:--›
‹inv:deviceIds›4741429‹/inv:deviceIds›
‹inv:pageStart›1‹/inv:pageStart›
‹/inv:CustomerExtendedInventoryDetailRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailResponseOutputxmlns:inv="http://www.cisco.com/InventoryService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:imp="http://www.cisco.com/ImportService"
xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance"
xmlns:npd="http://www.cisco.com/NPDRService"
xmlns:is="http://www.cisco.com/ISAlertService"
xmlns:lastUpd="http://www.cisco.com/LastUpdatedService"
xmlns:psirt="http://www.cisco.com/PSIRTAlertService"
xmlns:con="http://www.cisco.com/ContractService"›
‹inv:pages›
‹inv:pageSize›50‹/inv:pageSize›
‹inv:pageCurrent›1‹/inv:pageCurrent›
‹inv:pageTotal›1‹/inv:pageTotal›
‹inv:pidCount›1‹/inv:pidCount›
‹/inv:pages›
‹inv:deviceDetail›
‹inv:deviceId›4741429‹/inv:deviceId›
‹inv:hostName›172.21.140.139mun-0840‹/inv:hostName›
‹inv:ipAddress›172.21.140.139‹/inv:ipAddress›
‹inv:originalSerialNumber›KQAMZDF‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›JAB12240224‹/inv:validatedSerialNumber›
‹inv:productId›MCS7825I3-K9-CMB2 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^IBM Server with SW-CUP7.0-K9 Preloaded‹/inv:productDescription›
‹inv:productFamily›Cisco 7800 Series Media Convergence Servers‹/inv:productFamily›
‹inv:productName›Cisco MCS7825I3-K9-CUP7‹/inv:productName›
‹inv:productModel›Cisco MCS7825I3-K9-CUP7‹/inv:productModel›
‹inv:elementType›SERVER‹/inv:elementType›
‹inv:exceptionDetail›
‹inv:exception›-‹/inv:exception›
‹/inv:exceptionDetail›
‹inv:originalInventoryDate›2014-01-09T00:00:00.000‹/inv:originalInventoryDate›
‹inv:lastInventoryDate›2014-01-09T00:00:00.000‹/inv:lastInventoryDate›
‹inv:baseProductId›MCS7825I3-K9-CMB2‹/inv:baseProductId›
‹inv:hardWareVersion›‹/inv:hardWareVersion›
‹inv:softwareVersion›7.1.2.30003-1‹/inv:softwareVersion›
‹inv:softwareType›UCOS‹/inv:softwareType›
‹inv:manufacturer›CISCOinv:manufacturer›
‹inv:manufacturer›CISCO/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2008-06-17 00:00:00.0‹/inv:shipDate›
‹inv:osVersion›4.0.0.0-16‹/inv:osVersion›
‹inv:categoryName›Voice and Unified Communications‹/inv:categoryName›
‹inv:categoryShortName›VUC‹/inv:categoryShortName›
‹inv:itemType›CCM‹/inv:itemType›
‹inv:snmpLocation›-‹/inv:snmpLocation›
‹inv:shipToAddress›225 WEST TASMAN DRIVE, SAN JOSE, 95134-1706, CA, US‹/inv:shipToAddress›
‹inv:installAtAddress›C3 CIBER ADDRESS, SAN JOSE, 95134, CA, US‹/inv:installAtAddress›
‹inv:selectionType›DEVICE‹/inv:selectionType›
‹/inv:deviceDetail›
‹inv:responseTimestamp›2015-05-14T07:54:43.754-04:00‹/inv:responseTimestamp›
‹inv:message›
‹inv:messageType›SUCCESS‹/inv:messageType›
‹inv:messageDetail›Request processed successfully‹/inv:messageDetail›
‹/inv:message›
‹/inv:CustomerExtendedInventoryDetailResponseOutput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inv="http://www.cisco.com/InventoryService"›
‹soapenv:Header/›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailRequestInput›
‹inv:customerId›‹/inv:customerId›
‹inv:inventoryId›118537‹/inv:inventoryId›
‹!--Zero or more repetitions:--›
‹inv:deviceIds›4741429‹/inv:deviceIds›
‹inv:pageStart›1‹/inv:pageStart›
‹/inv:CustomerExtendedInventoryDetailRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹soapenv:Fault›
‹faultcode›soapenv:INVALID-CUSTOMER-ID-101‹/faultcode›
‹faultstring›Invalid Customer Id.‹/faultstring›
‹detail›
‹tns:InventoryPaginatedServiceException
xmlns:tns="http://www.cisco.com/InventoryService"›
‹tns:InventoryPaginatedServiceException
xsi:type="ns2:InventoryPaginatedServiceException"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ns2="http://exception.service.csp.ca.cisco.com/xsd"›
‹ns2:MessageCause›User provided an Invalid Customer Id.‹/ns2:MessageCause›
‹ns2:messageCode›INVALID-CUSTOMER-ID-101‹/ns2:messageCode›
‹ns2:messageDetail›Invalid Customer Id.‹/ns2:messageDetail›
‹ns2:pageEnd/›
‹ns2:pageStart/›
‹ns2:serviceName›Paginated Inventory Service‹/ns2:serviceName›
‹/tns:InventoryPaginatedServiceException›
‹/tns:InventoryPaginatedServiceException›
‹/detail›
‹/soapenv:Fault›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inv="http://www.cisco.com/InventoryService"›
‹soapenv:Header/›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailRequestInput›
‹inv:customerId›8587390007‹/inv:customerId›
‹inv:inventoryId›‹/inv:inventoryId›
‹!--Zero or more repetitions:--›
‹inv:deviceIds›4741429‹/inv:deviceIds›
‹inv:pageStart›1‹/inv:pageStart›
‹/inv:CustomerExtendedInventoryDetailRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹soapenv:Fault›
‹faultcode›soapenv:INVALID-INVENTORY-ID-102‹/faultcode›
‹faultstring›Invalid Inventory Id.‹/faultstring›
‹detail›
‹tns:InventoryPaginatedServiceException xmlns:tns="http://www.cisco.com/InventoryService"›
‹tns:InventoryPaginatedServiceException xsi:type="ns2:InventoryPaginatedServiceException" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns2="http://exception.service.csp.ca.cisco.com/xsd"›
‹ns2:MessageCause›User provided an Invalid Inventory Id.‹/ns2:MessageCause›
‹ns2:messageCode›INVALID-INVENTORY-ID-102‹/ns2:messageCode›
‹ns2:messageDetail›Invalid Inventory Id.‹/ns2:messageDetail›
‹ns2:pageEnd/›
‹ns2:pageStart/›
‹ns2:serviceName›Paginated Inventory Service‹/ns2:serviceName›
‹/tns:InventoryPaginatedServiceException›
‹/tns:InventoryPaginatedServiceException›
‹/detail›
‹/soapenv:Fault›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹soapenv:Fault›
‹faultcode›soapenv:INVALID-INVENTORY-ID-102‹/faultcode›
‹faultstring›Invalid Inventory Id.‹/faultstring›
‹detail›
‹tns:InventoryPaginatedServiceException xmlns:tns="http://www.cisco.com/InventoryService"›
‹tns:InventoryPaginatedServiceException xsi:type="ns2:InventoryPaginatedServiceException" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns2="http://exception.service.csp.ca.cisco.com/xsd"›
‹ns2:MessageCause›User provided an Invalid Inventory Id.‹/ns2:MessageCause›
‹ns2:messageCode›INVALID-INVENTORY-ID-102‹/ns2:messageCode›
‹ns2:messageDetail›Invalid Inventory Id.‹/ns2:messageDetail›
‹ns2:pageEnd/›
‹ns2:pageStart/›
‹ns2:serviceName›Paginated Inventory Service‹/ns2:serviceName›
‹/tns:InventoryPaginatedServiceException›
‹/tns:InventoryPaginatedServiceException›
‹/detail›
‹/soapenv:Fault›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹soapenv:Fault›
‹faultcode›soapenv:INVALID-PAGESTART-ID-108‹/faultcode›
‹faultstring›Invalid pageStart.‹/faultstring›
‹detail›
‹tns:InventoryPaginatedServiceException xmlns:tns="http://www.cisco.com/InventoryService"›
‹tns:InventoryPaginatedServiceException xsi:type="ns2:InventoryPaginatedServiceException" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns2="http://exception.service.csp.ca.cisco.com/xsd"›
‹ns2:MessageCause›User provided an Invalid pageStart.‹/ns2:MessageCause›
‹ns2:messageCode›INVALID-PAGESTART-ID-108‹/ns2:messageCode›
‹ns2:messageDetail›Invalid pageStart.‹/ns2:messageDetail›
‹ns2:pageEnd/›
‹ns2:pageStart/›
‹ns2:serviceName›Paginated Inventory Service‹/ns2:serviceName›
‹/tns:InventoryPaginatedServiceException›
‹/tns:InventoryPaginatedServiceException›
‹/detail›
‹/soapenv:Fault›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.cisco.com/InventoryService"›
‹soapenv:Header/›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailRequestInput›
‹inv:customerId›8587390007‹/inv:customerId›
‹inv:inventoryId›118537‹/inv:inventoryId›
‹!--Zero or more repetitions:--›
‹inv:deviceIds›‹/inv:deviceIds›
‹inv:pageStart›1‹/inv:pageStart›
‹/inv:CustomerExtendedInventoryDetailRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailResponseOutput xmlns:inv="http://www.cisco.com/InventoryService" xmlns:impInv="http://www.cisco.com/ImportService" xmlns:fn="http://www.cisco.com/FNAlertService" xmlns:hweox="http://www.cisco.com/HwEoxAlertService" xmlns:sweox="http://www.cisco.com/SwEoxAlertService" xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance" xmlns:npd="http://www.cisco.com/NPDRService" xmlns:is="http://www.cisco.com/ISAlertService" xmlns:lastUpd="http://www.cisco.com/LastUpdatedService" xmlns:psirt="http://www.cisco.com/PSIRTAlertService" xmlns:con="http://www.cisco.com/ContractService"›
‹inv:pages›
‹inv:pageSize›500‹/inv:pageSize›
‹inv:pageCurrent›1‹/inv:pageCurrent›
‹inv:pageTotal›1‹/inv:pageTotal›
‹inv:pidCount›257‹/inv:pidCount›
‹/inv:pages›
‹inv:deviceDetail›
‹inv:deviceId›4741429‹/inv:deviceId›
‹inv:hostName›172.21.140.139mun-0840‹/inv:hostName›
‹inv:ipAddress›172.21.140.139‹/inv:ipAddress›
‹inv:originalSerialNumber›KQAMZDF‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›JAB12240224‹/inv:validatedSerialNumber›
‹inv:productId›MCS7825I3-K9-CMB2 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^IBM Server with SW-CUP7.0-K9 Preloaded‹/inv:productDescription›
‹inv:productFamily›Cisco 7800 Series Media Convergence Servers‹/inv:productFamily›
‹inv:productName›Cisco MCS7825I3-K9-CUP7‹/inv:productName›
‹inv:productModel›Cisco MCS7825I3-K9-CUP7‹/inv:productModel›
‹inv:elementType›SERVER‹/inv:elementType›
‹inv:exceptionDetail›
‹inv:exception›-‹/inv:exception›
‹/inv:exceptionDetail›
‹inv:originalInventoryDate›2014-01-09T00:00:00.000‹/inv:originalInventoryDate›
‹inv:lastInventoryDate›2014-01-09T00:00:00.000‹/inv:lastInventoryDate›
‹inv:baseProductId›MCS7825I3-K9-CMB2‹/inv:baseProductId›
‹inv:hardWareVersion›‹/inv:hardWareVersion›
‹inv:softwareVersion›7.1.2.30003-1‹/inv:softwareVersion›
‹inv:softwareType›UCOS‹/inv:softwareType›
‹inv:flashMemory›0‹/inv:flashMemory›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2008-06-17 00:00:00.0‹/inv:shipDate›
‹inv:osVersion›4.0.0.0-16‹/inv:osVersion›
‹inv:categoryName›Voice and Unified Communications‹/inv:categoryName›
‹inv:categoryShortName›VUC‹/inv:categoryShortName›
‹inv:itemType›CHASSIS‹/inv:itemType›
‹inv:snmpLocation›-‹/inv:snmpLocation›
‹inv:shipToAddress›225 WEST TASMAN DRIVE, SAN JOSE, 95134-1706, CA, US‹/inv:shipToAddress›
‹inv:installAtAddress›C3 CIBER ADDRESS, SAN JOSE, 95134, CA, US‹/inv:installAtAddress›
‹inv:selectionType›CHASSIS‹/inv:selectionType›
‹/inv:deviceDetail›
‹inv:deviceDetail›
‹inv:deviceId›4741430‹/inv:deviceId›
‹inv:ipAddress›172.23.164.83‹/inv:ipAddress›
‹inv:originalSerialNumber›16077717‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›16077717‹/inv:validatedSerialNumber›
‹inv:productId›CISCO7204VXR (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^Cisco 7204VXR, 4-slot chassis, 1 AC Supply w/IP Software‹/inv:productDescription›
‹inv:productFamily›Cisco 7200 Series Routers‹/inv:productFamily›
‹inv:productName›Cisco 7204VXR Router‹/inv:productName›
‹inv:productModel›Cisco 7204VXR Router‹/inv:productModel›
‹inv:elementType›ROUTER‹/inv:elementType›
‹inv:cardDetail›
‹inv:cardId›21552105‹/inv:cardId›
‹inv:deviceId›4741430‹/inv:deviceId›
‹inv:productId›NPE-400 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^7200VXR NPE-400‹/inv:productDescription›
‹inv:productFamily›CPU‹/inv:productFamily›
‹inv:fruFlag›1‹/inv:fruFlag›
‹inv:originalSerialNumber›31687593‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›31687593‹/inv:validatedSerialNumber›
‹inv:slotNumber›0‹/inv:slotNumber›
‹inv:hardwareVersionNumber›1.8‹/inv:hardwareVersionNumber›
‹inv:c3instanceid›[191805723]‹/inv:c3instanceid›
‹inv:shipDate›2004-04-19 00:00:00.0‹/inv:shipDate›
‹inv:cardType›Modules‹/inv:cardType›
‹inv:exception›-‹/inv:exception›
‹inv:baseProductId›NPE-400‹/inv:baseProductId›
‹inv:selectionType›CARD‹/inv:selectionType›
‹inv:categoryName›Modules‹/inv:categoryName›
‹inv:categoryShortName›Modules‹/inv:categoryShortName›
‹inv:itemType›CARD‹/inv:itemType›
‹/inv:cardDetail›
‹inv:exceptionDetail›
‹inv:exception›The device installed RAM (128)is less than the minimum required (512)‹/inv:exception›
‹/inv:exceptionDetail›
‹inv:exceptionDetail›
‹inv:exception›Device is running an early deployment image‹/inv:exception›
‹/inv:exceptionDetail›
‹inv:originalInventoryDate›2014-01-09T00:00:00.000‹/inv:originalInventoryDate›
‹inv:lastInventoryDate›2014-01-09T00:00:00.000‹/inv:lastInventoryDate›
‹inv:baseProductId›CISCO7204VXR‹/inv:baseProductId›
‹inv:installedMemory›128‹/inv:installedMemory›
‹inv:hardWareVersion›‹/inv:hardWareVersion›
‹inv:softwareType›IOS‹/inv:softwareType›
‹inv:flashMemory›150‹/inv:flashMemory›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:osVersion›12.4(24)T3‹/inv:osVersion›
‹inv:featureSet›IP BASE‹/inv:featureSet›
‹inv:categoryName›Routers‹/inv:categoryName›
‹inv:categoryShortName›Routers‹/inv:categoryShortName›
‹inv:itemType›CHASSIS‹/inv:itemType›
‹inv:snmpLocation›-‹/inv:snmpLocation›
‹inv:selectionType›CHASSIS‹/inv:selectionType›
‹/inv:deviceDetail›
...
‹inv:responseTimestamp›2015-03-25T11:38:48.161-04:00‹/inv:responseTimestamp›
‹inv:message›
‹inv:messageType›SUCCESS‹/inv:messageType›
‹inv:messageDetail›Request processed successfully‹/inv:messageDetail›
‹/inv:message›
‹/inv:CustomerExtendedInventoryDetailResponseOutput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inv="http://www.cisco.com/InventoryService"›
‹soapenv:Header/›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailRequestInput›
‹inv:customerId›8587390007‹/inv:customerId›
‹inv:inventoryId›118537‹/inv:inventoryId›
‹!--Zero or more repetitions:--›
‹inv:deviceIds›4741429‹/inv:deviceIds›
‹inv:pageStart›1‹/inv:pageStart›
‹/inv:CustomerExtendedInventoryDetailRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailResponseOutput
xmlns:inv="http://www.cisco.com/InventoryService"
xmlns:impInv="http://www.cisco.com/ImportService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance"
xmlns:npd="http://www.cisco.com/NPDRService"
xmlns:is="http://www.cisco.com/ISAlertService"
xmlns:lastUpd="http://www.cisco.com/LastUpdatedService"
xmlns:psirt="http://www.cisco.com/PSIRTAlertService" xmlns:con="http://www.cisco.com/ContractService"›
‹inv:pages›
‹inv:pageSize›500‹/inv:pageSize›
‹inv:pageCurrent›1‹/inv:pageCurrent›
‹inv:pageTotal›1‹/inv:pageTotal›
‹inv:pidCount›3‹/inv:pidCount›
‹/inv:pages›
‹inv:deviceDetail›
‹inv:deviceId›4741429‹/inv:deviceId›
‹inv:hostName›172.21.140.139mun-0840‹/inv:hostName›
‹inv:ipAddress›172.21.140.139‹/inv:ipAddress›
‹inv:originalSerialNumber›KQAMZDF‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›JAB12240224‹/inv:validatedSerialNumber›
‹inv:productId›MCS7825I3-K9-CMB2 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^IBM Server with SW-CUP7.0-K9 Preloaded‹/inv:productDescription›
‹inv:productFamily›Cisco 7800 Series Media Convergence Servers‹/inv:productFamily›
‹inv:productName›Cisco MCS7825I3-K9-CUP7‹/inv:productName›
‹inv:productModel›Cisco MCS7825I3-K9-CUP7‹/inv:productModel›
‹inv:elementType›SERVER‹/inv:elementType›
‹inv:originalInventoryDate›2014-01-09T00:00:00.000‹/inv:originalInventoryDate›
‹inv:lastInventoryDate›2014-01-09T00:00:00.000‹/inv:lastInventoryDate›
‹inv:baseProductId›MCS7825I3-K9-CMB2‹/inv:baseProductId›
‹inv:hardWareVersion›‹/inv:hardWareVersion›
‹inv:softwareVersion›7.1.2.30003-1‹/inv:softwareVersion›
‹inv:softwareType›UCOS‹/inv:softwareType›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2008-06-17 00:00:00.0‹/inv:shipDate›
‹inv:osVersion›4.0.0.0-16‹/inv:osVersion›
‹inv:categoryName›Voice and Unified Communications‹/inv:categoryName›
‹inv:categoryShortName›VUC‹/inv:categoryShortName›
‹inv:itemType›CHASSIS‹/inv:itemType›
‹inv:snmpLocation›-‹/inv:snmpLocation›
‹inv:shipToAddress›225 WEST TASMAN DRIVE, SAN JOSE, 95134-1706, CA, US‹/inv:shipToAddress›
‹inv:installAtAddress›C3 CIBER ADDRESS, SAN JOSE, 95134, CA, US‹/inv:installAtAddress›
‹inv:selectionType›CHASSIS‹/inv:selectionType›
‹/inv:deviceDetail›
‹inv:deviceDetail›
‹inv:deviceId›4741430‹/inv:deviceId›
‹inv:ipAddress›172.23.164.83‹/inv:ipAddress›
‹inv:originalSerialNumber›16077717‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›16077717‹/inv:validatedSerialNumber›
‹inv:productId›CISCO7204VXR (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^Cisco 7204VXR, 4-slot chassis, 1 AC Supply w/IP Software‹/inv:productDescription›
‹inv:productFamily›Cisco 7200 Series Routers‹/inv:productFamily›
‹inv:productName›Cisco 7204VXR Router‹/inv:productName›
‹inv:productModel›Cisco 7204VXR Router‹/inv:productModel›
‹inv:elementType›ROUTER‹/inv:elementType›
‹inv:cardDetail›
‹inv:cardId›21552105‹/inv:cardId›
‹inv:deviceId›4741430‹/inv:deviceId›
‹inv:productId›NPE-400 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^7200VXR NPE-400‹/inv:productDescription›
‹inv:productFamily›CPU‹/inv:productFamily›
‹inv:fruFlag›1‹/inv:fruFlag›
‹inv:originalSerialNumber›31687593‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›31687593‹/inv:validatedSerialNumber›
‹inv:hardwareVersionNumber›1.8‹/inv:hardwareVersionNumber›
‹inv:c3instanceid›[191805723]‹/inv:c3instanceid›
‹inv:shipDate›2004-04-19 00:00:00.0‹/inv:shipDate›
‹inv:cardType›Modules‹/inv:cardType›
‹inv:exception›-‹/inv:exception›
‹inv:baseProductId›NPE-400‹/inv:baseProductId›
‹inv:selectionType›CARD‹/inv:selectionType›
‹inv:categoryName›Modules‹/inv:categoryName›
‹inv:categoryShortName›Modules‹/inv:categoryShortName›
‹inv:itemType›CARD‹/inv:itemType›
‹/inv:cardDetail›
‹inv:exceptionDetail›
‹inv:exception›The device installed RAM (128)is less than the minimum required (512)‹/inv:exception›
‹/inv:exceptionDetail›
‹inv:originalInventoryDate›2014-01-09T00:00:00.000‹/inv:originalInventoryDate›
‹inv:lastInventoryDate›2014-01-09T00:00:00.000‹/inv:lastInventoryDate›
‹inv:baseProductId›CISCO7204VXR‹/inv:baseProductId›
‹inv:installedMemory›128‹/inv:installedMemory›
‹inv:hardWareVersion›‹/inv:hardWareVersion›
‹inv:softwareType›IOS‹/inv:softwareType›
‹inv:flashMemory›150‹/inv:flashMemory›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:osVersion›12.4(24)T3‹/inv:osVersion›
‹inv:featureSet›IP BASE‹/inv:featureSet›
‹inv:categoryName›Routers‹/inv:categoryName›
‹inv:categoryShortName›Routers‹/inv:categoryShortName›
‹inv:itemType›CHASSIS‹/inv:itemType›
‹inv:snmpLocation›-‹/inv:snmpLocation›
‹inv:selectionType›CHASSIS‹/inv:selectionType›
‹/inv:deviceDetail›
‹inv:responseTimestamp›2015-03-25T11:41:00.343-04:00‹/inv:responseTimestamp›
‹inv:message›
‹inv:messageType›SUCCESS‹/inv:messageType›
‹inv:messageDetail›Request processed successfully‹/inv:messageDetail›
‹/inv:message›
‹/inv:CustomerExtendedInventoryDetailResponseOutput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.cisco.com/InventoryService"›
‹soapenv:Header/›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailRequestInput›
‹inv:customerId›8587390007‹/inv:customerId›
‹inv:inventoryId›118537‹/inv:inventoryId›
‹!--Zero or more repetitions:--›
‹inv:deviceIds›4741429‹/inv:deviceIds›
‹inv:deviceIds›4741430‹/inv:deviceIds›
‹inv:pageStart›1‹/inv:pageStart›
‹/inv:CustomerExtendedInventoryDetailRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹inv:CustomerExtendedInventoryDetailResponseOutput
xmlns:inv="http://www.cisco.com/InventoryService"
xmlns:impInv="http://www.cisco.com/ImportService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance"
xmlns:npd="http://www.cisco.com/NPDRService"
xmlns:is="http://www.cisco.com/ISAlertService"
xmlns:lastUpd="http://www.cisco.com/LastUpdatedService"
xmlns:psirt="http://www.cisco.com/PSIRTAlertService"
xmlns:con="http://www.cisco.com/ContractService"›
‹inv:pages›
‹inv:pageSize›500‹/inv:pageSize›
‹inv:pageCurrent›1‹/inv:pageCurrent›
‹inv:pageTotal›1‹/inv:pageTotal›
‹inv:pidCount›3‹/inv:pidCount›
‹/inv:pages›
‹inv:deviceDetail›
‹inv:deviceId›4741429‹/inv:deviceId›
‹inv:hostName›172.21.140.139mun-0840‹/inv:hostName›
‹inv:ipAddress›172.21.140.139‹/inv:ipAddress›
‹inv:originalSerialNumber›KQAMZDF‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›JAB12240224‹/inv:validatedSerialNumber›
‹inv:productId›MCS7825I3-K9-CMB2 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^IBM Server with SW-CUP7.0-K9 Preloaded‹/inv:productDescription›
‹inv:productFamily›Cisco 7800 Series Media Convergence Servers‹/inv:productFamily›
‹inv:productName›Cisco MCS7825I3-K9-CUP7‹/inv:productName›
‹inv:productModel›Cisco MCS7825I3-K9-CUP7‹/inv:productModel›
‹inv:elementType›SERVER‹/inv:elementType›
‹inv:originalInventoryDate›2014-01-09T00:00:00.000‹/inv:originalInventoryDate›
‹inv:lastInventoryDate›2014-01-09T00:00:00.000‹/inv:lastInventoryDate›
‹inv:baseProductId›MCS7825I3-K9-CMB2‹/inv:baseProductId›
‹inv:hardWareVersion›‹/inv:hardWareVersion›
‹inv:softwareVersion›7.1.2.30003-1‹/inv:softwareVersion›
‹inv:softwareType›UCOS‹/inv:softwareType›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2008-06-17 00:00:00.0‹/inv:shipDate›
‹inv:osVersion›4.0.0.0-16‹/inv:osVersion›
‹inv:categoryName›Voice and Unified Communications‹/inv:categoryName›
‹inv:categoryShortName›VUC‹/inv:categoryShortName›
‹inv:itemType›CHASSIS‹/inv:itemType›
‹inv:snmpLocation›-‹/inv:snmpLocation›
‹inv:shipToAddress›225 WEST TASMAN DRIVE, SAN JOSE, 95134-1706, CA, US‹/inv:shipToAddress›
‹inv:installAtAddress›C3 CIBER ADDRESS, SAN JOSE, 95134, CA, US‹/inv:installAtAddress›
‹inv:selectionType›CHASSIS‹/inv:selectionType›
‹/inv:deviceDetail›
‹inv:deviceDetail›
‹inv:deviceId›4741430‹/inv:deviceId›
‹inv:ipAddress›172.23.164.83‹/inv:ipAddress›
‹inv:originalSerialNumber›16077717‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›16077717‹/inv:validatedSerialNumber›
‹inv:productId›CISCO7204VXR (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^Cisco 7204VXR, 4-slot chassis, 1 AC Supply w/IP Software‹/inv:productDescription›
‹inv:productFamily›Cisco 7200 Series Routers‹/inv:productFamily›
‹inv:productName›Cisco 7204VXR Router‹/inv:productName›
‹inv:productModel›Cisco 7204VXR Router‹/inv:productModel›
‹inv:elementType›ROUTER‹/inv:elementType›
‹inv:cardDetail›
‹inv:cardId›21552105‹/inv:cardId›
‹inv:deviceId›4741430‹/inv:deviceId›
‹inv:productId›NPE-400 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^7200VXR NPE-400‹/inv:productDescription›
‹inv:productFamily›CPU‹/inv:productFamily›
‹inv:fruFlag›1‹/inv:fruFlag›
‹inv:originalSerialNumber›31687593‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›31687593‹/inv:validatedSerialNumber›
‹inv:hardwareVersionNumber›1.8‹/inv:hardwareVersionNumber›
‹inv:c3instanceid›[191805723]‹/inv:c3instanceid›
‹inv:shipDate›2004-04-19 00:00:00.0‹/inv:shipDate›
‹inv:cardType›Modules‹/inv:cardType›
‹inv:exception›-‹/inv:exception›
‹inv:baseProductId›NPE-400‹/inv:baseProductId›
‹inv:selectionType›CARD‹/inv:selectionType›
‹inv:categoryName›Modules‹/inv:categoryName›
‹inv:categoryShortName›Modules‹/inv:categoryShortName›
‹inv:itemType›CARD‹/inv:itemType›
‹/inv:cardDetail›
‹inv:exceptionDetail›
‹inv:exception›The device installed RAM (128)is less than the minimum required (512)‹/inv:exception›
‹/inv:exceptionDetail›
‹inv:originalInventoryDate›2014-01-09T00:00:00.000‹/inv:originalInventoryDate›
‹inv:lastInventoryDate›2014-01-09T00:00:00.000‹/inv:lastInventoryDate›
‹inv:baseProductId›CISCO7204VXR‹/inv:baseProductId›
‹inv:installedMemory›128‹/inv:installedMemory›
‹inv:hardWareVersion›‹/inv:hardWareVersion›
‹inv:softwareType›IOS‹/inv:softwareType›
‹inv:flashMemory›150‹/inv:flashMemory›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:osVersion›12.4(24)T3‹/inv:osVersion›
‹inv:featureSet›IP BASE‹/inv:featureSet›
‹inv:categoryName›Routers‹/inv:categoryName›
‹inv:categoryShortName›Routers‹/inv:categoryShortName›
‹inv:itemType›CHASSIS‹/inv:itemType›
‹inv:snmpLocation›-‹/inv:snmpLocation›
‹inv:selectionType›CHASSIS‹/inv:selectionType›
‹/inv:deviceDetail›
‹inv:responseTimestamp›2015-03-25T11:41:00.343-04:00‹/inv:responseTimestamp›
‹inv:message›
‹inv:messageType›SUCCESS‹/inv:messageType›
‹inv:messageDetail›Request processed successfully‹/inv:messageDetail›
‹/inv:message›
‹/inv:CustomerExtendedInventoryDetailResponseOutput›
‹/soapenv:Body›
‹/soapenv:Envelope›
This API call fetches a list of Customer ID's and Inventory ID's. This is the second step in a four step process of obtaining service call related information. Normally the customerIds input is none, so that a list of all the registered customers will be returned.
| Parameter | Required | Type | Description |
|---|---|---|---|
| customerIds | Optional | string | Input can be null or a specified number. If the API input is null, all of the registered customers will be returned in the output. |
| Parameter | Type | Length | Description |
|---|---|---|---|
| customerId | string | 500 | Is an id used by Cisco to uniquely identify the company. |
| customerName | string | 240 | Is the name of the customer for whose network data is being retrieved via the API's. |
| inventoryId | string | 20 | Inventory Id is a unique inventory name for a specific uploaded inventory. |
| inventoryName | string | 255 | Inventory Name is name of the file which has the network device information collected by collectors. |
| applianceIds | string | 50 | Uniquely identifies a collector. |
| uploadTime | date | DATE | Is the date the inventory was uploaded to the PSS Support Service. |
responseTimestamp
| Parameter | Type | Length | Description |
|---|---|---|---|
| date | DATE | The time stamp indicates when this service call was performed. | |
| inventoryName | string | 255 | Inventory Name is name of the file which has the network device information collected by collectors. |
Message [ ]
| Parameter | Type | Length | Description |
|---|---|---|---|
| See Message Format section for more details. | |||
| messageType | string | 255 | |
| messageDetail | string | 255 |
POST https://api.cisco.com/pss/v1.0/InventoryService HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "getCustomersInventoryIds"
Authorization: Bearer yh4xkpx7cbgy6wqynre4wf4r
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inv="http://www.cisco.com/InventoryService"›
‹soapenv:Header/›
‹soapenv:Body›
‹inv:CustomerInventoryRequest›
‹!--Zero or more repetitions:--›
‹inv:customerIds›‹/inv:customerIds›
‹/inv:CustomerInventoryRequest›
‹/soapenv:Body›
‹/soapenv:Envelope›
HTTP/1.1 200 OK
Date: Tue, 02 Apr 2013 14:40:51 GMT
Server: IBM_HTTP_Server
X-Mashery-Responder: APIX-PROD-01
Cache-Control: private
Pragma: private
Content-Type: text/xml; charset=UTF-8
Content-Language: en-US
Cache-Control: max-age=0
Expires: Tue, 02 Apr 2013 14:40:51 GMT
Set-Cookie: TOOLS-Loc=tools1.cisco.com; path=/; domain=.cisco.com
Set-Cookie: ObSSOCookie=EptpiaRBPtVfWgAxgDQmSJGMFi8r0gTmaFH3JOz5A%2BYd30QzIpa%2BSyfrfe0r6mYZvQLVlgZOejbn9kpt9PDxtW0dFZlEpEcIr%2FuF3suPaQg%2Bw8%2Fjiz0rKm7BgyLJz%2BhvpiNGQwHsh44QC%2BgUU05fFoFTcCQBrPv%2F8bg915k1YOGQfMsrAqXF1HV2DXwGh3yrUka8%2BGA9ENoBJDcpnh2oTDnNTkrTJSGBnjImwnhgeykki4toF9%2FtpaAOp58WXYRQNkcTUTdm5YgAO1c3SHBVdNyxPk3eweSYrV%2FjKBXHaOFoEMPviB6KhgewZj%2BhsFaK%2BdCensIKXedYMZ4nzvifhAewWThecEZdqHedPDh6cwsek3ht8d4vFjtpIpc7f6OF;
path=/; domain=.cisco.com;
Set-Cookie: CP_GUTC=173.37.185.86.1364913651472559; path=/; expires=Sun, 01-Apr-18 14:40:51 GMT; domain=.cisco.com
Set-Cookie: CP_GUTC=72.163.4.56.1364913651474212; path=/; expires=Sun, 01-Apr-18 14:40:51 GMT; domain=.cisco.com
Connection: close
Transfer-Encoding: chunked
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹inv:CustomersInventoryResponse
xmlns:inv="http://www.cisco.com/InventoryService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance"
xmlns:is="http://www.cisco.com/ISAlertService"
xmlns:psirt="http://www.cisco.com/PSIRTAlertService"
xmlns:con="http://www.cisco.com/ContractService"›
‹inv:customerInventory›
‹inv:customer›
‹inv:customerId›109757‹/inv:customerId›
‹inv:customerName›CISCO SYSTEMS LTD‹/inv:customerName›
‹/inv:customer›
‹inv:inventory›
‹inv:inventoryId›15224‹/inv:inventoryId›
‹inv:inventoryName›Partner1-Customer1‹/inv:inventoryName›
‹inv:applianceIds›CSP0009000099‹/inv:applianceIds›
‹inv:uploadTime›2012-09-14T17:17:08.000-07:00‹/inv:uploadTime›
‹/inv:inventory›
‹inv:inventory›
‹inv:inventoryId›16225‹/inv:inventoryId›
‹inv:inventoryName›Partner1-Customer2‹/inv:inventoryName›
‹inv:applianceIds›CSP0009000100‹/inv:applianceIds›
‹inv:uploadTime›2012-02-29T11:51:20.000-08:00‹/inv:uploadTime›
‹/inv:inventory›
‹inv:inventory›
‹inv:inventoryId›22235‹/inv:inventoryId›
‹inv:inventoryName›Partner2-Customer2‹/inv:inventoryName›
‹inv:applianceIds›CSP0009000189‹/inv:applianceIds›
‹inv:uploadTime›2012-02-29T11:31:03.000-08:00‹/inv:uploadTime›
‹/inv:inventory›
‹/inv:customerInventory›
‹inv:customerInventory›
‹inv:customer›
‹inv:customerId›120803113‹/inv:customerId›
‹inv:customerName›CISCO SYSTEMS, INC.‹/inv:customerName›
‹/inv:customer›
‹/inv:customerInventory›
‹inv:customerInventory›
‹inv:customer›
‹inv:customerId›100856745‹/inv:customerId›
‹inv:customerName›CISCO SYSTEMS LTD‹/inv:customerName›
‹/inv:customer›
‹inv:inventory›
‹inv:inventoryId›81281‹/inv:inventoryId›
‹inv:inventoryName›Partner1-Customer1‹/inv:inventoryName›
‹inv:applianceIds›CSP0009000099‹/inv:applianceIds›
‹inv:uploadTime›2012-12-13T03:07:18.000-08:00‹/inv:uploadTime›
‹/inv:inventory›
‹/inv:customerInventory›
‹inv:customerInventory›
‹inv:customer›
‹inv:customerId›925265‹/inv:customerId›
‹inv:customerName›CISCO SYSTEMS INC‹/inv:customerName›
‹/inv:customer›
‹/inv:customerInventory›
‹inv:responseTimestamp›2013-04-02T07:40:51.526-07:00‹/inv:responseTimestamp›
‹inv:message›
‹inv:messageType›SUCCESS‹/inv:messageType›
‹inv:messageDetail›Request processed successfully‹/inv:messageDetail›
‹/inv:message›
‹/inv:CustomersInventoryResponse›
‹/soapenv:Body›
‹/soapenv:Envelope›
Cisco recommends to use the getCustomerExtendedInventoryDetails API or the getCustomerInventoryPaginatedDetails API for all Inventory Service API usage. The getCustomerExtendedInventoryDetails does not support pagination, so it is limited to small customer network collections, and therefore, not recommended for use as a standard practice.
This API service call returns a collection of Inventory elements (device details, chassis details) for a given Inventory. This is the third step in a four step process of obtaining service call related information.
The getCustomerExtendedInventoryDetails API is certified to return data for 10,000 Product IDs. A device can have more than one product ID, and each ID is counted towards the 10K limit. If the calling application requests data for the inventory for more than 10K PIDs, then getCustomerExtendedInventoryDetails will return data for first 10K PIDs, along with a message code indicating that there are more devices in the inventory, and not all of the information has been returned.
Normally the customerId and inventoryId info from the getCustomersInventoryIds API service call is used and the deviceIds parameter is null so that all the registered customers will be returned in the response.
The input data (customer ID, inventory ID) was obtained from the first Inventory API service call (for more information see the "Manual Process Overview for API Service Calls" section).
| Parameter | Required | Type | Description |
|---|---|---|---|
| customerId | Yes | string | This parameter is returned in the API service call getCustomersInventoryIds. customerId is an id used by Cisco to uniquely identify the company. |
| inventoryId | Yes | string | This parameter is returned in the API service call getCustomersInventoryIds. inventoryId identifies the inventory whose data will be accessed for the chassis & card level details. |
| deviceIds | Optional | string | The deviceIds input can be zero or more. When not providing the deviceIds, the api will return a full collection of data for that given Inventory ID, for that given Customer ID, of that given PartyGUID; all the devices collected for that inventory will be returned. |
DeviceDetail
| Parameter | Type | Length | Description |
|---|---|---|---|
| deviceId | string | 22 | Device id of the device contained in a specific customer inventory. |
| hostName | string | 255 | Hostname of the device. |
| ipAddress | string | 64 | IP address of the device. |
| originalSerialNumber | string | 1500 | Serial number of the device noted on the purchase order. |
| validatedSerialNumber | string | 50 | Actual number physically found on the device. |
| productId | string | 255 | Refers to the validated product id of the device. |
| productDescription | string | 4000 | Product description of the device. |
| productFamily | string | 255 | Product family the device belongs to. |
| productName | string | 255 | Product name of the device. |
| productModel | string | 255 | Product model of the device. |
| elementType | string | 150 | Element type of the device. |
| originalInventoryDate | date | DATE | Date the original inventory was performed. |
| lastInventoryDate | date | DATE | The date the last inventory was performed. |
| baseProductId | string | 255 | Base product id of the device. |
| installedMemory | string | 20 | Amount of memory the device has installed. |
| hardWareVersion | string | 20 | Hardware version of the device. |
| softwareVersion | string | 50 | Software version of the device. |
| softwareType | string | 50 | OS type of the software. |
| flashMemory | string | 22 | Amount of flash memory the device has installed. |
| manufacturer | string | 255 | Original Manufacturer of device. |
| c3instanceid | string | 4000 | Unique association between PID and SN. |
| shipDate | string | 21 | Ship Date of device. |
| osVersion | string | 50 | Operating System version of the device. |
CardDetail
| Parameter | Type | Length | Description |
|---|---|---|---|
| cardId | string | 22 | API calls the ID of the card contained inside the device. |
| deviceId | string | 22 | Device id of the device. |
| cardDescription | string | 0 | Description of the card inside the device. |
| cardFamily | string | 0 | Identifies which family the card belongs to. |
| productId | string | 255 | Base product id of the card. |
| productDescription | string | 4000 | Product description of the card. |
| productFamily | string | 255 | Product family the card belongs to. |
| fruFlag | string | 22 | fruFlag: 1: Card is field replaceable unit. fruFlag: 2: Card is not field replaceable unit. fruFlag: 0: When element is Chassis or in Case of card data is not populated. |
| originalSerialNumber | string | 1500 | Original manufacturer's serial number for the card. |
| validatedSerialNumber | string | 50 | Serial number that someone validated to be on the card. |
| slotNumber | string | 20 | Slot number where the card is plugged. |
| firmwareVersionNumber | string | 255 | Card's firmware version number. |
| hardwareVersionNumber | string | 255 | Card's hardware version number. |
| softwareVersion | string | 0 | Card's software version number. |
| manufacturer | string | 255 | Original Manufacturer of device. |
| c3instanceid | string | 4000 | Unique association between PID and SN. |
| shipDate | string | 21 | Ship Date of device. |
| responseTimestamp | date | DATE | Time stamp that indicates when this service call was performed. |
message
| Parameter | Type | Length | Description |
|---|---|---|---|
| See Message Format section for more details. | |||
| messageType | string | 255 | |
| messageDetail | string | 255 |
POST https://api.cisco.com/pss/v1.0/InventoryService HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "getCustomerInventoryDetails&
Authorization: Bearer yh4xkpx7cbgy6wqynre4wf4r
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inv="http://www.cisco.com/InventoryService"›
‹soapenv:Header/›
‹soapenv:Body›
‹inv:CustomerInventoryDetailRequestInput›
‹inv:customerId›100856745‹/inv:customerId›
‹inv:inventoryId›81281‹/inv:inventoryId›
‹!--Zero or more repetitions:--›
‹inv:deviceIds›3814689‹/inv:deviceIds›
‹/inv:CustomerInventoryDetailRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
HTTP/1.1 200 OK
Date: Tue, 02 Apr 2013 14:48:38 GMT
Server: IBM_HTTP_Server
X-Mashery-Responder: APIX-PROD-04
Cache-Control: private
Pragma: private
Content-Type: text/xml; charset=UTF-8
Content-Language: en-US
Cache-Control: max-age=0
Expires: Tue, 02 Apr 2013 14:48:38 GMT
Set-Cookie: TOOLS-Loc=tools1.cisco.com; path=/; domain=.cisco.com
Set-Cookie: ObSSOCookie=eXxUsIVNak%2FgpdxvL0HY8s3RS7PCp7jUo6df0618%2FHRJnkgmzJKWbQRVWDlrJMW83lOIn3WCF%2FdPiR%2BeWoX1BuCV1XijA3wLQfJRgRorElOIf%2FZUMuRoN3wC9MCgESD8VpmBVDVikbbWNJpG%2FAeOXwAPGITVas3XwIdjWwVBOHwZFMsvnDDEFTjDsuW%2BlDcaZWpuxHErlisJkcaGoltKLRSLTqMJ5qnoLfNUzCBktkVWc7MTbSBbO9KrMGZ6yEBs11%2BXv6OC9XiJuT60xv%2BKRVPLxz6SGVRIylALQTrMUdrPd6u5Y1HzwyDUBJ5Ht3WjCPDyEs8nDNkO6B%2FHbGHzpWvao%2FVn4nqO8Fc%2Bhw1Q8wSOfOEHQAs65SimrLwa4VjN; path=/;
domain=.cisco.com;
Connection: close
Transfer-Encoding: chunked
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹inv:CustomerInventoryDetailResponseOutput
xmlns:inv="http://www.cisco.com/InventoryService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance"
xmlns:is="http://www.cisco.com/ISAlertService"
xmlns:psirt="http://www.cisco.com/PSIRTAlertService"
xmlns:con="http://www.cisco.com/ContractService"›
‹inv:deviceDetail›
‹inv:deviceId›3740223‹/inv:deviceId›
‹inv:hostName›CM_TSPM-SJ-CCM2‹/inv:hostName›
‹inv:ipAddress›172.21.34.42‹/inv:ipAddress›
‹inv:productId›MCS-7835-I1-IPC1 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›^HW Only MCS-7835-I1 with 2048MB RAM and Two 72GB SCSI HD‹/inv:productDescription›
‹inv:productFamily›Cisco 7800 Series Media Convergence Servers‹/inv:productFamily›
‹inv:productName›Cisco MCS 7835-I1‹/inv:productName›
‹inv:productModel›Cisco MCS 7835-I1‹/inv:productModel›
‹inv:originalInventoryDate›2012-09-14T00:00:00.000‹/inv:originalInventoryDate›
‹inv:lastInventoryDate›2012-09-14T00:00:00.000‹/inv:lastInventoryDate›
‹inv:baseProductId›MCS-7835-I1-IPC1‹/inv:baseProductId›
‹inv:hardWareVersion›‹/inv:hardWareVersion›
‹inv:softwareVersion›Linux release:2.6.18-194.26.1.el5PAE machine:i686‹/inv:softwareVersion›
‹inv:softwareType›UCOS‹/inv:softwareType›
‹inv:flashMemory›0‹/inv:flashMemory›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2004-04-19 00:00:00.0‹/inv:shipDate›
‹inv:osVersion›Linux release:2.6.18-194.26.1.el5PAE machine:i686‹/inv:osVersion›
‹/inv:deviceDetail›
‹inv:deviceDetail›
‹inv:deviceId›3740236‹/inv:deviceId›
‹inv:hostName›TSPM-SJ-P1C1SW1‹/inv:hostName›
‹inv:ipAddress›172.21.34.101‹/inv:ipAddress›
‹inv:originalSerialNumber›SMG1441N07D‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›SMG1441N07D‹/inv:validatedSerialNumber›
‹inv:productId›WS-6509-EXL-FWM-K9 (Validated PID), WS-C6509 (PCE PID)‹/inv:productId›
‹inv:productDescription›^Cat 6509 Chassis, 9slot, 15RU, No Pow Supply, No Fan Tray‹/inv:productDescription›
‹inv:productFamily›Cisco Catalyst 6500 Series Switches‹/inv:productFamily›
‹inv:productName›Cisco Catalyst 6509 Switch‹/inv:productName›
‹inv:productModel›Cisco Catalyst 6509 Switch‹/inv:productModel›
‹inv:elementType›SWITCH‹/inv:elementType›
‹inv:cardDetail›
‹inv:cardId›18857879‹/inv:cardId›
‹inv:deviceId›3740236‹/inv:deviceId›
‹inv:productId›WS-CAC-4000W-US (Validated PID)‹/inv:productId›
‹inv:fruFlag›1‹/inv:fruFlag›
‹inv:originalSerialNumber›SNI1440BKD4‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›SNI1440BKD4‹/inv:validatedSerialNumber›
‹inv:slotNumber›0‹/inv:slotNumber›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2004-04-19 00:00:00.0‹/inv:shipDate›
‹/inv:cardDetail›
‹inv:cardDetail›
‹inv:cardId›18857880‹/inv:cardId›
‹inv:deviceId›3740236‹/inv:deviceId›
‹inv:productId›WS-SVC-FWM-INC-K9 (Validated PID), WS-SVC-FWM-1-K9 (PCE PID)‹/inv:productId›
‹inv:productDescription›Firewall blade for 6500 and 7600, VFW License Separate‹/inv:productDescription›
‹inv:productFamily›Catalyst 6500 Series Modules‹/inv:productFamily›
‹inv:fruFlag›1‹/inv:fruFlag›
‹inv:originalSerialNumber›SAL1443XWT8‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›SAL1443XWT8‹/inv:validatedSerialNumber›
‹inv:slotNumber›0‹/inv:slotNumber›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2004-04-19 00:00:00.0‹/inv:shipDate›
‹/inv:cardDetail›
...
‹inv:responseTimestamp›2013-04-02T07:48:38.907-07:00‹/inv:responseTimestamp›
‹inv:message›
‹inv:messageType›SUCCESS‹/inv:messageType›
‹inv:messageDetail›Request processed successfully‹/inv:messageDetail›
‹/inv:message›
‹/inv:CustomerInventoryDetailResponseOutput›
‹/soapenv:Body›
‹/soapenv:Envelope›
This operation accepts a new mandatory parameter called pageStart (along with the currently existing parameters-customerId, inventoryId, deviceIds).
This operation will return (in addition to what is returned by getCustomerInventoryDetails) a new section at the beginning of the response called 'pages'. This section has four parts:
| Parameter | Required | Type | Description |
|---|---|---|---|
| customerId | Yes | string | This parameter is returned in the API service call getCustomersInventoryIds. customerId is an id used by Cisco to uniquely identify the company. |
| inventoryID | Yes | string | This parameter is returned in the API service call getCustomersInventoryIds. inventoryId identifies the inventory whose data will be accessed for the chassis & card level details. |
| deviceIds | Optional | string | The deviceIds input can be zero or more. When not providing the deviceIds, the api will return a full collection of data for that given InventoryID, for that given CustomerId, of that given PartyGUID; all the devices collected for that inventory will be returned. |
| pageStart | Yes | string | The number of pages to be returned. The first time this API is called, this value should always be 1. |
pages
| Parameter | Type | Length | Description |
|---|---|---|---|
| pageSize | string | 5 | The chunk size for each response returned. |
| pageCurrent | string | 5 | The current page being returned. |
| pageTotal | string | 5 | The total number of pages which can be returned. |
| pidCount | string | 6 | The total number of PIDs returned by this request. |
DeviceDetail
| Parameter | Type | Length | Description |
|---|---|---|---|
| deviceId | string | 22 | Device id of the device contained in a specific customer inventory. |
| hostName | string | 255 | Hostname of the device. |
| ipAddress | string | 64 | IP address of the device. |
| originalSerialNumber | string | 1500 | Serial number of the device noted on the purchase order. |
| validatedSerialNumber | string | 50 | Actual number physically found on the device. |
| productId | string | 255 | Refers to the validated product id of the device. |
| productDescription | string | 4000 | Product description of the device. |
| productFamily | string | 255 | Product family the device belongs to. |
| productName | string | 255 | Product name of the device. |
| productModel | string | 255 | Product model of the device. |
| elementType | string | 150 | Element type of the device. |
| originalInventoryDate | date | DATE | Date the original inventory was performed. |
| lastInventoryDate | date | DATE | Date the last inventory was performed. |
| baseProductId | string | 255 | Base product id of the device. |
| installedMemory | string | 20 | Amount of memory the device has installed. |
| hardWareVersion | string | 20 | Hardware version of the device. |
| softwareVersion | string | 50 | Software version of the device. |
| softwareType | string | 50 | OS type of the software. |
| flashMemory | string | 22 | Amount of flash memory the device has installed. |
| manufacturer | string | 255 | Original Manufacturer of device |
| c3instanceid | string | 4000 | Unique association between PID and SN |
| shipDate | string | 21 | Ship Date of device |
| osVersion | string | 50 | Operating System version of the device. |
CardDetail
| Parameter | Type | Length | Description |
|---|---|---|---|
| cardId | string | 22 | API calls the ID of the card contained inside the device. |
| deviceId | string | 22 | Device ID of the device. |
| cardDescription | string | 0 | Description of the card inside the device. |
| cardFamily | string | 0 | Identifies which family the card belongs to. |
| productId | string | 255 | Base product ID of the card. |
| productDescription | string | 4000 | Product description of the card. |
| productFamily | string | 255 | Product family the card belongs to. |
| fruFlag | string | 22 | fruFlag: 1: Card is field replaceable unit. fruFlag: 2: Card is not field replaceable unit. fruFlag: 0: When element is Chassis or in Case of card data is not populated. |
| originalSerialNumber | string | 1500 | Original manufacturer's serial number for the card |
| validatedSerialNumber | string | 50 | Serial number that someone validated to be on the card. |
| slotNumber | string | 20 | Slot number where the card is plugged. |
| firmwareVersionNumber | string | 255 | Card's firmware version number. |
| hardwareVersionNumber | string | 255 | Card's hardware version number. |
| softwareVersion | string | 0 | Card's software version number. |
| manufacturer | string | 255 | Original Manufacturer of device. |
| c3instanceid | string | 4000 | Unique association between PID and SN. |
| shipDate | string | 21 | Ship Date of device. |
responseTimestamp
| Parameter | Type | Length | Description |
|---|---|---|---|
| date | DATE | Time stamp that indicates when this service call was performed. |
message
| Parameter | Type | Length | Description |
|---|---|---|---|
| See Message Format section for more details. | |||
| messageType | string | 255 | |
| messageDetail | string | 255 |
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:inv="http://www.cisco.com/InventoryService"›
‹soapenv:Header/›
‹soapenv:Body›
‹inv:CustomerInventoryDetailPaginatedRequestInput›
‹inv:customerId›79954‹/inv:customerId›
‹inv:inventoryId›84625‹/inv:inventoryId›
‹!--Zero or more repetitions:--›
‹inv:deviceIds›‹/inv:deviceIds›
‹inv:pageStart›1‹/inv:pageStart›
‹/inv:CustomerInventoryDetailPaginatedRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹inv:CustomerInventoryDetailPaginatedResponseOutput
xmlns:inv="http://www.cisco.com/InventoryService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance"
xmlns:is="http://www.cisco.com/ISAlertService"
xmlns:psirt="http://www.cisco.com/PSIRTAlertService"
xmlns:con="http://www.cisco.com/ContractService"›
‹inv:pages›
‹inv:pageSize›500‹/inv:pageSize›
‹inv:pageCurrent›1‹/inv:pageCurrent›
‹inv:pageTotal›6‹/inv:pageTotal›
‹inv:pidCount›2539‹/inv:pidCount›
‹/inv:pages›
‹inv:deviceDetail›
‹inv:deviceId›4543124‹/inv:deviceId›
‹inv:hostName›GRRBUDDA1.red.telefonica-wholesale.net‹/inv:hostName›
‹inv:ipAddress›94.142.96.93‹/inv:ipAddress›
‹inv:originalSerialNumber›FHK1242F3BX‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›FHK1242F3BX‹/inv:validatedSerialNumber›
‹inv:productId›CISCO2821 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›2821 w/ AC PWR,2GE,4HWICs,3PVDM,1NME-X,2AIM,IPBASE,128F/512D‹/inv:productDescription›
‹inv:productFamily›Cisco 2800 Series Integrated Services Routers‹/inv:productFamily›
‹inv:elementType›ROUTER‹/inv:elementType›
‹inv:cardDetail›
‹inv:cardId›22143992‹/inv:cardId›
‹inv:deviceId›4543124‹/inv:deviceId›
‹inv:productId›HWIC-16A (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›16-Port Async HWIC‹/inv:productDescription›
‹inv:productFamily›WAN Interface Cards‹/inv:productFamily›
‹inv:fruFlag›1‹/inv:fruFlag›
‹inv:originalSerialNumber›FOC12325UNJ‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›FOC12325UNJ‹/inv:validatedSerialNumber›
‹inv:slotNumber›0‹/inv:slotNumber›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2004-04-19 00:00:00.0‹/inv:shipDate›
‹/inv:cardDetail›
‹inv:cardDetail›
‹inv:cardId›22143993‹/inv:cardId›
‹inv:deviceId›4543124‹/inv:deviceId›
‹inv:productId›WIC-1B-S/T-V3 (Validated PID and PCE PID)‹/inv:productId›
‹inv:productDescription›1-Port ISDN WAN Interface Card (dial and leased line)‹/inv:productDescription›
‹inv:productFamily›WAN Interface Cards‹/inv:productFamily›
‹inv:fruFlag›1‹/inv:fruFlag›
‹inv:originalSerialNumber›FOC123861Y6‹/inv:originalSerialNumber›
‹inv:validatedSerialNumber›FOC123861Y6‹/inv:validatedSerialNumber›
‹inv:slotNumber›0‹/inv:slotNumber›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2004-04-19 00:00:00.0‹/inv:shipDate›
‹/inv:cardDetail›
‹inv:originalInventoryDate w3c:nil="true"/›
‹inv:lastInventoryDate›2012-05-25T00:00:00.000‹/inv:lastInventoryDate›
‹inv:baseProductId›CISCO2821‹/inv:baseProductId›
‹inv:installedMemory›512‹/inv:installedMemory›
‹inv:hardWareVersion›‹/inv:hardWareVersion›
‹inv:softwareVersion›12.4(24)T3‹/inv:softwareVersion›
‹inv:softwareType›IOS‹/inv:softwareType›
‹inv:flashMemory›256‹/inv:flashMemory›
‹inv:manufacturer›CISCO‹/inv:manufacturer›
‹inv:c3instanceid›[401108352]‹/inv:c3instanceid›
‹inv:shipDate›2004-04-19 00:00:00.0‹/inv:shipDate›
‹inv:osVersion›Linux release:2.6.18-194.26.1.el5PAE machine:i686‹/inv:osVersion›
‹/inv:deviceDetail›
...
‹inv:responseTimestamp›2013-06-13T15:45:53.243-04:00‹/inv:responseTimestamp›
‹inv:message›
‹inv:messageType›SUCCESS‹/inv:messageType›
‹inv:messageDetail›Request processed successfully. Returning 1 to 500 of 2539 PIDs.‹/inv:messageDetail›
‹/inv:message›
‹/inv:CustomerInventoryDetailPaginatedResponseOutput›
‹/soapenv:Body›
‹/soapenv:Envelope›
The getDeviceConfig is a REST based API.
This API returns the device configuration for the selected devices if collected by the collector. This API returns Startup configs and Running configs.
The input data parameters(customerId and deviceIds) are obtained from the data returned in the first two Inventory API service calls. You must provide the configType you want to retrieve, either RUNNING, STARTUP, or BOTH.
Only output files of up to 100 MB size of the configurations are supported.
| Parameter | Required | Type | Description |
|---|---|---|---|
| customerId | Yes | string | This parameter is returned in the API service call getCustomersInventoryIds. customerId is an id used by Cisco to uniquely identify the company. |
| deviceIds | Yes | string | The deviceIds input is limited to a maximum of 5 devices per call. |
| configType | Yes | string | configType selects the configuration type you want to return. The only valid input strings are RUNNING, STARTUP, and BOTH. |
ZIP file which contains the.txt files for the requested configuration files.
Format of the text file is (Deviceid_ConfigType__‹TIMESTAMP›.txt). The timestamp is the collected timestamp of the running and startup configs.
Look at the response data type (MIME-.zipfile) in the response and download the file. Read the file name from response header or provide the download zip file name as per the preference.
GET
https://api.cisco.com/pss/v1.0/inventory/customers/349944/devices/14216087,14229454,14216090,14216093,14216095?configType=RUNNING HTTP/1.1
Accept-Encoding: gzip,deflate
X-Party-Id: 209678445
Host: localhost:8080
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_77)
HTTP/1.1 200 OK
Date: Sat, 29 Oct 2016 00:25:22 GMT
X-Mashery-Message-ID: 66d0ad01-077d-4e2a-a499-2c2991f49ecd
Cache-Control: private
Pragma: private
Content-Disposition: attachment; filename=deviceconfig_100856745_996296262.zip
Content-Type: application/zip
Content-Length: 3702
Cache-Control: private
LAEHOST: lae-rtp1-xx-101.cisco.com
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-type, fromPartyID, inputFormat, outputFormat, Authorization, Content-Length, Accept, Origin
X-RP-SSL-Name: lae-rtp1-rpx02
HTTP/1.1 400 Bad Request
{
"error": {
"errorCode": "GENERAL_INVS_GET_DEVICE_CONFIG_MAX_DEVICES",
"errorMessage": "Please specify up to 5 deviceids only."
}
}
©2016 Cisco Systems, Inc. · All Rights Reserved · This site is Cisco Confidential. For Cisco Field and Channel Partner use only. Not for public distribution.