Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.
[
{
"title": "New Article 1",
"content": "This is my first article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
},
{
"title": "New Article 2",
"content": "This is my second article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
}
]The title of the article
The content of the article, for any Editor type, use this property
The ID of the category where the article will be created, CategoryId will be null for custom pages
The project version ID in which the article will be created
The position of the article in the category tree (By default, it will be placed at the bottom of the category)
The ID of the team account that will be marked as a contributor of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.
[
{
"title": "New Article 1",
"content": "This is my first article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
},
{
"title": "New Article 2",
"content": "This is my second article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
}
]The title of the article
The content of the article, for any Editor type, use this property
The ID of the category where the article will be created, CategoryId will be null for custom pages
The project version ID in which the article will be created
The position of the article in the category tree (By default, it will be placed at the bottom of the category)
The ID of the team account that will be marked as a contributor of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.
[
{
"title": "New Article 1",
"content": "This is my first article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
},
{
"title": "New Article 2",
"content": "This is my second article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
}
]The title of the article
The content of the article, for any Editor type, use this property
The ID of the category where the article will be created, CategoryId will be null for custom pages
The project version ID in which the article will be created
The position of the article in the category tree (By default, it will be placed at the bottom of the category)
The ID of the team account that will be marked as a contributor of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.
[
{
"title": "New Article 1",
"content": "This is my first article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
},
{
"title": "New Article 2",
"content": "This is my second article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
}
]The title of the article
The content of the article, for any Editor type, use this property
The ID of the category where the article will be created, CategoryId will be null for custom pages
The project version ID in which the article will be created
The position of the article in the category tree (By default, it will be placed at the bottom of the category)
The ID of the team account that will be marked as a contributor of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Success
The article has been created under the following category. you can use the article Id to view the article in the portal.
{
"data": [
{
"article_id": "d83f3388-7493-489f-ab51-249d4e6a25ce",
"success": true,
"details": "Successfully created article c1"
},
{
"article_id": "5cabbba1-fc2a-4f82-9dee-01759509b109",
"success": true,
"details": "Successfully created article c2"
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Bulk article create response
Article ID that has updated
Indicates if articles creation was successful
Additional information about articles creation status
Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information
Bad Request
Kindly check your user Id and perform the task again. Find your user Id at /v2/Teams.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Failed to create article c2\r\nError: The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly check the project_version_id from /v2/ProjectVersions and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Failed to create article c1\r\nError: The supplied workspace id 46f48bc7-760f-4b07-b2d2-fce4aa8ba2341 does not exist in your project..",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly check the category_id from /v2/ProjectVersions//categories and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Failed to create article c1\r\nError: Unable to find specified parent category with an id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly check the title is empty or null, and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The Title field is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information