メソッド
Management APIは、リソースごとに操作のメソッドを持ちます。各メソッドは /v2beta/cms/{リソース}/{操作} のパスに対して、HTTP POSTで呼び出します。
リソースと操作
リソースごとに利用できる操作は次のとおりです。
| リソース | パスの接頭辞 | 操作 |
|---|---|---|
| コンテンツ | /v2beta/cms/content | list / get / create / update / patch / delete / publish / unpublish |
| アセット | /v2beta/cms/asset | list / get / update / delete / publish / unpublish / upload |
| コレクション | /v2beta/cms/collection | list / get / create / update / delete |
| モデル | /v2beta/cms/model | list / get / create / update / delete |
| カスタムフィールドタイプ | /v2beta/cms/customFieldType | list / get / create / update / delete |
各操作の意味は次のとおりです。
- list: リソースの一覧を取得する
- get: リソースを1件取得する
- create: リソースを作成する
- update: リソースを更新する
- patch: コンテンツの一部のフィールドだけを更新する
- delete: リソースを削除する
- publish: コンテンツやアセットを公開する
- unpublish: コンテンツやアセットを非公開にする
- upload: アセットをアップロードする
各操作のパラメータやレスポンスの詳細は、Craft Cross CMSのAPIリファレンスを参照してください。
ライフサイクル操作
コンテンツとアセットには、状態を変更するための操作があります。
- publish: 下書きの内容を公開し、CDN APIやAssets APIで取得できる状態にする
- unpublish: 公開を取り消し、CDN APIやAssets APIで取得できない状態にする
コンテンツの状態については、コンテンツのページを参照してください。
コンテンツには、入力済みの内容を保ったまま一部のフィールドだけを更新する patch もあります。すべてのフィールドを送り直す update と使い分けます。