This documentation supports the 20.02 version of BMC Helix Platform.To view the documentation for the current version, select 20.08 from the Product version menu.

Get approval details by using user ID


You can use the getApprovalsByUserId method to get all the approvals that contain the specified user as the approver.

URL

The following URL is the syntax to use the getApprovalsByUserId method:

GET rx/application/approval/{userId}?

Parameters

The following parameters are supported by the getApprovalsByUserId method:

Parameter

Description

Example

URL parameter

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 string fieldNames or a combination of both.

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

status

Returns the list of approvals with the specified status.

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

Query parameter

modified-before

Returns the list of approvals that were modified before the specified date.

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

modified-after

Returns the list of approvals that were modified after the specified date.

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

created-before

Returns the list of approvals that were created before the specified date.

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

created-after

Returns the list of approvals that were created after the specified date.

GET rx/application/approval/{userId}?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, you can use the following URL:

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

Related topics

Get-approvals-list

Get-approval-details-by-using-entry-ID

Adding-an-approval-process-to-an-application

 

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