API Reference

Export Translation File

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

Note

  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.

Please replace these parameters with your actual values and remove the brackets {SYSTEM_GUID} and {LANGUAGE_GUID}

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, XLIFF_STRICT, XLSX, RESJSON.
XLIFF_STRICT gives ability to validate xml against Walkme XLIFF Schema extension.

publishStatus Object

The available publish status attributes for the export

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.

{
  envId: 0,
  types: [ “published”, “publishedAndModified”, “draft” ]
}

Example:
https://api.walkme.com/public/v2/systems/{00000000-0000-0000-0000-000000000000}/languages/{00000000-0000-0000-0000-000000000000}/export 

{
    "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>