1. REST API for Knowledge Advanced in B2C Service
  2. Tasks
  3. Content (IM)
  4. Categories

Find by ID

get

/km/api/v1/categories/{id}

This method returns the Category object specified by the unique identifier. The unique identifier can be recordId parameter, referenceKey parameter or externalId 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 views associated with the request.

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/categories/{id}

    The request returns a Category object having the specified ID parameter.

    • http://<IM_REST_API_HOST>/km/api/latest/categories/{id}?withParents=true

      The request returns a Category object having the specified ID parameter. List of parent categories that match the visibility filtering rules will be included in the returned object.

    • http://<IM_REST_API_HOST>/km/api/latest/categories/{referenceKey}

      The request returns a Category object having the specified referenceKey parameter value.

    • http://<IM_REST_API_HOST>/km/api/latest/categories/{externalId}

      The request returns a Category object having the specified externalId parameter value.

Request

Path Parameters
  • The unique identifier of the object to be retrieved.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : Category
Match All
Show Source
Nested Schema : CategoryData
Match All
Show Source
Nested Schema : CategoryKey
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : CategoryKey-allOf[1]
Type: object
Show Source

  • 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 of the Category object

  • The unique identifier used while integrating the repository data with the external system.

  • The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.

  • The name of the category.

  • The hierarchichal position of the category
  • 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

  • The unique record ID of the Category object.

  • 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.

  • 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.

Nested Schema : CategoryData-allOf[1]
Type: object
Show Source

  • The date when the Category object was created or added.

  • The date when the Category object was last modified.

    A category is considered to be modified in any of the following situations:

    • The category is created. The parent category to which the new category is added to is also considered as modified.
    • The name of the category is changed in any locale.
    • A child category is deleted.
    • The category is moved. A moved category has a new parent,so the previous and new parent categories are also considered as modified.
    • The sort order of the category is changed. The sort orders of sibling categories also undergo change, so those categories are also considered as modified.

  • Flag to determine if category has children.

  • The assigned position of category object in the list of objects.

Nested Schema : Category-allOf[1]
Type: object
Show Source
Nested Schema : parents
Type: 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
Show Source
Back to Top

Examples

The following example shows how to view the Category object specified by the unique identifier. The unique identifier can be recordId parameter, referenceKey parameter or externalId parameter.

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/categories/{id}"

Example of Response Header

The following shows an example of the response header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \
	-H "Accept: application/json">

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "parent" : {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "externalId" : 1428416790847,
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
Back to Top