ファイルメタデータ一覧の取得

クエリパラメータで指定されたレコードに紐づくファイルのメタデータ一覧を返却する

📬 リクエスト

GET {resource_api_url}/files

リクエストヘッダ

キー	値
Authorization	Bearer {アクセストークン}

クエリパラメータ

パラメータ	形式	必須	説明	値の例
record_entity	文字列	YES	レコードのエンティティ名	account
record_id	文字列	YES	レコードID（単一指定のみ）	account-00000001
limit	整数値	NO	1回のリクエストで取得する最大ファイルメタデータ数	100
offset	整数値	NO	取得開始位置（スキップするファイルメタデータ数）	0

✨ 成功レスポンス

ステータスコード

200 : OK

レスポンスヘッダ

キー	値
Content-Type	application/json

レスポンスボディ

フィールド	形式	必須	説明	値の例
has_next_page	真偽値	YES	取得結果に対して、次ページが存在するかどうか	false
total_size	整数値	YES	指定されたレコードに紐づくファイルの総数	2
data	ファイルメタデータオブジェクトの配列	YES	紐づくファイルのメタデータ一覧	[ { "id": "file-00000001", "type": "image/jpeg" }, ... ]

ファイルメタデータオブジェクト

フィールド	形式	必須	説明	値の例
id	文字列	YES	ファイルのID	file-00000001
type	文字列	YES	ファイルのMIMEタイプ	image/jpeg

レスポンスボディのサンプル

レスポンスボディのサンプル

{
  "has_next_page": false,
  "total_size": 2,
  "data": [
    {
      "id": "file-00000001",
      "type": "image/jpeg"
    },
    {
      "id": "file-00000002",
      "type": "audio/mpeg"
    }
  ]
}

💬 具体的な要求事項

基本要求

• クエリパラメータで指定されたレコードに紐づくファイルのメタデータ一覧を返却してください
• 紐づくファイルが存在しない場合、または、指定されたレコードが存在しない場合は、「data」フィールドに空配列を設定してください（「200 : OK」）
• 結果のソート順は任意ですが、冪等になるようルールを設定してください（例: ID順）

「limit」パラメータ

• 「limit」パラメータが指定された場合、指定の件数を最大値としたファイルメタデータ数を返却する必要があります（SQLのlimit句と同等）

「offset」パラメータ

• 「offset」パラメータが指定された場合、指定の件数分をスキップしたファイルメタデータ一覧を返却する必要があります（SQLのoffset句と同等）
• UPWARDが送信するリクエストでは、offsetパラメータ指定時はlimitパラメータも必ず指定されます

「has_next_page」レスポンスフィールド

• 「limit」パラメータ + 「offset」パラメータを用いて得られる取得結果（= 「data」レスポンスフィールド）に対し、残りの取得結果（ページ）が存在するかどうかを返却してください

「total_size」レスポンスフィールド

• 指定されたレコードに紐づくファイルの総数を返却してください
  • この値は、「limit」パラメータ、および、「offset」パラメータを指定しない場合の「data」レスポンスフィールドの件数と合致します

「data」レスポンスフィールド

• 紐づくファイルのメタデータ一覧を返却してください
  • ファイルコンテンツは単一ファイルの取得を通じて取得するため、本APIで返却する必要はありません
• 「type」フィールドはInternet Assigned Numbers Authority (IANA)で定義されているMIMEタイプを設定してください

📚 参考資料

• 単一ファイルの取得
• Internet Assigned Numbers Authority (IANA)