Skip to Content

ETL configuration APIs

Use the ETL configuration APIs to export the existing ETL configuration, import the configuration, retrieve the current status of the tasks, retrieve the list of all ETLs, and for performing other tasks.

Warning

Note

ETL configuration APIs are available only when you apply Cumulative Hotfix 21 or later on Patch 1 (20.02.01) of TrueSight Capacity Optimization 20.02.

Related topics

Exporting-and-importing-ETL-configuration-by-using-APIs

Before you begin

Ensure that the following requirements are met:

  1. The appropriate read or write activity is assigned to your user role to access the API. For more information, see Adding and managing roles.
  2. Valid user credentials or a bearer token is available for authentication. For more information, see Accessing-the-public-APIs.

ETL configuration endpoints

URL to access: https://<host_name>/dh-services/backend/etls

This table lists the endpoints for ETLs.

API endpoint

Description

Endpoints for exporting ETL configuration

GET/dh-services/backend/etls/

Retrieves a list of all ETLs with the ETL IDs and run configurations.

{{status colour="Green" title="POST "/}}

/dh-services/backend/etls/<etl-id>/configuration

Extracts the configuration of the specified (batch or a service ETL) ETL ID.

{{status colour="Green" title="POST "/}}

/dh-services/backend/etls/<etl-id>/configuration/<run-configuration-id>

Extracts the configuration for the given ETL ID with the specific run configuration.

{{status colour="Blue" title="GET"/}}

/dh-services/backend/etls/<etl-id>/status

Retrieves the current status of the given task, which can be one of the following:

  • RUNNING: The task is currently being executed.
  • SERVICE_ON: This status is related to service ETLs. The task is currently running (SERVICE_ON).
  • SERVICE_OFF: This status is related to service ETLs. The task is currently paused (SERVICE_OFF).
  • WAITING: The task is waiting to be executed at the specified time (meaning, the next execution has already been scheduled).
  • ENDED: The execution of the task was terminated and it has not been rescheduled.
  • ABORTED: The execution of the task was aborted.
  • no value: The task has never been executed nor has it been scheduled.
{{status colour="Blue" title="GET"/}}

/dh-services/backend/etls/entitycatalogs/

Retrieves all the available entity catalogs.

{{status colour="Blue" title="GET"/}}

/dh-services/backend/schedulers/

Retrieves all the available schedulers.

{{status colour="Blue" title="GET"/}}

/dh-services/backend/etls/dbconnections/

Retrieves all external database connections.

{{status colour="Blue" title="GET"/}}

/dh-services/backend/etls/metricprofiles/

Retrieves all the available metric profiles.

{{status colour="Blue" title="GET"/}}

/dh-services/backend/etls/taskgroups/

Retrieves all the available task groups.

{{status colour="Green" title="POST "/}}/dh-services/backend/etls/instance

Creates an ETL instance with shared lookup and a new destination domain.

{{status colour="Green" title="POST "/}}

/dh-services/backend/etls/instance

Creates ETL instance with private lookup and using an existing domain.

{{status colour="Yellow" title="PUT "/}}

(% style="color: rgb(0,0,0);" %)/dh-services/backend/etls/<etl-id>/configuration

Updates all the details of the specified ETL ID.

{{status colour="Green" title="post"/}}

(% style="color: rgb(0,0,0);" %)/dh-services/backend/etls/<etl-id>/configuration

Updates the specified set of details for the given ETL ID.

{{status colour="Red" title="DELete"/}}

/dh-services/backend/etls/<etl-id>/instance

Deletes an ETL instance.

{{status colour="Green" title="POST "/}}

/dh-services/backend/etls/<etl-id>/stop

Stops the execution of an ETL.

{{status colour="Green" title="POST "/}}

/dh-services/backend/etls/<etl-id>/run

Runs the ETL.

{{status colour="Green" title="POST "/}}

(% style="color: rgb(0,0,0);" %)/dh-services/(%%)backend/etls/<etl-id>/schedule

Schedules the ETL run.

{{status colour="Green" title="POST "/}}

(% style="color: rgb(0,0,0);" %)/dh-services/(%%)backend/etls/<etl-id>/kill

Kills (if running) or cancels the ETL execution.

For detailed information about how to use the ETL configuration endpoints, see Exporting and importing ETL configuration using APIs.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC TrueSight Capacity Optimization 20.02