Start a new export
- 29 May 2023
- 10 Minutes to read
- Contributors
- Print
- DarkLight
Start a new export
- Updated on 29 May 2023
- 10 Minutes to read
- Contributors
- Print
- DarkLight
Article Summary
Post
/v2/Project/Export
Sample requests:
POST /Export - Export all the versions in the documentation
{
"entity": "Project", // Version/Category/Article
"entity_ids": [], // should be empty array
"filter_by_article_modified_at": { // filter articles by modified at date range
"after": "2021-05-17T03:42:52.109Z",
"before": "2021-05-17T03:42:52.109Z"
},
"exclude_media_files": true // exculde media files on export
}
POST /Export - Export specific versions in the documentation
{
"entity": "Version",
"entity_ids": ["695782c0-a0a3-4664-9bfd-0197d26379ee"], // Pass ',' separated values for multiple versions
"filter_by_article_modified_at": null,
"exclude_media_files": true
}
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Body parameters
Filter to export Full/Part of the documenation
Export - Complete Project
To export the complete project set Entity as Project. entity_ids should be an empty array in this case. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Project",
"entity_ids": [
"c7fa6558-7607-4594-ac82-e9b5b96aa8ab",
"6558-7607-4594-ac82-e9b5b96aa8sfsd"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}Export - One or more project versions
To export one or more project versions set entity as Version. In entity_ids pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Version",
"entity_ids": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}Export - One or more Category
To export one or more Category set entity as Category. In entity_ids pass an array of Category ids. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Category",
"entity_ids": [
"v4e4-7607-4594-ac82-dg43f4tvw",
"a5sa8-7607-r594-af82-df3e3bdfve34"
],
"language_code": "en",
"filter_by_article_modified_at": {
"after": "2023-05-29T10:34:06.6571527Z",
"before": "2023-05-29T10:34:06.6571539Z"
},
"exclude_media_files": true
}Export - One or more Article
To export one or more Article set entity as Article. In entity_ids pass an array of Article ids. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Article",
"entity_ids": [
"4f58-7f47-4594-a4ds-e9b56a2w3",
"ve558-fv607-4e394-ac82-dfv34rfe"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}object
entity
string Required
Area to export. It can be Project or Version or Category or Article
Min length1
Default"Project"
entity_ids
Array of string
IDs of the entities.For example, if the entity is Category then the fields have to be category IDs.This is required for entities other than Project.
language_code
string
Filter articles by language code
filter_by_article_modified_at
object
after
string
Filter the articles which are all modified after the given date
before
string
Filter the articles which are all modified before the given date
exclude_media_files
boolean
If true, media files will not be included in the .zip file
Default"False"
Export - Complete Project
To export the complete project set Entity as Project. entity_ids should be an empty array in this case. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Project",
"entity_ids": [
"c7fa6558-7607-4594-ac82-e9b5b96aa8ab",
"6558-7607-4594-ac82-e9b5b96aa8sfsd"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}Export - One or more project versions
To export one or more project versions set entity as Version. In entity_ids pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Version",
"entity_ids": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}Export - One or more Category
To export one or more Category set entity as Category. In entity_ids pass an array of Category ids. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Category",
"entity_ids": [
"v4e4-7607-4594-ac82-dg43f4tvw",
"a5sa8-7607-r594-af82-df3e3bdfve34"
],
"language_code": "en",
"filter_by_article_modified_at": {
"after": "2023-05-29T10:34:06.6571527Z",
"before": "2023-05-29T10:34:06.6571539Z"
},
"exclude_media_files": true
}Export - One or more Article
To export one or more Article set entity as Article. In entity_ids pass an array of Article ids. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Article",
"entity_ids": [
"4f58-7f47-4594-a4ds-e9b56a2w3",
"ve558-fv607-4e394-ac82-dfv34rfe"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}object
entity
string Required
Area to export. It can be Project or Version or Category or Article
Min length1
Default"Project"
entity_ids
Array of string
IDs of the entities.For example, if the entity is Category then the fields have to be category IDs.This is required for entities other than Project.
language_code
string
Filter articles by language code
filter_by_article_modified_at
object
after
string
Filter the articles which are all modified after the given date
before
string
Filter the articles which are all modified before the given date
exclude_media_files
boolean
If true, media files will not be included in the .zip file
Default"False"
Export - Complete Project
To export the complete project set Entity as Project. entity_ids should be an empty array in this case. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Project",
"entity_ids": [
"c7fa6558-7607-4594-ac82-e9b5b96aa8ab",
"6558-7607-4594-ac82-e9b5b96aa8sfsd"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}Export - One or more project versions
To export one or more project versions set entity as Version. In entity_ids pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Version",
"entity_ids": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}Export - One or more Category
To export one or more Category set entity as Category. In entity_ids pass an array of Category ids. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Category",
"entity_ids": [
"v4e4-7607-4594-ac82-dg43f4tvw",
"a5sa8-7607-r594-af82-df3e3bdfve34"
],
"language_code": "en",
"filter_by_article_modified_at": {
"after": "2023-05-29T10:34:06.6571527Z",
"before": "2023-05-29T10:34:06.6571539Z"
},
"exclude_media_files": true
}Export - One or more Article
To export one or more Article set entity as Article. In entity_ids pass an array of Article ids. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Article",
"entity_ids": [
"4f58-7f47-4594-a4ds-e9b56a2w3",
"ve558-fv607-4e394-ac82-dfv34rfe"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}object
entity
string Required
Area to export. It can be Project or Version or Category or Article
Min length1
Default"Project"
entity_ids
Array of string
IDs of the entities.For example, if the entity is Category then the fields have to be category IDs.This is required for entities other than Project.
language_code
string
Filter articles by language code
filter_by_article_modified_at
object
after
string
Filter the articles which are all modified after the given date
before
string
Filter the articles which are all modified before the given date
exclude_media_files
boolean
If true, media files will not be included in the .zip file
Default"False"
Export - Complete Project
To export the complete project set Entity as Project. entity_ids should be an empty array in this case. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Project",
"entity_ids": [
"c7fa6558-7607-4594-ac82-e9b5b96aa8ab",
"6558-7607-4594-ac82-e9b5b96aa8sfsd"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}Export - One or more project versions
To export one or more project versions set entity as Version. In entity_ids pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Version",
"entity_ids": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}Export - One or more Category
To export one or more Category set entity as Category. In entity_ids pass an array of Category ids. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Category",
"entity_ids": [
"v4e4-7607-4594-ac82-dg43f4tvw",
"a5sa8-7607-r594-af82-df3e3bdfve34"
],
"language_code": "en",
"filter_by_article_modified_at": {
"after": "2023-05-29T10:34:06.6571527Z",
"before": "2023-05-29T10:34:06.6571539Z"
},
"exclude_media_files": true
}Export - One or more Article
To export one or more Article set entity as Article. In entity_ids pass an array of Article ids. Also modify the entity_ids according to the existing user, the example here shown is random entity_ids.
{
"entity": "Article",
"entity_ids": [
"4f58-7f47-4594-a4ds-e9b56a2w3",
"ve558-fv607-4e394-ac82-dfv34rfe"
],
"language_code": null,
"filter_by_article_modified_at": null,
"exclude_media_files": true
}object
entity
string Required
Area to export. It can be Project or Version or Category or Article
Min length1
Default"Project"
entity_ids
Array of string
IDs of the entities.For example, if the entity is Category then the fields have to be category IDs.This is required for entities other than Project.
language_code
string
Filter articles by language code
filter_by_article_modified_at
object
after
string
Filter the articles which are all modified after the given date
before
string
Filter the articles which are all modified before the given date
exclude_media_files
boolean
If true, media files will not be included in the .zip file
Default"False"
Responses
200
Status of the export
Export Documentation - 200 Status response.
The below example shows the status response for export documentation. Here the export for a new documentation will be triggered.
{
"id": "69c2a0ee-bbac-4563-921c-08efef575b64",
"status": "Initiated",
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}object
id
string
The ID of the export request. Use this ID to get export details
status
string
Current status of the export
extension_data
object
success
boolean
Status indication for customer API response
errors
Array of object
Errors in the customer API response
object
extension_data
stack_trace
string
Stack trace for error response message
description
string
Description for error cause
error_code
string
Error code for Api resonse
custom_data
object
warnings
Array of object
Warning in the customer API response
object
extension_data
description
string
Warning description
warning_code
string
warning code for customer Api base response
information
Array of object
Information passed by the customer API response
object
extension_data
description
string
status description for customer Api response information
400
Bad Request
Export Documentation - 400 Status response invalid language code.
The below example shows the error status response says invalid language code.
{
"id": null,
"status": null,
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The LanguageCode field is required",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Export Documentation - 400 Status response for reaching export documentation limit.
The below example shows the error status that you had reached the limit for the day.
{
"id": null,
"status": null,
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Export API request limit(2) is reached for the day.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Export Documentation - 400 Status response for invalid entity field.
The below example shows the error status that the entity field should not be empty or invalid. Entity options are - 1.Project 2.Version , 3.Category , 4.Article
{
"id": null,
"status": null,
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The Entity field is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}object
id
string
The ID of the export request. Use this ID to get export details
status
string
Current status of the export
extension_data
object
success
boolean
Status indication for customer API response
errors
Array of object
Errors in the customer API response
object
extension_data
stack_trace
string
Stack trace for error response message
description
string
Description for error cause
error_code
string
Error code for Api resonse
custom_data
object
warnings
Array of object
Warning in the customer API response
object
extension_data
description
string
Warning description
warning_code
string
warning code for customer Api base response
information
Array of object
Information passed by the customer API response
object
extension_data
description
string
status description for customer Api response information
Was this article helpful?