ProcessAdministrationRead

Extracts process administration configuration data.

Usage

Use the ProcessAdministrationRead method to extract process administration configuration data. The Process Administration privilege is required.

Note: The ProcessAdministrationRead method does not read the field setup and related access control configuration data for transition states.

You can query process administration data using the following child elements of apQuery:Process:

  • <RecordType>

  • <ProcessName>

  • <RecordType> + <ProcessName>

See ProcessAdministrationUpsert for information about the process administration data specified in apData:Process.

Arguments

The following table describes the arguments taken by the ProcessAdministrationRead method.

Table Arguments Taken by the ProcessAdministrationRead Method

Name Description Required Default I/O

apQuery:Process

The process administration query criteria.

Yes

Not applicable

Input

apData:ListOfProcess

The extracted process administration data.

Not applicable

Not applicable

Output

Return Value of the Call

The process administration data is returned.