projects/{pid}/workflows/jobs/new

pid

The project’s ID.

int, Mandatory

mode

Defines the scope of the jobs:

• Project: This is the default value. The jobs will be for one or more documents (see documentIds).

• Segments: Specify a filter to select segments and those segments will be assigned to the jobs. There is no need to specify any documents.

• ProjectAndSegments: Specify both documents and a filter. The jobs will then include the documents but refer to just the filtered segments in those documents.

Note: With Segments you can even pull segments from other projects or translation memories. With ProjectAndSegments, your jobs look very “regular” and the editor will allow preview and other document-centric operations. This option is useful for “split big documents into chunks” scenarios.

string, Optional

documentIds

The documents to include in the jobs. These must be documents from the project. Mandatory if mode is Project or ProjectAndSegments. Optional otherwise.

int[], Optional

segments

Required if mode is Segments or ProjectAndSegments.

object, Optional

segments.scope

Defines the scope of segments to filter. See Scope (Object)

object, Mandatory

segments.query

Defines an optional filter on the segments within the scope. See Search and filter segments for how to construct this object.

object?, Optional

segments.maxSegments

Specify the maximum number of segments that should be selected. By default this is 1000. Jobs with too many segments may not be practical.

int, Optional

trgs

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

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

string[], Mandatory

workflowProfileId

An optional workflow profile ID. If null then the method uses the project’s profile (see the “Workflow & Supplier” page in the project).

int, Optional

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

startDate

Optional earliest start date for jobs. If null then this will be set for immediate start.

datetime?, Optional

startWorkflow

Optional boolean, default is true.

If true, the initial steps (jobs) in the workflow will be started (if assigned) or proposals will be sent out (if supplier groups are assigned in workflow profile).

bool, Optional

Instructions

Optional instructions added to each job. Visible to the workers.

string?, Optional

Comments

Optional internal comments added to each job. Not visible to workers (unless these are internal and have sufficient access rights)

string?, 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 “title” (name).

Example:

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

object[], 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