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

Update content from import

put

/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. You must specify file attachments along with a composite Content Business Object to perform an import.

Create Import Flow Conditions

When you create a new document during the create import flow, consider the following:

  • The dateAdded value of the new document is set as the createDate of the new document. Any specified dateAdded value is ignored.
  • 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 dateModified value.
    • The createDate value when set to null, the current date and current time values are set as create date.
  • When you specify a value for dateModified field, consider the following:
    • The dateModified value cannot be in the future.
    • The dateModified value must be later than or same as the createDate.
    • The dateModified value must be specified only when there is a createDate value.
    • The dateModified value when set to null, the current date and current time values are set the date modified.

Update Import Flow Conditions

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.
  • The dateAdded of the new version of the document is set as the dateAdded for the previous version of the document. Any specified dateAdded value is ignored.
  • When you specify a value for the dateModified field, consider the following:
    • The dateModified value cannot be in the future.
    • The dateModified value must be later than or equal to the previous version's dateModified.
    • The dateModified value when set to null, the current date and current time values are set as the new version's date modified.

    • Translate Import Flow Conditions

    When you create a new version of the document in another locale during the translate import flow, consider the following:

    • The dateAdded value of the new version of the document is set as the createDate value. Any specified dateAdded value is ignored.
    • 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.
      • The createDate value when set to null, the current date and current time values are set as create date.
    • When you specify a value for the dateModified field, consider the following :
      • The dateModified value cannot be in the future.
      • The dateModified value must be later than or same as the createDate.
      • The dateModified value when set to null, the current date and current time values are set as the date modified.
      • The dateModified value must be specified only when there is a createDate value.

    The following table lists the regular flow conditions and import flow conditions of the field parameters that are used while calling the create or translate, and update methods.

    Field Regular flow Regular Flow Conditions Import flow Import Flow Conditions
    CREATE/ TRANSLATE UPDATE CREATE/ TRANSLATE UPDATE
    creator NOT ALLOWED NOT ALLOWED None ALLOWED IGNORED You can specify a user as creator only during the creation of an article. When a creator is not specified, the active user is set as creator.
    owner OPTIONAL OPTIONAL You can specify a different user as an owner using the creator field. When an owner is not specified the active user is set as the owner. OPTIONAL OPTIONAL You can specify a different user as an owner using the owner field. When an owner is not specified during the update the active user is set as the creator.
    lastModifier NOT ALLOWED NOT ALLOWED The active user is always the last modifier by default. OPTIONAL OPTIONAL You can specify a different user as the last modifier using the lastModifier field. When the last modifier is not specified, the active user is considered as the last modifier.
    createDate NOT ALLOWED NOT ALLOWED None OPTIONAL OPTIONAL  
    dateAdded NOT ALLOWED NOT ALLOWED None IGNORED IGNORED The dateAdded value is ignored for all import flows.
    dateModified NOT ALLOWED EXPECTED During update, the dateModified value must match the latest version's DateModified. OPTIONAL OPTIONAL For more information, see Create Import Flow Conditions, Update Import Flow Conditions, and Translate Import Flow Conditions sections.
    publish Not applicable. Not applicable. The publish field is not applicable in regular flow. OPTIONAL OPTIONAL None.

    Note: To import a new document, use the corresponding POST method on import.

    Request

    Supported Media Types
    Path Parameters
    Body ()
    The Composite of ContentBO to be updated and the Modification Qualifier BO.
    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
    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
    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
    Nested Schema : ContentTypeKey
    Type: object
    Title: ContentTypeKey
    Show Source
    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
    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
    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
    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
    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
    Nested Schema : ContentTypeKey
    Type: object
    Title: ContentTypeKey
    Show Source
    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
    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
    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
    Nested Schema : ReplacementToken
    Type: object
    Title: ReplacementToken
    Show Source
    Back to Top

    Examples

    The following example shows how to import the Content Business object which is specified in the request:

    curl -X PUT "https://<IM_REST_API_HOST>/km/api/latest/content/{id}/import" -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"
    }
  ],
  "locale": {
    "recordId": "en_US"
  },
  "contentType": {
    "recordId": "98055D055BA8467B8097FB0B52923FD2",
    "referenceKey": "FAQ",
    "name": "FAQ"
  },

  "published": false,
  "recordId": "42346CE6A4E04813A857E9C776AD3CF8",
  "versionId": "1A87AFC4F7C94D479AF5C6F26807C3AB",
  "documentId": "FAQ15",
  "version": "1.0",
  "xml":"<FAQ><QUESTION><![CDATA[Questions for me ...]]></QUESTION><ANSWER><![CDATA[Answers for me ... ]]></ANSWER><SUMMARY><![CDATA[Summary in me]]></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": "42346CE6A4E04813A857E9C776AD3CF8",
  "versionId": "961B13A6ABD2479C819810E4372BE327",
  "documentId": "FAQ15",
  "title": "Summary in me",
  "version": "2.0",
  "answerId": 1001006,
  "locale": {
    "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"
      }
    ]
  },
  "dateModified": "2018-11-26T14:13:26+0530",
  "links": [
    {
      "rel": "canonical",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/content/42346CE6A4E04813A857E9C776AD3CF8",
      "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-26T14:11:49+0530",
  "lastModifiedDate": "2018-11-26T14:13:26+0530",
  "dateAdded": "2018-11-26T14:13:26+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,
  "publishedVersion": "1.0",
  "xml": "<FAQ><QUESTION><![CDATA[Questions for me ...]]></QUESTION><ANSWER><![CDATA[Answers for me ...]]></ANSWER><SUMMARY><![CDATA[Summary in me]]></SUMMARY></FAQ>",
  "resourcePath": "$STAGING_RESOURCE_HOST_URL/fusion/content/draft/42346CE6A4E04813A857E9C776AD3CF8/961B13A6ABD2479C819810E4372BE327/"
}
    Back to Top