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

Find content schema attributes

get

/km/api/v1/contentTypes/{contentTypeId}/contentSchema

Returns the list of content schema attributes for a content type. Schema will be returned in FULL mode. Caller needs to pass in the correct content type recordid otherwise exception will be thrown. Also if the logged in user does not have VIEW privilege on the content type, exception will be thrown.

Response Errors

The possible error responses for this method are as follows:

  • OKDOM-GEN0001

    The error occurs when a bad channel id is passed in

  • OK-SEC0007

    If the User doe snot have any VIEW content type privilege

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList SchemaAttribute
Type: object
Title: ResultList SchemaAttribute
Match All
Show Source
Nested Schema : Collection Paging Resource
Title: Collection Paging Resource
Oracle base collection resource schema definition.
Match All
Oracle base collection resource schema definition.
Oracle base collection resource schema definition.
Show Source
Nested Schema : Base Collection Resource
Title: Base Collection Resource
Oracle base collection resource schema definition.
Match All
Oracle base collection resource schema definition.
Oracle base collection resource schema definition.
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : Base Collection Resource-allOf[1]
Type: object
Show Source
Nested Schema : Collection Paging Resource-allOf[1]
Type: object
Show Source
  • Number of resource instances returned in the current range.
  • Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
  • Actual paging size used by the server.
  • Offset value used in the current page.
  • Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
Nested Schema : ResultList SchemaAttribute-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: array
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

Back to Top

Examples

The following example shows how to find all the content schema attributes of the specified Content Type object in full mode 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/{contentTypeId}/contentSchema"

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.

{
  "items" : [ {
    "children" : [ ],
    "recordId" : "a142bf94d4c0439a8d30afdf41f0f859",
    "xpath" : "//NEWS/TITLE",
    "name" : "Title",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET"
    } ],
    "requireWorkflowApproval" : false,
    "allowPreselectedUserGroupChange" : false,
    "counter" : -1,
    "enableFullTextSearch" : true,
    "includeInMasterIdentifier" : true,
    "isNode" : false,
    "allowMultipleNodes" : false,
    "isRequired" : false,
    "readOnly" : false,
    "enableAttributeLevelSearch" : false,
    "schemaAttrType" : "TEXT_FIELD",
    "secureWithUserGroups" : false,
    "securedFileResource" : false,
    "userGroupSelectionRequired" : false,
    "sortOrder" : 1,
    "referenceKey" : "TITLE"
  } ]
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "count" : 1
}
Back to Top