CLI を使い始める

saved-views

orc saved-views は、クエリーフィルターのJSONオブジェクトに名前を付けて保存し、保存済みビューを一覧にするコマンドです。同じ条件を再利用するためのフィルターを保持します。

実行にはCLIの認証と対象Workspaceの選択が必要です。Issueのレイアウトや共有既定値を管理する orc issues views とは別のリソースです。保存時にフィルターのキーをレポートのクエリーパラメーターと照合することはなく、適用時の解釈はクライアントが行います。

使い方

terminal
orc saved-views list --json

保存済みのフィルターを一覧にします。

サブコマンド

list

現在のWorkspaceで保存されたクエリーフィルタービューを一覧にします。--limit と --cursor でページを指定できます。

terminal
orc saved-views list [options]

create

name とJSONオブジェクトの filter を指定して保存します。名前は前後の空白を除いて1〜120文字です。ネストしたフィルターは完全なJSONリソースを --stdin で送信できます。

terminal
orc saved-views create [options]

固有のオプション

--idempotency-key

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

terminal
orc saved-views create --idempotency-key <value>
--name

(required) Display name, trimmed on creation. Contains 1–120 characters after trimming.; max 120 chars

型: string。任意。

terminal
orc saved-views create --name <value>
--filter

(required) Stored query-filter object. Keys are not validated against report query parameters when saved; clients interpret the object when applying the view.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc saved-views create --filter <value>

使用例

ファイルから名前付きフィルターを保存します。

terminal
orc saved-views create --stdin < saved-view.json

ファイルから名前付きフィルターを保存します。

関連項目

計測設定と保存済みフィルターを管理する で、計測設定と保存した条件を組み合わせる操作を確認できます。

グローバルオプション

orc saved-views では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。