プロジェクト取得

メソッド

RESTメソッドを採用しています。

HTTPメソッド

GET: 単一プロジェクト情報取得

命名規則

クエリパラメータとノードの命名を統一し、可読性を向上させるため、リクエスト時のURIとJSON内のノードにはsnake_caseを使用します。

リクエストとレスポンス

ヘッダー

メタ情報はレスポンスボディではなく、HTTPヘッダーに設定されます。

リクエストヘッダー

Authorization
Content-Type
Accept
Accept-language

レスポンスヘッダー

Content-Type

単一プロジェクト情報取得

URI

GET /v1/organizations/{organization_id}/projects/{project_id}

パスパラメータ

名前	型	必須	説明
organization_id	string	必須	組織UUID
project_id	string	必須	プロジェクトUUID

レスポンス

レスポンスはJSONです。

{
  "id": "project-uuid",
  "name": "Project Alpha",
  "organizationId": "org-uuid",
  "codeCount": 15,
  "designCount": 8,
  "createdAt": 1234567890000,
  "updatedAt": 1234567890000,
  "deletedAt": null,
  "createdBy": "user-id",
  "updatedBy": "user-id",
  "deletedBy": null
}

レスポンスフィールド

名前	型	説明
id	string	プロジェクトUUID
name	string	プロジェクト名
organizationId	string	親組織UUID
codeCount	number	コード数
designCount	number	デザイン数
createdAt	number	作成日時（エポックミリ秒）
updatedAt	number	更新日時（エポックミリ秒）
deletedAt	number \| null	削除日時（エポックミリ秒）

認証

認証はAmazon Cognitoから発行されるJSON Web Tokens (JWT)を使用して行われます。

管理者にはロール権限を適用します。一般ユーザーには、読み取りまたは読み取り・書き込み権限の有効な user_project 割り当てが必要です。

例外処理

例外処理のステータスコードは以下の通りです。

説明	ステータスコード	ステータス名
認証情報不足	401	Unauthorized
実行権限不足	403	Forbidden
プロジェクトまたは組織が見つかりません	404	Not Found
内部サーバーエラー	500	Internal Server Error

処理フロー

パスパラメータから組織IDとプロジェクトIDを抽出
ユーザーが組織に属していることを検証
プロジェクトが指定された組織に属していることを検証
一般ユーザーの場合、読み取りまたは読み取り・書き込み権限の有効なプロジェクト割り当てを検証
プロジェクト情報を返却

詳細フローチャート

flowchart TD
    Start([GET Request]) --> Auth[認証・パラメータ取得]
    Auth --> Service[Service Layer]
    Service --> AccessCheck[権限チェック]
    AccessCheck --> HasAccess{Read権限?}
    HasAccess -->|なし| Err404[404 Not Found]
    HasAccess -->|あり| QueryDB[Repository Layer]
    QueryDB --> FindRecord[レコード取得<br/>WHERE deletedAt IS NULL]
    FindRecord --> Exists{存在?}
    Exists -->|なし| Err404
    Exists -->|あり| Format[レスポンス整形]
    Format --> Success[200 OK]