オブジェクトの一覧を返します。ステータス付きモデルの場合認証付きリクエストで権限がない場合、非公開・無効なオブジェクトは取得できません。
※ 認証付きリクエストで listエンドポイントにアクセスした時、ユーザーの権限に基づき、管理画面のオブジェクト一覧画面のルールでオブジェクトを取得します。
/api/v1/スコープID/モデル名/list
/api/v1/1/entry/listGET または POST※ パラメタはすべてオプションです。
?limit=件数&offset=スキップする件数&sort_by=カラム名&sort_order=昇順もしくは降順&cols=返却するキー1,返却するキー2&query=キーワード&search_cols=検索対象のカラム1,search_cols=検索対象のカラム2&search_type=検索タイプ管理画面やダイナミックパブリッシングで利用できる一覧のフィルタ指定が可能です。
例えば特定のユーザーの記事のIDとタイトルのみを取得する場合は以下のようなリクエストとなります(リレーション指定の時、ユーザーの場合はnickname、その他のモデルではプライマリカラムの値を指定します)
https://example.com/powercmsx/api/v1/1/entry/list?_filter_value_user_id[]=User%20Name&_filter_cond_user_id[]=eq&cols=id,titletotalResultには、limitに関わらず指定した条件にマッチするオブジェクトのトータル件数がセットされます。
{
"totalResult": 10,
"items": [
{
"id": 1,
"title": "Welcome!",
"text": "<h2>Our Story<\/h2>\n<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<\/p>\n<blockquote>\n<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<\/p>\n<\/blockquote>",
"text_format": "richtext",
"assets": [
{
"id": 26,
"label": "powercmsx",
"file": {
"Url": "https:\/\/localhost\/01\/assets\/powercmsx.png",
"Label": null,
"Metadata": {
"file_size": 76618,
"image_width": 600,
"image_height": 600,
"class": "image",
"extension": "png",
"mime_type": "image\/png",
"uploaded": "2021-09-02 15:11:58",
"user_id": 1
}
},
"extra_path": "assets\/",
"file_name": "powercmsx.png",
"file_ext": "png",
"mime_type": "image\/png",
"tags": [],
"size": 76618,
"image_width": 600,
"image_height": 600,
"class": "image",
"status": 4,
"created_by": 1,
"modified_by": 1,
"created_on": "2021-09-02 15:11:58",
"modified_on": "2021-09-02 15:11:58",
"workspace_id": 1,
"published_on": "2021-09-02 15:11:58",
"rev_type": 0,
"user_id": 1,
"uuid": "a415ce51-5e70-4b1b-9413-8342f3e864ab",
"Permalink": "http:\/\/mt4local.alfasado.net\/01\/assets\/powercmsx.png",
"Thumbnail": "https:\/\/localhost\/powercmsx\/assets_c\/thumb-asset-128xauto-square-26-file.png"
}
],
"text_more": "",
"excerpt": "Our StoryLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"keywords": "",
"categories": [
{
"id": 1,
"label": "Press Release",
"order": 1,
"basename": "press_release",
"workspace_id": 1,
"created_on": "2021-08-27 15:13:45",
"modified_on": "2021-08-27 15:13:45",
"created_by": 1,
"modified_by": 1,
"Permalink": "http:\/\/mt4local.alfasado.net\/01\/press_release\/index.html",
"Path": "press_release"
}
],
"tags": [
{
"id": 6,
"name": "PowerCMS X",
"normalize": "powercmsx",
"class": "entry",
"order": 2,
"workspace_id": 1,
"created_on": "2021-09-02 15:09:57",
"modified_on": "2021-09-02 15:09:57",
"created_by": 1,
"modified_by": 1
}
],
"extra_path": "",
"basename": "powercmsx",
"status": 4,
"has_deadline": 0,
"published_on": "2021-09-01 12:47:46",
"user_id": {
"id": 1,
"nickname": "Junnama Noda",
"photo": "",
"text_format": "",
"space_order": "",
"fix_spacebar": 1,
"language": "ja",
"control_border": "",
"status": 2
},
"previous_owner": 0,
"allow_comment": 0,
"created_on": "2021-08-27 15:13:45",
"modified_on": "2021-09-02 15:12:06",
"created_by": 1,
"modified_by": 1,
"workspace_id": 1,
"uuid": "d574478a-6762-434f-b002-723c835444ee",
"Permalink": "http:\/\/mt4local.alfasado.net\/01\/press_release\/powercmsx.html"
}
]
}共通レスポンスエラーについてはこちら 新しいウィンドウでリンクを開くを参照ください。
{
"status": 400,
"message": "Method リクエストメソッド not allowed."
}{
"status": 403,
"message": "Permission denied."
}