こんにちは！更新情報のお知らせです。

microCMSではAPIリクエスト時に orders パラメータの指定により、コンテンツを並び替えた状態で取得できます。
これまで orders に指定できるのは「数字フィールド」「日時フィールド」のみでしたが、今回のアップデートで「テキストフィールド」「テキストエリア」が利用できるようになりました。

この記事では基本的な使い方についてご紹介します。
APIの詳細については以下のドキュメントをご覧ください。

• GET /api/v1/contents/{endpoint}

APIの使い方

orders にフィールドIDを指定する

例えばAPIに、 title というテキストフィールドがあるケースを考えます。
title フィールドの文字列で昇順に並び替えるには orders=title と指定します（降順は orders=-title ）。

curlコマンドの場合、リクエスト全体は以下のようになります。

curl "https://<SERVICE_ID>.microcms.io/api/v1/<ENDPOINT>?orders=title" -H "X-MICROCMS-API-KEY: <API_KEY>"

テキストエリアの場合も指定方法は同じです。

なお文字列を昇順でソートした場合の例としては、以下のような順序となります。

0123456789
@micro_cms
APIベース
CMS
Content Management System
cms
microCMS
あいアイ
あたらしい機能
あアいイ
アイあい
ヘッドレスCMS
マイクロシーエムエス
並び替え
更新情報

orders の柔軟な使い方

今回のアップデートによるものではありませんが、orders の便利な使い方を紹介します。

orders はカスタムフィールド内のフィールドも対象にできます。
例えば「SEO」というカスタムフィールドの中にある「title」というフィールドで並び替えたい場合、orders=seo.title のように . （ドット）繋ぎで記載します。

また、複数のフィールドを指定しての並び替えも可能です。
orders=title,createdAt と指定すると、まずtitle で並び替えられ、title が同じ場合は createdAt でコンテンツが並び替えられます。

コンテンツを柔軟に並び替えて取得したい場合はご活用ください。

おわりに

テキストフィールド、テキストエリアでソートできるようになるアップデートのお知らせでした。

より使いやすいサービスを目指してAPI、管理画面ともに改善してまいります。ご要望などございましたら管理画面右下のチャットボタンよりご意見いただけますと幸いです。