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

Find by ID

get

/km/api/v1/contentTypes/{id}

This method returns the ContentType object having the specified ID parameter.

Example URIs

The example URIs for this method are as follows:

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

    The request returns the ContentType object having specified ID parameter in FULL mode.

  • http://<IM_REST_API_HOST>/km/api/contentTypes/{id}?mode=KEY

    The request returns the ContentType object having specified ID parameter in the KEY mode.

  • http://<IM_REST_API_HOST>/km/api/contentTypes/{id}?mode=DATA

    The request returns the ContentType object having specified ID parameter in the DATA mode.

Response Errors

  • OKDOM-GEN0001

    The error occurs when an invalid id has been given.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

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

  • The description for the ContentType object. Content Types support multiple languages.

    This field identifies the object associated with the language specified by the user.

  • The name for the ContentType object. The name field can only be used for sorting.

    Content Types support multiple languages. This field identifies the object associated with the language specified by the user.

  • The unique identifier of the ContentType object.

  • The reference key for the ContentType object.

    ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.

Nested Schema : ContentTypeData-allOf[1]
Type: object
Show Source
Nested Schema : ContentTypeExtended-allOf[1]
Type: object
Show Source
Nested Schema : ContentType-allOf[1]
Type: object
Show Source
  • categories

    The list of Category objects configured in the content type, which are available to the content authors to assign to the content. The Category objects are used to tag or label the content to improve searchability.

  • customMetrics

    The unit of measurement used to track the activities on the content in a content type.

  • requiredCategories

    The Category objects that the content type requires for all its contents. The content authors must assign these categories to the content while content authoring. Authors are not allowed to save the content if they do not assign the categories.

  • translationRequestLocales

    The list of Locale objects for which the automatic translation request is enabled in the content type. The content type sends translation requests to content translators of specific set of languages, each time the content is ready for publication.

  • userGroups

    The UserGroup objects associated with the content type. Content authors assign a user Group to the content, so that users with a certain level of access will have access to the content.

  • WorkflowKey
Nested Schema : Schema
Match All
Show Source
Nested Schema : RatingKey
Match All
Show Source
Nested Schema : SchemaData
Match All
Show Source
Nested Schema : SchemaKey
Match All
Show Source
Nested Schema : SchemaKey-allOf[1]
Type: object
Show Source
Nested Schema : SchemaData-allOf[1]
Type: object
Show Source
Nested Schema : Schema-allOf[1]
Type: object
Show Source
Nested Schema : schemaAttributes
Type: array
List of schema attributes for the schema
Show Source
Nested Schema : SchemaAttribute
Match All
Show Source
Nested Schema : SchemaAttributeData
Match All
Show Source
Nested Schema : SchemaAttributeKey
Match All
Show Source
Nested Schema : SchemaAttributeKey-allOf[1]
Type: object
Show Source
  • Localized name of the attribute. This need NOT be unique within the Schema.
  • Unique identifier for the SchemaAttribute object
  • The XPATH of this attribute within the schema. This is unique within the Schema.
Nested Schema : SchemaAttributeData-allOf[1]
Type: object
Show Source
Nested Schema : SchemaAttribute-allOf[1]
Type: object
Show Source
Nested Schema : children
Type: array
List of child nodes of the current element
Show Source
Nested Schema : schemaAttributeUserGroupList
Type: array
List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType
Show Source
Nested Schema : SchemaAttributeUserGroup
Type: object
Title: SchemaAttributeUserGroup
Show Source
Nested Schema : UserGroupKey
Match All
Show Source
Nested Schema : UserGroupKey-allOf[1]
Type: object
Show Source

  • The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.

  • The ExternalType is the type of the corresponding userGroup from an external system.

  • The localized name of the user group. The name field can only be used for sorting.

  • The unique identifier from the TAG table that represent a userGroups resource

  • The non localized name of the user group

Nested Schema : RatingKey-allOf[1]
Type: object
Show Source
Nested Schema : categories
Type: array

The list of Category objects configured in the content type, which are available to the content authors to assign to the content. The Category objects are used to tag or label the content to improve searchability.

Show Source
Nested Schema : customMetrics
Type: array

The unit of measurement used to track the activities on the content in a content type.

Show Source
Nested Schema : requiredCategories
Type: array

The Category objects that the content type requires for all its contents. The content authors must assign these categories to the content while content authoring. Authors are not allowed to save the content if they do not assign the categories.

Show Source
Nested Schema : translationRequestLocales
Type: array

The list of Locale objects for which the automatic translation request is enabled in the content type. The content type sends translation requests to content translators of specific set of languages, each time the content is ready for publication.

Show Source
Nested Schema : userGroups
Type: array

The UserGroup objects associated with the content type. Content authors assign a user Group to the content, so that users with a certain level of access will have access to the content.

Show Source
Nested Schema : WorkflowKey
Match All
Show Source
Nested Schema : CategoryKey
Match All
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 : 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
Nested Schema : CustomMetricKey
Type: object
Title: CustomMetricKey
Show Source
  • Name of the CustomMetric object
  • The unique record ID of the CustomMetric object.
  • The reference key for the CustomMetric object. CustomMetric objects support multiple languages. This field can be used to identify the associated objects for all languages.
Nested Schema : LocaleKey
Match All
Show Source
Nested Schema : LocaleKey-allOf[1]
Type: object
Show Source
Nested Schema : WorkflowKey-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find the Content Type object that has the specified ID parameter by submitting a get request on the REST resource using cURL.

cURL Command

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

Example of Request Header

The following shows an example of the request header.

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

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "customMetrics" : [ ],
  "requiredCategories" : [ {
    "recordId" : "e3fad0e6303643bd8a930a6240db9ac7",
    "referenceKey" : "NEWS"
  }, {
    "recordId" : "f0e2432dd5a04be6a063eb2b7b9b80d9",
    "referenceKey" : "PRODUCTS"
  } ],
  "categories" : [ {
    "recordId" : "e3fad0e6303643bd8a930a6240db9ac7",
    "referenceKey" : "NEWS"
  }, {
    "recordId" : "f0e2432dd5a04be6a063eb2b7b9b80d9",
    "referenceKey" : "PRODUCTS"
  }, {
    "recordId" : "01f4d5b2fe264dd2b206260b010a861d",
    "referenceKey" : "SPORTS"
  } ],
  "translationRequestLocales" : [ {
    "recordId" : "en_US"
  }, {
    "recordId" : "es_ES"
  } ],
  "contentSchema" : {
    "schemaAttributes" : [ ],
    "recordId" : "ef1c3cb55e094e0cb4ecd04366722d98"
  },
  "recordId" : "ae944730029c4005b2916fbf886c3264",
  "referenceKey" : "NEWS",
  "name" : "News",
  "allowCheckOut" : true,
  "allowRecommendations" : false,
  "counterPrefix" : "NE",
  "defaultLifespan" : -1,
  "enableUserActivityLogging" : true,
  "hasPriority" : false,
  "hasRelatedContent" : false,
  "hasTalkBack" : false,
  "isEvent" : false,
  "isModerated" : false,
  "requireAtLeastOneCategory" : false,
  "requireAtLeastOneUserGroup" : false,
  "restrictToOneUserGroupSelection" : false,
  "categoriesRequireWorkflowApproval" : true,
  "userGroupRequireWorkflowApproval" : true,
  "viewsRequireWorkflowApproval" : true,
  "displayDatesRequireWorkflowApproval" : true,
  "eventDatesRequireWorkflowApproval" : true,
  "restrictAuthoringToWorkflowUser" : false,
  "notifyOnWorkflowApproval" : false,
  "notifyOnWorkflowRejection" : false,
  "notifyGroupOnWorkflowRejection" : false,
  "removeVersions" : false,
  "reviewDate" : -1,
  "validateHtml" : true,
  "enableIndexing" : true,
  "indexStatus" : "LIVE"
}
Back to Top