Translations

Export Bundle

Required scopes: project.translation (Read only).

post/projects/{projectId}/bundles/{bundleId}/exports

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

bundleIdinteger required

Bundle Identifier. Get via List Bundles

Request body

targetLanguageIdsstring[]

Specify target languages for export. Get via List Supported Languages

  • Leave this field empty to export all target languages
skipUntranslatedStringsboolean

Defines whether to export only translated strings

Note: true value can't be used with skipUntranslatedFiles=true in same request

skipUntranslatedFilesboolean

Defines whether to export only translated files

Note: true value can't be used with skipUntranslatedStrings=true in same request

exportWithMinApprovalsCountinteger

Defines whether to export only strings with a minimum number of approvals

Note: value greater than 0 can't be used with exportStringsThatPassedWorkflow=true in same request

exportStringsThatPassedWorkflowboolean

Defines whether to export only strings that passed workflow

Note: true value can't be used with exportWithMinApprovalsCount > 0 in same request or in projects without an assigned workflow

Example request

{
  "targetLanguageIds": [
    "uk"
  ],
  "exportStringsThatPassedWorkflow": true
}

Response

Bundle export was successfully started

Example response

{
  "data": {
    "identifier": "50fb3506-4127-4ba8-8296-f97dc7e3e0c3",
    "status": "finished",
    "progress": 100,
    "attributes": {
      "bundleId": 38,
      "targetLanguageIds": [
        "uk"
      ],
      "exportStringsThatPassedWorkflow": true
    },
    "createdAt": "2019-09-23T11:26:54+00:00",
    "updatedAt": "2019-09-23T11:26:54+00:00",
    "startedAt": "2019-09-23T11:26:54+00:00",
    "finishedAt": "2019-09-23T11:26:54+00:00",
    "eta": "1 second"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.