Get site details by using search criteria
The get sites by search text method enables you to fetch the details of all sites that match the search criteria.
URL
Use the following URL for the get sites by search text method:
/api/com.bmc.arsys.rx.foundation/location/site?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>>
&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 sites by search text method:
Example
To get all site names and descriptions where the location description contains the word Residential, use the following URL:
/api/com.bmc.arsys.rx.foundation/location/site?queryExpression='locationDescription' like "%Residential%"&propertySelection=locationName,locationDescription
In the example, locationDescription and locationName are site fields.
Related topics
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*