Find content schema attributes
/km/api/v1/contentTypes/{contentTypeId}/contentSchema
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
-
contentTypeId: string
The content type identifier
Response
- application/json
- application/xml
200 Response
object
ResultList SchemaAttribute
-
allOf
Collection Paging Resource
Title:
Collection Paging Resource
Oracle base collection resource schema definition. -
object
ResultList SchemaAttribute-allOf[1]
Collection Paging Resource
-
allOf
Base Collection Resource
Title:
Base Collection Resource
Oracle base collection resource schema definition. -
object
Collection Paging Resource-allOf[1]
Base Collection Resource
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
Base Collection Resource-allOf[1]
object
Singular Resource
object
-
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.
-
limit(optional):
integer
Actual paging size used by the server.
-
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
-
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.
object
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
SchemaAttributeKey-allOf[1]
object
-
name(optional):
string
Localized name of the attribute. This need NOT be unique within the Schema.
-
recordId(optional):
string
Unique identifier for the SchemaAttribute object
-
xpath(optional):
string
The XPATH of this attribute within the schema. This is unique within the Schema.
object
-
allowMultipleNodes(optional):
boolean
Flag indicating if multiple nodes are allowed of this type @since 8.3
-
allowPreselectedUserGroupChange(optional):
boolean
Enable editors to modify preselected user group restrictions @since 8.3
-
counter(optional):
integer
This attribute contains the current value of the ContentType DOC ID counter. This value should not be changed after content is added to the ContentType
-
counterPrefix(optional):
string
This attribute contains the prefix that is appended to the front of the DOC ID counter
-
dateAdded(optional):
string(date-time)
This attribute represents the timestamp when the SchemaAttribute definition was first created
-
dateModified(optional):
string(date-time)
This attribute represents the timestamp when the SchemaAttribute definition was last modified
-
description(optional):
string
Localized help text for the attribute. This text is displayed in the authoring view
-
enableAttributeLevelSearch(optional):
boolean
Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This field was previously called searchable @since 8.3
-
enableFullTextSearch(optional):
boolean
Flag indicating whether this field should be included in the full text index. This field was previously called indexable @since 8.3
-
includeInMasterIdentifier(optional):
boolean
Flag indicating whether this field should be appended to the master identifier of the document
-
isNode(optional):
boolean
Flag indicating if this element is a node @since 8.3
-
isRequired(optional):
boolean
Make attribute a required field @since 8.3
-
readOnly(optional):
boolean
Flag indicating whether this field is editable
-
referenceKey(optional):
string
Non localized name of the attribute. SchemaAttribute's referenceKey need NOT be unique within its Schema. But its xpath will be unique within its Schema.
-
requireWorkflowApproval(optional):
boolean
Attribute requires workflow approval if workflow is enabled
-
schemaAttrType(optional):
Allowed Values:
[ "TEXT_AREA", "WYSIWYG_EDIT", "TEXT_FIELD", "FILE", "BOOLEAN", "LIST", "COUNTER", "DATE", "DATETIME", "TIME", "INTEGER", "FLOAT" ]
Enumerated type representing the type of attribute - i.e. text field, rich text area -
securedFileResource(optional):
boolean
Flag indicating if this attribute (file types only) should be marked as secure - i.e. stored in the ~secure folder near the content XML file
-
secureWithUserGroups(optional):
boolean
Restrict attribute to selected user groups
-
securityRegex(optional):
string
The regular expression used to validate the field against security attacks.
-
sortOrder(optional):
integer
Display order of the schema attributes within the edit form
-
textHeight(optional):
string
Specifies the text height for text areas and rich text fields
-
textWidth(optional):
string
Specifies the max length for text fields
-
userGroupSelectionRequired(optional):
boolean
User groups are required for attribute
-
wysiwygType(optional):
Allowed Values:
[ "BASIC", "MEDIUM", "FULL" ]
Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM @since 8.3
object
-
children(optional):
array children
List of child nodes of the current element
-
schemaAttributeUserGroupList(optional):
array schemaAttributeUserGroupList
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
array
-
Array of:
object SchemaAttributeUserGroup
Title:
SchemaAttributeUserGroup
object
SchemaAttributeUserGroup
-
defaultValue(optional):
boolean
Flag indiacting whether the user group should be selected by default
-
recordId(optional):
string
GUID from the XMLSCHEMAATTRIBUTEUSERGROUP table
-
userGroup(optional):
UserGroupKey
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
UserGroupKey-allOf[1]
object
-
externalId(optional):
integer
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.
-
externalType(optional):
string
The ExternalType is the type of the corresponding userGroup from an external system.
-
name(optional):
string
The localized name of the user group. The name field can only be used for sorting.
-
recordId(optional):
string
The unique identifier from the TAG table that represent a userGroups resource
-
referenceKey(optional):
string
The non localized name of the user group
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 }