任务

任务负责在API上执行所有异步工作负载，例如与外部服务建立会话以及检索和处理数据。

任务通常是作为会话资源创建的一部分或在执行轮询期间创建的。

任务返回的任何数据都由任何关联的结果资源描述。

一些主要涉及系统和组织管理的任务可能不针对用户，源或会话，或者与轮询相关联。此类任务的示例是存储和webhook配置测试任务。

属性

来源类型

如果任务与源关联，则源的类型将非规范化到source_type任务属性上。这有助于简化对特定类型任务的查询。

种类

任务类型是一个标识在API中执行的基础任务的短标记。

如果任务涉及针对资源的活动，例如测试webhook配置，则其格式将类似于webhook_config.test 。

如果任务针对特定的源，则source_type属性将存储与源相关的信息，而type属性仅存储主操作。例如，创建会话将触发针对icloud.account类型的源创建一个session.init任务。

目标

这指定了基础任务的目标，并不总是设置。例如， webhook_config.test的目标将是要测试的webhook配置的ID。对于针对icloud.account类型源的data任务，它将是要检索的数据类型，如messages.whatsapp 。

州

• pending完成任务已创建，但当前正在队列中等待。
• API工作者正在执行processing任务。
• suspended任务正在等待阻止任务完成，然后再继续。
• succeeded完成任务，没有错误。
• 任务failed ，遇到错误。

错误

如果任务在处理期间遇到问题，则将使用遇到的错误代码设置此字段。

变更日志

2020-02-20

• 重大任务对象的results属性现在是嵌套列表对象，而不是简单的列表属性。

2019-10-16

• 任务对象的state属性现在可以具有suspended的值。这表明API正在等待Reincubate Relay应用程序完成操作，例如文件上载或元数据更新，以使其恢复并完成任务。

检索GET /tasks/{task ID}

使用cURL

curl https://ricloud-api.reincubate.com/tasks/<task ID> \
  -H 'Authorization: Token <your key_token>'

使用ricloud-py

import ricloud

task = ricloud.Task.retrieve(<task ID>)

样品回复

{
  "id": "00000001-1234-1234-1234-9876543210",
  "resource": "task",
  "organisation": 1,
  "key": 1,
  "user": 1,
  "source": 1,
  "session": "00000002-1234-1234-1234-9876543210",
  "poll": "00000003-1234-1234-1234-9876543210",
  "source_type": "mocks.mock",
  "type": "info",
  "target": null,
  "results": {
    "data": [],
    "has_more": false,
    "total_count": 1,
    "url": "/tasks/00000001-1234-1234-1234-9876543210/results"
  },
  "state": "processing",
  "error": null,
  "date_created": "2020-02-20T11:59:15.110451Z",
  "date_started": "2020-02-20T11:59:15.207932Z",
  "date_completed": null
}

列出GET /tasks

参数

使用cURL

curl https://ricloud-api.reincubate.com/tasks \
  -H 'Authorization: Token <your key_token>'

使用ricloud-py

import ricloud

tasks = ricloud.Task.list()