Bulk add articles
  • Updated on 07 Aug 2019
  • 1 minute to read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Bulk add articles

  • Print
  • Share
  • Dark
    Light

POST/articles/bulkcreate

Adds list of articles


Header

Parameter Type Description
api_token string REST API key you can get it from Settings > API.

Body Parameters Array[]

Parameters highlighted in bold are mandatory

Parameter Type Description
title string Title of the article
category_id string The ID of the category where article will be created
project_version_id string The project version ID in which the article will be created
user_id string The ID of the user that will be marked as an author of this article
content string Markdown content of the article
order number The position of the article in the category tree (Default is end of the category)

Sample Request

[
    {
      "title":"My Article",
      "project_version_id":"7ba483c0-0929-4bb6-aa43-04a2f4bb8453",
      "user_id":"5ae331f74e60146b233512x2",
      "category_id":"650aec55-c0a7-42bf-862c-1eea02b96trt",
      "content" : "## My Header"
    },
    {
      "title":"My Article 2",
      "project_version_id":"7ba483c0-0929-4bb6-aa43-04a2f4bb8453",
      "user_id":"5ae331f74e60146b233512x2",
      "category_id":"650aec55-c0a7-42bf-862c-1eea02b96trt",
      "content" : "## My Header 2"
    }
]

Sample Response

The response will show if all articles have been created succesfully. The details property will include any errors and article title, after issues have been be fixed, articles can be resubmitted for further processing.

{
   "data":[
      {
         "success":false,
         "details":"Failed to create article Final\r\nError: System.Exception: The creating user with id 5ae331f74e633558c6, does not exist in your project"
      },
      {
         "success":true,
         "details":"Successfully created article Final"
      }
   ],
   "extension_data":null,
   "context":null,
   "success":true,
   "errors":[ ],
   "warnings":[ ],
   "information":[ ]
}

Response Data Array[]

Parameter Type Description
success boolean Indicates if article creation was successful
details string Additional information about article creation status
Was this article helpful?