Request lock on Article

Overview

  • This API allows users to perform a forced checkin, on an article in certain language.
  • This article, in the given language, must already be checked-out by another user.
  • As a result request lock operation messages are sent to the user currently holding the lock on the given article ( in the given language ) as well as to users who have certain lock administration permissions.

Permissions

  • For articles in shared folders: 'Edit Article' Permission is required.
  • Request for article that is in personal folder is not allowed through this API.

Precondition

  • The article must be checked-out (locked ) in the language requested (specified by the $lang query parameter) by an user other than the requesting user.
  • The article must have at least one checked-in version in the language requested.
  • The language specified in $lang attribute has to be assigned to the requesting user.
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
Request Body schema: application/json
required
object (language)

Language passed in the request must be assigned to user.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Preconditions failed

500

Internal server error

put/articles/{ID}/requestlock
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>"
}