16.20 - Supported User Operations in the RESTful API - Teradata Ecosystem Manager

Teradata® Ecosystem Manager API Reference

prodname
Teradata Ecosystem Manager
vrm_release
16.20
created_date
December 2020
category
Programming Reference
featnum
B035-3204-107K
HTTP Method URL Description Input Parameters
GET /emrest/datadiscovery/databases Returns a list of databases registered with Ecosystem Manager
  • Optional query parameter
GET /emrest/datadiscovery/databases/{database-name} Returns database details
  • Required path variable
PUT /emrest/datadiscovery/databases/{database-name} Adds a new database or updates an existing database
  • Required path variable
  • Required request body
POST /emrest/emsetup/portlets Executes the UI config script to configure EM portlets
  • Required query parameters
POST /emrest/emsetup/server Executes the script to configure EM server
  • Required query parameters
GET /emrest/datadiscovery/objects Returns a list of objects
  • Required query parameter
GET /emrest/datadiscovery/objects/applications Returns a list of objects by applications
  • Required query parameter
GET /emrest/datadiscovery/objects/dbql Returns a list of objects by DBQL
  • Required query parameter
GET /emrest/datadiscovery/objects/queryband Returns a list of objects by query band
  • Required query parameter
PUT /emrest/datadiscovery/jobs/{job-id} Sends an event
  • Required request body
GET /emrest/datadiscovery/servers Returns a list of servers registered with Ecosystem Manager
  • Optional query parameter
DELETE /emrest/datadiscovery/servers/{server-name} Deletes a server
  • Required path variable
GET /emrest/datadiscovery/servers/{server-name} Returns server details
  • Required path variable
PUT /emrest/datadiscovery/servers/{server-name} Adds a new server or updates an existing server
  • Required path variable
  • Required request body
GET /emrest/datadiscovery/databases/{database-name}/tables Returns a list of tables for a given database
  • Required path variable
  • Optional query parameter
DELETE /emrest/datadiscovery/databases/{database-name}/tables/{table-name} Deletes a table for a given database
  • Required path variables
GET /emrest/datadiscovery/databases/{database-name}/tables/{table-name} Returns table details for a given database
  • Required path variable
PUT /emrest/datadiscovery/databases/{database-name}/tables/{table-name} Adds a new table or updates an existing table for a given database
  • Required path variables
  • Required request body
GET /emrest/datadiscovery/databases/{database-name}/tables/{table-name}/alerts Returns table-level alerts for a table on a given database
  • Required path variables
GET /emrest/datadiscovery/databases/{database-name}/tables/{table-name}/dependencies Returns table-level dependencies for a table on a given database
  • Required path variables
GET /emrest/datadiscovery/databases/{database-name}/tables/{table-name}/validations Returns a list of table validations
  • Required path variable
  • Optional query parameter
GET /emrest/datadiscovery/databases/{database-name}/tables/{table-name}/synchronizations Returns a list of table synchronizations
  • Required path variable
  • Optional query parameter
GET /emrest/datadiscovery/workflows Returns a list of workflows
  • Optional query parameter
PUT /emrest/datadiscovery/workflows/applicationseedings/{workflow-name} Generates an application seeding workflow
  • Required path variable
  • Required query parameter
  • Required request body
PUT /emrest/datadiscovery/workflows/systemseedings/{workflow-name} Generates a system seeding workflow
  • Required path variable
  • Required query parameter
  • Required request body
DELETE /emrest/datadiscovery/workflows/{workflow-name} Deletes a workflow
  • Required path variable
GET /emrest/datadiscovery/workflows/{workflow-name} Returns workflow details
  • Required path variable
PUT /emrest/datadiscovery/workflows/{workflow-name}/action Deploys, Undeploy, or Schedule a workflow
  • Required path variable
  • Required request body
PUT /emrest/datadiscovery/workflows/{workflow-name}/execution Starts, Restarts, Pauses, Resumes, or Rollbacks a workflow
  • Required path variable
  • Required request body
POST /emrest/table-validation Configures and executes table validation
  • Required request body
GET /emrest/table-validation Gets table validation execution details
  • Required query parameters
POST /emrest/table-synchronization Configures and executes table synchronization
  • Required request body
GET /emrest/table-synchronization Gets table synchronization execution status
  • Required query parameters