initiatives
orc initiatives は、WorkspaceのInitiativeを作成し、担当者・優先度・期日・状態を更新するコマンドです。所属するProjectの追加や並べ替え、進捗集計、コメントと更新投稿を扱い、お気に入りや購読も管理できます。削除したInitiativeは復元できます。
実行には認証とWorkspaceの選択が必要です。更新時には現在の応答から取得した version を指定します。Projectの追加には同じWorkspaceのProject IDを使用してください。
使い方
orc initiatives list --jsonWorkspaceのInitiativeを一覧にします。
サブコマンド
list
タブや状態で絞り込み、並び順とページを指定して一覧にします。--status とタブを併用した場合は、明示した状態が優先されます。
orc initiatives list [options]固有のオプション
--tab
Convenience filter: active selects active; planned selects proposed and planned. all or omission applies no tab filter. An explicit status takes precedence.; enum: active|planned|all
型: string。任意。
orc initiatives list --tab <value>--status
Exact lifecycle-state filter. Overrides tab when both are supplied.
型: string。任意。
orc initiatives list --status <value>--sort
Sort field. Defaults to created_at; manual uses the shared numeric rank and target_date uses the target calendar date.; enum: created_at|target_date|manual
型: string。任意。
orc initiatives list --sort <value>--order
Sort direction. Defaults to descending for created_at and ascending for target_date or manual. Keep it unchanged while following a cursor.; enum: asc|desc
型: string。任意。
orc initiatives list --order <value>create
名前を指定してInitiativeを作成します。名前は前後の空白を除いて最大200文字で、空白だけの名前は拒否されます。担当者、優先度、期日、状態やラベルも指定できます。
orc initiatives 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。任意。
orc initiatives create --idempotency-key <value>--color
Optional display color token. Null clears it; omission in an update preserves it.; (use "null" or "reset" to clear); max 100 chars
型: string。任意。
orc initiatives create --color <value>--description
Description text. Use an empty string to clear it.; max 2000 chars
型: string。任意。
orc initiatives create --description <value>--icon
Optional display icon token. Null clears it; omission in an update preserves it.; (use "null" or "reset" to clear); max 100 chars
型: string。任意。
orc initiatives create --icon <value>--labels
Complete label set. Labels are trimmed and must be unique. Use [] to clear; omission in an update preserves the set.; csv
型: string。任意。
orc initiatives create --labels <value>--name
(required) Initiative name. Leading and trailing whitespace is removed; a blank name is rejected.; max 200 chars
型: string。任意。
orc initiatives create --name <value>--owner-id
Owner user ID belonging to this workspace. Null clears the owner; omission in an update preserves it.; (use "null" or "reset" to clear)
型: string。任意。
orc initiatives create --owner-id <value>--priority
Priority label, or null when unset. Omission in an update preserves it.; enum: urgent|high|medium|low|; (use "null" or "reset" to clear)
型: string。任意。
orc initiatives create --priority <value>--status
Body field: status
型: string。任意。
orc initiatives create --status <value>--target-date
Target calendar date in YYYY-MM-DD form. Supply target_precision with it; set both to null to clear the target.; (use "null" or "reset" to clear)
型: string。任意。
orc initiatives create --target-date <value>--target-precision
Target date granularity. Supply target_date together with this field; both must be non-null or both null.; enum: day|month|quarter|half_year|year|; (use "null" or "reset" to clear)
型: string。任意。
orc initiatives create --target-precision <value>get
Initiative IDを指定して現在の情報を取得します。更新の version はこの応答から取得します。
orc initiatives get <id> [options]update
Initiative IDと現在の version を指定して内容を更新します。古いバージョンは競合となります。優先度は省略すると保持し、null で解除します。説明を解除する場合は空文字を指定します。
orc initiatives update <id> [options]固有のオプション
--color
Optional display color token. Null clears it; omission in an update preserves it.; (use "null" or "reset" to clear); max 100 chars
型: string。任意。
orc initiatives update <id> --color <value>--description
Description text. Use an empty string to clear it.; max 2000 chars
型: string。任意。
orc initiatives update <id> --description <value>--icon
Optional display icon token. Null clears it; omission in an update preserves it.; (use "null" or "reset" to clear); max 100 chars
型: string。任意。
orc initiatives update <id> --icon <value>--labels
Complete label set. Labels are trimmed and must be unique. Use [] to clear; omission in an update preserves the set.; csv
型: string。任意。
orc initiatives update <id> --labels <value>--name
Initiative name. Leading and trailing whitespace is removed; a blank name is rejected.; max 200 chars
型: string。任意。
orc initiatives update <id> --name <value>--owner-id
Owner user ID belonging to this workspace. Null clears the owner; omission in an update preserves it.; (use "null" or "reset" to clear)
型: string。任意。
orc initiatives update <id> --owner-id <value>--priority
Priority label, or null when unset. Omission in an update preserves it.; enum: urgent|high|medium|low|; (use "null" or "reset" to clear)
型: string。任意。
orc initiatives update <id> --priority <value>--rank
Workspace-shared manual position as a non-negative decimal string. Lower values appear first for ascending manual order.; max 100 chars
型: string。任意。
orc initiatives update <id> --rank <value>--status
Body field: status
型: string。任意。
orc initiatives update <id> --status <value>--target-date
Target calendar date in YYYY-MM-DD form. Supply target_precision with it; set both to null to clear the target.; (use "null" or "reset" to clear)
型: string。任意。
orc initiatives update <id> --target-date <value>--target-precision
Target date granularity. Supply target_date together with this field; both must be non-null or both null.; enum: day|month|quarter|half_year|year|; (use "null" or "reset" to clear)
型: string。任意。
orc initiatives update <id> --target-precision <value>--version
(required) Latest saved version from the Initiative response. A stale value returns a conflict; read the current resource before retrying.
型: number。任意。
orc initiatives update <id> --version <value>delete
Initiative IDを指定してソフトデリートします。
orc initiatives delete <id> [options]rollup get
Initiativeの進捗集計を取得します。個別設定の取得とは別の操作です。
orc initiatives rollup get <id> [options]projects list
Initiativeに所属するProjectを一覧にします。--limit と --cursor でページを指定します。
orc initiatives projects list <id> [options]projects create
同じWorkspaceの project_id を指定してInitiativeに追加します。所属の rank は非負整数で、省略するとProjectの表示順を使用します。
orc initiatives projects create <id> [options]固有のオプション
--project-id
(required) ID of a project in the same workspace.
型: string。任意。
orc initiatives projects create <id> --project-id <value>--rank
Non-negative integer membership rank. Defaults to the project display order when omitted.
型: number。任意。
orc initiatives projects create <id> --rank <value>projects update
Initiative ID、Project IDと新しい rank を指定して所属Projectを並べ替えます。非負整数の小さい値が先に表示されます。
orc initiatives projects update <id> <project-id> [options]固有のオプション
--rank
(required) New non-negative integer membership rank. Lower values appear first.
型: number。任意。
orc initiatives projects update <id> <project-id> --rank <value>projects delete
Initiative IDとProject IDを指定して所属を解除します。Project自体をアーカイブする操作とは異なります。
orc initiatives projects delete <id> <project-id> [options]activity list
Initiativeの変更履歴を一覧にします。
orc initiatives activity list <id> [options]Initiativeのコメントを一覧にします。
orc initiatives comments list <id> [options]comments create
Initiative IDと body を指定してコメントを投稿します。返信では parent_id を指定できます。
orc initiatives comments create <id> [options]固有のオプション
--body
(required) Comment text. Trimmed before validation; must contain 1 to 10000 characters.; max 10000 chars
型: string。任意。
orc initiatives comments create <id> --body <value>--parent-id
Top-level comment ID in this initiative. Omit or pass null to start a thread. Replies to replies are rejected.; (use "null" or "reset" to clear); max 500 chars
型: string。任意。
orc initiatives comments create <id> --parent-id <value>favorites enable
指定したInitiativeをお気に入りに追加します。
orc initiatives favorites enable <id> [options]favorites disable
指定したInitiativeをお気に入りから外します。
orc initiatives favorites disable <id> [options]restore
ソフトデリートしたInitiativeをIDで指定して復元します。
orc initiatives restore <id> [options]subscriptions enable
指定したInitiativeを購読します。
orc initiatives subscriptions enable <id> [options]subscriptions disable
指定したInitiativeの購読を解除します。
orc initiatives subscriptions disable <id> [options]updates list
Initiativeの更新投稿を一覧にします。
orc initiatives updates list <id> [options]updates create
Initiative ID、本文の body と health を指定して更新投稿を作成します。通常のコメントとは別の投稿です。
orc initiatives updates create <id> [options]固有のオプション
--body
(required) Progress-update text. Trimmed before validation; must contain 1 to 10000 characters.; max 10000 chars
型: string。任意。
orc initiatives updates create <id> --body <value>--health
(required) Body field: health
型: string。任意。
orc initiatives updates create <id> --health <value>batch update
JSONの items に複数の操作を指定します。各項目を入力順に独立して処理し、応答のindexは入力配列に対応します。個別の失敗は成功した項目をロールバックしません。
orc initiatives batch update [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。任意。
orc initiatives batch update --idempotency-key <value>--items
(required) Actions processed independently in input order. Each result index refers to this array. A malformed request is rejected before processing; reported item failures do not roll back successful items.; JSON array of objects (use --stdin for large resources)
型: string。任意。
orc initiatives batch update --items <value>使用例
名前を指定してInitiativeを作成します。
orc initiatives create --name "Improve onboarding" --json名前を指定してInitiativeを作成します。
現在の情報を取得して更新ファイルを送信します。
取得した version と変更する項目をJSONに含めてください。
orc initiatives get INITIATIVE_ID --json
orc initiatives update INITIATIVE_ID --stdin < initiative-update.json --json現在の情報を取得して更新ファイルを送信します。
同じWorkspaceのProjectを追加します。
orc initiatives projects create INITIATIVE_ID --project-id PROJECT_ID --json同じWorkspaceのProjectを追加します。
所属するProjectを並べ替えます。
orc initiatives projects update INITIATIVE_ID PROJECT_ID --rank 0 --json所属するProjectを並べ替えます。
Initiativeの進捗を集計します。
orc initiatives rollup get INITIATIVE_ID --jsonInitiativeの進捗を集計します。
更新の競合と並び順
更新が競合した場合は、get で現在の内容と version を読み直し、変更内容を確認して再送します。一括操作では各項目の結果を確認してください。リクエスト全体が不正な場合は処理前に拒否されますが、個別の失敗で成功済みの項目が取り消されることはありません。
Initiative自身の手動位置 rank は非負の十進文字列です。一方、InitiativeへのProject所属の rank は非負整数です。異なるリソースの並び順なので、値の型を混同しないでください。
グローバルオプション
orc initiatives では、次のグローバルオプションを使用できます。
各オプションの詳細と使用例は、グローバルオプションを参照してください。
comments list