はじめに

導入

運用

参加・貢献

リソース

GitHubでこのページを編集

Home / 5 / web_api / baser_admin_api / baser core / コンテンツ一覧の取得

コンテンツ一覧の取得

コンテンツ情報の一覧を取得します。

実行可能な権限

すべてのユーザー:公開された情報のみ
ログインユーザー以上:全て

リクエスト

認証なし場合、
GET /baser/api/baser-core/contents.json
認証した場合、
GET /baser/api/admin/baser-core/contents.json

クエリパラメーター

パラメーター名 内容
list_type 文字列 レスポンスボディの掲載パターンを増やします。
index:通常一覧(デフォルト)
tree:ツリー構造
limit 数値 取得件数
page 数値 ページ数
id 数値 コンテンツID
type 文字列 コンテンツタイプ(Page, ContentFolder etc…)
type! 文字列 指定以外のコンテンツタイプ
parent_id 数値 親のコンテンツID
author_id 数値 作成者のユーザーID
site_id 数値 サイトID
title 数値 コンテンツのタイトル(ワイルドカード)
name 数値 URL上のファイル名、もしくは、タイトル(ワイルドカード)
status 文字列 publish:有効なコンテンツのみ
all:全て
folder_id 数値 指定したコンテンツID配下のコンテンツを全て取得

レスポンス例

レスポンスボディ

通常一覧(list_type=index)の場合

{
    "contents": [
        {
            "id": 5,
            "name": "about",
            "plugin": "BaserCore",
            "type": "Page",
            "entity_id": 2,
            "url": "/about",
            "site_id": 1,
            "alias_id": null,
            "main_site_content_id": null,
            "parent_id": 1,
            "lft": 6,
            "rght": 7,
            "level": 1,
            "title": "会社案内",
            "description": "",
            "eyecatch": "",
            "author_id": 1,
            "layout_template": "",
            "status": true,
            "publish_begin": null,
            "publish_end": null,
            "self_status": true,
            "self_publish_begin": null,
            "self_publish_end": null,
            "exclude_search": false,
            "created_date": "2023-03-21T12:43:06+09:00",
            "modified_date": null,
            "site_root": false,
            "deleted_date": null,
            "exclude_menu": false,
            "blank_link": false,
            "created": null,
            "modified": "2023-03-21T12:43:06+09:00"
        },
        ...
    ]
}

ツリー構造(list_type=tree)の場合

{
  "contents": [
    {
      "id": 1,
      "name": "",
      "plugin": "BaserCore",
      "type": "ContentFolder",
      "entity_id": 1,
      "url": "/",
      "site_id": 1,
      "alias_id": null,
      "main_site_content_id": null,
      "parent_id": null,
      "lft": 1,
      "rght": 32,
      "level": null,
      "title": "baserCMSサンプル",
      "description": "",
      "eyecatch": "",
      "author_id": 1,
      "layout_template": "default",
      "status": true,
      "publish_begin": null,
      "publish_end": null,
      "self_status": true,
      "self_publish_begin": null,
      "self_publish_end": null,
      "exclude_search": false,
      "created_date": "2023-04-14T15:29:36+09:00",
      "modified_date": null,
      "site_root": true,
      "deleted_date": null,
      "exclude_menu": false,
      "blank_link": false,
      "created": "2023-04-14T15:29:19+09:00",
      "modified": "2023-04-14T15:29:36+09:00",
      "children": [
        {
          "id": 4,
          "name": "index",
          "plugin": "BaserCore",
          "type": "Page",
          "entity_id": 1,
          "url": "/index",
          "site_id": 1,
          "alias_id": null,
          "main_site_content_id": null,
          "parent_id": 1,
          "lft": 2,
          "rght": 3,
          "level": 1,
          "title": "トップページ",
          "description": "",
          "eyecatch": "",
          "author_id": 1,
          "layout_template": "",
          "status": true,
          "publish_begin": null,
          "publish_end": null,
          "self_status": true,
          "self_publish_begin": null,
          "self_publish_end": null,
          "exclude_search": false,
          "created_date": "2023-04-14T15:29:36+09:00",
          "modified_date": null,
          "site_root": false,
          "deleted_date": null,
          "exclude_menu": false,
          "blank_link": false,
          "created": "2023-04-14T15:29:19+09:00",
          "modified": "2023-04-14T15:29:36+09:00",
          "children": [
          ]
        },
        ...
      ]
    }
  ]
}