Start a workflow process

post/workflows/{workflowId}/processes

Starts a process instance of a workflow definition.

Request Samples

1

Response Samples

1{
2 "links": [
3 {
4 "method": "GET",
5 "rel": "self",
6 "href": "/workflows/processes",
7 "uri": "/workflows/processes",
8 "type": "application/vnd.sas.fcs.workflow.workflowProcess"
9 }
10 ],
11 "name": "workflowProcesses",
12 "accept": "application/vnd.sas.investigation.workflow.process",
13 "start": 0,
14 "count": 1,
15 "items": [
16 {
17 "links": [
18 {
19 "method": "GET",
20 "rel": "self",
21 "href": "/workflows/processes/processes/5ef6f52f-a5fa-11e8-9397-0242ac111543",
22 "uri": "/workflows/processes/processes/5ef6f52f-a5fa-11e8-9397-0242ac111543",
23 "type": "application/vnd.sas.investigation.workflow.process",
24 "responseType": "application/vnd.sas.investigation.workflow.process+json"
25 },
26 {
27 "method": "PUT",
28 "rel": "suspend",
29 "href": "/workflows/processes/processes/5ef6f52f-a5fa-11e8-9397-0242ac111543/suspended",
30 "uri": "/workflows/processes/processes/5ef6f52f-a5fa-11e8-9397-0242ac111543/suspended"
31 },
32 {
33 "method": "PUT",
34 "rel": "resume",
35 "href": "/workflows/processes/processes/5ef6f52f-a5fa-11e8-9397-0242ac111543/resumed",
36 "uri": "/workflows/processes/processes/5ef6f52f-a5fa-11e8-9397-0242ac111543/resumed"
37 },
38 {
39 "method": "DELETE",
40 "rel": "cancel",
41 "href": "/workflows/processes/processes/5ef6f52f-a5fa-11e8-9397-0242ac111543",
42 "uri": "/workflows/processes/processes/5ef6f52f-a5fa-11e8-9397-0242ac111543"
43 }
44 ],
45 "id": "5ef6f52f-a5fa-11e8-9397-0242ac111543"
46 }
47 ],
48 "limit": 1,
49 "version": 2
50}

Path Parameters

NameTypeRequiredDescription
workflowId
string
true

The ID of the workflow process.

Request Body

The name of the entity instance.

A representation of a workflow instance's context.

NameTypeRequiredDescription
variables
object
false

A map of the workflow variables for this instance.

entityInstanceId
string
false

The ID of the entity instance.

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

The request was invalid.

Schema
404Not Found

No workflow definition exists at the requested path.

Schema