Reference

Get contents

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

CMSで公開したコンテンツ一覧を取得します。

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.list

Required Role

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

Craft > Craft 設定の編集

レート制限

プロジェクトごとに、1秒あたり80回まで（キャッシュされていないリクエストのみ）です。CDN API・Preview API は別々に数え、一覧取得と単体取得は合算します。超えると 429 Too Many Requests を返します。Retry-After ヘッダーの秒数だけ待ってから再度リクエストしてください。

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

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

filter
object

取得するコンテンツの条件を指定できます。未入力のフィールドは型に応じた空値（空文字・0・false・null）として保存されるため、$ne は未入力のコンテンツにもマッチします。

select
array of strings
Defaults to []

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

select
order
array of strings
Defaults to -sys.raw.firstPublishedAt

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

order
integer | null
≥ 0
Defaults to 0

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

integer
1 to 1000
Defaults to 100

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

Headers
string

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

Responses

Updated 6 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago