user-site

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

Show example

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": "2024-04-09T11:35:32Z",
    "before": "2024-04-09T11:35:32Z"
  }
}

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": "2024-04-09T11:35:32Z",
    "before": "2024-04-09T11:35:32Z"
  }
}

Collapse all

object

entity

string | null

version_id

Array of string | null

string

selected_languages

Array of object (LanguageMeta) | null

object

code

string | null

version_id

string | null

selected_categories

Array of object (CategoryMeta) | null

object

exclude_media_files

boolean

filter_by_article_modified_at

object (DateRange)

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

{
  "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": "2024-04-09T11:35:32Z",
    "before": "2024-04-09T11:35:32Z"
  }
}

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": "2024-04-09T11:35:32Z",
    "before": "2024-04-09T11:35:32Z"
  }
}

Collapse all

object

entity

string | null

version_id

Array of string | null

string

selected_languages

Array of object (LanguageMeta) | null

object

code

string | null

version_id

string | null

selected_categories

Array of object (CategoryMeta) | null

object

exclude_media_files

boolean

filter_by_article_modified_at

object (DateRange)

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

{
  "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": "2024-04-09T11:35:32Z",
    "before": "2024-04-09T11:35:32Z"
  }
}

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": "2024-04-09T11:35:32Z",
    "before": "2024-04-09T11:35:32Z"
  }
}

Collapse all

object

entity

string | null

version_id

Array of string | null

string

selected_languages

Array of object (LanguageMeta) | null

object

code

string | null

version_id

string | null

selected_categories

Array of object (CategoryMeta) | null

object

exclude_media_files

boolean

filter_by_article_modified_at

object (DateRange)

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

{
  "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": "2024-04-09T11:35:32Z",
    "before": "2024-04-09T11:35:32Z"
  }
}

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": "2024-04-09T11:35:32Z",
    "before": "2024-04-09T11:35:32Z"
  }
}

Collapse all

object

entity

string | null

version_id

Array of string | null

string

selected_languages

Array of object (LanguageMeta) | null

object

code

string | null

version_id

string | null

selected_categories

Array of object (CategoryMeta) | null

object

exclude_media_files

boolean

filter_by_article_modified_at

object (DateRange)

Responses

200

400

Show example

Status of the export

Collapse all

object

string | null

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

status

string | null

Current status of the export

ExampleInitiated

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

Show example

Bad Request

Collapse all

object

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object