Tarefas do sistema

Esta é uma API de monitoramento de tarefas que estão rodando em background, disparados pelo usuário.

Listar tarefas e execução

API de listagem de tarefas executando, ou executadas que estão rodando em background, disparadas pelo do usuário

GET /api/tasks

Exemplo de requisição

GET /api/tasks
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

pages = sdk.alerts.get_tasks()
response = pages.next()
print(response.payload)

const response = await sdk.alerts.getTasks();
console.log(response.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "tasks": [
    {
      "id": 1,
      "datetime": "2017-10-05T12:20:02.932000+00:00",
      "failed_msg_id": "msg_translated_key",
      "msg_id": "msg_key",
      "status": "in_progress",
      "module": "dhcp",
      "target_type": "service",
      "target_id": null,
    },
    {
      "id": 2,
      "datetime": "2017-10-05T12:20:02.932000+00:00",
      "failed_msg_id": "msg_translated_key",
      "msg_id": "msg_key",
      "status": "success",
      "module": "dhcp",
      "target_type": "service",
      "target_id": null,
    },
  ],
}

[
  Task(
    id=1,
    datetime="2017-10-05T12:20:02.932000+00:00",
    failed_msg_id="msg_translated_key",
    msg_id="msg_key",
    status="in_progress",
    module="dhcp",
    target_type="service",
    target_id=None
  ),
  Task(
    id=2,
    datetime="2017-10-05T12:20:02.932000+00:00",
    failed_msg_id="msg_translated_key",
    msg_id="msg_key",
    status="success",
    module="dhcp",
    target_type="service",
    target_id=None
  )
]

[
  {
    id: 1,
    datetime: "2017-10-05T12:20:02.932000+00:00",
    failedMsgId: "msg_translated_key",
    msgId: "msg_key",
    status: "in_progress",
    module: "dhcp",
    targetType: "service",
    targetId: null
  },
  {
    id: 2,
    datetime: "2017-10-05T12:20:02.932000+00:00",
    failedMsgId: "msg_translated_key",
    msg_id: "msg_key",
    status: "success",
    module: "dhcp",
    targetType: "service",
    targetId: null
  }
];

Excluir uma task

API de exclusão do monitoramento de uma tarefa que foi executada pelo usuário.

Só é possível excluir a tarefa depois que ela tiver concluido.

DELETE /api/tasks/id

Exemplo de requisição

DELETE /api/tasks/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.alerts.delete_task(id=1)

const response = sdk.alerts.deleteTask({ id: 1 });

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

Excluir todas as tarefas

API de exclusão de todas as tarefas monitoradas do usuário. Isso só é possível fazer quando todas as tarefas estiverem concluídas

DELETE /api/tasks`

Exemplo de requisição

DELETE /api/tasks HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.alerts.delete_tasks()

const response = sdk.alerts.deleteTasks();

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

Formato dos dados

Resposta

Campo Descrição
id string

Identificador da tarefa.
datetime string

Data/Hora de início da tarefa.

Formato: ISO-8601
failed_msg_id string

Identificador do tipo de mensagem da notificação de tarefa falhada.
msg_id string

Identificador do tipo de descrição da tarefa.

Utilizado para tradução da descrição da tarefa.
status string

Status da tarefa.

Um usuário pode limpar/apagar tarefas somente se elas tiverem os status success, failed ou timed_out.

Enum: queued, in_progress, success, failed, timed_out
module string

Módulo/Produto onde a tarefa está sendo executada.

Exemplos: auth, firewall
target_type string

Tipo do item relacionado a tarefa.

Pode ser nulo se a tarefa for do módulo/produto como um todo.

Exemplos: user, rules.forward
target_desc string

Descrição/Nome do alvo da tarefa.

Pode ser nulo se a tarefa for do módulo/produto como um todo.

Dependendo do elemento relacionado a tarefa, pode ser o nome do mesmo (ex.: nome de um usuário) ou a descrição (ex.: descrição de uma regra de firewall).
target_id string

Identificador do item relacionado a tarefa.

Pode ser nulo se a tarefa for do módulo/produto como um todo.

Exemplos: "1", "iface:1"