FlexiPage

フレキシブルページとその詳細のリストを返します。返される情報には、フレキシブルページの範囲、各範囲内のコンポーネント、各コンポーネントのプロパティ、および関連付けられた QuickActions が含まれます。このリソースは API バージョン 29.0 以降で使用できます。

構文

URI

フレキシブルページの詳細をすべて返すには、/vXX.X/flexiPage/フレキシブルページの ID を使用します。

形式

JSON、XML

HTTP メソッド

HEAD, GET

認証

Authorization: Bearer token

パラメータ

不要

例

ルートフレキシブルページリソースの取得

1curl https://na1.salesforce.com/services/data/v29.0/flexiPage/ -H "Authorization: Bearer token"

ID が 0M0xx0000000001CAA であるフレキシブルページの取得

1curl https://na1.salesforce.com/services/data/v29.0/flexiPage/0M0xx0000000001CAA -H "Authorization: Bearer token"

/vXX.X/flexiPage/ のリクエストボディの例

不要

/vXX.X/flexiPage/ のレスポンスボディの例

1{
2 "urls" : {
3   "flexiPage" : "/services/data/v29.0/flexiPage",
4   "rowTemplate" : "/services/data/v29.0/flexiPage/{ID}"
5 }
6}

/vXX.X/flexiPage/{フレキシブルページの ID} のリクエストボディの例

不要

/vXX.X/flexiPage/{フレキシブルページの ID} のレスポンスボディの例

このコード例には、quickActionList 情報が含まれています。REST API でのクイックアクション (別名パブリッシャーアクション) についての詳細は、「Quick Actions」および「sObject Quick Actions」を参照してください。

メモ

1{
2    "name": "DeveloperNameOfFlexiPage",
3    "id": "0M0xx0000000001CAA",
4    "label": "FlexiPage Label",
5    "quickActionList": {
6        "quickActionListItems": [
7            {
8                "type": "Post",
9                "label": "Post",
10                "quickActionName": "FeedItem.TextPost",
11                "targetSobjectType": null,
12                "iconUrl": null,
13                "miniIconUrl": null
14            },
15            {
16                "type": "Create",
17                "label": "testFlexiQuickAction",
18                "quickActionName": "flexiAction",
19                "targetSobjectType": "Contact",
20                "iconUrl": "http://{SALESFORCE-APPSERVER-DOMAIN}/img/icon/contacts32.png",
21                "miniIconUrl": "http://{SALESFORCE-APPSERVER-DOMAIN}/img/icon/contacts16.png"
22            }
23        ]
24    },
25    "regions": [
26        {
27            "name": "main",
28            "components": [
29                {
30                    "properties": [
31                        {
32                            "name": "entityName",
33                            "value": "Account"
34                        },
35                        {
36                            "name": "filterName",
37                            "value": "MyAccounts"
38                        }
39                    ],
40                    "typeName": "filterList",
41                    "typeNamespace": "force"
42                }
43            ]
44        }
45    ]
46}

このサンプルコードの内容は次のとおりです。

• name — 範囲の名前
• components — 範囲の Aura コンポーネントの配列
• properties — コンポーネントのプロパティの配列
• typeName — Aura コンポーネントの名前
• typeNamespace — Aura コンポーネントの名前空間