GET List Runtime Report Job Status

URL: /runtimeReportJob/status

Accessible by: Utility and management accounts only.

Gets the status of the job for the given id or all current job statuses for the account carrying out the request.

Please avoid polling at a frequency of more than once per every 5 minutes.

Request Properties

Property	Version	Type	Required	Description
jobId	1	String	No	The id of the report job.

Response Properties

Property	Version	Type	Description
jobs	1	ReportJob []	The list of report jobs for the corresponding request.
status	1	Status	The api response code.

Example Request:

Request Body

NOTE: Request body is not encoded for example purposes.

HEADERS:
	Content-Type: application/json;charset=UTF-8
	Authorization: Bearer ACCESS_TOKEN
	
REQUEST:                               
	GET https://api.ecobee.com/1/runtimeReportJob/status?format=json&body=\{"jobId":"123"\}

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" "https://api.ecobee.com/1/runtimeReportJob/status?format=json&body=\{\}"

					

$.ajax({
    beforeSend: function(request) {
        request.setRequestHeader("Authorization", "Bearer ".concat(ACCESS_TOKEN));
    },
    dataType: 'json',
    url: 'https://api.ecobee.com/1/runtimeReportJob/status',
    success: function(data) {
    	var response = JSON.stringify(data, null, 4);
    }
});

Example Response:

{
  "jobs": [
    {
      "jobId": "123",
      "status": "queued"
    },
    {
      "jobId": "234",
      "status": "cancelled"
    },
    {
      "jobId": "345",
      "status": "completed",
      "files": [
        "https://s3.amazonaws.com/ecobee-utl/example_dir/examplefile-1.tar.gz.gpg"
      ]
    },
    {
      "jobId": "456",
      "status": "error",
      "message": "Error occured while trying to encrypt bundle."
    }
  ],
  "status": {
    "code": 0,
    "message": ""
  }