Page Comparison

files

An array containing one or more records, each describing a file to be uploaded. These records include a unique token referencing the uploaded file. For example:

[
    {
        "token": "77ca3562-ff01f5882dd1",
        "name": "myfolder/myfile.docx"
    }
]

See detailed description further down.

object[], Mandatory

src

The source language code. This must be a valid project language.

string, Mandatory

trgs

The languages to translate to. These must be valid project languages. Example:

"trgs": [ "es-ES", "fr-FR" ]

string[], Mandatory

deadline

Optional deadline for completion of work. Deadlines are assigned to the jobs that are created with the workflow. Example:

"deadline": "2024-04-03T06:00:00Z"

datetime?, Optional

workflow

Optional, selects "Default" if not specified. Fine-tune how workflows are created:

• Default : Create jobs according to the project’s Workflow & Suppliers configuration. Recommended value.

• None : Do not create any jobs.

string, Optional

allowUpdates

Optional. Default is true.

• true: You are allowed to replace existing files with new versions. In such cases, the file is replaced, a new set of jobs will be created and the new jobs will be assigned to the same workers as before.

• false: Any attempt to replace an existing file will return an error.

bool?, Optional

jobsCfs

Optional custom fields to assign to all jobs created for a file’s workflow. See Custom Field Collection Record for details. Note: You reference a CF by either its “id” or its “name”“title” (name).

Example:

"jobsCfs": {
    fields": [
      { "title": "Activity", "value": "Fulltime" },
      { "id": 4, "value": "A-221" }    
    ]
}

object[], Optional

maxFilesInJob

This parameter is applicable only to Standard projects, with a default value of 100. The maximum is 1000.

It is designed for scenarios involving the submission of a large number of files. The system will group the files into jobs, ensuring that no single job contains more than the specified number of files. If the total exceeds this limit, multiple jobs and workflows will be created automatically.

Note: For Codyt jobs, this parameter is not applicable, as Codyt always creates one workflow per file.

int, Optional

callbackurl
callback

Specify a URL which will be called upon success or failure of operation. This makes polling for operation status unnecessary. See Callbacks (with asynchronous operations)

Optional

token

Use API media/upload to upload a file. It returns the token to be included here. Note: The upload of your file or files must be done prior to calling the present method.

If you need to upload multiple files to get multiple tokens, use the multi-upload: media/upload/multi

string, Mandatory

name

The file name, with or without folders. The file will be stored with this name & folders in the project. Some valid filenames:

my-file.docx
marketing/section1/presentation.ppt
marketing\\section1\\presentation.ppt
strings.product.json

Note: When using “\” make sure to escape with “\\”. This is not necessary when using the forward “/” as folder separator.

string, Mandatory

Optional parameters

formatId

Optional document format configuration to be used for extracting content from the file. See Document formats to enumerate all existing file formats.

Normally, you do not need to override the defaults: By default, the system selects the filter from the project’s File Filter configuration.

int?, Optional

disableMt

Optional, default is false. If you explicitly want to prevent machine translation when preparing the file, set this property to true. Machine translation is enabled or disabled in the project’s word count profile.

bool, Optional

reference

Optional sender ID for the document. For example, this can hold an identifier you assign to the document outside of Wordbee.

string?, Optional

comments

Optional comments added to the document and shown in the translation editor.

string?, Optional

attachments

Optional array of files to attach to the document. This can be screenshots, reference material or more. Up to 10 files can be attached. See details below.

You can also upload attachments at a later time using Manage attachments

object[]?, Optional

token

Use API media/upload to upload a file. It returns the token to be included here. Note: The upload of your file or files must be done prior to calling the present method.

If you need to upload multiple files to get multiple tokens, use the multi-upload: media/upload/multi

string, Mandatory

name

The attachment file name, with or without folders.

string, Mandatory

locale

The language code of the attachment. Must be a source or a target language of the present request.

string, Mandatory