Change Article Stage

Overview

  • This PUT API allows users to change article stage for one article i.e. to send the article to a different stage (forward or back) in the article review process.

Permissions

  • The requesting user must be allowed to work on the current article stage.
  • The requesting user must be allowed to move the article to the target stage supplied in the request.
  • If article is being modified, 'Edit Article' permission on article's parent folder is required, OR
  • If an article is not being modified then 'View Folder' permission on article's parent folder is required.
  • Requests for article that are in personal folders are not allowed through this API.
  • If related article links are supplied with the request, the user must have 'View Folder' permission on the folder for each of the related articles. This is not required for unlinking.
  • The target review stage ID cannot be of "Published" stage.

Precondition

  • The article has to be checked out in the language requested.
  • The article can only be moved back to a stage that is specified in the workflow configuration, which could be a specific stage or any previous stage.
  • The target review stage supplied in the request must be different from the current review stage of article.
SecurityoAuthUser
Request
Request Body schema: application/json
Array of objects (link) >= 0 items
  • All related article IDs provided in those elements must be valid and existing article IDs.
  • The article being created must not be a personal article.
  • Each of the related articles must have at least one 'checked in' version or a 'published' version in the language specified.
  • Each of the related articles must belong to the same department as the article being modified.
  • None of the IDs used in the link section should be of a personal article ID.
Array of objects (link) >= 0 items
Array of objects (unlink) >= 0 items
Array of objects (unlink) >= 0 items
name
string (name)
object (Macro)
suggestionState
string (suggestionState)
Enum: "suggested" "rejected" "information requested"
required
object (ReviewStage)
required
object (language)

Language passed in the request must be assigned to user.

object (RelatedQuestions)
required
object (Versions)
object (Classifications)
object (CustomAttributes)
object (ArticleAction)
id
required
integer (id)
alternateId
string (alternateId)
suggestionResolutionCode
integer (suggestionResolutionCode)
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/articles/changestage
Request samples
application/json
{
  • "versions": {
    },
  • "language": {
    },
  • "reviewStage": {
    },
  • "id": 409600000002100
}
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>"
}