Export a translation file of a specific language, and a specific file type, with possible filters

POST

https://api.walkme.com/public/v2/systems/SYSTEM_GUID/languages/LANGUAGE_GUID/export

Notes

  1. As a response, you will get the Job State Object back.
  2. For default language LANGUAGE_GUID=”default” can be used.
  3. If publishStatus is not provided, default value will be used (Example on the right).
{
  envId: 0,
  types: [ “published”, “publishedAndModified”, “draft” ]
}

PATH PARAMS


SYSTEM_GUID String

System GUID in the format of (8,4,4,4,12): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

LANGUAGE_GUID String

Language GUID in the format of (8,4,4,4,12): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX


BODY PARAMS


fileType String Required

The file type format to be exported.
Supported file types: XLIFF, XLSX, RESJSON

translationFilters Array of Objects

Filters for the export API, will contain the different filters that will be available for the exports

publishStatus Object

The available publish status attributes for the export


translationFilters

collectionName String Required

deployableId Number

Id of the deployable

deployableType Number

Type of the deployable

isWysiwygTranslationItem Boolean

Wysiwyg or regular translation item

languageType Number

relatedObjectId Number


publishStatus

envId Number Required

The Id of the Environment to be exported

types Array Required

The status of the content to be exported according to the selected envId as shown in the Editor.
Possible values: published, publishedAndModified, draft, archived.

{
    "fileType": "XLIFF"
}
curl --location --request POST 'https://api.walkme.com/public/v2/systems/<system_guid>/languages/<language_guid>/export' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileType": "XLIFF"
}'
<Job State Oblect>