sObject ApprovalLayouts

指定されたオブジェクトの承認レイアウトのリストを返します。返される値を 1 つの特定の承認レイアウトに制限するには、特定の承認プロセス名を指定します。このリソースは REST API バージョン 30.0 以降で使用できます。

構文

URI

指定されたオブジェクトの承認レイアウトの説明を取得するには、/services/data/vXX.X/sobjects/sObject/describe/approvalLayouts/ を使用します。

特定の承認プロセスの承認レイアウトの説明を取得するには、/services/data/vXX.X/sobjects/sObject/describe/approvalLayouts/approvalProcessName を使用します。

形式

JSON、XML

HTTP のメソッド

HEAD, GET

認証

Authorization: Bearer token

要求パラメータ

不要

例

sObject のすべての承認レイアウトを取得する。

1curl https://yourInstance.salesforce.com/services/data/v54.0/sobjects/Account/describe/approvalLayouts/ -H "Authorization: Bearer token"

JSON レスポンスボディの例

1{
2  "approvalLayouts" : [ {
3    "id" : "04aD00000008Py9IAE",
4    "label" : "MyApprovalProcessName",
5    "layoutItems" : [...],
6    "name" : "MyApprovalProcessName"
7    }, {
8    "id" : "04aD00000008Q0KIAU",
9    "label" : "Process1",
10    "layoutItems" : [...],
11    "name" : "Process1"
12  } ]
13}

オブジェクトの承認レイアウトを定義していない場合は、応答が {"approvalLayouts" : [ ]} になります。

特定の承認プロセスの承認レイアウトを取得する。

1curl https://yourInstance.salesforce.com/services/data/v54.0/sobjects/Account/describe/approvalLayouts/MyApprovalProcessName -H "Authorization: Bearer token"

JSON レスポンスボディの例

1{
2  "approvalLayouts" : [ {
3    "id" : "04aD00000008Py9IAE",
4    "label" : "MyApprovalProcessName",
5    "layoutItems" : [...],
6    "name" : "MyApprovalProcessName"
7  } ]
8}