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

Search approval by user and by search text


You can use the searchApprovalsByUserAndSearchText method to get all the approvals that contain the specified users who are approvers  and the search text. The search is performed only on the character fields. This method does not support search on date fields and integer fields.

URL

The following URL is the syntax for the searchApprovalsByUserAndSearchText method:

GET rx/application/approval/search?

Parameters

The following parameters are supported by the searchApprovalsByUserAndSearchText method:

Parameter

Description

Example

userId

Specifies the user ID of the approver user

GET rx/application/approval/search?userId=Allen

searchText

(Required) Specifies the text that you want to search.

GET rx/application/approval/search?userId=Allen&searchText=Where Is My Approval

searchBy

Specifies the attributes from the Signature domain object on which you want to search. You can provide attributes such as justification, process, and application.

You can use the following searchBy attributes to search the AP:Detail-Signature fields:

  • summary14506 field
  • application10051 field
  • request10050 field
  • process10000 field
  • notes 14513 field
  • toolTip14512 field
  • justification14518 field
  • otherDetail114508 field
  • otherDetail214509 field
  • otherDetail314510 field
  • otherDetail414511 field

Note: If you do not specify the searchBy attribute, the search is performed on all the character fields of the Signature objects.

  • GET rx/application/approval/search?userId=Allen&searchText=Where Is My Approval&searchBy=justification&searchBy=process&searchBy=application
    The search is performed against the justification, process, application attributes of Signature domain object.
  • GET rx/application/approval/search?userId=Allen&searchText=Where Is My Approval
    The search is performed against all character attributes in the Signature domain object.

Related topics

Get-approvals-list

Get-approval-signature

Get-single-approval

Update-approval-status

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

 

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