Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This method permits to remove the workflow including all jobs from a specific document in a Codyt project.

URL

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

PARAMETERS

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:

tokenid

The token obtained on connection

string, Required

projectid

The project id

int, Required

documentidThe document idint, Required

targetlocales

Code Block
...&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.branchlocale

Optional.

To delete workflow/jobs for this specific target locale only. If not specified all workflows of the document are removed.

(The branch locale is always a locale defined in the project. In specific workflows (such as back translation) jobs may have pivot languages but they all are defined for a project target locale)

string,

Optional


RESULTS

The method returns no result.If the document already has a workflow you will get an error message.


RELATED METHODS

Assign workflow to document