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 site ID


The get site areas for site method is used to fetch the site areas that are associated with a site by using the site ID.

URL

Use the following URL for get site areas for site method:

/api/com.bmc.arsys.rx.foundation/location/site/<<Site Id>>/sitearea

Parameter

The following table provides information about the parameter of the get site areas for site method:

Parameter

Description

Example

Site Id

Specifies a valid site ID. If an invalid or incorrect site ID is provided, a response code 500 is returned. Additionally, the following message is displayed:

[ERROR (302): Entry does not exist in database; com.bmc.arsys.rx.foundation:Site:foundation_site_000011]

In the above message, foundation_site_000011 is an invalid site ID.

/location/site/foundation_site_00001

Example

To get site areas for a given site ID, use the following URL:

/api/com.bmc.arsys.rx.foundation/location/site/foundation_site_00001/sitearea

 In the example, foundation_site_00001 is a valid site ID.

Related topics

Get-site-area-details-by-using-search-criteria

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*