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

Unpublish all version of content in a locale

post

/km/api/v1/content/{id}/unpublishAllVersionInThisLocale/{localeCode}

This method unpublishes all versions of the specified Content translation as specified by the locale. 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 you pass an invalid id or an invalid localeId parameter value with the HTTP request.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList ActionResult ContentKey
Type: object
Title: ResultList ActionResult ContentKey
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : ActionResult ContentKey
Type: object
Title: ActionResult ContentKey
Show Source
Nested Schema : KMError Collection
Type: array
Title: KMError Collection
Collection of KMErrors
Show Source
Nested Schema : ContentKey
Type: object
Title: ContentKey
Show Source
Nested Schema : KMError
Type: object
Title: KMError
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 : 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
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 : 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
Back to Top

Examples

The following example shows how to unpublish all versions of the specified Content translation as specified by the locale:

curl -X POST "https://<IM_REST_API_HOST>/km/api/latest/content/{id}/unpublishAllVersionInThisLocale/{localeCode}" -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.

{
  "items": [
    {
      "result": {
        "recordId": "8F4EB443B31D4E569B18374ED39607F3",
        "versionId": "64C83D01464246969F818A84243E135B",
        "documentId": "FAQ13",
        "title": "Hi - Translates -en_GB  !!!!!",
        "version": "1.0",
        "answerId": 1001004,
        "locale": {
          "recordId": "en_GB"
        },
        "dateModified": "2018-11-26T13:42:40+0530"
      },
      "status": "COMPLETED",
      "operation": "UNPUBLISH_ACTION",
      "warningMessage": null,
      "message": "Content was Unpublished for versionID 64C83D01464246969F818A84243E135B",
      "errors": []
    }
  ],
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/content/8F4EB443B31D4E569B18374ED39607F3/unpublishAllVersionInThisLocale/en_GB?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 1
}
Back to Top