REST API for Knowledge Management in Oracle Fusion Service

Get a category

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.

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/{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

id: string

The unique identifier of the object to be retrieved.

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : Category

Type: object

Title: Category

Show Source

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
dateAdded(optional): string(date-time)

The date when the Category object was created or added.
dateModified(optional): string(date-time)
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.
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.
hasChildren(optional): boolean

Flag to determine if category has children.
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
parent(optional): object CategoryKey

Title: CategoryKey
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.
sortOrder(optional): integer

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

{
    "title":"Category",
    "properties":{
        "recordId":{
            "description":"<p>The unique record ID of the Category object.</p>",
            "type":"string"
        },
        "childrenCount":{
            "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>",
            "type":"integer"
        },
        "hasChildren":{
            "description":"Flag to determine if category has children.",
            "type":"boolean"
        },
        "dateModified":{
            "description":"<p>The date when the Category object was last modified.</p> <p>A category is considered to be modified in any of the following situations:</p><p>     <ul> <li> The category is created. The parent category to which the new category is added to is also considered as modified.</li> <li> The name of the category is changed in any locale.</li> <li> A child category is deleted.</li> <li> The category is moved. A moved category has a new parent,so the previous and new parent categories are also considered as modified.</li> <li> 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.</li> </ul> </p>",
            "format":"date-time",
            "type":"string"
        },
        "parents":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
            "type":"array"
        },
        "externalType":{
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>",
            "type":"string"
        },
        "sortOrder":{
            "description":"<p>The assigned position of category object in the list of objects.</p>",
            "type":"integer"
        },
        "inventoryOrgId":{
            "description":"<p>The inventory organization id of the specific product.</p>",
            "type":"integer"
        },
        "parent":{
            "description":"<p>The parent category of the specific category.</p>",
            "$ref":"#/definitions/CategoryKey"
        },
        "dateAdded":{
            "description":"<p>The date when the Category object was created or added.</p>",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>",
            "type":"integer"
        },
        "responseLocale":{
            "description":"<p>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.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>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.</p>",
            "type":"string"
        },
        "description":{
            "description":"Description of the Category object",
            "type":"string"
        },
        "objectId":{
            "description":"The hierarchichal position of the category",
            "type":"string"
        },
        "name":{
            "description":"<p>The name of the category.</p>",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : CategoryKey

Type: object

Title: CategoryKey

Show Source

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.

{
    "title":"CategoryKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique record ID of the Category object.</p>",
            "type":"string"
        },
        "responseLocale":{
            "description":"<p>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.</p>",
            "type":"string"
        },
        "childrenCount":{
            "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>",
            "type":"integer"
        },
        "externalType":{
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>",
            "type":"string"
        },
        "parents":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
            "type":"array"
        },
        "referenceKey":{
            "description":"<p>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.</p>",
            "type":"string"
        },
        "objectId":{
            "description":"The hierarchichal position of the category",
            "type":"string"
        },
        "description":{
            "description":"Description of the Category object",
            "type":"string"
        },
        "name":{
            "description":"<p>The name of the category.</p>",
            "type":"string"
        },
        "inventoryOrgId":{
            "description":"<p>The inventory organization id of the specific product.</p>",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>",
            "type":"integer"
        }
    }
}

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

Array of: object CategoryKey

Title: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
    "type":"array"
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

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.

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"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.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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

Array of: object CategoryKey

Title: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
    "type":"array"
}

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 Request Header

The following shows an example of the request header.

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/categories/{id}" -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:

{
    "recordId": "58921ED6778448CA8DF3D1C77336C332",
    "referenceKey": "FUSION_CATEGORY_300100163778925",
    "objectId": "029",
    "name": "BIQA_KM_TOP",
    "externalId": 300100163778925,
    "externalType": "CATEGORY",
    "description": "BIQA_KM_TOP",
    "links": [
        {
            "rel": "children",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/categories/58921ED6778448CA8DF3D1C77336C332/children",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/categories/58921ED6778448CA8DF3D1C77336C332",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "collection",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/categories",
            "mediaType": "application/json, application/xml",
            "method": "GET",
            "profile": "https://<IM_REST_API_HOST>/km/api/v1/metadata-catalog/categories"
        }
    ],
    "dateAdded": "2018-06-06T06:32:22+0000",
    "dateModified": "2018-06-06T06:32:23+0000",
    "sortOrder": 26,
    "hasChildren": true
}