アノテーション キュー アイテムの進捗を更新する

現在のアノテーターに対するキューアイテムのアノテーション状態を更新します。

POST /annotation_queues/{queue_id}/items/{item_id}/progress

アノテーション キュー アイテムの進捗を更新する

cURL

curl --request POST \
  --url https://api.example.com/annotation_queues/{queue_id}/items/{item_id}/progress \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "annotation_state": "<string>"
}
'

200

{
  "item": {
    "id": "<string>",
    "project_id": "<string>",
    "queue_id": "<string>",
    "call_id": "<string>",
    "call_started_at": "2023-11-07T05:31:56Z",
    "call_op_name": "<string>",
    "call_trace_id": "<string>",
    "display_fields": [
      "<string>"
    ],
    "annotation_state": "unstarted",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "call_ended_at": "2023-11-07T05:31:56Z",
    "added_by": "<string>",
    "annotator_user_id": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "position_in_queue": 123
  }
}

承認

Authorization · string · header · 必須

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

パスパラメータ

queue_id · string · 必須

item_id · string · 必須

ボディ

application/json

アノテーションの進捗を更新するためのリクエストボディです（queue_id と item_id はパスから取得されます）。

注意: wb_user_id はリクエストボディに含めないでください。認証済みセッションに基づきサーバー側で設定されます。

project_id · string · 必須

例:

"entity/project"

annotation_state · string · 必須

新しい状態: 'in_progress'、'completed'、または 'skipped'

例:

"in_progress"

"completed"

"skipped"

レスポンス

200

application/json

成功時のレスポンス

アノテーション状態を更新したときのレスポンス。

item · AnnotationQueueItemSchema · object · 必須

アノテーションキューアイテムのレスポンス用スキーマ。

表示 子属性