リスト形式のAPIにおいてはコンテンツのメタ情報一覧が取得でき、オブジェクト形式のAPIにおいては単一コンテンツのメタ情報が取得ができます。

オブジェクト形式のAPIの場合はGET /api/v1/contents/{endpoint}/{content_id}と同様の結果が得られます。

ここではリスト形式のAPIの場合におけるリクエストヘッダー、クエリパラメータについて解説します。

リクエストヘッダー

X-MICROCMS-API-KEY

マネジメントAPIのGET APIリクエストの際に必要な認証キーです。
マネジメントAPIのデフォルト権限で「コンテンツの取得 (一覧・詳細)」を有効にして、リクエストヘッダーに含めて送信してください。

レスポンスボディ

こちらがマネジメントAPIで取得したコンテンツ一覧のレスポンス例です。

{
  "contents": [
    {
      "id": "contentId",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedAt": "2019-08-24T14:15:22Z", 
      "revisedAt": "2019-08-24T14:15:22Z",
      "closedAt": null,
      "status": [
        "DRAFT"
      ],
      "customStatus": null, 
      "draftKey": "draftKey",
      "createdBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
      "updatedBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
      "reservationTime": {
        "publishTime": "2019-08-24T14:15:22Z", 
        "stopTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "totalCount": 1,
  "offset": 0,
  "limit": 10
}

contentsについて

取得したコンテンツの値はcontentsという配列で返されます。contents内のオブジェクトには以下の項目が含まれます。

マネジメントAPIでのみ取得できる値

contents内のオブジェクトに含まれるマネジメントAPI特有の値は以下のとおりです。これらの値はコンテンツAPIには含まれません。

• closedAt
• status
• customStatus
• createdBy
• updatedBy
• reservationTime

クエリストリング

本APIにはクエリストリングを指定できます。

limit

取得件数を指定します。
デフォルト値は10です。上限値は100です。

offset

コンテンツを取得開始する位置を、指定した値だけ後ろにずらします。
デフォルト値は0です。

カスタムステータス

カスタムステータスが設定されたコンテンツでは以下のように customStatus がレスポンスに含まれます。

{
  "id": "contentId",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "publishedAt": "2019-08-24T14:15:22Z",
  "revisedAt": "2019-08-24T14:15:22Z",
  "status": [
    "PUBLISH"
  ],
  // このcustomStatusが新たに追加されます。
  // customStatusが未対応のプランや設定されていない場合はnullになります。
  "customStatus": [
    {
      "key": "USER_DEFINED_CUSTOM_STATUS_KEY123",
      "description": "ユーザが定義したカスタムステータスです。",
      "name": "カスタムステータスのテスト",
      "behaviour": "PUBLISH",
      "color": "#a20063",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "draftKey": "draftKey",
  "createdBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
  "updatedBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
  "reservationTime": {
    "publishTime": "2019-08-24T14:15:22Z",
    "stopTime": "2019-08-24T14:15:22Z"
  }
}

カスタムステータスについて詳しくは以下ドキュメントをご覧ください。