CRcrowdin
Translations

Build Project Directory Translation

Required scopes: project.source.file (Read only).

post/projects/{projectId}/translations/builds/directories/{directoryId}

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

directoryIdinteger required

Directory Identifier. Get via List Directories

Request body

targetLanguageIdsstring[]

Specify target languages for build. Get via List Supported Languages

  • Leave this field empty to build 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 approved strings

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

preserveFolderHierarchyboolean

Preserve folder hierarchy

Example request

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

Response

Directory build was successfully started

Example response

{
  "data": {
    "id": 2,
    "projectId": 2,
    "status": "finished",
    "progress": 100,
    "createdAt": "2019-09-19T15:10:43+00:00",
    "updatedAt": "2019-09-19T15:10:46+00:00",
    "finishedAt": "2019-09-19T15:10:46+00:00",
    "attributes": {
      "directoryId": 1,
      "targetLanguageIds": [
        "en"
      ],
      "exportStringsThatPassedWorkflow": true
    }
  }
}

Changes

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