Skip to Content

Executing ETL tasks by using API

Use the Execute ETL APIs to run, schedule, stop, and kill the ETL tasks.  

Before you begin

Ensure that the following requirements are met:

  • The appropriate read or write activity is assigned to your user role to access the API. The user account must have the following permissions (through user roles):
    • READ: capacity_optimization.admin.etls_read or capacity_optimization.admin.admin_section_read
    • WRITE: capacity_optimization.custom_etl.edit or capacity_optimization.admin.admin_section_edit

For information about the user roles and permissions, see Default-user-roles-and-permissions.

Related topics

Performing-the-capacity-management-tasks-by-using-REST-APIs

Continuous-Optimization-REST-API-endpoints

Run an ETL

post/opt/api/v1/backend/etls/<etl-id>/run

Runs the ETL.

Request URL
https://<host_name>/opt/api/v1/backend/etls/<etl-id>/run
Example request URL
https://hostname.bmc.com/opt/api/v1/backend/etls/294/run
Request Header
Content-Type: application/json
Authorization: Bearer <jwttoken>
Request body
{
 "run_execution_properties": {
   "additional.property": "example of optional run execution property"
 }
}

Sample response

{
 "task_execution_request_id": <id of the execution, -1 in case of service ETLs>,
 "request_status": "OK" (or ERROR)
}

Schedule an ETL

post/opt/api/v1/backend/etls/<etl-id>/schedule

Schedules the ETL run.

Request URL
https://<host_name>/opt/api/v1/backend/etls/<etl-id>/schedule
Example request URL
https://hostname.bmc.com/opt/api/v1/backend/etls/57/schedule
Request Header
Content-Type: application/json
Authorization: Bearer <jwttoken>
Request body
{
 "run_execution_properties": {
   "additional.property": "example of optional run execution property"
 }
}

Sample response

{
 "task_execution_request_id": <id of the execution, -1 in case of service ETLs>,
 "request_status": "OK" (or ERROR)
}

Stop an ETL

post/opt/api/v1/backend/etls/<etl-id>/stop

Stops the execution of an ETL.

Request URL
https://<host_name>/opt/api/v1/backend/etls/<etl-id>/stop
Example request URL
https://hostname.bmc.com/opt/api/v1/backend/etls/53/stop
Request Header
Content-Type: application/json
Authorization: Bearer <jwttoken>

Sample response

{
 "task_execution_request_id": <id of the execution, -1 in case of service ETLs>,
 "request_status": "OK" (or ERROR)
}

Kill an ETL

post/opt/api/v1/backend/etls/<etl-id>/kill

Kills (if running) or cancels the ETL execution.

Request URL
https://<host_name>/opt/api/v1/backend/etls/<etl-id>/kill
Example request URL
https://hostname.bmc.com/opt/api/v1/backend/etls/458/kill
Request Header
Content-Type: application/json
Authorization: Bearer <jwttoken>

Sample response

{
 "task_execution_request_id": <id of the execution, -1 in case of service ETLs>,
 "request_status": "OK" (or ERROR)
}

Response

HTTP code

Message

Description

200

OK

Request succeeded

400


ETL not found

500


Error

 

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

BMC Helix Continuous Optimization 25.1