Update content from import
/km/api/v1/content/{id}/import
This method imports the Content Business object which is specified in the request. The import is done as an update to an existing document.
To import new composite content, use the corresponding POST method on import.
Rules :
When you create a new document during the create import flow, consider the following:
- If createDate is set to null then the current day and time will be used as the createDate.
- When you specify a value for createDate field, consider the following:
- The createDate value must be in the past.
- The createDate value must be earlier than or same as the lastModifiedDate value.
- When you specify a value for lastModifiedDate field, consider the following:
- The lastModifiedDate value cannot be in the future.
- The lastModifiedDate value must be later than or the same as the createDate.
- The lastModifiedDate value must be specified only when there is a createDate value.
- The lastModifiedDate value when set to null, the current date and current time values are set the date modified.
-
Any supplied value for dateAdded and dateModified will be ignored
When you create a new version of the document in the current locale during the update import flow, consider the following:
- The createDate of the new version of the document is set as the createDate for the previous version of the document. Any specified createDate value is ignored.
- If lastModifiedDate is set to null then the current day and time will be used to modify the version's lastModifiedDate.
- When you specify a value for the lastModifiedDate field, consider the following:
- The lastModifiedDate value cannot be in the future.
- The lastModifiedDate value must be later or equal to the previous version's lastModifiedDate.
-
Any supplied value for dateAdded and dateModified will be ignored
Translate Import Flow Conditions
When you create a new version of the document in another locale during the translate import flow, consider the following:
- When you specify a value for the createDate field, consider the following:
- The createDate value cannot be in the future.
- The createDate value must be earlier than or same as the dateModified.
- If the createDate value is set to null, the current date and current time values are set as createDate.
- If lastModifiedDate is set to null then the current day and time will be used.
- When you specify a value for the lastModifiedDate field, consider the following :
- The lastModifiedDate value cannot be in the future.
- The lastModifiedDate value must be later than or same as the createDate.
- The lastModifiedDate value must be specified only when there is a createDate value.
-
Any supplied value for dateAdded and dateModified will be ignored
Field | Regular flow | Regular Flow Conditions | Import flow | Import Flow Conditions | ||
---|---|---|---|---|---|---|
CREATE/ TRANSLATE | UPDATE | CREATE/ TRANSLATE | UPDATE | |||
creator | Not allowed | Not allowed | None | Optional | Optional | If not supplied during update, the existing creator is retained. Otherwise, the active user is recorded as the Creator. To specify a different user as the creator, this attribute value must be explicitly supplied. |
owner | Optional | Optional | If not supplied during update, owner of the latest version in the locale becomes the owner. Otherwise, the active user becomes the owner. To specify a different user as the owner, this attribute value must be explicitly supplied. | Optional | Optional | If not supplied during update, owner of the latest version in the locale becomes the owner. If not supplied, during create, the active user becomes the owner. To specify a different user as the owner, this attribute value must be explicitly supplied. |
lastModifier | Not allowed | Not allowed | The active user is always the last modifier. | Optional | Optional | If not supplied, the active user is the last modifier. To specify a different user as the last modifier, this attribute value must be explicitly supplied. |
answerId | Not allowed | Must match existing value. | AnswerId value is auto generated for create or translate. | Conditional | Must match existing value. | Custom value for answerId may only be supplied during create scenario. If answerId value is given then it must be less than 1,000,000 and no other document may be associated with the given answerId. |
createDate | Not allowed | Not allowed | None | Optional | Optional | If you don't want to explicitly change CreateDate, then set it to null. Setting this date to null has the following impact:
|
dateAdded | Not allowed | Expected | None | Not expected but optional | Not expected but optional |
|
lastModifiedDate | Not allowed | Not allowed | During update, the value of this attribute must match the latest version's lastDateModified. | Optional | Optional | Last Date Modified can be explicitly set during import, for both create and update flows. Do not set Last Date Modified, if you do not want to explicitly modify it. Last Date Modified defaults to current time. And when not set. Last Date Modified should not be earlier than Create Date otherwise it is an error. When the import succeeds, but Last Date Modified cannot be set to the supplied value, then there will be no error sent to the caller. The returned Content business object has the actual lastModifiedDate set by the system. Caller has to compare the input Last Date Modified with the returned Last Date Modified to figure out that the Last Date Modified was not updated even though the import is successful. |
dateModified | Not allowed | Expected | During update, the dateModified value must match the latest version's DateModified for Optimistic Locking Error Check. | Not expected but optional | Expected |
|
displayStartDate | Optional | Optional | For CREATE/UPDATE, the display start date cannot be in the past. | Optional | Optional | For CREATE/UPDATE, the display start date can be in the past. But, must be before the displayEndDate. |
displayEndDate | Optional | Optional | For CREATE/UPDATE, the display end date cannot be in the past. | Optional | Optional | For CREATE/UPDATE, the display end date can be in the past. |
eventStartDate | Optional | Optional | For CREATE/UPDATE, the event start date cannot be in the past. | Conditional | Conditional | Can be in the past, eventStartDate must be before the eventEndDate. For CREATE/UPDATE, the event start date can be in the past. But, it must be before the event end date. Note: You can specify an eventStartDate only when even start date attribute is enabled in the contentType. |
eventEndDate | Optional | Optional | For CREATE/UPDATE, the event end date cannot be in the past. | Conditional | Conditional | The event end date cannot be in the past. Note: You can specify an eventEndDate only when the event end date attribute is enabled in the contentType. |
displayReviewDate | Optional | Optional | For CREATE/UPDATE, the display review date cannot be in the past. | Optional | Optional | For CREATE/UPDATE, the display review date can be in the past. |
publish | Not applicable. | Not applicable. | The publish field is not applicable in regular flow. | Optional | Optional | When the contentType does not contain workflows :
|
bypassWorkflowAndPublish | Not applicable. | Not applicable. | The publish field is not applicable in regular flow. | Optional | Optional | You can set a value to the bypassWorkflowAndPublish field only when the contentType contains workflows. Otherwise, the value of the publish field is ignored. |
Content Security
While posting/updating a content with schema attribute which does not allow modifications to user group restrictions('Enable editors to modify preselected user group restrictions' is not selected) and which has preselected default user groups, the default user groups are automatically added. Regardless of editor passing user group security, content gets created with only the default user groups which were pre-defined
While posting/updating a content with schema attribute which allows modifictions to user group restrictions('Enable editors to modify preselected user group restrictions' is selected), the default user groups if any are not automatically added.
Request
- application/json
- application/xml
-
id: string
The content identifier
object
CompositeContent
-
content(optional):
Content
-
contentModificationQualifier(optional):
object ContentModificationQualifier
Title:
ContentModificationQualifier
object
ContentModificationQualifier
-
bypassWorkflowAndPublish(optional):
boolean
Flag indicating whether the existing record to be updated should be published automatically by bypassing workflow (even if one exists) after saving the record.
-
ipAddress(optional):
string
IP Address of the Client who is making modifications to Content
-
publish(optional):
boolean
Flag indicating whether the new record to be created or existing record to be updated should be published automatically after saving it
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ContentKey-allOf[1]
object
Singular Resource
object
-
allTranslations(optional):
array allTranslations
This field will return list of all translated content that the user can view
This field will only be populated if allTranslations query parameter is passed in with value true.
-
answerId(optional):
integer
The unique identifier that enables mapping between an answer and the content.
-
dateModified(optional):
string(date-time)
The date when the content was last modified in the Oracle Knowledge Repository.
-
documentId(optional):
string
The unique identifier of a document that indicates the content type in which the content is saved.
-
locale(optional):
LocaleKey
-
recordId(optional):
string
The unique identifier of the document. This ID is same in all versions in all locales of the document.
-
title(optional):
string
The tittle of the document.
-
version(optional):
string
Version of the Content object
-
versionId(optional):
string
The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.
object
-
basedLocale(optional):
LocaleKey
-
basedOnVersion(optional):
string
Version of the Content object
-
checkedOut(optional):
boolean
The date when an author has checked out or locked the document for editing.
-
checkedOutBy(optional):
UserKey
-
contentType(optional):
ContentTypeKey
-
createDate(optional):
string(date-time)
The date when the content was created. For legacy systems, the create date is the date when the document was created in those systems.
-
creator(optional):
UserKey
-
dateAdded(optional):
string(date-time)
The date when the content was added to the content type. For legacy systems, the create date is the date when the document was migrated from the legacy system to the Oracle Knowledge Repository.
-
displayEndDate(optional):
string(date-time)
The date when the service stops the display of the document to the end users.
-
displayPosition(optional):
Allowed Values:
[ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]
LookUp code that can be Fixed@Top, Place@Top , Historical Usefulness -
displayReviewDate(optional):
string(date-time)
The date when the document requires a review by an author capable of performing the review.
-
displayStartDate(optional):
string(date-time)
The date when the document will be available to display to end-users.
-
eventEndDate(optional):
string(date-time)
The date when the document's event ends.
-
eventStartDate(optional):
string(date-time)
The date when the document's event begins.
-
lastModifiedDate(optional):
string(date-time)
The date when the content was last modified. For legacy systems, the lastModifiedDate date is the date when the document was last modified in those systems.
-
lastModifier(optional):
UserKey
-
owner(optional):
UserKey
-
pending(optional):
boolean
The flag that indicates whether the document is pending for publication.
-
priority(optional):
Allowed Values:
[ "PRIORITY_0", "PRIORITY_1", "PRIORITY_2", "PRIORITY_3", "PRIORITY_4", "PRIORITY_5", "PRIORITY_6", "PRIORITY_7", "PRIORITY_8", "PRIORITY_9", "PRIORITY_10", "PRIORITY_11", "PRIORITY_12", "PRIORITY_13", "PRIORITY_14", "PRIORITY_15", "PRIORITY_16", "PRIORITY_17", "PRIORITY_18", "PRIORITY_19", "PRIORITY_20" ]
The priority assigned to the content.
The valid values are: PRIORITY_0 to PRIORITY_20. For example, PRIORITY_1 or PRIORITY_18 are valid values, but PRIORITY_21 is not.
-
publishDate(optional):
string(date-time)
The date when the document was first displayed to end users.
-
published(optional):
boolean
The flag that indicates whether the document is published.
-
publishedVersion(optional):
string
Version of the Content object
-
suppressNotification(optional):
boolean
The flag that indicates whether the document's subscription notification is suppressed.
object
-
metaDataResourcePath(optional):
string
MetaDataResourcePath of the Content object
-
metaDataXml(optional):
string
MetaDataXml of the Content object
-
reasonForEdit(optional):
string
Reasons for editing or creating a content. This will only be used when creating or updating the document.
-
resourcePath(optional):
string
EXAMPLE URL : http://<IM_REST_API_HOST>/okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}. If the user name is not passed then it will be defaulted to 'guest' user.
-
wfStepNotificationOverride(optional):
string(date-time)
The date when the service sends notification to the author involved in the review. Once the workflow notification is given, the service updates the next review date.
-
workflowStep(optional):
WorkflowStepKey
-
xml(optional):
string
Xml of the Content object
object
-
categories(optional):
array categories
The Category object or list of Category objects assigned to the Content.
For example. If world is a category at level one, we may have Africa, Uk, America etc. at level two. You can specify requests for objects in a category hierarchically or non- hierarchically. If a content that is assigned Florida is requested using hierarchical request world, you get the result. Whereas, the same request done non- hierarchically gives no result.
The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.
- Match Any
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'RN_CATEGORY_34587323'&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('RN_CATEGORY_34587323')&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'RN_CATEGORY_34587323'&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('RN_CATEGORY_34587323')&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522')&mode=KEY&orderBy=mostPopular
The following example URIs returns Content objects that match the multiple criterion specified in the request
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the published Date.
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the dateModified.
The service matches any of the category specified in the request if you pass the
contentType.refKey eq
parameter orcontentType.refKey in
parameter with the request.Example URIs for the category parameter are as follows:
OR
The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.
OR
The following example URIs returns Content objects that match the multiple criterion specified in the request.
- Match ALL
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY
The request returns all Content objects in the world and movies category. The service returns a Content object in the category Africa because Africa is a child category for the category world.
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY&orderBy=mostPopular
The objects in the returned list are sorted by the view in descending order.
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the published date descending order.
The service matches all the categories specified in the request if you pass the
andcategories.refKey matchAll
parameter with the request. -
isForEdit(optional):
boolean
The parameter to request editable content.
-
replacementTokens(optional):
array replacementTokens
The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.
Note: Do not specify the replacementToken object while using 'Content/Create', 'Content/Update', 'Content/Create content from import', and 'Content/Update content from import' services.
-
userGroups(optional):
array userGroups
The user groups assigned to the content. The member of the assigned user group will only have access to the content.
-
views(optional):
array views
The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.
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.
array
This field will return list of all translated content that the user can view
This field will only be populated if allTranslations query parameter is passed in with value true.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
LocaleKey-allOf[1]
object
-
recordId(optional):
string
The unique identifier of the Locale object.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
UserKey-allOf[1]
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ContentTypeKey-allOf[1]
object
-
email(optional):
string
Email of the User object
-
externalId(optional):
integer
The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
-
externalType(optional):
string
The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
-
name(optional):
string
User's full name
-
recordId(optional):
string
The unique record ID of the User object.
object
-
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.
-
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.
-
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.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
WorkflowStepKey-allOf[1]
object
-
name(optional):
string
Localized name of the workflow step
-
recordId(optional):
string
GUID from the WORKFLOWSTEP table
-
referenceKey(optional):
string
Non localized name of the workflow step
array
The Category object or list of Category objects assigned to the Content.
For example. If world is a category at level one, we may have Africa, Uk, America etc. at level two. You can specify requests for objects in a category hierarchically or non- hierarchically. If a content that is assigned Florida is requested using hierarchical request world, you get the result. Whereas, the same request done non- hierarchically gives no result.
The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.
- Match Any
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'RN_CATEGORY_34587323'&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('RN_CATEGORY_34587323')&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'RN_CATEGORY_34587323'&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('RN_CATEGORY_34587323')&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522')&mode=KEY&orderBy=mostPopular
The following example URIs returns Content objects that match the multiple criterion specified in the request
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the published Date.
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the dateModified.
The service matches any of the category specified in the request if you pass the contentType.refKey eq
parameter or contentType.refKey in
parameter with the request.
Example URIs for the category parameter are as follows:
OR
The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.
OR
The following example URIs returns Content objects that match the multiple criterion specified in the request.
- Match ALL
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY
The request returns all Content objects in the world and movies category. The service returns a Content object in the category Africa because Africa is a child category for the category world.
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY&orderBy=mostPopular
The objects in the returned list are sorted by the view in descending order.
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the published date descending order.
The service matches all the categories specified in the request if you pass the andcategories.refKey matchAll
parameter with the request.
array
The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.
Note: Do not specify the replacementToken object while using 'Content/Create', 'Content/Update', 'Content/Create content from import', and 'Content/Update content from import' services.
array
The user groups assigned to the content. The member of the assigned user group will only have access to the content.
array
The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
CategoryKey-allOf[1]
object
-
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.
-
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
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
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ReplacementTokenKey-allOf[1]
object
-
recordId(optional):
string
The replacement token's record Id.
-
tokenName(optional):
string
The replacement token's name.
object
-
dateAdded(optional):
string(date-time)
The date added for the replacement token for the specified locale.
-
dateModified(optional):
string(date-time)
The date modified for the replacement token for the specified locale.
-
replacementText(optional):
string
The HTML formatted replacement text.
-
replacementTextNonFormatted(optional):
string
The non-HTML formatted replacement text.
-
tokenType(optional):
string
The token type of the token. Used to specify what kind of text editor was used to create/edit this token: rich text('RICH_TEXT') or plain text('PLAIN_TEXT').
-
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
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ViewKey-allOf[1]
object
-
name(optional):
string
Localized name of the view
-
recordId(optional):
string
GUID of the SITE table containing the view definition
-
referenceKey(optional):
string
Non localized reference key for the view
Response
- application/json
- application/xml
200 Response
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ContentKey-allOf[1]
object
Singular Resource
object
-
allTranslations(optional):
array allTranslations
This field will return list of all translated content that the user can view
This field will only be populated if allTranslations query parameter is passed in with value true.
-
answerId(optional):
integer
The unique identifier that enables mapping between an answer and the content.
-
dateModified(optional):
string(date-time)
The date when the content was last modified in the Oracle Knowledge Repository.
-
documentId(optional):
string
The unique identifier of a document that indicates the content type in which the content is saved.
-
locale(optional):
LocaleKey
-
recordId(optional):
string
The unique identifier of the document. This ID is same in all versions in all locales of the document.
-
title(optional):
string
The tittle of the document.
-
version(optional):
string
Version of the Content object
-
versionId(optional):
string
The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.
object
-
basedLocale(optional):
LocaleKey
-
basedOnVersion(optional):
string
Version of the Content object
-
checkedOut(optional):
boolean
The date when an author has checked out or locked the document for editing.
-
checkedOutBy(optional):
UserKey
-
contentType(optional):
ContentTypeKey
-
createDate(optional):
string(date-time)
The date when the content was created. For legacy systems, the create date is the date when the document was created in those systems.
-
creator(optional):
UserKey
-
dateAdded(optional):
string(date-time)
The date when the content was added to the content type. For legacy systems, the create date is the date when the document was migrated from the legacy system to the Oracle Knowledge Repository.
-
displayEndDate(optional):
string(date-time)
The date when the service stops the display of the document to the end users.
-
displayPosition(optional):
Allowed Values:
[ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]
LookUp code that can be Fixed@Top, Place@Top , Historical Usefulness -
displayReviewDate(optional):
string(date-time)
The date when the document requires a review by an author capable of performing the review.
-
displayStartDate(optional):
string(date-time)
The date when the document will be available to display to end-users.
-
eventEndDate(optional):
string(date-time)
The date when the document's event ends.
-
eventStartDate(optional):
string(date-time)
The date when the document's event begins.
-
lastModifiedDate(optional):
string(date-time)
The date when the content was last modified. For legacy systems, the lastModifiedDate date is the date when the document was last modified in those systems.
-
lastModifier(optional):
UserKey
-
owner(optional):
UserKey
-
pending(optional):
boolean
The flag that indicates whether the document is pending for publication.
-
priority(optional):
Allowed Values:
[ "PRIORITY_0", "PRIORITY_1", "PRIORITY_2", "PRIORITY_3", "PRIORITY_4", "PRIORITY_5", "PRIORITY_6", "PRIORITY_7", "PRIORITY_8", "PRIORITY_9", "PRIORITY_10", "PRIORITY_11", "PRIORITY_12", "PRIORITY_13", "PRIORITY_14", "PRIORITY_15", "PRIORITY_16", "PRIORITY_17", "PRIORITY_18", "PRIORITY_19", "PRIORITY_20" ]
The priority assigned to the content.
The valid values are: PRIORITY_0 to PRIORITY_20. For example, PRIORITY_1 or PRIORITY_18 are valid values, but PRIORITY_21 is not.
-
publishDate(optional):
string(date-time)
The date when the document was first displayed to end users.
-
published(optional):
boolean
The flag that indicates whether the document is published.
-
publishedVersion(optional):
string
Version of the Content object
-
suppressNotification(optional):
boolean
The flag that indicates whether the document's subscription notification is suppressed.
object
-
metaDataResourcePath(optional):
string
MetaDataResourcePath of the Content object
-
metaDataXml(optional):
string
MetaDataXml of the Content object
-
reasonForEdit(optional):
string
Reasons for editing or creating a content. This will only be used when creating or updating the document.
-
resourcePath(optional):
string
EXAMPLE URL : http://<IM_REST_API_HOST>/okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}. If the user name is not passed then it will be defaulted to 'guest' user.
-
wfStepNotificationOverride(optional):
string(date-time)
The date when the service sends notification to the author involved in the review. Once the workflow notification is given, the service updates the next review date.
-
workflowStep(optional):
WorkflowStepKey
-
xml(optional):
string
Xml of the Content object
object
-
categories(optional):
array categories
The Category object or list of Category objects assigned to the Content.
For example. If world is a category at level one, we may have Africa, Uk, America etc. at level two. You can specify requests for objects in a category hierarchically or non- hierarchically. If a content that is assigned Florida is requested using hierarchical request world, you get the result. Whereas, the same request done non- hierarchically gives no result.
The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.
- Match Any
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'RN_CATEGORY_34587323'&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('RN_CATEGORY_34587323')&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'RN_CATEGORY_34587323'&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('RN_CATEGORY_34587323')&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522')&mode=KEY&orderBy=mostPopular
The following example URIs returns Content objects that match the multiple criterion specified in the request
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the published Date.
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the dateModified.
The service matches any of the category specified in the request if you pass the
contentType.refKey eq
parameter orcontentType.refKey in
parameter with the request.Example URIs for the category parameter are as follows:
OR
The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.
OR
The following example URIs returns Content objects that match the multiple criterion specified in the request.
- Match ALL
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY
The request returns all Content objects in the world and movies category. The service returns a Content object in the category Africa because Africa is a child category for the category world.
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY&orderBy=mostPopular
The objects in the returned list are sorted by the view in descending order.
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the published date descending order.
The service matches all the categories specified in the request if you pass the
andcategories.refKey matchAll
parameter with the request. -
isForEdit(optional):
boolean
The parameter to request editable content.
-
replacementTokens(optional):
array replacementTokens
The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.
Note: Do not specify the replacementToken object while using 'Content/Create', 'Content/Update', 'Content/Create content from import', and 'Content/Update content from import' services.
-
userGroups(optional):
array userGroups
The user groups assigned to the content. The member of the assigned user group will only have access to the content.
-
views(optional):
array views
The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.
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.
array
This field will return list of all translated content that the user can view
This field will only be populated if allTranslations query parameter is passed in with value true.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
LocaleKey-allOf[1]
object
-
recordId(optional):
string
The unique identifier of the Locale object.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
UserKey-allOf[1]
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ContentTypeKey-allOf[1]
object
-
email(optional):
string
Email of the User object
-
externalId(optional):
integer
The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
-
externalType(optional):
string
The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
-
name(optional):
string
User's full name
-
recordId(optional):
string
The unique record ID of the User object.
object
-
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.
-
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.
-
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.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
WorkflowStepKey-allOf[1]
object
-
name(optional):
string
Localized name of the workflow step
-
recordId(optional):
string
GUID from the WORKFLOWSTEP table
-
referenceKey(optional):
string
Non localized name of the workflow step
array
The Category object or list of Category objects assigned to the Content.
For example. If world is a category at level one, we may have Africa, Uk, America etc. at level two. You can specify requests for objects in a category hierarchically or non- hierarchically. If a content that is assigned Florida is requested using hierarchical request world, you get the result. Whereas, the same request done non- hierarchically gives no result.
The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.
- Match Any
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'RN_CATEGORY_34587323'&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('RN_CATEGORY_34587323')&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'RN_CATEGORY_34587323'&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('RN_CATEGORY_34587323')&mode=KEY
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522')&mode=KEY&orderBy=mostPopular
The following example URIs returns Content objects that match the multiple criterion specified in the request
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the published Date.
http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('RN_CATEGORY_45587634', 'RN_CATEGORY_45587522') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the dateModified.
The service matches any of the category specified in the request if you pass the contentType.refKey eq
parameter or contentType.refKey in
parameter with the request.
Example URIs for the category parameter are as follows:
OR
The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.
OR
The following example URIs returns Content objects that match the multiple criterion specified in the request.
- Match ALL
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY
The request returns all Content objects in the world and movies category. The service returns a Content object in the category Africa because Africa is a child category for the category world.
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY&orderBy=mostPopular
The objects in the returned list are sorted by the view in descending order.
http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('RN_CATEGORY_34587323', 'RN_CATEGORY_34587345')&mode=KEY&orderBy=mostRecent
The objects in the returned list are sorted by the published date descending order.
The service matches all the categories specified in the request if you pass the andcategories.refKey matchAll
parameter with the request.
array
The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.
Note: Do not specify the replacementToken object while using 'Content/Create', 'Content/Update', 'Content/Create content from import', and 'Content/Update content from import' services.
array
The user groups assigned to the content. The member of the assigned user group will only have access to the content.
array
The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
CategoryKey-allOf[1]
object
-
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.
-
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
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
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ReplacementTokenKey-allOf[1]
object
-
recordId(optional):
string
The replacement token's record Id.
-
tokenName(optional):
string
The replacement token's name.
object
-
dateAdded(optional):
string(date-time)
The date added for the replacement token for the specified locale.
-
dateModified(optional):
string(date-time)
The date modified for the replacement token for the specified locale.
-
replacementText(optional):
string
The HTML formatted replacement text.
-
replacementTextNonFormatted(optional):
string
The non-HTML formatted replacement text.
-
tokenType(optional):
string
The token type of the token. Used to specify what kind of text editor was used to create/edit this token: rich text('RICH_TEXT') or plain text('PLAIN_TEXT').
-
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
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
ViewKey-allOf[1]
object
-
name(optional):
string
Localized name of the view
-
recordId(optional):
string
GUID of the SITE table containing the view definition
-
referenceKey(optional):
string
Non localized reference key for the view
Examples
The following example shows how to update the Content object from import by submitting a put request on the REST resource using cURL.
cURL Command
Command: curl -X "PUT" "http://<IM_REST_API_HOST>/km/api/latest/content/{id}/import"
Example of Request Header
The following shows an example of the request header.
-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"UoyWTKRG4RpyJCH4Wqjzht2iYUrsDdk5ir+3IpwEkxcwajJkGR9OGSQBTANQVGW0iVT9MFeDzqL+RYdgfzGSK+h5QzDFIDM+rDLgdKeEE19ljWFm3zMCF+kgYp/dJ/Yq5V7Re+aDXqHg6YkHfvprFA==\"}" \ -H "Accept: application/json"
Example of Request Body
The following shows an example of the request body in JSON format.
{ "content" : { "isForEdit" : true, "views" : [ { "recordId" : "0246897531", "referenceKey" : "PRODUCT_MANAGEMENT", "name" : "PRODUCT_MANAGEMENT" } ], "recordId" : "12345678", "versionId" : "4B5BE004C5BD48B8B67D48E93E2D750D", "documentId" : "FAQ92", "version" : "0.1", "answerId" : 1001041, "locale" : { "recordId" : "es_ES" }, "dateModified" : "2017-05-18T12:10:38-0700", "contentType" : { "recordId" : "9876543210", "referenceKey" : "FAQ", "name" : "FAQ" }, "createDate" : "2017-05-18T12:10:38-0700", "dateAdded" : "2017-05-18T12:10:38-0700", "basedOnVersion" : "2.0", "basedLocale" : { "recordId" : "en_US" }, "xml" : "XML_VALUE" }, "contentModificationQualifier" : { } }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "isForEdit" : true, "replacementTokens" : [ { "dateModified" : "284852364-01-15T04:07:46-0800", "replacementText" : "REPLACEMENTTEXT_VALUE", "replacementTextNonFormatted" : "REPLACEMENTTEXTNONFORMATTED_VALUE", "tokenType" : "TOKENTYPE_VALUE", "tokenName" : "TOKENNAME_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] } ], "categories" : [ { "referenceKey" : "REFERENCEKEY_VALUE", "name" : "NAME_VALUE", "externalType" : "EXTERNALTYPE_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] } ], "userGroups" : [ { "referenceKey" : "REFERENCEKEY_VALUE", "name" : "NAME_VALUE", "externalType" : "EXTERNALTYPE_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] } ], "views" : [ { "referenceKey" : "REFERENCEKEY_VALUE", "name" : "NAME_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] } ], "versionId" : "VERSIONID_VALUE", "documentId" : "DOCUMENTID_VALUE", "title" : "TITLE_VALUE", "version" : "VERSION_VALUE", "answerId" : 1428416791848, "locale" : { "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] }, "dateModified" : "2013-04-23T18:06:26-0700", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ], "contentType" : { "referenceKey" : "REFERENCEKEY_VALUE", "name" : "NAME_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] }, "priority" : "PRIORITY_20", "createDate" : "2013-04-23T18:06:26-0700", "dateAdded" : "2013-04-23T18:06:26-0700", "displayStartDate" : "2013-04-23T18:06:26-0700", "displayEndDate" : "2013-04-23T18:06:26-0700", "eventStartDate" : "2013-04-23T18:06:26-0700", "eventEndDate" : "2013-04-23T18:06:26-0700", "owner" : { "name" : "NAME_VALUE", "externalId" : 1428416791841, "externalType" : "EXTERNALTYPE_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] }, "lastModifier" : { "name" : "NAME_VALUE", "externalId" : 1428416791859, "externalType" : "EXTERNALTYPE_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] }, "creator" : { "name" : "NAME_VALUE", "externalId" : 1428416791867, "externalType" : "EXTERNALTYPE_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] }, "published" : true, "pending" : false, "displayReviewDate" : "2013-04-23T18:06:26-0700", "checkedOut" : true, "checkedOutBy" : { "name" : "NAME_VALUE", "externalType" : "EXTERNALTYPE_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] }, "basedOnVersion" : "BASEDONVERSION_VALUE", "publishedVersion" : "PUBLISHEDVERSION_VALUE", "basedLocale" : { "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] }, "displayPosition" : "HISTORICAL_USEFULNESS", "workflowStep" : { "referenceKey" : "REFERENCEKEY_VALUE", "name" : "NAME_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET" } ] }, "wfStepNotificationOverride" : "2013-04-23T18:06:26-0700", "xml" : "XML_VALUE", "metaDataXml" : "METADATAXML_VALUE", "resourcePath" : "http://<IM_REST_API_HOST>/okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}", "metaDataResourcePath" : "METADATARESOURCEPATH_VALUE", "reasonForEdit" : "REASON_FOR_EDITING_OR_CREATING_CONTENT_RECORD" }