CustomRecordTypeRead
Extracts customized record type configuration data.
Usage
Use the CustomRecordTypeRead method to extract customized record type configuration data matching the input criteria.
The record type is specified with the <Name> child element of apQuery:CustomRecordType.
If the <IncludeAll> child element of apQuery:CustomRecordType specifies true, the method returns configuration data including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.
See CustomRecordTypeUpsert for information about the customized record type data specified in apData:ListOfCustomRecordType.
Arguments
The following table describes the arguments taken by the CustomRecordTypeRead method.
| Name | Description | Required | Default | I/O |
|---|---|---|---|---|
apQuery:CustomRecordType |
The customized record type query criteria. |
Yes |
Not applicable |
Input |
apData:ListOfCustomRecordType |
The extracted customized record type data. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The customized record type data is returned.