Workflow for Extracting Faceted Catalog Data
The GET /facets end point of the Catalog Content API enables your application to get faceted catalog data based on specific attributes.
-
The client application sends a request for faceted data from an individual catalog based on a specific attribute, using the GET /facets endpoint.
The request must contain the correct Catalog Name and the Supplier ID as received in the response to the catalog subscription API call.
You can specify any refinable attribute as a facet in the request. For example, specifying ClassificationCode as the facet for a specific catalog returns the list of categories and the count of items within each category.
GET {{runtime_url}}/facets?select={attribute name}&rsqlfilter=CatalogName=={catalogname};SupplierId=={domain:value}- select
- Specifies the facet attribute.
- CatalogName
- Specifies the name of the catalog from which you want to request data. Use the exact name as freceived in the response to the catalog subsciption API call.
- SupplierId
- The supplier domain and the value as received in the response to the catalog subscription API call.
-
The procurement solution sends a response to the request with a list of facets and its count. For hierarchal fields like commodity codes, the response would also contain the parent commodity codes with the child commodity code aggregated count.