KAkarte
Collections

Get a collection

Craft Cross CMSのコレクションの情報を取得します。

Required Scope

APIの実行に必要なScopeです。

beta.cms.collection.get

Required Role

管理画面でScopeを追加する際に必要な権限です。

Craft Cross CMS > CMSの閲覧
post/v2beta/cms/collection/get

Request

  • Base URL
    https://api.karte.io
  • URL
    https://api.karte.io/v2beta/cms/collection/get
  • Auth
    HTTP bearer

Headers

x-karte-apistring

今後利用する可能性のある予約語です。現在は設定不要です。

authorizationstring

認証情報を含むトークンです。"Authorization" ヘッダーに Bearer <token> の形式で設定してください。

content-typestring

リクエストのコンテンツタイプを指定します。通常は application/json を使用してください。

Request body

collectionIdstring required

コレクションのID

Example request

{
  "collectionId": "6347f05d5d18d4536af5f336"
}

Response

A successful response.

idstring required

コレクションのID

namestring required

コレクション名

descriptionstring required

コレクションの説明

Example response

{
  "id": "6347f05d5d18d4536af5f336",
  "name": "Blog Posts",
  "description": "ブログ記事を管理するコレクション"
}

Changes

No recorded changes to this operation across all 1 revision of this API.