ひまらつ
こんにちは！更新情報のお知らせです。
microCMSではAPIリクエスト時に orders パラメータの指定により、コンテンツを並び替えて取得できます。
今回のアップデートで、orders に「管理画面の表示順」を指定して取得できるようになりました。
この記事ではAPIでの指定方法についてご紹介します。
管理画面でのコンテンツ並び替え
microCMSの管理画面では、ドラッグ&ドロップなどの操作でコンテンツを並び替えられます。
ここで並び替えた順序はAPIでのコンテンツ取得時にも利用されます。orders パラメータを指定しない場合は、管理画面と同じ並び順で取得されるようになっています。
今回のアップデートでは、明示的に「管理画面の並び順」を指定できるようになりました。これにより、次のような場面で便利にお使いいただけます。
- 管理画面の表示の逆順で取得したいとき
qパラメータで絞り込んだコンテンツを管理画面の表示順で取得したいとき
APIでの利用方法
system:default を指定する
「管理画面の表示順」でソートするには、 orders パラメータに system:default を指定します。管理画面の表示と逆順にしたければ -system:default です。
orders は複数のフィールドを指定しての並び替えも可能です。orders=title,system:default と指定すると、まずtitle で並び替えられ、title が同じ値の場合は管理画面の表示順に従ってコンテンツが並び替えられます。
qパラメータと組み合わせる
q パラメータはコンテンツの全文検索を行うパラメータです。orders を指定しない場合はキーワードに対する合致度が高い順にソートされますが、orders を指定すれば希望のソート順で取得できます。
今回のアップデートにより、q パラメータでコンテンツを検索したうえで管理画面の表示順で取得できるようになりました。
qパラメータの詳しい使い方はドキュメントをご覧ください。
おわりに
今回のアップデートで orders パラメータに新しく管理画面の表示順の選択肢が追加されました。ご活用いただけますと幸いです。
より使いやすいサービスを目指してAPI、管理画面ともに改善してまいります。ご要望などございましたら管理画面右下のチャットボタンよりご意見いただけますと幸いです。
関連ドキュメント
この記事で触れたコンテンツの並び替え、orders パラメータについてのドキュメントは以下になります。
