​

projects

orc projects は、WorkspaceのProjectを作成し、担当者・日付・優先度などの計画を更新し、進捗の集計を確認するコマンドです。不要なProjectはアーカイブし、後から復元できます。

実行には認証とWorkspaceの選択が必要です。作成時の project_key はWorkspace内で一意な検索キーで、更新では変更できません。get、update、archive、restore にはこのキーを指定します。

WorkspaceのProjectを一覧にします。

Projectを一覧にします。--include-archived でアーカイブ済みも含め、ページ数は --limit と --cursor で指定できます。

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: string。任意。

Include archived projects in the response.; enum: true|false

型: string。任意。

project_key と name を指定して作成します。作成時に状態を省略すると planned になります。同じWorkspaceの initiative_id や、マイルストーンのJSONを併せて指定できます。

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。任意。

(required) Project lookup key, unique within the workspace. Must not contain slash, backslash or two consecutive dots. This key cannot be changed through the update endpoint.

型: string。任意。

(required) Display name.

型: string。任意。

Project lifecycle status. Omitted on creation, it defaults to planned.; enum: planned|in_progress|paused|completed|canceled

型: string。任意。

Project priority; null means unassigned.; enum: urgent|high|medium|low; (use "null" or "reset" to clear)

型: string。任意。

Active workspace member id of the project lead. null means no lead is assigned.; (use "null" or "reset" to clear)

型: string。任意。

Planned start as YYYY, YYYY-MM or YYYY-MM-DD. This is a calendar value, not a timestamp. null clears it.; (use "null" or "reset" to clear)

型: string。任意。

Target completion as YYYY, YYYY-MM or YYYY-MM-DD. This is a calendar value, not a timestamp. null clears it.; (use "null" or "reset" to clear)

型: string。任意。

Active workspace member ids assigned to this project. The array replaces the current assignment on update; an empty array clears it. These assignments do not define the workspace access boundary.; csv

型: string。任意。

Project label values. The array replaces current labels on update; an empty array clears them. At most one label from each configured label group may be selected.; csv

型: string。任意。

Presentation precision for the planned start date. null leaves the precision unspecified.; enum: day|month|quarter|half_year|year; (use "null" or "reset" to clear)

型: string。任意。

Presentation precision for the target date. null leaves the precision unspecified.; enum: day|month|quarter|half_year|year; (use "null" or "reset" to clear)

型: string。任意。

Short project summary, separate from the detailed description. Null or empty clears it.; (use "null" or "reset" to clear); max 1000 chars

型: string。任意。

Optional description.

型: string。任意。

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: string。任意。

Optional parent Initiative ID in the same Workspace.; (use "null" or "reset" to clear)

型: string。任意。

Optional embedded project milestone. Supply both name and date; omission or null stores no milestone. This does not create a record in the project milestones collection.

型: string。任意。

Project list ordering value; smaller values come first and equal values are ordered by projectKey. Creation appends after the current largest value when omitted.

型: number。任意。

Visual identity color token. Creation defaults to default when omitted.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red

型: string。任意。

Visual identity mode. Creation defaults to initial when omitted.; enum: color|initial|icon|emoji|image

型: string。任意。

Icon token used with identity_kind=icon. null clears the stored token.; (use "null" or "reset" to clear); max 64 chars

型: string。任意。

Emoji used with identity_kind=emoji. null clears the stored emoji.; (use "null" or "reset" to clear); max 32 chars

型: string。任意。

Uploaded image file id used with identity_kind=image. null clears the reference.; (use "null" or "reset" to clear)

型: string。任意。

Projectの検索キーを指定して詳細を取得します。組織スコープの認証情報では、必要に応じて --workspace-id で対象Workspaceを指定します。

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: string。任意。

名前、状態、優先度、担当者、日付、表示順、見た目やInitiativeへの所属を更新します。visibility は workspace または private の保存メタデータですが、このAPIの読み取り権限はWorkspace単位であり、private は別のメンバーアクセス境界を作りません。

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: string。任意。

Project display name.

型: string。任意。

Project lifecycle status. Omitted on creation, it defaults to planned.; enum: planned|in_progress|paused|completed|canceled

型: string。任意。

Project priority; null means unassigned.; enum: urgent|high|medium|low; (use "null" or "reset" to clear)

型: string。任意。

Active workspace member id of the project lead. null means no lead is assigned.; (use "null" or "reset" to clear)

型: string。任意。

Planned start as YYYY, YYYY-MM or YYYY-MM-DD. This is a calendar value, not a timestamp. null clears it.; (use "null" or "reset" to clear)

型: string。任意。

Target completion as YYYY, YYYY-MM or YYYY-MM-DD. This is a calendar value, not a timestamp. null clears it.; (use "null" or "reset" to clear)

型: string。任意。

Active workspace member ids assigned to this project. The array replaces the current assignment on update; an empty array clears it. These assignments do not define the workspace access boundary.; csv

型: string。任意。

Project label values. The array replaces current labels on update; an empty array clears them. At most one label from each configured label group may be selected.; csv

型: string。任意。

Presentation precision for the planned start date. null leaves the precision unspecified.; enum: day|month|quarter|half_year|year; (use "null" or "reset" to clear)

型: string。任意。

Presentation precision for the target date. null leaves the precision unspecified.; enum: day|month|quarter|half_year|year; (use "null" or "reset" to clear)

型: string。任意。

Short project summary, separate from the detailed description. Null or empty clears it.; (use "null" or "reset" to clear); max 1000 chars

型: string。任意。

Project description.

型: string。任意。

Project list ordering value; smaller values come first and equal values are ordered by projectKey. Creation appends after the current largest value when omitted.

型: number。任意。

Stored project visibility metadata. Project reads in this API are authorized at workspace level; private does not create a separate member access boundary.; enum: workspace|private

型: string。任意。

Visual identity color token. Creation defaults to default when omitted.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red

型: string。任意。

Visual identity mode. Creation defaults to initial when omitted.; enum: color|initial|icon|emoji|image

型: string。任意。

Icon token used with identity_kind=icon. null clears the stored token.; (use "null" or "reset" to clear); max 64 chars

型: string。任意。

Emoji used with identity_kind=emoji. null clears the stored emoji.; (use "null" or "reset" to clear); max 32 chars

型: string。任意。

Uploaded image file id used with identity_kind=image. null clears the reference.; (use "null" or "reset" to clear)

型: string。任意。

Optional parent Initiative ID in the same Workspace.; (use "null" or "reset" to clear)

型: string。任意。

Embedded project milestone. Omit to preserve it, send null to clear it, or send both name and date to replace it. This does not update records managed by the project milestones collection.

型: string。任意。

アーカイブ済みProjectを検索キーで指定して復元します。

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。任意。

Projectの検索キーを指定してアーカイブします。組織スコープの認証情報では、Projectが属するWorkspaceを --workspace-id で指定してください。

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。任意。

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: string。任意。

Project IDまたは既存のProjectキーを指定して進捗の集計を取得します。個別のProject設定の取得とは別の操作です。

検索キーと名前を指定してProjectを作成します。

進行中へ変更します。

進捗を集計します。

アーカイブしたProjectを復元します。

project_key には /、\、連続する .. を含められません。IssueにProjectを関連付ける project_id はUUIDであり、この検索キーとは異なります。Initiativeへの所属は同じWorkspace内で指定し、解除するときは更新本文の initiative_id を null にします。マイルストーンの管理には orc projects milestones を使用します。

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

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