Get approvals list


Use the getApproval method to get a list of all approvals assigned to all users.

URL

The following URL is the syntax for the getApproval method:

GET rx/application/approval?

Parameters

The following parameters are supported by the getApproval method:

Parameter

Description

Example

URL parameters

pageSize

Specifies how many records should be returned in this page.

GET rx/application/approval/{userId}?&pageSize=10&status=Pending&status=Approved

startIndex

Specifies the first record index of the page.

GET rx/application/approval/{userId}?&startIndex=0&status=Pending&status=Approved

propertySelection

Specifies the list of comma-separated properties that should appear in the response object.

The propertySelection parameter accepts numeric fieldIds or a string of fieldNames or a combination of both.

GET rx/application/approval/{userId}?&propertySelection=application,summary,requester,status,request,createDateSig

status

Specifies status types for which want to get approvals.

GET rx/application/approval?status=Pending&status=Approved

Query parameters

modified-before

Returns a list of approvals modified before the specified date.

GET rx/application/approval?modified-before=2017-04-21T07:22:21.000Z

modified-after

Returns a list of approvals modified after the specified date.

GET rx/application/approval?modified-after=2017-04-21T07:22:21.000Z

created-before

Returns a list of approvals created before the specified date.

GET rx/application/approval?created-before=2017-04-21T07:22:21.000Z

created-after

Returns a list of approvals created after the specified date.

GET rx/application/approval?created-after=2017-04-21T07:22:21.000Z

Example: Using multiple values in query parameters

You can also use multiple values in the query parameters. If you provide multiple values in the query parameters, the method returns the approvals that match any property value.

If you want the list of approvals with pending status and approved status that were modified after a specific date, use the following URL:

rx/application/approval?modified-after=2017-04-21T07:22:21.000Z&status=Pending&status=Approved


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*