ApprovalRequestList Message
The
getApprovalRequests operation (and other operations provided by the Approval service) returns an
ApprovalRequestList message. This message contains an array of
ApprovalRequest elements. Each ApprovalRequest element in the array represents a single approval request and contains the following information:
The key of the approval request object (this key is required to perform operations that act directly on a specific approval request)
The key of the user who submitted the approval request
The date on which the approval request was submitted
The key of registry object for which the approval request was submitted
The type of object for which the approval request was submitted
The status of the request
Remarks, if any, that were submitted with the approval request
The approval requests in the array are not sorted.
The
ApprovalRequestList message also returns an attribute called
count, which indicates the total number of approval requests in the result set. If the operation did not find any approval requests that satisfied the operation's criteria, there will be no elements returned in
ApprovalRequest[] and the
count value will be zero.
If you want to receive the result set a few entries at a time instead of all at once, you can use the
scroll parameter in the request message to specify which block of entries you want the operation to return. For more information about using the
scroll parameter, see
Scrolling Through the List of Returned Approval
Requests.
