1. REST API for Knowledge Management in Oracle Fusion Service
  2. Tasks
  3. Content (IM)
  4. Content

Translate content

post

/km/api/v1/content/{versionId}/translate

This method creates translated content, given as part of a CompositeContent object

A POST must be requested and a CompositeContent object must be provided to perform the translate request.

The translated content's data should be provided as a Content object.

Specific attributes of the translated Content object should be set as follows:

Attribute Value
locale The LocaleKey for the locale the content is being translated to.
recordId Same value as the recordId of the existing Content object being translated.
documentId Same value as the documentId of the existing Content object being translated.
basedOnVersion Same value as the version of the existing Content object being translated.
basedLocale Same LocaleKey as the locale of the existing Content object being translated.

Rules regarding createDate, dateAdded and dateModified :

During the translate flow, when a new version of the document is created in another locale.
  • The new version's dateAdded value will be set to the same value as the createDate.

    Any supplied value for dateAdded will be ignored.

    • If createDate is set to null then the current day and time will be used.
    • If createDate is specified :
      • createDate cannot be in the future.
      • createDate must be earlier or equal to the dateModified.
    • If dateModified is set to null then the current day and time will be used.
    • If dateModified is supplied :
      • dateModified cannot be in the future.
      • dateModified must be later or equal to the createDate.
      • dateModified cannot be supplied without createDate.

    Content Field Rules

    All fields listed are optional.

    Field Flow Conditions
    creator If not supplied the active user will become the creator.
    owner If not supplied the active user becomes the owner. To specify a different user as the owner, this attribute value must be explicitly supplied.
    lastModifier 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.
    createDate Refer to the rules int the section above.
    dateAdded dateAdded will be ignored.
    dateModified Refer to the rules in the section above. eventStartDate Can be in the past, eventStartDate must be before the eventEndDate.
    eventEndDate contentType must have the event start and end date attributes enabled in order to supply eventStartDate and eventEndDate. Cannot be in the past.
    displayReviewDate Can be in the past.

    ContentModificationQualifier Field Rules

    All fields listed are optional.

    Field Flow Conditions
    ipAddress DO NOT POPULATE. A validation error will occur if this field is specified.
    publish When the contentType does not contain workflows :
    • publish set to true will create/update the article and then publish the article.
    • publish set to false will create/update the article but not publish the article.
    When the contentType contains workflows :
    • publish set to true and bypassWorkflowAndPublish set to false will result in an error condition.
    • publish set to true and bypassWorkflowAndPublish set to true will result in the article being created/updated and then published.
    • publish set to false and bypassWorkflowAndPublish set to true or false will result in the article being created/updated but not published.
    bypassWorkflowAndPublish This field is only relevant when the contentType contains workflows, otherwise the value of this field is not taken into effect.

    Response Errors

    Following are the possible error responses for this method:

    • OK-FMS0005

      The error occurs when the file nodes specified do not match the uploaded files.

    • OKDOM-CONT0144

      The error occurs when the locale in the translated Content object contains an invalid locale code.

    • OKDOM-CONT0143

      The error occurs when the locale in the translated Content object is valid, but the locale is not currently available on the site.

    • OKDOM-CONT0124

      The error occurs when the locale in the translated Content object matches the locale of the existing Content object being translated.

Request

Supported Media Types
Path Parameters
Body ()
A CompositeContent object containing the translated content to be created
Root Schema : CompositeContent
Type: object
Title: CompositeContent
Show Source
Nested Schema : Content
Type: object
Title: Content
Show Source
  • 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.

  • The unique identifier that enables mapping between an answer and the content.

  • ArticleStatusKey
    Title: ArticleStatusKey
  • LocaleKey
    Title: LocaleKey
  • Version of the Content object
  • 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

      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:

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

      • OR

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

      • The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

      • OR

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

      • 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 ('USA', 'EUROPE')&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 ('USA', 'EUROPE') 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 ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

      The objects in the returned list are sorted by the dateModified.

      Match ALL

      The service matches all the categories specified in the request if you pass the andcategories.refKey matchAll parameter with the request.

    • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&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 ('WORLD', 'MOVIES')&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 ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

      The objects in the returned list are sorted by the published date descending order.

  • The date when an author has checked out or locked the document for editing.

  • UserKey
    Title: UserKey
  • ContentTypeKey
    Title: ContentTypeKey

  • The date when the content was created. For legacy systems, the create date is the date when the document was created in those systems.

  • UserKey
    Title: UserKey

  • 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.

  • The date when the content was last modified in the Oracle Knowledge Repository.

  • The date when the service stops the display of the document to the end users.

  • Allowed Values: [ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]
    LookUp code that can be Fixed@Top, Place@Top , Historical Usefulness

  • The date when the document requires a review by an author capable of performing the review.

  • The date when the document will be available to display to end-users.

  • The unique identifier of a document that indicates the content type in which the content is saved.

  • The date when the document's event ends.

  • The date when the document's event begins.

  • The parameter to request editable content.

  • 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.

  • UserKey
    Title: UserKey
  • ContentKey
    Title: ContentKey
  • links
  • LocaleKey
    Title: LocaleKey
  • MetaDataResourcePath of the Content object
  • MetaDataXml of the Content object
  • UserKey
    Title: UserKey

  • The flag that indicates whether the document is pending for publication.

  • 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.

  • The date when the document was first displayed to end users.

  • The flag that indicates whether the document is published.

  • ContentKey
    Title: ContentKey
  • Version of the Content object
  • DataForm
    Title: DataForm
  • AggregateFormResults
    Title: AggregateFormResults
  • Reasons for editing or creating a content. This will only be used when creating or updating the document.

  • The unique identifier of the document. This ID is same in all versions in all locales of the document.

  • 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.

  • 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.
  • schemaAttributes

    This field will return list of schema attributes associated with the content type of this content.

    This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

  • The tittle of the document.

  • userGroups

    The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone.

  • Version of the Content object

  • 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.

  • 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.

  • 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.

  • WorkflowStepKey
    Title: WorkflowStepKey
  • Xml of the Content object
Nested Schema : ContentModificationQualifier
Type: object
Title: ContentModificationQualifier
Show Source
  • Flag indicating whether the existing record to be updated should be published automatically by bypassing workflow (even if one exists) after saving the record.
  • IP Address of the Client who is making modifications to Content
  • Flag indicating whether the new record to be created or existing record to be updated should be published automatically after saving it
Nested Schema : allTranslations
Type: 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.

Show Source
Nested Schema : ArticleStatusKey
Type: object
Title: ArticleStatusKey
Show Source
  • links

  • The localized name of the ArticleStatus object. The name field can only be used for sorting.

  • The unique identifier of the ArticleStatus object.

  • The reference key for the ArticleStatus object.
    ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.

Nested Schema : LocaleKey
Type: object
Title: LocaleKey
Show Source
Nested Schema : categories
Type: 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

    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:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

    • The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

    • 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 ('USA', 'EUROPE')&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 ('USA', 'EUROPE') 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 ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

    The objects in the returned list are sorted by the dateModified.

    Match ALL

    The service matches all the categories specified in the request if you pass the andcategories.refKey matchAll parameter with the request.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&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 ('WORLD', 'MOVIES')&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 ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

    The objects in the returned list are sorted by the published date descending order.

Show Source
Nested Schema : UserKey
Type: object
Title: UserKey
Show Source
  • Email of the User object
  • 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.
  • 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.
  • links
  • User's full name
  • The unique record ID of the User object.
Nested Schema : ContentTypeKey
Type: object
Title: ContentTypeKey
Show Source

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

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

  • links

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

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

  • The unique identifier of the ContentType object.

  • The reference key for the ContentType object.

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

  • Lookup code that indicates the stripe code.

Nested Schema : ContentKey
Type: object
Title: ContentKey
Show Source
Nested Schema : links
Type: array
Show Source
Nested Schema : DataForm
Type: object
Title: DataForm
Show Source
Nested Schema : AggregateFormResults
Type: object
Title: AggregateFormResults
Show Source
Nested Schema : replacementTokens
Type: 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.

Show Source
Nested Schema : schemaAttributes
Type: array

This field will return list of schema attributes associated with the content type of this content.

This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

Show Source
Nested Schema : userGroups
Type: array

The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone.

Show Source
Nested Schema : views
Type: 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.

Show Source
Nested Schema : WorkflowStepKey
Type: object
Title: WorkflowStepKey
Show Source
Nested Schema : CategoryKey
Type: object
Title: CategoryKey
Show Source

  • This field will return number of immediate children a category has.

    This field will only be populated if childrenCount query parameter is passed in with value true.

    Example URIs for the this parameter are as follows:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY
  • Description of the Category object

  • The unique identifier used while integrating the repository data with the external system.

  • The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.

  • The inventory organization id of the specific product.

  • links

  • The name of the category.

  • The hierarchichal position of the category
  • parents

    This field will return all parents of category.

    This field will only be populated if withParents query parameter is passed in with value true.

    Example URIs for the this parameter are as follows:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY

  • The unique record ID of the Category object.

  • The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.

  • This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.

Nested Schema : parents
Type: array

This field will return all parents of category.

This field will only be populated if withParents query parameter is passed in with value true.

Example URIs for the this parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
Show Source
Nested Schema : allTranslations
Type: 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.

Show Source
Nested Schema : schemaAttributes
Type: array

This field will return list of schema attributes associated with the content type of this content.

This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

Show Source
Nested Schema : SchemaAttribute
Type: object
Title: SchemaAttribute
Show Source
Nested Schema : children
Type: array
List of child nodes of the current element
Show Source
Nested Schema : localizedAttributes
Type: array
List of LocalizedAttributes of this SchemaAttribute name and description in various Locales
Show Source
Nested Schema : schemaAttributeUserGroupList
Type: array
List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType
Show Source
Nested Schema : LocalizedAttributes
Type: object
Title: LocalizedAttributes
Show Source
Nested Schema : SchemaAttributeUserGroup
Type: object
Title: SchemaAttributeUserGroup
Show Source
Nested Schema : UserGroupKey
Type: object
Title: UserGroupKey
Show Source

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

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

  • links

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

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

  • The non localized name of the user group

  • Stripe for UserGroup

Nested Schema : questions
Type: array
To Many Relationship to Question
Show Source
Nested Schema : views
Type: array
To Many Relationship to View
Show Source
Nested Schema : DataFormQuestion
Type: object
Title: DataFormQuestion
Show Source
Nested Schema : answers
Type: array
To Many Relationship to Answer
Show Source
Nested Schema : DataFormKey
Type: object
Title: DataFormKey
Show Source
Nested Schema : DataFormAnswer
Type: object
Title: DataFormAnswer
Show Source
Nested Schema : DataFormQuestionKey
Type: object
Title: DataFormQuestionKey
Show Source
  • links
  • The unique record ID of the DataFormQuestion object.
  • The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.
Nested Schema : ViewKey
Type: object
Title: ViewKey
Show Source
Nested Schema : questions
Type: array
To Many Relationship to AggregateQuestionResult
Show Source
Nested Schema : AggregateQuestionResult
Type: object
Title: AggregateQuestionResult
Show Source
Nested Schema : answers
Type: array
To Many Relationship to AggregateAnswerResult
Show Source
Nested Schema : AggregateAnswerResult
Type: object
Title: AggregateAnswerResult
Show Source
  • Localized display name for the Answer
  • The unique record ID of the AggregateAnswerResult object.
  • The reference key for the AggregateAnswerResult object. AggregateAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages.
  • TotalResponses of the AggregateAnswerResult object
Nested Schema : ReplacementToken
Type: object
Title: ReplacementToken
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : Content
Type: object
Title: Content
Show Source
  • 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.

  • The unique identifier that enables mapping between an answer and the content.

  • ArticleStatusKey
    Title: ArticleStatusKey
  • LocaleKey
    Title: LocaleKey
  • Version of the Content object
  • 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

      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:

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

      • OR

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

      • The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

      • OR

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

      • 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 ('USA', 'EUROPE')&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 ('USA', 'EUROPE') 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 ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

      The objects in the returned list are sorted by the dateModified.

      Match ALL

      The service matches all the categories specified in the request if you pass the andcategories.refKey matchAll parameter with the request.

    • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&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 ('WORLD', 'MOVIES')&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 ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

      The objects in the returned list are sorted by the published date descending order.

  • The date when an author has checked out or locked the document for editing.

  • UserKey
    Title: UserKey
  • ContentTypeKey
    Title: ContentTypeKey

  • The date when the content was created. For legacy systems, the create date is the date when the document was created in those systems.

  • UserKey
    Title: UserKey

  • 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.

  • The date when the content was last modified in the Oracle Knowledge Repository.

  • The date when the service stops the display of the document to the end users.

  • Allowed Values: [ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]
    LookUp code that can be Fixed@Top, Place@Top , Historical Usefulness

  • The date when the document requires a review by an author capable of performing the review.

  • The date when the document will be available to display to end-users.

  • The unique identifier of a document that indicates the content type in which the content is saved.

  • The date when the document's event ends.

  • The date when the document's event begins.

  • The parameter to request editable content.

  • 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.

  • UserKey
    Title: UserKey
  • ContentKey
    Title: ContentKey
  • links
  • LocaleKey
    Title: LocaleKey
  • MetaDataResourcePath of the Content object
  • MetaDataXml of the Content object
  • UserKey
    Title: UserKey

  • The flag that indicates whether the document is pending for publication.

  • 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.

  • The date when the document was first displayed to end users.

  • The flag that indicates whether the document is published.

  • ContentKey
    Title: ContentKey
  • Version of the Content object
  • DataForm
    Title: DataForm
  • AggregateFormResults
    Title: AggregateFormResults
  • Reasons for editing or creating a content. This will only be used when creating or updating the document.

  • The unique identifier of the document. This ID is same in all versions in all locales of the document.

  • 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.

  • 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.
  • schemaAttributes

    This field will return list of schema attributes associated with the content type of this content.

    This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

  • The tittle of the document.

  • userGroups

    The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone.

  • Version of the Content object

  • 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.

  • 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.

  • 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.

  • WorkflowStepKey
    Title: WorkflowStepKey
  • Xml of the Content object
Nested Schema : allTranslations
Type: 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.

Show Source
Nested Schema : ArticleStatusKey
Type: object
Title: ArticleStatusKey
Show Source
  • links

  • The localized name of the ArticleStatus object. The name field can only be used for sorting.

  • The unique identifier of the ArticleStatus object.

  • The reference key for the ArticleStatus object.
    ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.

Nested Schema : LocaleKey
Type: object
Title: LocaleKey
Show Source
Nested Schema : categories
Type: 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

    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:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

    • The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

    • 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 ('USA', 'EUROPE')&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 ('USA', 'EUROPE') 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 ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

    The objects in the returned list are sorted by the dateModified.

    Match ALL

    The service matches all the categories specified in the request if you pass the andcategories.refKey matchAll parameter with the request.

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&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 ('WORLD', 'MOVIES')&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 ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

    The objects in the returned list are sorted by the published date descending order.

Show Source
Nested Schema : UserKey
Type: object
Title: UserKey
Show Source
  • Email of the User object
  • 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.
  • 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.
  • links
  • User's full name
  • The unique record ID of the User object.
Nested Schema : ContentTypeKey
Type: object
Title: ContentTypeKey
Show Source

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

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

  • links

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

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

  • The unique identifier of the ContentType object.

  • The reference key for the ContentType object.

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

  • Lookup code that indicates the stripe code.

Nested Schema : ContentKey
Type: object
Title: ContentKey
Show Source
Nested Schema : links
Type: array
Show Source
Nested Schema : DataForm
Type: object
Title: DataForm
Show Source
Nested Schema : AggregateFormResults
Type: object
Title: AggregateFormResults
Show Source
Nested Schema : replacementTokens
Type: 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.

Show Source
Nested Schema : schemaAttributes
Type: array

This field will return list of schema attributes associated with the content type of this content.

This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

Show Source
Nested Schema : userGroups
Type: array

The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone.

Show Source
Nested Schema : views
Type: 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.

Show Source
Nested Schema : WorkflowStepKey
Type: object
Title: WorkflowStepKey
Show Source
Nested Schema : CategoryKey
Type: object
Title: CategoryKey
Show Source

  • This field will return number of immediate children a category has.

    This field will only be populated if childrenCount query parameter is passed in with value true.

    Example URIs for the this parameter are as follows:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY
  • Description of the Category object

  • The unique identifier used while integrating the repository data with the external system.

  • The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.

  • The inventory organization id of the specific product.

  • links

  • The name of the category.

  • The hierarchichal position of the category
  • parents

    This field will return all parents of category.

    This field will only be populated if withParents query parameter is passed in with value true.

    Example URIs for the this parameter are as follows:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY

  • The unique record ID of the Category object.

  • The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.

  • This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.

Nested Schema : parents
Type: array

This field will return all parents of category.

This field will only be populated if withParents query parameter is passed in with value true.

Example URIs for the this parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
Show Source
Nested Schema : allTranslations
Type: 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.

Show Source
Nested Schema : schemaAttributes
Type: array

This field will return list of schema attributes associated with the content type of this content.

This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

Show Source
Nested Schema : SchemaAttribute
Type: object
Title: SchemaAttribute
Show Source
Nested Schema : children
Type: array
List of child nodes of the current element
Show Source
Nested Schema : localizedAttributes
Type: array
List of LocalizedAttributes of this SchemaAttribute name and description in various Locales
Show Source
Nested Schema : schemaAttributeUserGroupList
Type: array
List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType
Show Source
Nested Schema : LocalizedAttributes
Type: object
Title: LocalizedAttributes
Show Source
Nested Schema : SchemaAttributeUserGroup
Type: object
Title: SchemaAttributeUserGroup
Show Source
Nested Schema : UserGroupKey
Type: object
Title: UserGroupKey
Show Source

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

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

  • links

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

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

  • The non localized name of the user group

  • Stripe for UserGroup

Nested Schema : questions
Type: array
To Many Relationship to Question
Show Source
Nested Schema : views
Type: array
To Many Relationship to View
Show Source
Nested Schema : DataFormQuestion
Type: object
Title: DataFormQuestion
Show Source
Nested Schema : answers
Type: array
To Many Relationship to Answer
Show Source
Nested Schema : DataFormKey
Type: object
Title: DataFormKey
Show Source
Nested Schema : DataFormAnswer
Type: object
Title: DataFormAnswer
Show Source
Nested Schema : DataFormQuestionKey
Type: object
Title: DataFormQuestionKey
Show Source
  • links
  • The unique record ID of the DataFormQuestion object.
  • The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.
Nested Schema : ViewKey
Type: object
Title: ViewKey
Show Source
Nested Schema : questions
Type: array
To Many Relationship to AggregateQuestionResult
Show Source
Nested Schema : AggregateQuestionResult
Type: object
Title: AggregateQuestionResult
Show Source
Nested Schema : answers
Type: array
To Many Relationship to AggregateAnswerResult
Show Source
Nested Schema : AggregateAnswerResult
Type: object
Title: AggregateAnswerResult
Show Source
  • Localized display name for the Answer
  • The unique record ID of the AggregateAnswerResult object.
  • The reference key for the AggregateAnswerResult object. AggregateAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages.
  • TotalResponses of the AggregateAnswerResult object
Nested Schema : ReplacementToken
Type: object
Title: ReplacementToken
Show Source
Back to Top

Examples

The following example shows how to create translated content, given as part of a CompositeContent object:

curl -X POST "https://<IM_REST_API_HOST>/km/api/latest/content/{versionId}/translate" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json" -d "@<FilePath/RequestBody.json>"

Example of Request Body

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

{
  "content" : {
    "isForEdit" : true,
    "views" : [ {
      "recordId" : "BBA181DFB52148779A416184A191B2AF",
      "referenceKey" : "SERVICE",
      "name" : "Service"
    } ],
    "recordId": "8F4EB443B31D4E569B18374ED39607F3",
 "documentId" : "FAQ13",
    "locale" : {
      "recordId" : "en_GB"
    },
    "contentType" : {
      "recordId" : "98055D055BA8467B8097FB0B52923FD2",
      "referenceKey" : "FAQ",
      "name" : "FAQ"
    },
    "published" : false,
    "pending" : false,
    "checkedOut" : false,
    "basedOnVersion" : "1.0",
    "basedLocale" : {
      "recordId" : "en_US"
    },
    "xml" : "<FAQ><QUESTION><![CDATA[Sayyed Testing-Translated]]></QUESTION><ANSWER><![CDATA[Hello Sir - Translates -en_GB !!!!!]]></ANSWER><SUMMARY><![CDATA[Hello Sir - Translates -en_GB  !!!!!]]></SUMMARY></FAQ>"
  },
  "contentModificationQualifier" : {
    "publish" : false,
    "bypassWorkflowAndPublish" : false
  }
}

Example of Response Body

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

{
  "isForEdit": true,
  "categories": [],
  "userGroups": [],
  "views": [
    {
      "recordId": "BBA181DFB52148779A416184A191B2AF",
      "referenceKey": "SERVICE",
      "name": "Service",
      "links": [
        {
          "rel": "canonical",
          "href": "https://<IM_REST_API_HOST>/km/api/latest/views/BBA181DFB52148779A416184A191B2AF",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    }
  ],
  "recordId": "8F4EB443B31D4E569B18374ED39607F3",
  "versionId": "64C83D01464246969F818A84243E135B",
  "documentId": "FAQ13",
  "title": "Hi- Translates -en_GB  !!!!!",
  "version": "1.0",
  "answerId": 1001004,
  "locale": {
    "recordId": "en_GB",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/locales/en_GB",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "dateModified": "2018-11-26T13:37:03+0530",
  "links": [
    {
      "rel": "canonical",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/content/8F4EB443B31D4E569B18374ED39607F3",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "collection",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/content",
      "mediaType": "application/json, application/xml",
      "method": "GET",
      "profile": "https://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/content"
    }
  ],
  "contentType": {
    "recordId": "98055D055BA8467B8097FB0B52923FD2",
    "referenceKey": "FAQ",
    "name": "FAQ",
    "description": "A simple template containing a common question and answer on a specific topic",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/contentTypes/98055D055BA8467B8097FB0B52923FD2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "priority": "PRIORITY_0",
  "createDate": "2018-11-26T13:37:03+0530",
  "lastModifiedDate": "2018-11-26T13:37:03+0530",
  "dateAdded": "2018-11-26T13:37:03+0530",
  "displayStartDate": "1900-01-01T00:00:00+0530",
  "displayEndDate": "9999-12-31T00:00:00+0530",
  "owner": {
    "recordId": 2,
    "name": "Default Administrator",
    "email": "user@example.com",
    "externalType": "ACCOUNT",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/users/2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "lastModifier": {
    "recordId": 2,
    "name": "Default Administrator",
    "email": "user@example.com",
    "externalType": "ACCOUNT",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/users/2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "creator": {
    "recordId": 2,
    "name": "Default Administrator",
    "email": "user@example.com",
    "externalType": "ACCOUNT",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/users/2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "published": false,
  "pending": false,
  "checkedOut": false,
  "basedOnVersion": "1.0",
  "basedLocale": {
    "recordId": "en_US",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/locales/en_US",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "xml": "<FAQ><QUESTION><![CDATA[ Testing-Translated]]></QUESTION><ANSWER><![CDATA[Hi - Translates -en_GB !]]></ANSWER><SUMMARY><![CDATA[Hi - Translates -en_GB  !!!!!]]></SUMMARY></FAQ>",
  "resourcePath": "$STAGING_RESOURCE_HOST_URL/fusion/content/draft/8F4EB443B31D4E569B18374ED39607F3/64C83D01464246969F818A84243E135B/"
}
Back to Top