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 Current »

Call this method to log the successful download and processing of a delivery.

Example: When a workflow is finished (“Work Finished”) you are ready to download the deliverable file. Then check contents and store the data in whatever place it needs to go. Finally, call the present method to change the workflow status from “Work Finished” to “Work Delivered”.

When a project manager reopens the workflow, the workflow status will change again, such as being reset to “Work in progress”. Wait again for the completion, download, store and log delivery…

URL

(POST) /api/projects/{pid}/workflows/{did}/status/{trg}/delivery/success

PARAMETERS

The URL parameters are:

pid

The project ID

int, Mandatory

did

The document ID

int, Mandatory

trg

The target language code

string, Mandatory

RESULTS

The method returns the workflow status and an acknowledgement:

  • changed: Boolean. True if the status could be changed to “Work delivered”.

  • status: The current workflow status (after the change).

  • statusTitle: Name of status.

Example 1: The status was not “Work finished” and thus could not be changed to “Work delivered”:

{
    "changed": false,
    "status": 0,
    "statusTitle": "Work in progress"
}

Example 2: The status could be changed:

{
    "changed": true,
    "status": 4,
    "statusTitle": "Work delivered"
}

  • No labels