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

The get site area by ID method enables you to fetch details of a site area by using the site area ID. 


Use the following URL for get site area by ID method:

/api/<<SiteArea Id>>


The following table provides information about the parameters of the get site area by ID method

SiteArea Id

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

[ERROR (302): Entry does not exist in database; Area:foundation_sitearea_000011]

In the above message, foundation_sitearea_000011 is an invalid site area ID.

/location/sitearea/ foundation_sitearea_00001


To get the site area by searching with the site area ID, use the following URL:


In the example, foundation_sitearea_00001 is a valid site area ID.

Related topics

Get site area details by using site ID

Get site area details by using search criteria

Was this page helpful? Yes No Submitting... Thank you