user-site

Export - Complete Project

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
}

Export - One or more project versions

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
}

Export - One or more Category

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-03-08T10:40:05.4364233Z",
    "before": "2023-03-08T10:40:05.4364242Z"
  },
  "exclude_media_files": true
}

Export - One or more Article

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
}

Collapse all

object

entity

string Required

Area to export. It can be Project or Version or Category or Article

Min length1

Default"Project"

entity_ids

Array of string

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.

language_code

string

Filter articles by language code

filter_by_article_modified_at

object

after

string

Filter the articles which are all modified after the given date

before

string

Filter the articles which are all modified before the given date

exclude_media_files

boolean

If true, media files will not be included in the .zip file

Default"False"

Export - Complete Project

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
}

Export - One or more project versions

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
}

Export - One or more Category

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-03-08T10:40:05.4364233Z",
    "before": "2023-03-08T10:40:05.4364242Z"
  },
  "exclude_media_files": true
}

Export - One or more Article

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
}

Collapse all

object

entity

string Required

Area to export. It can be Project or Version or Category or Article

Min length1

Default"Project"

entity_ids

Array of string

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.

language_code

string

Filter articles by language code

filter_by_article_modified_at

object

after

string

Filter the articles which are all modified after the given date

before

string

Filter the articles which are all modified before the given date

exclude_media_files

boolean

If true, media files will not be included in the .zip file

Default"False"

Export - Complete Project

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
}

Export - One or more project versions

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
}

Export - One or more Category

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-03-08T10:40:05.4364233Z",
    "before": "2023-03-08T10:40:05.4364242Z"
  },
  "exclude_media_files": true
}

Export - One or more Article

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
}

Collapse all

object

entity

string Required

Area to export. It can be Project or Version or Category or Article

Min length1

Default"Project"

entity_ids

Array of string

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.

language_code

string

Filter articles by language code

filter_by_article_modified_at

object

after

string

Filter the articles which are all modified after the given date

before

string

Filter the articles which are all modified before the given date

exclude_media_files

boolean

If true, media files will not be included in the .zip file

Default"False"

Export - Complete Project

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
}

Export - One or more project versions

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
}

Export - One or more Category

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-03-08T10:40:05.4364233Z",
    "before": "2023-03-08T10:40:05.4364242Z"
  },
  "exclude_media_files": true
}

Export - One or more Article

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
}

Collapse all

object

entity

string Required

Area to export. It can be Project or Version or Category or Article

Min length1

Default"Project"

entity_ids

Array of string

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.

language_code

string

Filter articles by language code

filter_by_article_modified_at

object

after

string

Filter the articles which are all modified after the given date

before

string

Filter the articles which are all modified before the given date

exclude_media_files

boolean

If true, media files will not be included in the .zip file

Default"False"