THthingsboard
job-controller

GET /api/jobs

Request

Query parameters

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

textSearchstring

Case-insensitive 'substring' filter based on job's description

sortPropertystring

Property of entity to sort by

sortOrderstring

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

typesstring[]
statusesstring[]
entitiesstring[]
startTimeinteger
endTimeinteger

Response

OK

totalPagesinteger

Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria

totalElementsinteger

Total number of elements in all available pages

hasNextboolean

'false' value indicates the end of the result set

Example response

{
  "data": [
    {
      "id": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "JOB"
      },
      "createdTime": 1746028547220,
      "tenantId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "TENANT"
      },
      "entityId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "DEVICE"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.