フィードバックの作成

呼び出しまたはオブジェクトにフィードバックを追加

POST /feedback/create

フィードバックの作成

cURL

curl --request POST \
  --url https://api.example.com/feedback/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "weave_ref": "<string>",
  "feedback_type": "<string>",
  "payload": {},
  "id": "018f1f2a-9c2b-7d3e-b5a1-8c9d2e4f6a7b",
  "creator": "Jane Smith",
  "annotation_ref": "weave:///entity/project/object/name:digest",
  "runnable_ref": "weave:///entity/project/op/name:digest",
  "call_ref": "weave:///entity/project/call/call_id",
  "trigger_ref": "weave:///entity/project/object/name:digest",
  "queue_id": "018f1f2a-9c2b-7d3e-b5a1-8c9d2e4f6a7b",
  "wb_user_id": "<string>"
}
'

200

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "wb_user_id": "<string>",
  "payload": {}
}

承認

Authorization · string · header · 必須

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

ボディ

application/json

project_id · string · 必須

例:

"entity/project"

weave_ref · string · 必須

例:

"weave:///entity/project/object/name:digest"

feedback_type · string · 必須

例:

"custom"

payload · Payload · object · 必須

例:

{ "key": "value" }

id · string | null

クライアントから指定された場合、この ID がサーバー生成の ID に代わって feedback 行の ID として使用されます。

例:

"018f1f2a-9c2b-7d3e-b5a1-8c9d2e4f6a7b"

creator · string | null

例:

"Jane Smith"

annotation_ref · string | null

例:

"weave:///entity/project/object/name:digest"

runnable_ref · string | null

例:

"weave:///entity/project/op/name:digest"

call_ref · string | null

例:

"weave:///entity/project/call/call_id"

trigger_ref · string | null

例:

"weave:///entity/project/object/name:digest"

queue_id · string | null

この feedback が作成された annotation queue の ID。annotation_queues.id を参照します。キューの外部で feedback が作成された場合は NULL になります。

例:

"018f1f2a-9c2b-7d3e-b5a1-8c9d2e4f6a7b"

wb_user_id · string | null

このフィールドは直接設定しないでください。サーバーが自動的に設定します。

レスポンス

200

application/json

成功時のレスポンス

id · string · 必須

created_at · string<date-time> · 必須

wb_user_id · string · 必須

payload · Payload · object · 必須