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 person details


The get Person Information method enables you to fetch the contact details of any person within the organization. The person can be an employee, agent, customer, or vendor. 

URL

Use the following URL for get Person Information method:

/api/com.bmc.arsys.rx.foundation/person?pageSize=<<any valid number as pageSize>>
&startIndex=<<any valid number as startIndex>>
&propertySelection=<<comma separated fieldIds or fieldNames>>
&sortBy=<<comma separated fieldIds>>
&queryExpression=<<any valid query expression>>
&loginId=<<any valid login Id>>
&personId=<<any valid person Id>>
&organizationId=<<any valid organization Id>>

Parameters

The following table provides information about the parameters of the get Person Information method.

Example

To fetch the person details for a given login ID, person ID, and organization ID, use the following URL:

/api/com.bmc.arsys.rx.foundation/person?propertySelection=loginId,id&loginId=employee9&personId=EMPID9&organizationId=ORGMO10BU1DEPT1SG1

In the example, loginId and id are person fields. employee9 is a valid login ID, EMPID9 is a valid person ID, and ORGMO10BU1DEPT1SG1 is a valid organization ID.

Related topics

Get-person-details-by-using-person-ID

Get-person-information-by-notification

 

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