{ "info": { "_postman_id": "242ee4ab-558d-4f21-befd-3b98aae7a92c", "name": "ThingsBoard Admin admin-controller job-controller API", "description": "ThingsBoard Admin API \u2014 subset of the ThingsBoard REST API (open-source IoT platform). Covers: Admin, Audit Log, Event, Usage Info, Queue, Queue Stats, Mail Config Template, Qr Code Settings, Job.\n\nContact Support:\n Name: ThingsBoard team\n Email: info@thingsboard.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:12:44.000Z", "updatedAt": "2026-07-28T03:12:44.000Z", "lastUpdatedBy": "35240", "uid": "35240-242ee4ab-558d-4f21-befd-3b98aae7a92c" }, "item": [ { "name": "api", "item": [ { "name": "job", "item": [ { "name": "{id}", "item": [ { "name": "reprocess", "item": [ { "name": "reprocess Job", "id": "2bc214f2-de8e-459b-bffd-e8e78d1507eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/job/:id/reprocess", "host": [ "{{baseUrl}}" ], "path": [ "api", "job", ":id", "reprocess" ], "variable": [ { "id": "61865c84-e3bb-443c-9a2d-67e8bc79da2e", "key": "id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "17a004f3-c7f3-4be9-ad19-bfd3cded6dfd", "name": "OK", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/job/:id/reprocess", "host": [ "{{baseUrl}}" ], "path": [ "api", "job", ":id", "reprocess" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-17a004f3-c7f3-4be9-ad19-bfd3cded6dfd" } ], "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-2bc214f2-de8e-459b-bffd-e8e78d1507eb" } ], "id": "6d5e84ca-c460-4f55-963c-60585f51e152", "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-6d5e84ca-c460-4f55-963c-60585f51e152" }, { "name": "cancel", "item": [ { "name": "cancel Job", "id": "fc683ec5-f700-467d-8cf2-852d4a7fe003", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/job/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "job", ":id", "cancel" ], "variable": [ { "id": "c6a3359e-0417-4687-90b8-5f3c938fe1fe", "key": "id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "2585cf88-31dd-4a54-891d-929e6f7316a4", "name": "OK", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/job/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "job", ":id", "cancel" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-2585cf88-31dd-4a54-891d-929e6f7316a4" } ], "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-fc683ec5-f700-467d-8cf2-852d4a7fe003" } ], "id": "043d7a19-1ec1-4cf4-9b09-162920ecb18e", "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-043d7a19-1ec1-4cf4-9b09-162920ecb18e" }, { "name": "get Job By Id", "id": "bde17f88-b64c-4101-8354-82a9ccf9f94b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/job/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "job", ":id" ], "variable": [ { "id": "2af791c1-228c-4188-8e09-5a9990e551d0", "key": "id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "29c6b0ba-3874-4531-83ac-8746e9ef5f3f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/job/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "job", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"tasksKey\": \"\",\n \"type\": \"\",\n \"toReprocess\": [\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n },\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n }\n ],\n \"taskProcessingTimeMs\": \"\",\n \"successfulTasksCount\": \"\",\n \"failedTasksCount\": \"\",\n \"permanentlyFailedTasksCount\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"retries\": \"\",\n \"taskProcessingTimeoutMs\": \"\",\n \"generalError\": \"\",\n \"submittedTasksBeforeGeneralError\": \"\"\n },\n \"entityId\": {\n \"entityType\": \"API_KEY\",\n \"id\": \"\"\n },\n \"key\": \"\",\n \"result\": {\n \"jobType\": \"\",\n \"successfulCount\": \"\",\n \"failedCount\": \"\",\n \"discardedCount\": \"\",\n \"totalCount\": \"\",\n \"results\": [\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n },\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n }\n ],\n \"generalError\": \"\",\n \"startTs\": \"\",\n \"finishTs\": \"\",\n \"cancellationTs\": \"\"\n },\n \"status\": \"FAILED\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"type\": \"DUMMY\",\n \"id\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"entityName\": \"\"\n}", "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-29c6b0ba-3874-4531-83ac-8746e9ef5f3f" } ], "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-bde17f88-b64c-4101-8354-82a9ccf9f94b" }, { "name": "delete Job", "id": "951f06cf-5f81-4284-95ba-e0073fd6f330", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/job/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "job", ":id" ], "variable": [ { "id": "1a949dfb-64f2-4fbd-b632-27338dfb7778", "key": "id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "412b477b-867c-4b2a-afa5-17220022beab", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/job/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "job", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-412b477b-867c-4b2a-afa5-17220022beab" } ], "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-951f06cf-5f81-4284-95ba-e0073fd6f330" } ], "id": "cabca195-5503-4ac8-a21b-d3995d7849c3", "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-cabca195-5503-4ac8-a21b-d3995d7849c3" } ], "id": "c3638887-3328-416c-9427-7f60a11ba1b4", "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-c3638887-3328-416c-9427-7f60a11ba1b4" }, { "name": "jobs", "item": [ { "name": "get Jobs", "id": "14411ca9-a9e5-401e-8525-4738a4a4e135", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/jobs?pageSize=&page=&textSearch=&sortProperty=&sortOrder=&types=DUMMY&types=DUMMY&statuses=QUEUED&statuses=CANCELLED&entities=&entities=&startTime=&endTime=", "host": [ "{{baseUrl}}" ], "path": [ "api", "jobs" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filter based on job's description", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" }, { "key": "types", "value": "DUMMY" }, { "key": "types", "value": "DUMMY" }, { "key": "statuses", "value": "QUEUED" }, { "key": "statuses", "value": "CANCELLED" }, { "key": "entities", "value": "" }, { "key": "entities", "value": "" }, { "key": "startTime", "value": "" }, { "key": "endTime", "value": "" } ] } }, "response": [ { "id": "06443f09-2ff5-4864-8bcc-ca24a8040e3d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/jobs?pageSize=&page=&textSearch=&sortProperty=&sortOrder=&types=DUMMY&statuses=CANCELLED&entities=&startTime=&endTime=", "host": [ "{{baseUrl}}" ], "path": [ "api", "jobs" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filter based on job's description", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" }, { "key": "types", "value": "DUMMY" }, { "key": "statuses", "value": "CANCELLED" }, { "key": "entities", "value": "" }, { "key": "startTime", "value": "" }, { "key": "endTime", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"configuration\": {\n \"tasksKey\": \"\",\n \"type\": \"\",\n \"toReprocess\": [\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n },\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n }\n ],\n \"taskProcessingTimeMs\": \"\",\n \"successfulTasksCount\": \"\",\n \"failedTasksCount\": \"\",\n \"permanentlyFailedTasksCount\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"retries\": \"\",\n \"taskProcessingTimeoutMs\": \"\",\n \"generalError\": \"\",\n \"submittedTasksBeforeGeneralError\": \"\"\n },\n \"entityId\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"key\": \"\",\n \"result\": {\n \"jobType\": \"\",\n \"successfulCount\": \"\",\n \"failedCount\": \"\",\n \"discardedCount\": \"\",\n \"totalCount\": \"\",\n \"results\": [\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n },\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n }\n ],\n \"generalError\": \"\",\n \"startTs\": \"\",\n \"finishTs\": \"\",\n \"cancellationTs\": \"\"\n },\n \"status\": \"COMPLETED\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"type\": \"DUMMY\",\n \"id\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"entityName\": \"\"\n },\n {\n \"configuration\": {\n \"tasksKey\": \"\",\n \"type\": \"\",\n \"toReprocess\": [\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n },\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n }\n ],\n \"taskProcessingTimeMs\": \"\",\n \"successfulTasksCount\": \"\",\n \"failedTasksCount\": \"\",\n \"permanentlyFailedTasksCount\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"retries\": \"\",\n \"taskProcessingTimeoutMs\": \"\",\n \"generalError\": \"\",\n \"submittedTasksBeforeGeneralError\": \"\"\n },\n \"entityId\": {\n \"entityType\": \"ADMIN_SETTINGS\",\n \"id\": \"\"\n },\n \"key\": \"\",\n \"result\": {\n \"jobType\": \"\",\n \"successfulCount\": \"\",\n \"failedCount\": \"\",\n \"discardedCount\": \"\",\n \"totalCount\": \"\",\n \"results\": [\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n },\n {\n \"jobType\": \"\",\n \"key\": \"\",\n \"success\": \"\",\n \"discarded\": \"\",\n \"finishTs\": \"\",\n \"failure\": {\n \"error\": \"\",\n \"number\": \"\",\n \"failAlways\": \"\"\n }\n }\n ],\n \"generalError\": \"\",\n \"startTs\": \"\",\n \"finishTs\": \"\",\n \"cancellationTs\": \"\"\n },\n \"status\": \"QUEUED\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"type\": \"DUMMY\",\n \"id\": {\n \"entityType\": \"JOB\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"entityName\": \"\"\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-06443f09-2ff5-4864-8bcc-ca24a8040e3d" } ], "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-14411ca9-a9e5-401e-8525-4738a4a4e135" } ], "id": "29baeb43-25cb-41d6-a504-232b9196fc11", "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-29baeb43-25cb-41d6-a504-232b9196fc11" } ], "id": "003f03bc-f654-48f3-9af5-0bed55ecf5a5", "createdAt": "2026-07-28T03:12:45.000Z", "updatedAt": "2026-07-28T03:12:45.000Z", "uid": "35240-003f03bc-f654-48f3-9af5-0bed55ecf5a5" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }