GET /dataset/{schema_name}

スキーマの公開済みドキュメントを、すべて・単一・バッチ・ページ単位で JSON 配列としてストリーミング取得します。

スキーマの公開済みドキュメントを取得します。すべて、一件、ID によるバッチ、あるいはページ単位など、結果は JSON 配列としてストリームされます。/schemas/{schema_name} でも利用できます。画像参照は URL に解決され、language が設定されている場合は、対応する翻訳がベースコンテンツにマージされます。

認証: API キー。サーバーが require_schema_api_key = true を設定している場合にのみキーが必要で、それ以外では匿名読み取りが許可されます。

パスパラメーター

パラメーター	型	必須	備考
`schema_name`	string	はい	ドキュメントスキーマ。例: `post`。

クエリパラメーター

パラメーター	型	必須	備考
`websiteId`	uuid	いいえ	対象のウェブサイト。指定がない場合は `Host` ヘッダーまたは設定値が使用されます。
`id`	uuid	いいえ	単一ドキュメントを取得します。`ids` より優先されます。
`ids`	string	いいえ	UUID をカンマ区切りで指定します（バッチ、最大 200 件）。ページネーションより優先されます。
`language`	string	いいえ	指定ロケールの翻訳をベースコンテンツにマージします。
`limit`	integer	いいえ	ページサイズ。デフォルトは `200` で、上限も `200` です。
`offset`	integer	いいえ	スキップする行数（正の limit を指定した場合にのみ適用）。
`api_key`	string	いいえ	`x-api-key` ヘッダーの代替。

id も ids も指定されていない場合、ドキュメントは published_at DESC で並べ替えて返されます。

レスポンス

ストリーミングされた JSON 配列です。各要素には、ドキュメントの公開済みコンテンツがトップレベルで展開され、さらに _id、_title、_publishedAt のキーが挿入されます。

[
  {
    "_id": "...",
    "_title": "はじめに",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "はじめに",
    "description": "...",
    "content": "..."
  }
]

衝突が発生した場合は、コンテンツ側のフィールドが挿入されたキーより優先されます。{ alt, _asset: { id } } 形式の画像参照には、解決済みの url が _asset に挿入されます。

例

curl '{CMS_API_URL}/dataset/post?websiteId=<uuid>&limit=50' \
  -H 'x-api-key: <key>'

エラー

400 — websiteId が無効、id が無効、または ids が不正（空、200 件超過、または無効な UUID）。
401 — API キーが無効（必要な場合に未指定を含む）。
500 — クエリ失敗。

Previous‹GET /components/{name}NextGET /content-changes (SSE)›