モバイル・カスタム開発が加速するuser interface apiのご紹介
TRANSCRIPT
モバイル・カスタム開発が加速する
User Interface APIのご紹介
Michikazu Sugahara
Salesforce Demo Engineer
2017.7.26
User Interface API
https://releasenotes.docs.salesforce.com/ja-jp/summer17/release-notes/rn_api_ui.htm
Summer’17〜 開発者プレビュー （2017/7/27現在、Developer Editionでのみ使用可能
）
User Interface API
・Salesforceレコードデータ＆メタデータを取得するREST形式のAPI
・専用ブランディングを施したネイティブモバイルApp・カスタムWebAppなどが簡単に開発できるように
（↓カスタムWebアプリのサンプル）
今まで必要だった面倒な手続き
・オブジェクトメタデータを取得する
・レイアウト情報を取得する
・SOQLクエリを実行し、レコードデータを取得する
・項目レベルセキュリティ設定、共有設定等参照し、権限を確認する
User Interface APIでできること
〜取得系〜
・ページレイアウト取得
・オブジェクトメタデータ取得
・レコードデータ取得
・ページレイアウト/オブジェクトメタデータ/レコードデータ一括取得
・ピックリスト値取得
・※クローン/新規作成時用デフォルト値取得
〜編集系〜
・新規レコード作成
・既存データ変更
・既存データ削除
ページレイアウト取得
GET
/services/data/v40.0/ui-api/layout/{オブジェクト名}
パラメータ：
formFactor – Large, Medium, Small
layoutType – Compact, Full
mode – Create, Edit, View
recordTypeId – レコードタイプID(新規作成モード時指定する場合)
オブジェクトメタデータ取得
GET
/services/data/v40.0/ui-api/object-info/{オブジェクト名}
パラメータ：
layoutType – Compact, Full
modes – Create, Edit, View
recordTypeId – レコードタイプID(新規作成モード時指定する場合)
レコードデータ取得
GET
/services/data/v40.0/ui-api/records/{レコードID}
パラメータ：
fields – 項目API名
layoutTypes – Compact, Full
modes – Create, Edit, View
optionalFields – その他項目API名
ページレイアウト/オブジェクトメタデータ/レコードデータ一括取得
GET
/services/data/v40.0/ui-api/record-ui/{レコードID}
パラメータ：
fields – 項目API名
layoutTypes – Compact, Full
modes – Create, Edit, View
optionalFields – その他項目API名
ピックリスト値取得
GET
/services/data/v40.0/ui-api/object-info/{オブジェクト名}/picklist-values/{レコードタイプID}/{項目名}
新規レコード作成
POST
/services/data/v40.0/ui-api/records
リクエストボディ：
{
“apiName”: ”{オブジェクト名}",
"fields": {
”{項目名}“: ”{値}”,
” {項目名}“: ”{値}”,
…
}
}
既存データの変更
PATCH
/services/data/v40.0/ui-api/records/{レコードID}
リクエストボディ：
{
"fields": {
”{項目名}“: ”{変更後の値}”,
” {項目名}“: ”{変更後の値}”,
…
}
}
既存データの削除
DELETE
/services/data/v40.0/ui-api/records/{レコードID}
※新規作成用デフォルト値の取得
GET
/services/data/v40.0/ui-api/record-defaults/create/{オブジェクト名}
パラメータ：
formFactor – Large, Medium, Small
recordTypeId – レコードタイプID(新規作成モード時指定する場合)
※レコードコピー用デフォルト値の取得
GET
/services/data/v40.0/ui-api/record-defaults/clone/{レコードID}
パラメータ：
formFactor – Large, Medium, Small
recordTypeId – レコードタイプID(新規作成モード時指定する場合)
User Interface API
〜デモ〜
