GET /api/v1/cloud/environments/{environment_id}/work
self_hosted Environment の work item を一覧取得します。結果はカーソルページネーションを使用し、キューの作成順に一致する ID の昇順で返されます。
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
environment_id | string | env_ プレフィックス付きの Environment ID |
リクエストヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer $QODER_PAT |
クエリパラメータ
| パラメータ | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
limit | integer | いいえ | 20 | 1 ページあたりのアイテム数。正の値でなければならない。100 を超える値は 100 に制限される |
page | string | いいえ | - | 前のレスポンスの next_page が返したカーソル |
before_id | string | いいえ | - | この work item ID より前のレコードを返す |
after_id | string | いいえ | - | この work item ID より後のレコードを返す |
page、before_id、after_id は相互排他的です。カーソルのセマンティクスについては ページネーション を参照してください。
リクエスト例
レスポンス例
HTTP 200 OKレスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
data | Work item オブジェクト の配列 | 現在のページの work item |
first_id | string|null | このページの最初のレコードの ID |
last_id | string|null | このページの最後のレコードの ID |
has_more | boolean | さらにレコードが残っているかどうか |
next_page | string|null | 次ページのカーソル。has_more が true の場合は last_id と等しく、それ以外は null |
エラー
| HTTP | type | トリガー |
|---|---|---|
| 400 | invalid_request_error | limit が正の整数でない |
| 400 | invalid_request_error | page、before_id、after_id のうち複数が指定された |
| 400 | invalid_request_error | Environment が self_hosted でない |
| 401 | authentication_error | PAT が無効または期限切れ |
| 403 | permission_error | この操作の権限がない |
| 404 | not_found_error | Environment が存在しない |
関連
クラウド環境
Agent が実行されるコンテナ、ネットワーク、依存関係を選択する。