Work item メタデータの更新

POST /api/v1/cloud/environments/{environment_id}/work/{work_id} work item の文字列のみのメタデータマップを更新します。このエンドポイントは merge-patch セマンティクスを使用します。文字列値はキーを upsert し、null 値はキーを削除します。

パスパラメータ

パラメータ	型	説明
`environment_id`	string	`env_` プレフィックス付きの Environment ID
`work_id`	string	`work_` プレフィックス付きの Work item ID

リクエストヘッダー

ヘッダー	必須	説明
`Authorization`	はい	`Bearer $QODER_ACCESS_TOKEN`
`Content-Type`	はい	`application/json`

リクエストボディ

フィールド	型	必須	説明
`metadata`	object	いいえ	work メタデータへのマージパッチ。文字列値はキーを upsert し、`null` はキーを削除する。省略すると現在のアイテムを変更せずに返す

リクエスト例

curl -X POST "https://api.qoder.com/api/v1/cloud/environments/env_019e64e01a137caf953ac2ac7b42ec5c/work/work_019f3be4fd2475d9a784bf2c739e1194" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "worker": "byoc-worker-01",
      "obsolete_key": null
    }
  }'

レスポンス例

HTTP 200 OK

{
  "id": "work_019f3be4fd2475d9a784bf2c739e1194",
  "type": "work",
  "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
  "data": {
    "type": "session",
    "id": "sess_019f3be3fa66750bb9a1fbcde85b5fe1"
  },
  "state": "active",
  "created_at": "2026-07-01T08:15:01Z",
  "acknowledged_at": "2026-07-01T08:15:04Z",
  "started_at": "2026-07-01T08:15:06Z",
  "latest_heartbeat_at": "2026-07-01T08:16:06.120394Z",
  "stop_requested_at": null,
  "stopped_at": null,
  "metadata": {
    "job": "daily-report",
    "worker": "byoc-worker-01"
  }
}

レスポンスフィールド

更新された Work item オブジェクトを返します。

エラー

HTTP	type	トリガー
400	`invalid_request_error`	リクエストボディが有効な JSON でない
400	`invalid_request_error`	`metadata` の値が文字列でも `null` でもない
400	`invalid_request_error`	Environment が `self_hosted` でない
401	`authentication_error`	PAT または SAT が無効または期限切れ
403	`permission_error`	この操作の権限がない
404	`not_found_error`	Environment または work item が存在しない

完全なエラーエンベロープについてはエラーリファレンスを参照してください。

クラウド環境

Agent が実行されるコンテナ、ネットワーク、依存関係を選択する。

​パスパラメータ

​リクエストヘッダー

​リクエストボディ

​リクエスト例

​レスポンス例

​レスポンスフィールド

​エラー

​関連