Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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

The document must be marked for translation and have no workflow yet.

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 the "Settings" section of 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.





  • No labels