Create Article

Overview

  • This API allows user to create an article of specified language in a folder.
  • The articles created in the personal folder act as a personal article for the user who created it, while the articles created in the shared folder can be shared across different users.
  • Newly created shared articles are created in the checked-out state, whereas, personal articles are always created in a published state.

Permissions

  • To create shared articles and personal articles: 'Create Article' permission on the folder is required.
  • 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.
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
object (Macro)
required
object (language)

Language passed in the request must be assigned to user.

required
object (Folder)
object (RelatedQuestions)
required
object (Versions)
object (Classifications)
object (ArticleAction)
object (CustomAttributes)
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

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