settings/workflows/{id}

Get details for a workflow template with given ID.

URL

(GET) /api/settings/workflows/{id}

PARAMETERS

URL parameters are:

id

The unique ID of the workflow template.

Use settings/workflows/list to enumerate templates and get IDs and names.

int, Mandatory

RESULTS

The result is a JSON object with the template properties.

NOTE:

At this point, we do not document the properties, they are currently for internal use.

However, most of them are self-descriptive.

EXAMPLES

A typical workflow may look like this:

{
    "details": {
        "fixedAutoCost": true,
        "crowdAutoCost": true,
        "isReadOnly": false,
        "startWorkflow": true,
        "autoConsolidate": false,
        "autoDeliver": false,
        "autoDeliverRename": "NoChange",
        "autoDeliverFolder": "{locale}",
        "completeProjectWhenJobsAreDone": false,
        "finishOrderWhenProjectIsComplete": false,
        "deliverableCreate": false,
        "deliverableCreateCL": false,
        "deliverableSkipIfExists": false,
        "createSupplierInvoice": false,
        "keepSameWorkflowBetweenFilesVersions": true,
        "ca": {
            "mode": "None",
            "xprofiles": [],
            "xinternals": false,
            "xmultilogins": true,
            "xclients": true
        },
        "deadlineMode": 0,
        "deadlineReminderHours": null,
        "flex": {
            "notifySuppliers": false,
            "reopenJobs": true,
            "clientCost": false,
            "clientInvStatus": 10,
            "clientInvTasks": [
                "TR"
            ],
            "supplierCost": false,
            "supplierInvStatus": 10
        },
        "steps": {
            "*": [
                {
                    "id": 1,
                    "task": "TR",
                    "alloc": 0,
                    "leadHours": 0,
                    "wordsPerDay": 0,
                    "allocGroups": [
                        {
                            "id": 0,
                            "delayh": 0.0
                        }
                    ],
                    "predecessors": [],
                    "input": "s",
                    "inputv": null,
                    "output": "t",
                    "outputv": null,
                    "enabledForClient": false,
                    "includeDeadlineCompletionDates": false,
                    "enabledPublishOpeningsUponActive": false,
                    "columns": [
                        {
                            "field": "text",
                            "locale": "_s_",
                            "id": null,
                            "locked": true,
                            "localet": "Source language",
                            "fieldName": null,
                            "title": "Source language",
                            "useForSource": false
                        },
                        {
                            "field": "text",
                            "locale": "_t_",
                            "id": null,
                            "locked": true,
                            "localet": "Target language",
                            "fieldName": null,
                            "title": "Target language",
                            "useForSource": false
                        }
                    ],
                    "requireQAToCompleteJobs": false,
                    "QAProfileRequired": 0,
                    "QAOnDoneId": null,
                    "deadlineOffsetHours": 0,
                    "conditions": null
                },
                {
                    "id": 2,
                    "task": "RV",
                    "alloc": 0,
                    "leadHours": 0,
                    "wordsPerDay": 0,
                    "allocGroups": [
                        {
                            "id": 0,
                            "delayh": 0.0
                        }
                    ],
                    "predecessors": [
                        1
                    ],
                    "input": "s",
                    "inputv": null,
                    "output": "t",
                    "outputv": null,
                    "enabledForClient": false,
                    "includeDeadlineCompletionDates": false,
                    "enabledPublishOpeningsUponActive": false,
                    "columns": [
                        {
                            "field": "text",
                            "locale": "_s_",
                            "id": null,
                            "locked": true,
                            "localet": "Source language",
                            "fieldName": null,
                            "title": "Source language",
                            "useForSource": false
                        },
                        {
                            "field": "text",
                            "locale": "_t_",
                            "id": null,
                            "locked": true,
                            "localet": "Target language",
                            "fieldName": null,
                            "title": "Target language",
                            "useForSource": false
                        }
                    ],
                    "requireQAToCompleteJobs": false,
                    "QAProfileRequired": 0,
                    "QAOnDoneId": null,
                    "deadlineOffsetHours": 0,
                    "conditions": null
                }
            ]
        }
    }
}