Newer Version Available
describeApprovalLayout()
Syntax
Usage
Use this call to retrieve information about the approval layout for a given object type. Each approval process has one approval layout.
If you supply a null value for approvalProcessNames, all the approval layouts for the object are returned, instead of the approval layout of each specified approval process.
Sample Code—Java
This sample shows how to get the approval layouts of an Account sObject. It calls describeApprovalLayout() with the name of the sObject type to describe. After getting the approval layouts, the sample prints the name and fields found for each approval layout.
Arguments
| Name | Type | Description |
|---|---|---|
| sObjectType | string | The specified value must be a valid object for your organization. If the object is a person account, specify Account, or if it is a person contact, specify Contact. |
| approvalProcessNames | string[] | Optional array of the approval process API names to return approval layout metadata for. |