Assign workflow to document

This method permits to assign a workflow (jobs, deadlines, etc.) to a specific document in a Codyt project.

Note: The document must be marked for translation and have no workflow yet. Delete existing workflow using: Delete workflow from a document

The result of this operation will be:

  • Jobs are created as per workflow in the languages of the document (also see targetLocales) 
  • Jobs are assigned to suppliers as per workflow configuration.
  • Notifications are sent.

URL

(PUT) projects/{projectid}/documents/{documentid}/workflow?token=&workflowname=&targetlocales=&workflowstart=

PARAMETERS

tokenid

The token obtained on connection

string, Required

projectid

The project id

int, Required

documentidThe document idint, Required

targetlocales

Optional. If not set, then a workflow is assigned to all target locales of the document (these are specified when marking the document for translation).

Example:

...&targetlocales=fr,es

string, Optional

workflowstart

If not set then the workflow is kicked off immediately. Otherwise specify a future UTC date.

datetime, Optional

workflowname

Optional. The name of a workflow template configured in "Settings" > "Workflow templates" in Wordbee Translator.

If not specified, then the workflow configured in the project is used.

string,

Optional


RESULTS

The method returns no result.

If the document already has a workflow you will get an error message.


RELATED METHODS

Delete workflow from a document

Project workflow settings





Copyright Wordbee - Buzzin' Outside the Box since 2008