タスク

タスクは、外部サービスとのセッションの確立、データの取得および処理など、API上のすべての非同期ワークロードの実行を担当します。

タスクは通常、セッションリソースの作成の一部として、またはポーリングの実行中に作成されます。

タスクから返されたデータは、関連付けられた結果リソースによって記述されます。

主にシステムおよび組織の管理に関連する一部のタスクは、ユーザー、ソース、またはセッションをターゲットにしていないか、またはポーリングに関連付けられていない可能性があります。この種のタスクの例としては、storageタスクとwebhook configテストタスクがあります。

属性

ソースタイプ

タスクがソースに関連付けられている場合、ソースのタイプはsource_typeタスク属性に非正規化されます。これにより、特定の種類のタスクに対するクエリが簡単になります。

タイプ

タスクタイプは、API内で実行されている基になるタスクを識別する短いスラグです。

タスクがリソースに対する活性に関連する場合、そのようなウェブフックの設定をテストするように、それは次のようにフォーマットされるwebhook_config.test 。

タスクが特定のソースをターゲットとする場合、 source_type属性はソース関連情報を保存しますが、 type属性はメインアクションのみを保存します。たとえば、セッションを作成すると、タイプicloud.accountソースに対してsession.initタスクが作成されます。

目標

これは基になるタスクのターゲットを指定し、常に設定されるわけではありません。たとえば、 webhook_config.testのターゲットはテストされるwebhook設定のIDになります。 icloud.accountタイプのソースに対するdataタスクの場合は、 icloud.accountように取得されるデータタイプになりmessages.whatsapp 。

状態

• pendingタスクは作成されましたが、現在キューで待機しています。
• タスクのprocessingはAPIワーカーによって実行されています。
• suspendedたタスクは、ブロックするタスクが完了するのを待ってから続行します。
• succeededエラーなしで完了したタスクを。
• failedたタスクでエラーが発生しました。

エラー

処理中にタスクが問題にぶつかった場合、このフィールドは発生したエラーのコードで設定されます。

変更ログ

2020-02-20

• Majorタスクオブジェクトの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()