Start a new export
  • 26 Sep 2023
  • 9 Minutes to read
  • Contributors
  • Dark
    Light

Start a new export

  • Dark
    Light

Article Summary

Post
/v2/Project/Export

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

}

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. 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
}
Export - One or more project versions

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
}
Export - One or more Category

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": "2023-09-26T06:34:59.5527974Z",
    "before": "2023-09-26T06:34:59.5527984Z"
  }
}
Export - One or more Language

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": "2023-09-26T06:34:59.5528391Z",
    "before": "2023-09-26T06:34:59.5528392Z"
  }
}
Expand All
object
entity
string
version_id
Array of string
string
selected_languages
Array of object (LanguageMeta)
object
code
string
id
string
version_id
string
selected_categories
Array of object (CategoryMeta)
object
language_id
string
id
string
version_id
string
exclude_media_files
boolean
filter_by_article_modified_at
object (DateRange)
after
string (date-time)

Filter the articles which are all modified after the given date

before
string (date-time)

Filter the articles which are all modified before the given date

Export - Complete Project

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
}
Export - One or more project versions

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
}
Export - One or more Category

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": "2023-09-26T06:34:59.5527974Z",
    "before": "2023-09-26T06:34:59.5527984Z"
  }
}
Export - One or more Language

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": "2023-09-26T06:34:59.5528391Z",
    "before": "2023-09-26T06:34:59.5528392Z"
  }
}
Expand All
object
entity
string
version_id
Array of string
string
selected_languages
Array of object (LanguageMeta)
object
code
string
id
string
version_id
string
selected_categories
Array of object (CategoryMeta)
object
language_id
string
id
string
version_id
string
exclude_media_files
boolean
filter_by_article_modified_at
object (DateRange)
after
string (date-time)

Filter the articles which are all modified after the given date

before
string (date-time)

Filter the articles which are all modified before the given date

Export - Complete Project

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
}
Export - One or more project versions

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
}
Export - One or more Category

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": "2023-09-26T06:34:59.5527974Z",
    "before": "2023-09-26T06:34:59.5527984Z"
  }
}
Export - One or more Language

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": "2023-09-26T06:34:59.5528391Z",
    "before": "2023-09-26T06:34:59.5528392Z"
  }
}
Expand All
object
entity
string
version_id
Array of string
string
selected_languages
Array of object (LanguageMeta)
object
code
string
id
string
version_id
string
selected_categories
Array of object (CategoryMeta)
object
language_id
string
id
string
version_id
string
exclude_media_files
boolean
filter_by_article_modified_at
object (DateRange)
after
string (date-time)

Filter the articles which are all modified after the given date

before
string (date-time)

Filter the articles which are all modified before the given date

Export - Complete Project

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
}
Export - One or more project versions

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
}
Export - One or more Category

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": "2023-09-26T06:34:59.5527974Z",
    "before": "2023-09-26T06:34:59.5527984Z"
  }
}
Export - One or more Language

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": "2023-09-26T06:34:59.5528391Z",
    "before": "2023-09-26T06:34:59.5528392Z"
  }
}
Expand All
object
entity
string
version_id
Array of string
string
selected_languages
Array of object (LanguageMeta)
object
code
string
id
string
version_id
string
selected_categories
Array of object (CategoryMeta)
object
language_id
string
id
string
version_id
string
exclude_media_files
boolean
filter_by_article_modified_at
object (DateRange)
after
string (date-time)

Filter the articles which are all modified after the given date

before
string (date-time)

Filter the articles which are all modified before the given date

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": []
}
Expand All
object
id
string

The ID of the export request. Use this ID to get export details

status
string

Current status of the export

ExampleInitiated
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
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 (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
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": []
}
Expand All
object
id
string

The ID of the export request. Use this ID to get export details

status
string

Current status of the export

ExampleInitiated
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
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 (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

status description for customer Api response information


Was this article helpful?