本文へ
GETBearer トークン

操作状況を取得

/api/v1/tasks/:taskKey

所属組織の操作について、永続化された状態を取得します。state とプロバイダーの taskStatus は意味が異なります。認証情報やウォレット署名は返されません。

API のフィールド名、型、コードはすべての言語で共通です。

リクエスト例

cURL
curl "https://tovahub.com/api/v1/tasks/server%3A507f1f77bcf86cd799439012%3Arestart%3Adocs_example_001" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

表示のみ。このページから API リクエストは送信されません。

パラメーター

taskKeyパス · 必須

string

8–240 文字。英数字、コロン、アンダースコア、ハイフンを使用できます。返された taskKey をそのまま使用してください。

レスポンス

HTTP ステータス 200

組織の既存の操作について永続化された状態を取得します。

taskKeystring

固定のプラットフォーム操作キー。

actionstring

記録された操作名。

statestring ('started' | 'succeeded' | 'failed')

プラットフォーム側の操作状態。プロバイダーのタスク状態とは異なります。

pendingboolean

プラットフォーム側またはプロバイダー側の完了が未確定の間は true。

localFinishPendingboolean

スナップショット要求が succeeded で、保存済みの応答と有効な完了時刻があり、プロバイダーのタスク ID がなく、受付後のローカル処理が未完了の場合は true。元の action と requestKey で recover_snapshot を呼び出してください。タスクの GET は読み取り専用です。

taskIdstring | null

存在する場合、プロバイダーのタスク識別子。

taskStatusstring | null

最後に観測されたプロバイダーのタスク状態。

errorstring | null

存在する場合、機密情報を除去した記録済みエラー。

createdAtstring (ISO 8601)

プラットフォーム側の操作作成日時。

finishedAtstring (ISO 8601) | null

存在する場合、プラットフォーム側の完了日時。

actorUserIdstring (ObjectId) | null

元の操作者のアカウントID。履歴が不完全ならnullです。現在の閲覧者は同じ固定チームの有効メンバーである必要があります。