/api/task

get
Path parameters
taskIdnumber · int64Required

The ID of the task.

Query parameters
offsetnumber · int64Optional

Request the given offset of the log.

limitnumber · int64Optional

Request using the given limit.

Responses
200

Task runners can write log entries. This endpoint can be used to retrieve them.

application/json
200

Task runners can write log entries. This endpoint can be used to retrieve them.

[
  {
    "idx": 1,
    "level": "debug",
    "msg": "text",
    "status_percent": 1,
    "timestamp": "text"
  }
]
post
Path parameters
taskIdnumber · int64Required

The ID of the task.

Responses
200

The task was updated to be canceled. The task runner will cancel the task as soon as possible. The task will be in status canceled.

application/json
200

The task was updated to be canceled. The task runner will cancel the task as soon as possible. The task will be in status canceled.

{
  "acknowledged": "ok"
}
delete
Path parameters
taskIdnumber · int64Required

The ID of the task.

Responses
200

The task was successfully deleted.

application/json
{
  "acknowledged": "ok"
}
get
Path parameters
taskIdnumber · int64Required

The ID of the task.

Responses
200

The task was updated to be canceled. The task runner will cancel the task as soon as possible. The task will be in status canceled.

application/json
200

The task was updated to be canceled. The task runner will cancel the task as soon as possible. The task will be in status canceled.

{
  "_user": {
    "_basetype": "user",
    "user": {
      "_generated_displayname": "text",
      "_id": 1
    }
  },
  "task": {
    "_id": 1,
    "created_at": "text",
    "description": "text",
    "email": {
      "recipients": [
        {
          "email": "[email protected]",
          "problems_only": true
        }
      ]
    },
    "frontend_prefs": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "next_run_at": "text",
    "run_canceled_at": "text",
    "run_finished_at": "text",
    "run_started_at": "text",
    "schedules": [
      {
        "days_of_month": [
          1
        ],
        "hours": [
          1
        ],
        "minutes": [
          1
        ],
        "timezone": "text",
        "weekdays": [
          "sunday"
        ]
      }
    ],
    "state": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "status": "new",
    "status_msg": "text",
    "status_percent": 1,
    "task_module": "text",
    "task_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "task_timeout_sec": 1,
    "updated_at": "text",
    "version": 1
  }
}
get
Responses
200

Retrieve a list of available task modules.

application/json
200

Retrieve a list of available task modules.

{
  "modules": {
    "description": {
      "de-DE": "Deutscher text",
      "en-US": "English text"
    },
    "name": "text",
    "params": [
      {
        "group": "text",
        "name": "text",
        "parameters": {
          "name": "text",
          "position": 1,
          "type": "text",
          "default": true
        },
        "require_system_right": "text",
        "unauthenticated_visible": true
      }
    ]
  }
}
post
Bodyobject[]
Responses
200

Retrieve a list of tasks

200

Retrieve a list of tasks

No content

get
Responses
200

Retrieve a list of tasks

application/json
200

Retrieve a list of tasks

[
  {
    "_user": {
      "_basetype": "user",
      "user": {
        "_generated_displayname": "text",
        "_id": 1
      }
    },
    "task": {
      "_id": 1,
      "created_at": "text",
      "description": "text",
      "email": {
        "recipients": [
          {
            "email": "[email protected]",
            "problems_only": true
          }
        ]
      },
      "frontend_prefs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "next_run_at": "text",
      "run_canceled_at": "text",
      "run_finished_at": "text",
      "run_started_at": "text",
      "schedules": [
        {
          "days_of_month": [
            1
          ],
          "hours": [
            1
          ],
          "minutes": [
            1
          ],
          "timezone": "text",
          "weekdays": [
            "sunday"
          ]
        }
      ],
      "state": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "status": "new",
      "status_msg": "text",
      "status_percent": 1,
      "task_module": "text",
      "task_params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "task_timeout_sec": 1,
      "updated_at": "text",
      "version": 1
    }
  }
]

Last updated