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
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
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
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
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 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
Warning in the customer Api response
Information passed by the customer Api response