Edit Article

Overview

  • This API allows user to edit details of an article.
  • It allows user to publish or checkin article when 'operation' query parameter is passed.

Permissions

  • If article is being saved
    • User must have 'Edit Article' permission on the parent folder.
    • 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.
  • If article is getting published.
    • The requesting user must be allowed to work on the current article stage for each article.
    • If article is being modified, 'Edit Article' permission on article's parent folder is required.
    • If an article is not being modified then 'View Folder' permission on article's parent folder is required.
    • The requesting user must be allowed by this article's workflow to move the article to 'published' stage i.e. the user has to have all the stages between the current and 'published' assigned.
    • 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.
  • If article is getting checked in
    • If article is in draft stage or checkin an article without modifying it, The user must have 'Edit Article' permission on the parent folder.
    • If article is in any other stage, The user must be a reviewer of the current article stage and must have 'Edit Article' permission on the parent folder.
    • If article is in any other stage, To checkin an article without modifying it, the user must be a reviewer of the current article stage and must have 'View Folder' permission on the parent folder.
    • Additionally, if related article links are part of the request, the user must have 'View Folder' permission on the parent folder for each of the related articles. This is not required for unlinking.

Precondition

  • Article's version to be edited is always the latest version.
  • Article must have been checked out by the requesting user.
SecurityoAuthUser
Request
Request Body schema: application/json

Article to be edited

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

412

Preconditions failed

500

Internal server error

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