Get preview contents

get

https://{subdomain}.cdn-api.karte.io/beta/cms/content/preview/list

プレビュー用のコンテンツ一覧を取得します。

APIエンドポイント

{subdomain} にはプロジェクト固有の値が入ります。KARTE管理画面の「CMS設定」>「APIエンドポイント」で確認できます。

⚠️ 注意: Base URLの{subdomain}を編集しても、API Requestのコード例には反映されません。Shell/Node/Ruby等のExampleは反映されるのでそちらを使うか、API Requestを利用する場合はdevKarte.server()で実際のエンドポイントURLを指定してください。

Required Scope

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

beta.cdn.cms.content.preview.list

Required Role

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

Craft > Craft 設定の編集

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

modelId

string

required

取得するコンテンツが所属するモデルのIDを指定します。

filter

object

取得するコンテンツの条件を指定できます。

select

array of strings

Defaults to

取得するコンテンツが持つプロパティを指定できます。複数の値を指定できます。idは必ず含まれます。

select

order

array of strings

Defaults to -sys.raw.createdAt

取得するコンテンツの順番を指定できます。複数の値を指定できます。降順にしたい場合は「-」をつけます。

order

skip

integer | null

≥ 0

Defaults to 0

何件のコンテンツをスキップするか指定できます。

limit

integer

1 to 1000

Defaults to 100

最大何個のコンテンツを取得するか指定できます。

Headers

x-karte-api

string

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

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Choose an example:

application/json

200Success Response

defaultunexpected error