Sample requests:
POST /Export - Export all the versions in the documentation { "entity": "Project", // Project / version "versionId": [], // should be empty array "SelectedLanguages":[], "SelectedCategories":[], "FilterByArticleModifiedAt": { // filter articles by modified at date range "after": "2021-05-17T03:42:52.109Z", "before": "2021-05-17T03:42:52.109Z" }, "excludeMediaFiles": true // exculde media files on export }
POST /Export - Export specific versions in the documentation { "entity": "Version", // Project / version "versionId": ["695782c0-a0a3-4664-9bfd-0197d26379ee"], "SelectedLanguages":[], "SelectedCategories":[], "FilterByArticleModifiedAt": { // filter articles by modified at date range "after": "2021-05-17T03:42:52.109Z", "before": "2021-05-17T03:42:52.109Z" }, "excludeMediaFiles": true // exculde media files on export }
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Filter to export Full/Part of the documenation
To export the complete project set Entity as Project. versionId should be an empty array in this case.
{
"entity": "Project",
"version_id": [],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null
}To export one or more project versions set entity as Version. In VersionId pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the version according to the existing user, the example here shown is random versionId.
{
"entity": "Version",
"version_id": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null
}To export one or more Category, In SelectedCategory field, add categoryId (Id), LanguageId and VersionId. Set entity as Version and add versionIds to versionId field.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": null,
"selected_categories": [
{
"language_id": "",
"id": "",
"version_id": ""
},
{
"language_id": "",
"id": "",
"version_id": ""
}
],
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T02:30:00Z",
"before": "2024-06-13T02:30:00Z"
}
}To export one or more Language set entity as Version. In SelectedLanguages pass LanguageId (Id), Code , versionId.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": [
{
"code": "",
"id": "",
"version_id": ""
},
{
"code": "",
"id": "",
"version_id": ""
}
],
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T02:30:00Z",
"before": "2024-06-13T02:30:00Z"
}
}Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
To export the complete project set Entity as Project. versionId should be an empty array in this case.
{
"entity": "Project",
"version_id": [],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null
}To export one or more project versions set entity as Version. In VersionId pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the version according to the existing user, the example here shown is random versionId.
{
"entity": "Version",
"version_id": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null
}To export one or more Category, In SelectedCategory field, add categoryId (Id), LanguageId and VersionId. Set entity as Version and add versionIds to versionId field.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": null,
"selected_categories": [
{
"language_id": "",
"id": "",
"version_id": ""
},
{
"language_id": "",
"id": "",
"version_id": ""
}
],
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T02:30:00Z",
"before": "2024-06-13T02:30:00Z"
}
}To export one or more Language set entity as Version. In SelectedLanguages pass LanguageId (Id), Code , versionId.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": [
{
"code": "",
"id": "",
"version_id": ""
},
{
"code": "",
"id": "",
"version_id": ""
}
],
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T02:30:00Z",
"before": "2024-06-13T02:30:00Z"
}
}Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
To export the complete project set Entity as Project. versionId should be an empty array in this case.
{
"entity": "Project",
"version_id": [],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null
}To export one or more project versions set entity as Version. In VersionId pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the version according to the existing user, the example here shown is random versionId.
{
"entity": "Version",
"version_id": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null
}To export one or more Category, In SelectedCategory field, add categoryId (Id), LanguageId and VersionId. Set entity as Version and add versionIds to versionId field.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": null,
"selected_categories": [
{
"language_id": "",
"id": "",
"version_id": ""
},
{
"language_id": "",
"id": "",
"version_id": ""
}
],
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T02:30:00Z",
"before": "2024-06-13T02:30:00Z"
}
}To export one or more Language set entity as Version. In SelectedLanguages pass LanguageId (Id), Code , versionId.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": [
{
"code": "",
"id": "",
"version_id": ""
},
{
"code": "",
"id": "",
"version_id": ""
}
],
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T02:30:00Z",
"before": "2024-06-13T02:30:00Z"
}
}Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
To export the complete project set Entity as Project. versionId should be an empty array in this case.
{
"entity": "Project",
"version_id": [],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null
}To export one or more project versions set entity as Version. In VersionId pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the version according to the existing user, the example here shown is random versionId.
{
"entity": "Version",
"version_id": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null
}To export one or more Category, In SelectedCategory field, add categoryId (Id), LanguageId and VersionId. Set entity as Version and add versionIds to versionId field.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": null,
"selected_categories": [
{
"language_id": "",
"id": "",
"version_id": ""
},
{
"language_id": "",
"id": "",
"version_id": ""
}
],
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T02:30:00Z",
"before": "2024-06-13T02:30:00Z"
}
}To export one or more Language set entity as Version. In SelectedLanguages pass LanguageId (Id), Code , versionId.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": [
{
"code": "",
"id": "",
"version_id": ""
},
{
"code": "",
"id": "",
"version_id": ""
}
],
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T02:30:00Z",
"before": "2024-06-13T02:30:00Z"
}
}Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
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 response
Warnings 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.
{
"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.
{
"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
{
"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": []
}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 response
Warnings 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