describeApprovalLayout()
構文
1DescribeApprovalLayoutResult approvalLayoutResult = connection.describeApprovalLayout(string sObjectType, string[] approvalProcessNames);使用方法
このコールを使用して、指定されたオブジェクト種別の承認レイアウトに関する情報を取得します。承認プロセスごとに 1 つの承認レイアウトがあります。
approvalProcessNames に null 値を指定した場合、指定された各承認プロセスの承認レイアウトではなく、そのオブジェクトのすべての承認レイアウトが返されます。
サンプルコード — Java
このサンプルでは、取引先 sObject の承認レイアウトを取得する方法を示します。記述する sObject 種別の名前を使用して、describeApprovalLayout() をコールします。承認レイアウトの取得後、検出された各承認レイアウトの名前と項目が出力されます。
1public void describeApprovalLayoutSample() {
2 try {
3 String objectToDescribe = "Account";
4 DescribeApprovalLayoutResult approvalLayoutResult =
5 connection.describeApprovalLayout(objectToDescribe, null);
6 System.out.print("There are " + approvalLayoutResult.getApprovalLayouts().length);
7 System.out.println(" approval layouts for the " + objectToDescribe + " object.");
8
9 // Get all the approval layouts for the sObject
10 for (int i = 0; i < approvalLayoutResult.getApprovalLayouts().length; i++) {
11 DescribeApprovalLayout aLayout = approvalLayoutResult.getApprovalLayouts()[i];
12 System.out.println(" There is an approval layout with name: " + aLayout.getName());
13 DescribeLayoutItem[] layoutItems = aLayout.getLayoutItems();
14 System.out.print(" There are " + layoutItems.length);
15 System.out.println(" fields in this approval layout.");
16 for (int j = 0; j < layoutItems.length; j++) {
17 System.out.print("This approval layout has a field with name: ");
18 System.out.println(layoutItems[j].getLabel());
19 }
20 }
21 } catch (ConnectionException ce) {
22 ce.printStackTrace();
23 }
24}引数
| 名前 | 型 | 説明 |
|---|---|---|
| sObjectType | string | 指定された値は、組織で有効なオブジェクトである必要があります。オブジェクトが個人取引先である場合は Account を指定し、個人取引先責任者である場合は Contact を指定します。 |
| approvalProcessNames | string[] | 承認レイアウトメタデータを返す対象の承認プロセス API 名の配列 (任意指定)。 |