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

​
パスパラメータ

パラメータ型説明
environment_idstringenv_ プレフィックス付きの Environment ID
work_idstringwork_ プレフィックス付きの Work item ID

​
リクエストヘッダー

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

​
リクエストボディ

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

​
リクエスト例

curl -X POST "https://api.qoder.com/api/v1/cloud/environments/env_019e64e01a137caf953ac2ac7b42ec5c/work/work_019f3be4fd2475d9a784bf2c739e1194" \
  -H "Authorization: Bearer $QODER_PAT" \
  -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 オブジェクト を返します。

​
エラー

HTTPtypeトリガー
400invalid_request_errorリクエストボディが有効な JSON でない
400invalid_request_errormetadata の値が文字列でも null でもない
400invalid_request_errorEnvironment が self_hosted でない
401authentication_errorPAT が無効または期限切れ
403permission_errorこの操作の権限がない
404not_found_errorEnvironment または work item が存在しない
完全なエラーエンベロープについては エラーリファレンス を参照してください。

​
関連

クラウド環境

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