Rollback Article Version

Overview

  • This API allows to rollback ( revert ) an article to one of the older versions.
  • As the result of this operation, a new version of the article is created, which is a copy of the version specified in request.
  • This newly created article version is in a checked-out state.
  • Blocked attachments, if any, will be removed during this operation.

Precondition

  • The article must not be checked out in the language requested by any user other than the requesting user. Only the user who checked-out this article version, can rollback this article version.
  • If the version ID specified in the request is the last version of the article in the specified language, it must be an abandoned versions.

Permissions

  • For articles in shared folders: 'Edit Article' Permission is required.
  • Article that are in personal folder are not allowed through this API.
SecurityoAuthUser
Request
path Parameters
ID
required
string

The ID of the article for which the operation is performed. Both numeric and alternate ID formats are supported.

Examples:
A readable article ID.
PROD-2268
A numeric article ID.
202200000002268
versionID
required
string

The Id of the article version.

Example: 202200000002270
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

post/articles/{ID}/versions/{versionID}/rollback
Request samples
Response samples
application/json
Required query parameter is missing


{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}