POST Cancel Runtime Report Job

URL: /runtimeReportJob/cancel

Accessible by: Utility and management accounts only.

Cancels any queued report job to avoid getting processed and to allow for queuing additional report jobs. A job that is already being processed will be completed, even if a request has been made to cancel it.

Request Properties

Property Version Type Required Description
jobId 1 String Yes The id of the report job to cancel.

Response Properties

Property Version Type Description
status 1 Status The api response code.

Example Request:

Request Body

NOTE: Request body is not encoded for example purposes.

	Content-Type: application/json;charset=UTF-8
	Authorization: Bearer Rc7JE8P7XUgSCPogLOx2VLMfITqQQrjg


The pretty formatted body of the request is:

	"jobId": "123456"

Sample API Call

Show code sample in:
curl -s --request POST --data-urlencode @json.txt -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer ACCESS_TOKEN" ""

Example Response:

    "status": {
        "code": 0,
        "message": ""

Back To Top