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

Get site area details by using search criteria


The get site area by search text method enables you to fetch the details of all the site areas that match the search criteria. 

URL

Use the following URL for the get site area by search text method:

/api/com.bmc.arsys.rx.foundation/location/sitearea?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>>

Parameters

The following table provides information about the parameters of the get site area by search text method:

Example

To get all site area names where the location description contains the word Pune, use the following URL:

/api/com.bmc.arsys.rx.foundation/location/sitearea?propertySelection=locationName&queryExpression='locationDescription' like "%Pune%"

 In the example, locationName and locationDescription are site area fields.

Related topics

Get-site-area-details-by-using-site-ID

Get-site-area-details-by-using-site-area-ID

 

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