REST API for Knowledge Advanced in B2C Service

Unpublish all version in this 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 responses for this method are 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

id(required): string

The content identifier
localeCode(required): string

The locale code identifier

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : ResultList ActionResult ContentKey

Type: object

Title: ResultList ActionResult ContentKey

Match All

Show Source

allOf Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.
object ResultList ActionResult ContentKey-allOf[1]

{
    "title":"ResultList ActionResult ContentKey",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/collectionPagedResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ActionResultContentKey"
                    }
                }
            }
        }
    ]
}

Nested Schema : Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.

Match All

Oracle base collection resource schema definition.

Show Source

allOf Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.
object Collection Paging Resource-allOf[1]

{
    "title":"Collection Paging Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/collectionBaseResource"
        },
        {
            "properties":{
                "hasMore":{
                    "type":"boolean",
                    "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
                },
                "totalResults":{
                    "type":"integer",
                    "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
                },
                "limit":{
                    "type":"integer",
                    "description":"Actual paging size used by the server."
                },
                "count":{
                    "type":"integer",
                    "description":"Number of resource instances returned in the current range."
                },
                "offset":{
                    "type":"integer",
                    "description":"Offset value used in the current page. "
                }
            }
        }
    ]
}

Nested Schema : Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.

Match All

Oracle base collection resource schema definition.

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object Base Collection Resource-allOf[1]

{
    "title":"Base Collection Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

links: array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : Base Collection Resource-allOf[1]

Type: object

Show Source

items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : Collection Paging Resource-allOf[1]

Type: object

Show Source

count: integer

Number of resource instances returned in the current range.
hasMore: boolean

Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
limit: integer

Actual paging size used by the server.
offset: integer

Offset value used in the current page.
totalResults: integer

Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.

{
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
        },
        "limit":{
            "type":"integer",
            "description":"Actual paging size used by the server."
        },
        "count":{
            "type":"integer",
            "description":"Number of resource instances returned in the current range."
        },
        "offset":{
            "type":"integer",
            "description":"Offset value used in the current page. "
        }
    }
}

Nested Schema : ResultList ActionResult ContentKey-allOf[1]

Type: object

Show Source

items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ActionResultContentKey"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/instanceLink"
    }
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

href(required): string

URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
mediaType: string

Media type, as defined by RFC 2046, describing the link target.
method: string

HTTP method for requesting the target of the link.
profile: string

Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
rel(required): string

Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
templated: boolean

Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

Array of: object ActionResult ContentKey

Title: ActionResult ContentKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ActionResultContentKey"
    }
}

Nested Schema : ActionResult ContentKey

Type: object

Title: ActionResult ContentKey

Match All

Show Source

object ActionResult

Title: ActionResult
object ActionResult ContentKey-allOf[1]

{
    "title":"ActionResult ContentKey",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ActionResult"
        },
        {
            "properties":{
                "result":{
                    "$ref":"#/definitions/ContentKey"
                }
            }
        }
    ]
}

Nested Schema : ActionResult

Type: object

Title: ActionResult

Show Source

errors: array KMError Collection

Title: KMError Collection

Collection of KMErrors
message: string

This will hold a success and failure message.
operation: string

The operation performed like PUBLISH_ACTION, UNPUBLISH_ACTION, etc.
status:

Allowed Values: [ "COMPLETED", "FAILED", "COMPLETED_WITH_WARNINGS" ]

Whether the Action completed successfully or not!
warningMessage: string

Only meant for Waring Kind of messages. Like operation was successful but with warnings.

{
    "title":"ActionResult",
    "type":"object",
    "properties":{
        "status":{
            "enum":[
                "COMPLETED",
                "FAILED",
                "COMPLETED_WITH_WARNINGS"
            ],
            "description":"Whether the Action completed successfully or not!"
        },
        "operation":{
            "type":"string",
            "description":"The operation performed like PUBLISH_ACTION, UNPUBLISH_ACTION, etc."
        },
        "warningMessage":{
            "type":"string",
            "description":"Only meant for Waring Kind of messages. Like operation was successful but with warnings."
        },
        "message":{
            "type":"string",
            "description":"This will hold a success and failure message."
        },
        "errors":{
            "$ref":"#/definitions/KMErrorCollection",
            "description":"List of errors"
        }
    }
}

Nested Schema : ActionResult ContentKey-allOf[1]

Type: object

Show Source

result: ContentKey

{
    "properties":{
        "result":{
            "$ref":"#/definitions/ContentKey"
        }
    }
}

Nested Schema : KMError Collection

Type: array

Title: KMError Collection

Collection of KMErrors

Show Source

Array of: object KMError

Title: KMError

{
    "title":"KMError Collection",
    "type":"array",
    "items":{
        "$ref":"#/definitions/KMError"
    },
    "description":"Collection of KMErrors"
}

Nested Schema : KMError

Type: object

Title: KMError

Show Source

errorCode: string

The Oracle Knowledge defined code for this error.
errorPath: string

The XPath of the field to which this error applies.
title: string

The error message title
type:

Allowed Values: [ "VALIDATION", "AUTHENTICATION", "AUTHORIZATION", "APPLICATION" ]

The error type.

{
    "title":"KMError",
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"The error message title"
        },
        "errorPath":{
            "type":"string",
            "description":"The XPath of the field to which this error applies."
        },
        "errorCode":{
            "type":"string",
            "description":"The Oracle Knowledge defined code for this error."
        },
        "type":{
            "enum":[
                "VALIDATION",
                "AUTHENTICATION",
                "AUTHORIZATION",
                "APPLICATION"
            ],
            "description":"The error type."
        }
    }
}

Nested Schema : ContentKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object ContentKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
                },
                "versionId":{
                    "type":"string",
                    "description":"<p>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.</p>"
                },
                "documentId":{
                    "type":"string",
                    "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
                },
                "title":{
                    "type":"string",
                    "description":"<p>The tittle of the document.</p>"
                },
                "version":{
                    "type":"string",
                    "description":"Version of the Content object"
                },
                "answerId":{
                    "type":"integer",
                    "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
                },
                "locale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object.</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
                }
            }
        }
    ]
}

Nested Schema : ContentKey-allOf[1]

Type: object

Show Source

answerId: integer

The unique identifier that enables mapping between an answer and the content.
dateModified: string(date-time)

The date when the content was last modified in the Oracle Knowledge Repository.
documentId: string

The unique identifier of a document that indicates the content type in which the content is saved.
locale: LocaleKey
recordId: string

The unique identifier of the document. This ID is same in all versions in all locales of the document.
title: string

The tittle of the document.
version: string

Version of the Content object
versionId: string

The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
        },
        "versionId":{
            "type":"string",
            "description":"<p>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.</p>"
        },
        "documentId":{
            "type":"string",
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
        },
        "title":{
            "type":"string",
            "description":"<p>The tittle of the document.</p>"
        },
        "version":{
            "type":"string",
            "description":"Version of the Content object"
        },
        "answerId":{
            "type":"integer",
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
        },
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object.</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
        }
    }
}

Nested Schema : LocaleKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object LocaleKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Locale object.</p>"
                }
            }
        }
    ]
}

Nested Schema : LocaleKey-allOf[1]

Type: object

Show Source

recordId: string

The unique identifier of the Locale object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Locale object.</p>"
        }
    }
}

Examples

The following example shows how to unpublish all versions of the specified Content translation in the specified locale by submitting a post request on the REST resource using cURL.

cURL Command

Command: curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/content/{id}/unpublishAllVersionInThisLocale/{localeCode}"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"UoyWTKRG4RpyJCH4Wqjzht2iYUrsDdk5ir+3IpwEkxcwajJkGR9OGSQBTANQVGW0iVT9MFeDzqL+RYdgfzGSK+h5QzDFIDM+rDLgdKeEE19ljWFm3zMCF+kgYp/dJ/Yq5V7Re+aDXqHg6YkHfvprFA==\"}" \
-H "Accept: application/json"

Example of Response Body

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

{
  "items" : null,
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "count" : 0
}