The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter describes the Mediation Product Catalog web service interface for HCM. You can provision Product Catalog information.
The ProductCatalog data service exposes the HCM northbound interface and operations, enabling queries of the product catalog entities. All operation request and response messages extend from a common base complexType, called OperationRequest and OperationResponse. See Figure 3-1.
Figure 3-1 Service Interface
This section describes the HCM XML API for the ProductCatalog data service that contains the following operations:
•getProductSpecification
–GetProductSpecificationRequest—Appendix B, "Sample getProductSpecification XML Request"
–GetProductSpecificationResponse—Appendix B, "Sample getProductSpecification XML Response"
•listDeviceSpecifications
–ListDeviceSpecificaitonsRequest—Appendix B, "Sample listDeviceSpecifications XML Request"
–ListDeviceSpecificaitonsResponse—Appendix B, "Sample listDeviceSpecifications XML Response"
•listLogicalResourceSpecifications
–ListLogicalResourceSpecificationsRequest—Appendix B, "Sample listLogicalResourceSpecifications XML Request"
–ListLogicalResourceSpecificationsResponse—Appendix B, "Sample listLogicalResourceSpecifications XML Response"
•listProductCategories
–ListProductCategoriesRequest—Appendix B, "Sample listProductCategories XML Request"
–ListProductCategoriesResponse—Appendix B, "Sample listProductCategories XML Response"
•listProductGroups
–ListProductGroupsRequest
–ListProductGroupsResponse
•listProductSpecificationIds
–ListProductSpecificationIdsRequest—Appendix B, "Sample listProductSpecificationIds XML Request"
–ListProductSpecificationIdsResponse—Appendix B, "Sample listProductSpecificationIds XML Response"
•listProductSpecCharacteristicValues
•listProductSpecCharacteristicValuesRequest—Appendix B, "Sample listProductSpecCharacteristicValues XML Request"
•listProductSpecCharacteristicValuesResponse—Appendix B, "Sample listProductSpecCharacteristicValues XML Response"
This section includes:
•listLogicalResourceSpecifications
See Appendix A, "HCSProductCatalog.wsdl File" for the ProductCatalog WSDL file.
See Appendix B, "Sample ProductCatalog Data Service XML API Requests and Responses" for samples of outbound request message and inbound server response message.
The getProductSpecification operation returns a ProductSpecification for the specified ProductId.
Table 3-1 lists the Logical Name, Xpath, and Data Types for the GetProductSpecificationRequest operation.
Table 3-2 lists the Logical Name, XPath, Data Types, and Comments/Validation/Rules for the GetProductSpecificationReponse operation.
The listDeviceSpecifications operation returns the list of all the DeviceSpecifications.
This section includes:
•ListDeviceSpecificationsRequest
•ListDeviceSpecificationsResponse
Table 3-3 lists the Entity, Path/Attribute, and Data Types for the ListDeviceSpecificationsRequest operation.
|
|
|
|
---|---|---|---|
ListDeviceSpecificationsRequest (extends OperationRequest) |
|||
— |
— |
— |
No inputs parameters. |
Table 3-4 lists the Logical Name, XPath, and Data Types for the ListDeviceSpecificationsResponse operation.
The listLogicalResourceSpecifications operation returns the list of all logical resource specifications. This section includes:
•ListLogicalResourceSpecificationsRequest
•ListLogicalResourceSpecificationsResponse
Table 3-5 lists the Entity, Path/Attribute, and Data Types for the ListLogicalResourceSpecificationsRequest operation.
Table 3-6 lists the Logical Name, XPath, and Data Types for the ListLogicalResourceSpecificationsReponse operation.
The listProductCategories operation returns the list of all the logical product categories. This section includes:
•ListProductCategoriesResponse
Table 3-7 lists the Entity, Path/Attribute, and Data Types for the ListProductCategoriesRequest operation.
|
|
|
|
---|---|---|---|
ListProductCategoriesRequest |
|||
— |
— |
— |
No inputs parameters. |
Table 3-8 lists the Logical Name, XPath, and Data Types for the ListProductCategoriesResponse operation.
The listProductSpecificationIds operation returns the list of product specification IDs that are specified by the input parameters. This section includes:
•ListProductSpecificationIdsRequest
•ListProductSpecificationIdsResponse
The ListProductSpecificationIdsRequest operation supports the following query modes:
•Parent Only—Returns only the parent product specifications.
•Children of Parent—Returns all child products for the specified ParentProductId.
•Products in a category—Returns all products for the specified ProductCategoryType.
These three modes are independent of each other. This operation expects a single argument for each invocation.
Table 3-9 lists the Entity, Path/Attribute, Data Types, and Comments/Validation/Rules for the ListProductSpecificationIdsRequest operation.
Table 3-10 lists the Logical Name, XPath, and Data Types for the ListProductSpecificationIdsResponse operation.
|
|
|
Rules |
---|---|---|---|
ListProductSpecificationIdsResponse |
|||
ProductIds[*] |
ProductIds |
Array String |
— |
The listProductSpecCharacteristicValues operation returns a list of product characteristic values for the specified product, attribute, and filter criteria. The listProductSpecCharacteristicValues operation is the only asynchronous operation. This section includes:
•ListProductSpecCharacteristicValuesRequest
•ListProductSpecCharacteristicValuesResponse
The ListProductSpecCharacteristicValues request takes a productNumber, a collection of productSpecCharacteristic IDs, and filter criteria. The FilterCriteria entity allows a choice of either a requestedGeographicSiteId or a requestedPhysicalDevice, which contains deviceName and capabilityName fields.
Table 3-11 lists the Entities, Path/Attribute, and Data Types for the ListProductSpecCharacteristicValuesRequest operation.
The ListProductSpecCharacteristicValues response is an asynchronous operation. The response message for this is the standard operation response message. For more information, see Chapter 2, "OperationResponse."