Backend Control API

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

Before you begin

  • Ensure that you have valid user credentials in Base64-encoded format for the Authorization HTTP header. For more details, see Restful web services authentication.
  • Ensure that you are assigned the out-of-the-box ADMIN role.

Executing a task/ETL

Method

POST

URI

https://clm-aus-011747.bmc.com:8280/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/ETL

Method

GET

URI

https://clm-aus-011747.bmc.com:8280/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://clm-aus-011747.bmc.com:8280/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://clm-aus-011747.bmc.com:8280/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

Was this page helpful? Yes No Submitting... Thank you

Comments