Get children categories
/km/api/v1/categories/{id}/children
This method returns a list of immediate children categories of the specified category.
This resource supports the orderBy request parameter. You can use this parameter along with the HTTP service request to sort the returned list.
You must get the schema and catalog of the resource for additional values that you can use with the orderBy parameter. To get the schema and catalog of the resource, you must use the GET method with the mediaType value as 'application/schema+json'
in the HTTP request.
This resource also supports the withParents request parameter.
When the withParents request parameter is set to true, for each category returned the parent categories of that category will be included, ordered from the root category to the immediate parent of each returned category.
Category and Product Visibility Filtering
The visibility of products and categories is dependent on the type of user making the request, and the content type and views associated with the request. The content type, and interface ID parameters are optional.
The example URI to get schema and catalog of the resource is as follows:
http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/categories
The example URI to get list of parents included in the returned category object is as follows:
http://<IM_REST_API_HOST>/km/api/latest/categories/{id}/children?withParents=true
Request
-
id: string
The Category or Product identifier
Response
- application/json
- application/xml
200 Response
object
ResultList CategoryKey
-
count(optional):
integer
Number of resource instances returned in the current range.
-
hasMore(optional):
boolean
Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
-
items(optional):
array items
-
limit(optional):
integer
Actual paging size used by the server.
-
links(optional):
array links
-
offset(optional):
integer
Offset value used in the current page.
-
totalResults(optional):
integer
Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
CategoryKey
-
childrenCount(optional):
integer
This field will return number of immediate children a category has.
This field will only be populated if childrenCount query parameter is passed in with value true.
Example URIs for the this parameter are as follows:
- http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&mode=KEY
- http://<IM_REST_API_HOST>/km/api/categories?childrenCount=true&mode=KEY
- http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY
-
description(optional):
string
Description of the Category object
-
externalId(optional):
integer
The unique identifier used while integrating the repository data with the external system.
-
externalType(optional):
string
The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.
-
inventoryOrgId(optional):
integer
The inventory organization id of the specific product.
-
links(optional):
array links
-
name(optional):
string
The name of the category.
-
objectId(optional):
string
The hierarchichal position of the category
-
parents(optional):
array parents
This field will return all parents of category.
This field will only be populated if withParents query parameter is passed in with value true.
Example URIs for the this parameter are as follows:
- http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
- http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
- http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
- http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
-
recordId(optional):
string
The unique record ID of the Category object.
-
referenceKey(optional):
string
The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.
-
responseLocale(optional):
string
This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
This field will return all parents of category.
This field will only be populated if withParents query parameter is passed in with value true.
Example URIs for the this parameter are as follows:
- http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
- http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
- http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
- http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
-
Array of:
object CategoryKey
Title:
CategoryKey
object
-
href:
string
URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
-
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
-
profile(optional):
string
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
-
rel:
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
-
templated(optional):
boolean
Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.
Examples
The following example shows how to view a list of immediate children categories of the specified category.
curl -X "GET" "http://IM_REST_API_HOST/km/api/latest/categories/{id}/children"
Example of Request Header
The following shows an example of the request header.
curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/categories/{id}/children" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "recordId": "8D6CD9BD918A4E9D8EF6302B9A2B4FD6", "referenceKey": "FUSION_PRODUCT_300100191655503", "objectId": "027.048.001.002.001.001", "name": "Brown_Bread42520200720_032427", "externalId": 300100191655503, "externalType": "PRODUCT", "description": "Brown_Bread42520200720_032427", "links": [ { "rel": "parent", "href": "<IM_REST_API_HOST>/km/api/v1/categories/E73CC63CE99547348CA06AEA43E164E0", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "canonical", "href": "<IM_REST_API_HOST>/km/api/v1/categories/8D6CD9BD918A4E9D8EF6302B9A2B4FD6", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "<IM_REST_API_HOST>/km/api/v1/categories", "mediaType": "application/json, application/xml", "method": "GET", "profile": "<IM_REST_API_HOST>/km/api/v1/metadata-catalog/categories" } ] } ], "hasMore": false, "limit": 20, "offset": 0, "links": [ { "rel": "canonical", "href": "<IM_REST_API_HOST>/km/api/v1/categories/E73CC63CE99547348CA06AEA43E164E0/children?limit=20&offset=0", "mediaType": "application/json, application/xml", "method": "GET" } ], "count": 1 }