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

Unpublish content

post

/km/api/v1/content/versions/{versionId}/unpublishThisVersion

This method unpublishes a version of Content object having the specified version ID. When a Content version is unpublished, it becomes unavailable to end-users.

Response Errors

The possible error response for this method is as follows:

  • OKDOM-GEN0001

    The error occurs when the value of the versionId parameter or localeId parameter is invalid.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ContentKey
Type: object
Title: ContentKey
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
  • 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 : DataForm
Type: object
Title: DataForm
Show Source
Nested Schema : AggregateFormResults
Type: object
Title: AggregateFormResults
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 : questions
Type: array
To Many Relationship to Question
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 : 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 : 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

Back to Top

Examples

The following example shows how to unpublish a version of Content object having the specified version ID:

curl -X POST "https://<IM_REST_API_HOST>/km/api/latest/content/versions/{versionId}/unpublishThisVersion" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

Example of Response Body

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

{
  "recordId": "8F4EB443B31D4E569B18374ED39607F3",
  "versionId": "B46EF56032C848FA9B24E74CF2E1595B",
  "documentId": "FAQ13",
  "title": "Q query  Testing",
  "version": "1.0",
  "answerId": 1001003,
  "locale": {
    "recordId": "en_US"
  },
  "dateModified": "2018-11-26T13:44:17+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"
    }
  ]
}
Back to Top