Publish article

Overview

  • This API allows user to publish article. Article Version Level Attribute added/update will be published by this API.

Permissions

  • User must have 'Edit Article' permission on article's parent folder.

Note

  • Bookmark, Queue, Category, Topic and Related article cannot be associate with article which does not have any checked-in version.
  • Topic and article are not in same department.
  • Personal , Data Link, Topic Home, Suggestion and VA Articles are not allowed to associate with topic.
  • Article cannot be added to Auto Generated Topic.
SecurityoAuthUser
Request
query Parameters
forcePublish
string

If 'forcePublish=yes', then it will force publish the article.

Value: "yes"
Example: forcePublish=yes
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 (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/publish
Request samples
application/json
{
  • "id": 409700000002497,
  • "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>"
}