Jump to

• Request
• Response
• Examples

Unpublish this version with comments

post

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

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

Response Errors

Following is the possible error response for this method:

• OKDOM-GEN0001

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

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• versionId(required): string
  The version identifier

Body ()

The comments to be provided for unpublish action.

Root Schema : Comments

Type: object

Title: Comments

Show Source

• comments: object Comments
  Title: Comments

{
    "title":"Comments",
    "properties":{
        "comments":{
            "$ref":"#/definitions/Comments",
            "description":"To gather comments from the user"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root 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. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
                },
                "allTranslations":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ContentKey"
                    },
                    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
                }
            }
        }
    ]
}

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 : ContentKey-allOf[1]

Type: object

Show Source

• allTranslations: array 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.

• 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. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
        },
        "allTranslations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
        }
    }
}

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 : 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

• Array of: ContentKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</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>"
        }
    }
}

Back to Top

Examples

The following example shows how to unpublish the version with comments of the Content object that has the specified version ID by submitting a post request on the REST resource using cURL.

cURL Command

curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/content/versions/{versionId}/unpublishThisVersionWithComments"

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 Request Body

{
    "comments": " COMMENTS_VALUE"
}

Example of Response Body

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

{
  "isForEdit" : true,
  "replacementTokens" : [ {
    "dateModified" : "284852364-01-15T17:37:46+0530",
    "replacementText" : "REPLACEMENTTEXT_VALUE",
    "replacementTextNonFormatted" : "REPLACEMENTTEXTNONFORMATTED_VALUE",
    "tokenType" : "TOKENTYPE_VALUE",
    "tokenName" : "TOKENNAME_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  } ],
  "categories" : [ {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  } ],
  "userGroups" : [ {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  } ],
  "views" : [ {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  } ],
  "versionId" : "VERSIONID_VALUE",
  "documentId" : "DOCUMENTID_VALUE",
  "title" : "TITLE_VALUE",
  "version" : "VERSION_VALUE",
  "answerId" : 1428416791848,
  "locale" : {
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "dateModified" : "2013-04-24T06:36:26+0530",
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
    "mediaType" : "application/json, application/xml",
    "templated" : true,
    "method" : "GET",
    "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
  } ],
  "contentType" : {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "priority" : "PRIORITY_20",
  "createDate" : "2013-04-24T06:36:26+0530",
  "dateAdded" : "2013-04-24T06:36:26+0530",
  "displayStartDate" : "2013-04-24T06:36:26+0530",
  "displayEndDate" : "2013-04-24T06:36:26+0530",
  "eventStartDate" : "2013-04-24T06:36:26+0530",
  "eventEndDate" : "2013-04-24T06:36:26+0530",
  "owner" : {
    "name" : "NAME_VALUE",
    "externalId" : 1428416791841,
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "lastModifier" : {
    "name" : "NAME_VALUE",
    "externalId" : 1428416791859,
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "creator" : {
    "name" : "NAME_VALUE",
    "externalId" : 1428416791867,
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "published" : true,
  "pending" : false,
  "displayReviewDate" : "2013-04-24T06:36:26+0530",
  "checkedOut" : true,
  "checkedOutBy" : {
    "name" : "NAME_VALUE",
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "basedOnVersion" : "BASEDONVERSION_VALUE",
  "publishedVersion" : "PUBLISHEDVERSION_VALUE",
  "basedLocale" : {
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "displayPosition" : "HISTORICAL_USEFULNESS",
  "suppressNotification" : false,
  "workflowStep" : {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET"
    } ]
  },
  "wfStepNotificationOverride" : "2013-04-24T06:36:26+0530",
  "xml" : "XML_VALUE",
  "metaDataXml" : "METADATAXML_VALUE",
  "resourcePath" : "http://${pageContext.request.serverName}:${pageContext.request.serverPort}/okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}",
  "metaDataResourcePath" : "METADATARESOURCEPATH_VALUE",
  "reasonForEdit" : "REASON_FOR_EDITING_OR_CREATING_CONTENT_RECORD"
}

Back to Top