Get a content type
/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.
http://<IM_REST_API_HOST>/km/api/contentTypes/{id}?mode=EXTENDED
The request returns the ContentType object having specified ID parameter in the EXTENDED mode.
Response Errors
- OKDOM-GEN0001
This error occurs when an invalid id has been given.
Request
-
id: string
The unique identifier of the object to be retrieved.
Response
- application/json
- application/xml
200 Response
object
ContentType
-
allowCheckOut(optional):
boolean
The flag indicates whether the ContentType object allows the content to be checkoutedout, to prevent other authors from editing the same content.
-
allowRecommendations(optional):
boolean
The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.
-
categories(optional):
array 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.
-
categoriesRequireWorkflowApproval(optional):
boolean
Categories requires workflow approval if workflow is enabled @since 8.3
-
contentSchema(optional):
object Schema
Title:
Schema
-
counterPrefix(optional):
string
The prefix used with all document IDs in a content type. For example, FA is the contentPrefix of the content type FAQ. All document IDs in the content type FAQ begins with the affix FA.
-
customMetrics(optional):
array customMetrics
The unit of measurement used to track the activities on the content in a content type.
-
dateAdded(optional):
string(date-time)
The date when the content type was created.
-
dateModified(optional):
string(date-time)
The date when the content type was last modified.
-
defaultLifespan(optional):
integer
The total number of days that the content is available to the end user. It indicates that the content will be available to end users for the specified number of days, starting from the day when the content was created.
-
description(optional):
string
The description for the ContentType object. Content Types support multiple languages.
This field identifies the object associated with the language specified by the user.
-
displayDatesRequireWorkflowApproval(optional):
boolean
Display dates requires workflow approval if workflow is enabled @since 8.3
-
enableIndexing(optional):
boolean
The flag indicates whether the Oracle Knowledge Search Indexing is enabled for the content type.
-
enableUserActivityLogging(optional):
boolean
The flag indicates whether the system tracks the user interactions with the content.
-
eventDatesRequireWorkflowApproval(optional):
boolean
Event dates requires workflow approval if workflow is enabled @since 8.3
-
extendReviewDate(optional):
boolean
The flag indicates whether the review date should be extended once content has been reviewed for the content type.
-
hasCategories(optional):
boolean
The flag indicates whether the content type has any categories associated with.
-
hasPriority(optional):
boolean
The flag indicates whether you can assign priority level to the content in the content type. Valid priority values are numbers from one to twenty and none.
-
hasProducts(optional):
boolean
The flag indicates whether the content type has any products associated with.
-
hasRelatedContent(optional):
boolean
The flag indicates whether the content type allows related documents to be specified while content authoring.
-
hasTalkBack(optional):
boolean
The flag indicates whether you can open discussions for contents in the content type.
-
hasUserGroups(optional):
boolean
The flag indicates whether the content type has any usergroups associated with.
-
indexStatus(optional):
Allowed Values:
[ "LIVE", "LATEST_VALID_DRAFT", "LIVE_AND_LATEST_VALID_DRAFT", "NONE" ]
The status of the documents assigned to have Oracle Knowledge Search indexing.
The valid values are:
- LIVE
- LATEST_VALID_DRAFT
- LIVE_AND_LATEST_VALID_DRAFT
- NONE
-
isEvent(optional):
boolean
The flag indicates whether the content type supports different event dates.
-
isModerated(optional):
boolean
The flag indicates whether the content needs moderation, for its open discussions, before the discussions are made public.
-
links(optional):
array links
-
localizedAttributes(optional):
array localizedAttributes
List of LocalizedAttributes of this ContentType name and description in various Locales
-
metaDataSchema(optional):
object Schema
Title:
Schema
-
name(optional):
string
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.
-
notifyGroupOnWorkflowRejection(optional):
boolean
The flag indicates whether notifications should be sent to content authors when the document is rejected.
-
notifyOnWorkflowApproval(optional):
boolean
The flag indicates whether the appropriate content author should be notified when a workflow approval step is completed.
-
notifyOnWorkflowRejection(optional):
boolean
The flag indicates whether the appropriate content author should be notified when the document is rejected.
-
rating(optional):
object RatingKey
Title:
RatingKey
-
recordId(optional):
string
The unique identifier of the ContentType object.
-
referenceKey(optional):
string
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.
-
removeVersions(optional):
boolean
The flag indicates whether to remove the minor versions of the content after publication.
-
requireAtLeastOneCategory(optional):
boolean
Require authors to select at least one category in addition to the categories marked as 'required' @since 8.3
-
requireAtLeastOneProduct(optional):
boolean
Require authors to select at least one product in addition to the products marked as 'required' @since 8.3
-
requireAtLeastOneUserGroup(optional):
boolean
Require at least one user group to be selected @since 8.3
-
requiredCategories(optional):
array 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.
-
restrictAuthoringToWorkflowUser(optional):
boolean
Restrict content editing to users that can perform the workflow step @since 8.3
-
restrictToOneUserGroupSelection(optional):
boolean
Restrict User Group selection to one group only @since 8.3
-
reviewDate(optional):
integer
The date on which the document requires review.
When the date approaches, the system generates a task for the appropriate author to review the content.
-
stripeCd(optional):
string
Lookup code that indicates the stripe code.
-
translationRequestLocales(optional):
array 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.
-
userGroupRequireWorkflowApproval(optional):
boolean
User Groups requires workflow approval if workflow is enabled @since 8.3
-
userGroups(optional):
array 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.
-
validateHtml(optional):
boolean
The flag indicates whether the content should be validated to adhere to HTML standards while content authoring.
-
viewsRequireWorkflowApproval(optional):
boolean
Views requires workflow approval if workflow is enabled @since 8.3
-
workflow(optional):
object WorkflowKey
Title:
WorkflowKey
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.
-
Array of:
object CategoryKey
Title:
CategoryKey
object
Schema
-
dateAdded(optional):
string(date-time)
Timestamp when the schema was added
-
dateModified(optional):
string(date-time)
Timestamp when the schema was last modified
-
links(optional):
array links
-
recordId(optional):
string
unique identfier of the schema object.
-
schemaAttributes(optional):
array schemaAttributes
List of schema attributes for the schema
array
The unit of measurement used to track the activities on the content in a content type.
-
Array of:
object CustomMetricKey
Title:
CustomMetricKey
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object LocalizedAttributes
Title:
LocalizedAttributes
object
RatingKey
-
links(optional):
array links
-
name(optional):
string
Localized display name for the Rating
-
recordId(optional):
string
GUID for the Rating
-
referenceKey(optional):
string
The non localized reference key for the Rating
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.
-
Array of:
object CategoryKey
Title:
CategoryKey
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.
-
Array of:
object LocaleKey
Title:
LocaleKey
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.
-
Array of:
object UserGroupKey
Title:
UserGroupKey
object
WorkflowKey
-
links(optional):
array links
-
name(optional):
string
Localized name of the Workflow
-
recordId(optional):
string
GUID for the Workflow
-
referenceKey(optional):
string
Non localized name of the Workflow
object
CategoryKey
-
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.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
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
-
Array of:
object CategoryKey
Title:
CategoryKey
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.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object SchemaAttribute
Title:
SchemaAttribute
object
SchemaAttribute
-
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
-
children(optional):
array children
List of child nodes of the current element
-
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
-
links(optional):
array links
-
localizedAttributes(optional):
array localizedAttributes
List of LocalizedAttributes of this SchemaAttribute name and description in various Locales
-
name(optional):
string
Localized name of the attribute. This need NOT be unique within the Schema.
-
readOnly(optional):
boolean
Flag indicating whether this field is editable
-
recordId(optional):
string
Unique identifier for the SchemaAttribute object
-
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
-
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
-
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 -
xpath(optional):
string
The XPATH of this attribute within the schema. This is unique within the Schema.
array
-
Array of:
object SchemaAttribute
Title:
SchemaAttribute
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object LocalizedAttributes
Title:
LocalizedAttributes
array
-
Array of:
object SchemaAttributeUserGroup
Title:
SchemaAttributeUserGroup
object
LocalizedAttributes
-
description(optional):
string
Localized description in the above Locale
-
localeId(optional):
string
RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.
-
name(optional):
string
Localized Name in the above Locale
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):
object UserGroupKey
Title:
UserGroupKey
object
UserGroupKey
-
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.
-
links(optional):
array links
-
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
-
stripeCD(optional):
string
Stripe for UserGroup
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
CustomMetricKey
-
name(optional):
string
Name of the CustomMetric object
-
recordId(optional):
string
The unique record ID of the CustomMetric object.
-
referenceKey(optional):
string
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.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
LocaleKey
-
links(optional):
array links
-
recordId(optional):
string
The unique identifier of the Locale object.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
Examples
The following example shows how to find the Content Type object that has the specified ID by submitting a get request on the REST resource using cURL.
curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/contentTypes/{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:
{ "userGroups": [ { "recordId": "BDEE31CAA50A4DA7B9789240028BA4E3", "referenceKey": "INTERNAL", "name": "Internal", "links": [ { "rel": "canonical", "href": "http://IM_REST_API_HOST/km/api/latest/userGroups/BDEE31CAA50A4DA7B9789240028BA4E3", "mediaType": "application/json, application/xml", "method": "GET" } ] } ], "customMetrics": [], "requiredCategories": [], "categories": [ { "recordId": "0009447D77914B088D3DE12B76065E1B", "referenceKey": "FUSION_CATEGORY_300100103980692", "objectId": "1000", "name": "Category person : 1491880448742", "externalId": 300100103980692, "externalType": "CATEGORY", "description": "119202", "links": [ { "rel": "canonical", "href": "http://IM_REST_API_HOST/km/api/latest/categories/0009447D77914B088D3DE12B76065E1B", "mediaType": "application/json, application/xml", "method": "GET" } ] }, ], "translationRequestLocales": [], "recordId": "C6FAA0D5AFF442C2BED0EED8D8EDD9C0", "referenceKey": "SOLUTION", "name": "Solution", "links": [ { "rel": "canonical", "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes/C6FAA0D5AFF442C2BED0EED8D8EDD9C0", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes", "mediaType": "application/json, application/xml", "method": "GET", "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/contentTypes" } ], "allowCheckOut": false, "allowRecommendations": false, "counterPrefix": "SOL", "dateAdded": "2017-03-24T23:53:57-0600", "dateModified": "2017-04-26T02:04:50-0600", "defaultLifespan": -1, "enableUserActivityLogging": false, "hasPriority": false, "hasRelatedContent": false, "hasTalkBack": false, "isEvent": false, "isModerated": false, "requireAtLeastOneProduct": false, "requireAtLeastOneCategory": false, "requireAtLeastOneUserGroup": false, "restrictToOneUserGroupSelection": false, "categoriesRequireWorkflowApproval": true, "userGroupRequireWorkflowApproval": true, "viewsRequireWorkflowApproval": true, "displayDatesRequireWorkflowApproval": true, "eventDatesRequireWorkflowApproval": true, "restrictAuthoringToWorkflowUser": true, "notifyOnWorkflowApproval": false, "notifyOnWorkflowRejection": false, "notifyGroupOnWorkflowRejection": false, "removeVersions": false, "reviewDate": -1, "validateHtml": false, "enableIndexing": true, "indexStatus": "LIVE", "rating": { "recordId": "72131BCD2DC94A7DAA3133D5A5E59250", "referenceKey": "5_STAR_RATING", "name": "5 Star Rating", "links": [ { "rel": "canonical", "href": "http://IM_REST_API_HOST/km/api/latest/dataForms/72131BCD2DC94A7DAA3133D5A5E59250", "mediaType": "application/json, application/xml", "method": "GET" } ] }, "contentSchema": { "schemaAttributes": [ { "children": [], "schemaAttributeUserGroupList": [], "recordId": "34C25D6B395B474DAD1DCE4CFFDC467A", "xpath": "//SOLUTION/RESOLUTION", "name": "Resolution", "links": [ { "rel": "canonical", "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes/C6FAA0D5AFF442C2BED0EED8D8EDD9C0/contentSchema/34C25D6B395B474DAD1DCE4CFFDC467A", "mediaType": "application/json, application/xml", "method": "GET" } ], "requireWorkflowApproval": false, "allowPreselectedUserGroupChange": true, "counter": 0, "dateAdded": "2017-03-24T23:53:57-0600", "dateModified": "2017-03-24T23:53:57-0600", "enableFullTextSearch": true, "includeInMasterIdentifier": false, "isNode": false, "allowMultipleNodes": false, "isRequired": false, "readOnly": false, "enableAttributeLevelSearch": false, "schemaAttrType": "WYSIWYG_EDIT", "secureWithUserGroups": false, "securedFileResource": false, "userGroupSelectionRequired": false, "sortOrder": 3, "referenceKey": "RESOLUTION", "wysiwygType": "FULL" }, { "children": [], "schemaAttributeUserGroupList": [], "recordId": "0E1621B868804CC5899C36A1C426B400", "xpath": "//SOLUTION/ENVIRONMENT", "name": "Environment", "links": [ { "rel": "canonical", "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes/C6FAA0D5AFF442C2BED0EED8D8EDD9C0/contentSchema/0E1621B868804CC5899C36A1C426B400", "mediaType": "application/json, application/xml", "method": "GET" } ], "requireWorkflowApproval": false, "allowPreselectedUserGroupChange": true, "counter": 0, "dateAdded": "2017-03-24T23:53:57-0600", "dateModified": "2017-03-24T23:53:57-0600", "enableFullTextSearch": true, "includeInMasterIdentifier": false, "isNode": false, "allowMultipleNodes": false, "isRequired": false, "readOnly": false, "enableAttributeLevelSearch": false, "schemaAttrType": "WYSIWYG_EDIT", "secureWithUserGroups": false, "securedFileResource": false, "userGroupSelectionRequired": false, "sortOrder": 4, "referenceKey": "ENVIRONMENT", "wysiwygType": "FULL" }, ], "recordId": "BC4E496996A141048893C5F13BFAFF77", "dateAdded": "2017-03-24T23:53:57-0600", "dateModified": "2017-03-24T23:53:57-0600" } }