16.10 - PUT (Workflow Execution) - Teradata Ecosystem Manager

Teradata Ecosystem Manager API Reference

prodname
Teradata Ecosystem Manager
vrm_release
16.10
created_date
June 2017
category
Programming Reference
featnum
B035-3204-067K

Purpose

Start, Restart, Pause, Resume, or Rollback a workflow.

URL

/emrest/datadiscovery/workflows/{workflow-name}/execution

HTTP Method

PUT

Request Parameters

Path variable:workflow-name

Request body in JSON with the following parameters.
Name Description Data Type Notes
execution_type Type of execution String Required. Possible values:
  • Start
  • Restart
  • Pause
  • Resume
  • Rollback
failed_node_name Identifies a failed node String Required if execution_type is set to Restart.

Response

A JSON response indicates success or error.

Status

A status code of 200 is returned on a successful completion. A non-200 status code is returned if an error occurs.

Example: Starting a workflow

{
"execution_type":"Start"
}

Example: Restarting a workflow from failed node named testNode

{
  "execution_type": "Restart",
  "failed_node_name": "testNode"
}