Get the details for the specified workflow definition

get/workflows/{workflowId}

Retrieves the details for the specified workflow definition.

Request Samples

1

Response Samples

1{
2 "links": [
3 {
4 "method": "GET",
5 "rel": "self",
6 "href": "/workflows/workflows/intel_report_workflow:1:f17ee9e4-a5ff-11e8-9397-0242ac110013",
7 "uri": "/workflows/workflows/intel_report_workflow:1:f17ee9e4-a5ff-11e8-9397-0242ac110013",
8 "type": "application/vnd.sas.investigation.workflow.workflow",
9 "responseType": "application/vnd.sas.investigation.workflow.workflow+json"
10 },
11 {
12 "method": "PUT",
13 "rel": "create new version",
14 "href": "/workflows/workflows/intel_report_workflow:1:f17ee9e4-a5ff-11e8-9397-0242ac110013",
15 "uri": "/workflows/workflows/intel_report_workflow:1:f17ee9e4-a5ff-11e8-9397-0242ac110013",
16 "type": "application/vnd.sas.investigation.workflow.workflow",
17 "responseType": "application/vnd.sas.investigation.workflow.workflow+json"
18 }
19 ],
20 "version": 1,
21 "entityId": 100515,
22 "entityName": "intel_report",
23 "entityLabel": "Intel Report",
24 "id": "intel_report_workflow:1:f17ee9e4-a5ff-11e8-9397-0242ac110013",
25 "labelResource": "svi.workflow.intel_report.1534937931623.label.txt",
26 "descriptionResource": "svi.workflow.intel_report.1534937931623.description.txt",
27 "graphicalModel": "{\"linkFromPortIdProperty\":\"fromPort\",\"linkToPortIdProperty\":\"toPort\",\"modelData\":{\"version\":10.21,\"entityIdsUpdated\":true},\"nodeDataArray\":[{\"key\":\"StartEvent1534937812963\",\"category\":\"event\",\"text\":\"Start\",\"textResource\":\"svi.workflow.intel_report.1534937931623.StartEvent1534937812963.name.txt\",\"item\":\"StartEvent\",\"descriptionResource\":\"svi.workflow.intel_report.1534937931623.StartEvent1534937812963.description.txt\",\"loc\":\"0 0\"},{\"key\":\"UserTask1534937831345\",\"category\":\"activity\",\"text\":\"User Task\",\"textResource\":\"svi.workflow.intel_report.1534937931623.UserTask1534937831345.name.txt\",\"item\":\"UserTask\",\"descriptionResource\":\"svi.workflow.intel_report.1534937931623.UserTask1534937831345.description.txt\",\"participants\":[{\"id\":\"user2\",\"type\":\"USER\",\"name\":\"Test user2\"},{\"id\":\"sviusrs\",\"type\":\"GROUP\",\"name\":\"Visual Investigator Users\"}],\"loc\":\"0.5 105\",\"size\":{\"width\":200,\"height\":70,\"class\":\"go.Size\"},\"taskActions\":[{\"id\":\"taskOption1534937831345\",\"name\":\"Completed\",\"processVariables\":[],\"entityFieldVariables\":[],\"nameResource\":\"svi.workflow.intel_report.1534937931623.UserTask1534937831345.action.taskOption1534937831345.name.txt\",\"value\":\"taskOption1534937831345\"}]},{\"key\":\"EndEvent1534937834926\",\"category\":\"event\",\"text\":\"End\",\"textResource\":\"svi.workflow.intel_report.1534937931623.EndEvent1534937834926.name.txt\",\"item\":\"EndEvent\",\"descriptionResource\":\"svi.workflow.intel_report.1534937931623.EndEvent1534937834926.description.txt\",\"loc\":\"0.5 335\"}],\"linkDataArray\":[{\"from\":\"StartEvent1534937812963\",\"to\":\"UserTask1534937831345\",\"visible\":true,\"fromPort\":\"bottomPort\",\"toPort\":\"topPort\",\"points\":[0,25,0,55,0,55,0,42,0,42,0,72],\"text\":\"\",\"textResource\":\"svi.workflow.intel_report.1534937931623.StartEvent1534937812963_UserTask1534937831345.name.txt\",\"descriptionResource\":\"svi.workflow.intel_report.1534937931623.StartEvent1534937812963_UserTask1534937831345.description.txt\"},{\"from\":\"UserTask1534937831345\",\"to\":\"EndEvent1534937834926\",\"fromPort\":\"bottomPort\",\"toPort\":\"topPort\",\"points\":[0,137,0,167,0,224,1,224,1,282,1,312],\"textResource\":\"svi.workflow.intel_report.1534937931623.UserTask1534937831345_EndEvent1534937834926.name.txt\",\"key\":\"UserTask1534937831345_EndEvent1534937834926\",\"descriptionResource\":\"svi.workflow.intel_report.1534937931623.UserTask1534937831345_EndEvent1534937834926.description.txt\"}],\"class\":\"go.GraphLinksModel\"}",
28 "userDefinedProcessVariables": [
29 {
30 "id": "WorkflowVariable1",
31 "name": "AUTO_ASSIGN_VAR",
32 "label": "AUTO_ASSIGN_VAR",
33 "defaultValue": "[{\"id\":\"user2\",\"type\":\"user\"}]",
34 "type": "USER_GROUP",
35 "isEntity": false,
36 "userSelectionStrategy": "USERS",
37 "allowMultipleSelections": false
38 },
39 {
40 "id": "WorkflowVariable2",
41 "name": "GET_RUNNING_TASK_USER",
42 "label": "GET_RUNNING_TASK_USER",
43 "defaultValue": "[]",
44 "type": "USER_GROUP",
45 "isEntity": false,
46 "userSelectionStrategy": "USERS",
47 "allowMultipleSelections": false
48 },
49 {
50 "id": "WorkflowVariable3",
51 "name": "STATUS",
52 "label": "STATUS",
53 "defaultValue": "",
54 "defaultValueResource": "svi.workflow.intel_report.1534937931623.WorkflowVariable3.defaultValue.txt",
55 "type": "STRING",
56 "isEntity": false
57 }
58 ],
59 "entityDefinedProcessVariables": [
60 "svi_first_name",
61 "svi_last_name"
62 ],
63 "startOnNewEntityInstance": false,
64 "createAt": "2018-08-22T11:38:52.236Z",
65 "createBy": "videmo",
66 "lastUpdateAt": "2018-08-22T11:38:52.236Z",
67 "lastUpdateBy": "videmo",
68 "name": "intel_report_workflow",
69 "label": "Intel Report Workflow",
70 "workflowVersion": 1
71}

Path Parameters

NameTypeRequiredDescription
workflowId
string
true

The ID of the workflow definition.

Query Parameters

NameTypeRequiredDescription
includeXMLModel
boolean
false

Includes the generated BPMN model.

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
404Not Found

No workflow definition exists at the requested path.

Schema