Purpose
Get workflow details.
URL
/emrest/datadiscovery/workflows/{workflow-name}
HTTP Method
GET
Request Parameters
Path variable:workflow-name
Response
An array of JSON as follows.
| Name | Description | Data Type |
|---|---|---|
| workflow_name | Name of workflow | String |
| template_name | Type of template for workflow | String |
| status | Status of workflow | String |
| execution_status | Execution status of the workflow | String |
| created_by | Created by details | String |
| modified_ts | Modified timestamp of workflow in UTC | String |
| modified_by | Modified by details | String |
| deployed_ts | Deployed timestamp of the workflow in UTC | String |
| deployed_by | Deployed by details of the workflow | String |
| schedule | Schedule details | String |
| scheduled_by | Scheduled by details of the workflow | String |
| execution_details | Execution details of the workflow | JSON Object (Details in Execution_details JSON Description table.) |
| nodes | Node details | An array of JSON objects (Details in Nodes JSON Description table.) |
| Name | Description | Data Type |
|---|---|---|
| run_id | Workflow execution run ID | Integer |
| start_ts | Start timestamp of the workflow in UTC | String |
| end_ts | End timestamp of the workflow in UTC | String |
| duration | Execution duration of workflow | String |
| Name | Description | Data Type |
|---|---|---|
| node_name | Name of the node | String |
| type | Type of node | String |
| execution_status | Execution station of the node | String |
| execution_message | Execution message of node if any | String |
| start_ts | Start timestamp of node in UTC | String |
| end_ts | End timestamp of node in UTC | String |
| duration | Execution duration of node execution | String |
Status
A status code of 200 is returned on a successful completion. A non-200 status code is returned if an error occurs.
Example: Getting Details for a Completed Workflow Using the API
{
"workflow_name": "sanwf3",
"template_name": "Default workflow",
"status": "deployed",
"execution_status": "SUCCESS",
"created_by": "admin",
"modified_ts": "2016-12-09T20:09:27.090Z",
"modified_by": "admin",
"deployed_ts": "2016-12-09T20:09:27.090Z",
"deployed_by": "admin",
"execution_details": {
"run_id": 131,
"start_ts": "2016-12-09T22:25:37.900Z",
"end_ts": "2016-12-09T22:25:41.520Z",
"duration": "0 00:00:03.620000"
},
"nodes": [
{
"node_name": "Start",
"type": "start",
"execution_status": "SUCCESS",
"start_ts": "2016-12-09T22:25:38.730Z",
"end_ts": "2016-12-09T22:25:39.080Z",
"duration": "000:00:00.350000"
},
{
"node_name": "tableValidation1",
"type": "tableValidation",
"execution_status": "SUCCESS",
"execution_message": "Successful table validation",
"start_ts": "2016-12-09T22:25:39.110Z",
"end_ts": "2016-12-09T22:25:40.910Z",
"duration": "0 00:00:01.800000"
},
{
"node_name": "End",
"type": "end",
"execution_status": "SUCCESS",
"start_ts": "2016-12-09T22:25:41.420Z",
"end_ts": "2016-12-09T22:25:41.540Z",
"duration": "000:00:00.120000"
}
]
}
Example: Getting Details for a Workflow Not Yet Deployed
{
"workflow_name": "firstwf",
"template_name": "DefaultWorkflow",
"status": "Created",
"created_by": "admin",
"modified_ts": "2016-10-05T12:03:05.550Z",
"modified_by": "admin",
"execution_details": {},
"nodes": [
{
"node_name": "Start",
"type": "start"
},
{
"node_name": "hadoop1",
"type": "hadoop"
},
{
"node_name": "End",
"type": "end"
},
{
"node_name": "or-split3",
"type": "or-split"
},
{
"node_name": "email4",
"type": "email"
},
{
"node_name": "scriptExecution5",
"type": "scriptExecution"
},
{
"node_name": "or-merge6",
"type": "or-merge"
}
]
}