Checkout Article

Overview

  • This API allows logged in author to checkout an article.
  • This checkout API creates a new version of each article in the language specified, in a checked-out state.

Permissions

  • Article should be in either 'draft' or 'published' article state.
  • User must have 'Edit Article' permissions on each article's parent folder.
  • Request of article that is in personal folder is not allowed through this API.

Precondition

  • The latest version of the article. to be edited, in the language specified, must not already have been checked-out.
  • Language specified must have been assigned to the user.
SecurityoAuthUser
Request
path Parameters
ID
required
string

The comma separated Ids of the articles on which operation is performed. Both numeric and alternate Ids formats are supported for article Id.

Examples:
Providing readable article ids.
PROD-2268,PROD-2269
Providing numeric article ids.
202200000002268,202200000002269
Request Body schema: application/json
required
object (language)

Language passed in the request must be assigned to user.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Preconditions failed

500

Internal server error

put/articles/{ID}/checkout
Request samples
application/json
{
  • "language": {
    }
}
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>"
}