microCMS

GET APIのフィールドごとのレスポンス形式

最終更新日:2023年11月20日

1. テキストフィールド

1行でテキストを自由入力できるフィールドです。

レスポンスの型

文字列

"textField": "some text"

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / null

informationInformation

フィールドが空値の場合のレスポンスの詳細につきまして、本ページ下部の一覧を併せてご確認ください。

2. テキストエリア

複数行でテキストを自由入力できるフィールドです。プレーンテキストによる入力となります。

レスポンスの型

文字列

"textArea": "some\ntext"

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / null

informationInformation

改行を含む場合、\n として出力されます。

3. リッチエディタ

複数行の装飾可能なテキストを自由入力できるフィールドです。

レスポンスの型

文字列(HTML形式)

"richEditor": "<p>some text</p>"

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / null

4. 旧リッチエディタ(非推奨)

複数行の装飾可能なテキストを自由入力できるフィールドです。

レスポンスの型

文字列(HTML形式)

"richEditorOld": "<p>some text</p>"

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / ""

5. 画像

画像用のフィールドです。

レスポンスの型

オブジェクト(画像オブジェクト)
heightwidth に関しては、ファイルによっては含まれない場合もあります。

"image": {
        "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/image.png.",
        "height": 630,
        "width": 1200
}

フィールドが空値の場合のレスポンス

キーなし

6. 複数画像

複数の画像用のフィールドです。

レスポンスの型

配列(画像オブジェクトの配列)

"imageList": [
        {
            "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/image1.png",
            "height": 630,
            "width": 1200
        },
        {
            "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/image2.png",
            "height": 630,
            "width": 1200
        }
]

フィールドが空値の場合のレスポンス

空配列([]

7. 日時

Date型のフィールドです。

レスポンスの型

文字列(日時、ISO 8601形式のUTC(協定世界時))

"date": "2023-01-01T00:00:00.000Z"

フィールドが空値の場合のレスポンス

キーなし

8. 真偽値

Boolean型のフィールドです。

レスポンスの型

真偽値(true or false

"boolean": true

フィールドが空値の場合のレスポンス

false

informationInformation

真偽値フィールドの値はデフォルトで false となっています。

9. セレクトフィールド

定義したリストの中から値を選択するフィールドです。

レスポンスの型

配列(事前に定義した選択肢の配列)

// 複数選択がOFFのとき
"selectField": ["Apple"]

// 複数選択がONで、複数選択しているとき
"selectField": ["Apple", "ORANGE"]

フィールドが空値の場合のレスポンス

空配列([]

10. コンテンツ参照

他コンテンツを参照するフィールドです。

レスポンスの型

オブジェクト(他コンテンツのデータ)

"relationalContent": {
        "id": "xxxxxxxxxx",
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-01T00:00:00.000Z",
        "publishedAt": "2023-01-01T00:00:00.000Z",
        "revisedAt": "2023-01-01T00:00:00.000Z",
            "title": "some title"  
}

フィールドが空値の場合のレスポンス

null

11. 複数コンテンツ参照

複数の他コンテンツを参照するフィールドです。

レスポンスの型

配列(他コンテンツのデータの配列)

"relationalContentList": [
        {
                "id": "xxxxxxxxxx",
                "createdAt": "2023-01-01T00:00:00.000Z",
                "updatedAt": "2023-01-01T00:00:00.000Z",
                "publishedAt": "2023-01-01T00:00:00.000Z",
                "revisedAt": "2023-01-01T00:00:00.000Z",
                "title": "some title"  
        },
        {
                "id": "yyyyyyyy",
                "createdAt": "2023-02-01T00:00:00.000Z",
                "updatedAt": "2023-02-01T00:00:00.000Z",
                "publishedAt": "2023-02-01T00:00:00.000Z",
             "revisedAt": "2023-02-01T00:00:00.000Z",
                "title": "some title 2" 
        }
]

フィールドが空値の場合のレスポンス

空配列([]

12. 数字

Number型のフィールドです。

レスポンスの型

数値

"number": 42

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
キーなし / null

13. カスタムフィールド

作成済みのカスタムフィールドを利用したフィールドです。

レスポンスの型

オブジェクト

"customField": {
        "fieldId": "someCustomField",
        // 以降、作成したカスタムフィールドの内容に準ずる
        "title": "some titlte"
}

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
null / {“fieldId”: “someFieldId”}

14. 繰り返しフィールド

作成済みのカスタムフィールドを複数選択し、繰り返し入力できるフィールドです。

レスポンスの型

配列(カスタムフィールドオブジェクトの配列)

"repeatField": [
        {
                "fieldId": "someCustomField",
                "title": "some titlte"
        },
        {
                "fieldId": "someCustomField",
                "title": "some titlte 2"
        }
]

フィールドが空値の場合のレスポンス

入力方法によって以下のパターンがあります。
空配列([]) / null

15. ファイル

ファイル用のフィールドです。

レスポンスの型

オブジェクト

"file": {
        "url": "https://files.microcms-assets.io/assets/xxxxx/yyyy/files.zip"
}

フィールドが空値の場合のレスポンス

キーなし

16. 拡張フィールド

外部データの読み込みができるフィールドです。

レスポンスの型

オブジェクト(アプリケーションから連携されたデータのオブジェクト)

"iframe": {
        "id": "123"
}

フィールドが空値の場合のレスポンス

キーなし

informationInformation

拡張フィールドのレスポンスに関する詳細は、拡張フィールドの詳細ページも合わせてご参照ください。
拡張フィールドによる外部データ連携|microCMSドキュメント

フィールドが空値の場合のレスポンス一覧

入力方法ごとに、各フィールドの値が空値だった場合のレスポンス一覧を示します。

管理画面からの入力

CSVインポート
(空値)

POST/PUT API
(※1)

PATCH API
(※2)

テキストフィールド

キーなし

キーなし

キーなし

null

テキストエリア

キーなし

キーなし

キーなし

null

リッチエディタ

キーなし

キーなし

キーなし

null

旧リッチエディタ(非推奨)

キーなし

キーなし

キーなし

""

画像

キーなし

キーなし

キーなし

(非対応)

複数画像

[]

[]

[]

(非対応)

日時

キーなし

キーなし

キーなし

キーなし

真偽値

false

false

false

false

セレクトフィールド

[]

[]

[]

[]

コンテンツ参照

null

null

null

null

複数コンテンツ参照

[]

[]

[]

[]

数字

キーなし

キーなし

キーなし

null

カスタムフィールド

{"fieldId": "someFieldId", ...}

(※3)

null

null

{"fieldId": "someFieldId", ...}

(※3)

繰り返しフィールド

[]

null

null

[]

ファイル

キーなし

キーなし

キーなし

(非対応)

拡張フィールド

キーなし(※4)

キーなし

キーなし

キーなし

(※1)POST/PUT APIにおいて、空値で登録する方法はそれぞれ「POST /api/v1/{endpoint}」「PUT /api/v1/{endpoint}/{content_id}」をご確認ください。
(※2)PATCH APIにおいて、空値で登録する方法は「PATCH /api/v1/{endpoint}/{content_id}」をご確認ください。
(※3)レスポンスの値はカスタムフィールドのスキーマ構造によって決定されます。
(※4)一度フィールドにデータを入力した後に、管理画面からデータを空にした場合は、キーはそのまま残り、任意の空値("" , null , [] など)が入ります。

informationInformation

「キーなし」とは、レスポンスに該当フィールドのキー自体を含まない状態を指しています。