16.10 - PUT (Workflow Action) - 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

Deploy, Undeploy, or Schedule a workflow.

URL

put /emrest/datadiscovery/workflows/{workflow-name}/action

HTTP Method

PUT

Request Parameters

Path variable:workflow-name

Request body in JSON with the following parameters.
Name Description Data Type Notes
action_type Name of the action String Required. Possible values:
  • Deploy
  • Undeploy
  • Schedule
schedule_cron Workflow schedule in cron format String Required if action_type is set to Schedule.
schedule_time_zone Identifies the time zone String Required if action_type is set to Schedule.

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: Scheduling a workflow to run every day at 12:00 AM Pacific time

{
  "action_type": "Schedule",
  "schedule_cron": "0 7 * * *",
  "schedule_time_zone": "GMT-08:00"
}

Example: Undeploying a deployed workflow

{
"action_type": "Undeploy"
}