- Print
- DarkLight
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
}
Filter to export Full/Part of the documenation
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
}
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
}
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
}
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
}
Area to export. It can be Project or Version or Category or Article
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.
Filter articles by language code
Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
If true, media files will not be included in the .zip file
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
}
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
}
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
}
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
}
Area to export. It can be Project or Version or Category or Article
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.
Filter articles by language code
Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
If true, media files will not be included in the .zip file
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
}
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
}
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
}
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
}
Area to export. It can be Project or Version or Category or Article
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.
Filter articles by language code
Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
If true, media files will not be included in the .zip file
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
}
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
}
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
}
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
}
Area to export. It can be Project or Version or Category or Article
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.
Filter articles by language code
Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
If true, media files will not be included in the .zip file
Status of the export
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": []
}
The ID of the export request. Use this ID to get export details
Current status of the export
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api resonse
Warning in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information
Bad Request
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": []
}
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": []
}
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": []
}
The ID of the export request. Use this ID to get export details
Current status of the export
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api resonse
Warning in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information