GET /components/{name}

名前を指定して単一のカスタムコンポーネントの完全なフィールド定義を取得します。

名前を指定して単一のカスタムコンポーネントの完全な定義（フィールド一覧を含む）を取得します。

認証: API キー（x-api-key ヘッダーまたは api_key クエリパラメーター）。

パスパラメーター

パラメーター	型	必須	備考
`name`	string	はい	スキーマ名。例: `post`。

クエリパラメーター

パラメーター	型	必須	備考
`websiteId`	uuid	はい	有効な UUID である必要があります。
`api_key`	string	いいえ	`x-api-key` ヘッダーの代替手段。

レスポンス

{
  "id": "...",
  "name": "post",
  "displayName": "投稿",
  "description": "ドキュメント用の投稿",
  "category": "Custom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields は計算結果であり、すべての文字列型フィールドの名前です。

例

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

エラー

400 — websiteId がないか無効です
401 — 無効な API キー
404 — スキーマが見つかりません

Previous‹GET /components NextGET /dataset/{schema_name}›