Backend Control API

The Backend Control API enables you to remotely manage and control the interactions with the backend components of BMC Helix Capacity Optimization.

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. For more information, see Configuring user roles and access groups.

• Valid user credentials or a bearer token is available for authentication. For more information, see Accessing the public APIs.

Executing a task/ETL

Method

POST

URI

https://<optconsole external address>/dh-services/backend/requestTaskExecution

Request parameters

NA

Sample request

<?xml version="1.0" encoding="UTF-8"?>
<TaskExecutionRequest>
  <taskid>38</taskid>
  <request>RUN</request>
</TaskExecutionRequest>

Request status

Possible values: OK, ERROR, WARNING

Sample response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TaskExecutionRequestStatus>
    <taskexecreqid>21359</taskexecreqid>
    <requestStatus>OK</requestStatus>
</TaskExecutionRequestStatus>

Checking the execution status of a task or ETL.

Method

GET

URI

https://<optconsole external address>/dh-services/backend/checkTaskExecutionStatus/<taskexecreqid>

Where taskexecreqid is the value obtained from the output of the /dh-services/backend/requestTaskExecution call.

Request parameters

NA

Sample request

NA

Sample response

Possible values: FINISHED, FAILED, TIMED_OUT, RUNNING, NO_STATUS

Submitting the execution report

Method

POST

URI

https://<optconsole external address>/dh-services/backend/submitReportExecution/<report_id>

Request parameters

NA

Sample request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TaskExecutionRequestStatus>
    <taskexecreqid>21360</taskexecreqid>
    <requestStatus>OK</requestStatus>
</TaskExecutionRequestStatus>

Request status

Possible values: OK, ERROR, WARNING

Sample response

Possible values: OK, ERROR, and WARNING

Check the status of execution report

Method

GET

URI

https://<optconsole external address>/dh-services/backend/checkReportExecutionStatus/<taskexecreqid>

Where taskexecreqid is the value obtained from the output of the /dh-services/backend/submitReportExecution/<report_id> call.

Request parameters

NA

Sample request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ReportExecutionResults>
    <overallStatus>GENERATED</overallStatus>
    <ReportExecution>
        <status>GENERATED</status>
        <rundate>2016-09-12T00:00:00.000-04:00</rundate>
        <reportId>15</reportId>
        <Results>/cpitrep/reports/15/report_15_1473754939852/Diagnostic%20-%20Data%20Flow%20and%20Statistics.pdf</Results>
    </ReportExecution>
</ReportExecutionResults>

Request status

Possible values: GENERATED, FAILED, RUNNING, NO_STATUS

Sample response

Possible values: GENERATED, FAILED, RUNNING, NO_STATUS

Activate the ETL

Method

POST

URI

https://<optapi external address>:<port number>/dh-services/backend/edk/activate

Request parameters

NA

Sample request

Body request is a Multipart Form Data, it should be the data package that will be activated.

Request status

Response body:

{          
“message”: Module created/updated successfully           
“moduleName”: <module name from the package>
}

Sample response

{          
“message”: Module created successfully           
“moduleName”: etlModuleName
}