要件取得

メソッド

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

HTTPメソッド

GET: 単一要件情報取得

命名規則

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

リクエストとレスポンス

ヘッダー

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

リクエストヘッダー

Authorization
Content-Type
Accept
Accept-language

レスポンスヘッダー

Content-Type

単一要件情報取得

URI

GET /api/v1/organizations/{organization_id}/projects/{project_id}/requirements/{requirement_id}

パスパラメータ

名前	型	必須	説明
organization_id	integer	必須	組織ID
project_id	integer	必須	プロジェクトID
requirement_id	string	必須	要件UUID

レスポンス

レスポンスはJSONです。

{
  "id": "requirement-uuid",
  "projectId": 1,
  "name": "My Requirement",
  "s3Key": "1/1/requirement/requirement-uuid",
  "createdAt": 1234567890000,
  "updatedAt": 1234567890000,
  "deletedAt": null,
  "createdBy": "user-cognito-sub",
  "updatedBy": "user-cognito-sub",
  "deletedBy": null
}

レスポンスフィールド

名前	型	説明
id	string	要件UUID
projectId	number	プロジェクトID
name	string	要件名
s3Key	string \| null	S3オブジェクトキー
createdAt	number	作成日時（エポックミリ秒）
updatedAt	number	更新日時（エポックミリ秒）
deletedAt	number \| null	削除日時（エポックミリ秒）。未削除の場合はnull
createdBy	string	作成者のユーザーID
updatedBy	string	更新者のユーザーID
deletedBy	string \| null	削除者のユーザーID。未削除の場合はnull

認証

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

例外処理

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

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

処理フロー

パスパラメータから組織ID、プロジェクト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]