WorkflowRuleSetRead
Extracts workflow rule configuration data.
Usage
Use the WorkflowRuleSetRead method to extract workflow rule configuration data.
You can read workflow rule sets by specifying the <RecordType>, <TriggerEvent>, and <ParentRecordType> child elements of apQuery:WorkflowRuleSet.
You can read an individual workflow rule by specifying a value for the <WorkflowName> element.
The <Order> element is returned for each workflow rule, otherwise only fields included in the request are returned.
See WorkflowRuleSetUpsert for information about the workflow rule data specified in apData:WorkflowRuleSet.
Arguments
The following table describes the arguments taken by the WorkflowRuleSetRead method.
Name | Description | Required | Default | I/O |
---|---|---|---|---|
apQuery:WorkflowRuleSet |
The workflow rule query criteria. |
Yes |
Not applicable |
Input |
apData:ListOfWorkflowRuleSet |
The extracted workflow rule data. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The workflow rules data is returned.