Scheduled Tasks

Get scheduled task details

Changed on

Retrieve details of a specific scheduled task by ID.

get/v1/scheduled-tasks/{task-id}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/scheduled-tasks/{task-id}
  • Auth
    HTTP bearer

Path parameters

task-idinteger required

Response

Task details retrieved successfully

idinteger

Unique task identifier

taskHandlerIdstring

Task handler identifier

schedulestring

Cron-style schedule expression (for recurrent tasks)

parametersstring

Task-specific persistent data

scheduledExecutionTimestring date-time nullable

Scheduled execution time in ISO 8601 format, or null if not set

lastExecutionTimestring date-time nullable

Last execution time in ISO 8601 format, or null if never executed

recurrentboolean

Whether this is a recurrent (cron-based) task

disabledboolean

Whether the task is disabled

completedboolean

Whether the task has completed

runningboolean

Whether the task is currently running

systemboolean

Whether this is a system task

userIdinteger

Owner user ID

objectIdinteger

Associated NetXMS object ID

commentsstring

Task comments

taskKeystring

Optional task key for identification

Changes