Skip to main content

Retrieve a single usage summary task

GET 
/platform/solutions/api/v1/reports/usage-jobs/{usageJobId}

This API retrieves the details of a single usage summary task identified by usageJobId.

The response includes all settings and configuration details of the task, such as schedule information, repeat period, end time, time zone, and job sorting options.

If the specified task does not exist or an error occurs while fetching the task, a 500 status code is returned with an error message containing the task ID and the error description.

Parameters

  • usageJobId: The unique identifier of the usage summary task to retrieve (required).

Notes

  • Ensure the usageJobId is correct.
  • The API only retrieves the task information; it does not modify or delete the task.
  • The returned object can be used to review or update the task via the update API.

200 Response

{
    usageJobId: c5177105-e695-49c3-abbf-936c53e9e1da,
    repeatPeriod: Daily,
    endTime: 20251231,
    timeZone: +08:30,
    jobs: [
        ActiveDeviceCount,
        DataPointCount
    ]
}

500 Response

{
    message: c5177105-e695-49c3-abbf-936c53e9e1da, summary report schedule id not found.
}

Request​

Responses​

OK