Sites⚓︎

Path⚓︎

/v1/sites

Resource Attributes⚓︎

The attributes for the sites resource are detailed below:

Attribute	Type	Required?	Description
name	String	YES	The name of the site.
uuid	String	YES	A unique identifier for the site.
location	Object	NO	The location of the site. Can be null if not provided.
extensions	Object	NO	A container for any additional properties or metadata.
roleNameFull	String	YES	The full role name associated with the site (e.g., ROLE_SITE).
roleName	String	YES	The short role name associated with the site (e.g., SITE).
roamingProfile	String	NO	The roaming profile assigned to the site (link).

Example⚓︎

{
  "name": "AcmeCorp",
  "uuid": "1234a123-123b-12a1-aa12-a1a2a345a1d2",
  "location": null,
  "extensions": {},
  "roleNameFull": "ROLE_SITE",
  "roleName": "SITE",
  "roamingProfile": "{baseUrl}/v1/roaming-profiles/123"
}

Endpoints⚓︎

Request Examples⚓︎

Find a Site using Search:⚓︎

Use findByName or findByDeepSearch:

{baseUrl}/v1/sites/search/findByDeepSearch?searchString=<searchCriteria>

Where <searchCriteria> is the text string used to find the site.

Find all Systems belonging to a Site:⚓︎

{baseUrl}/v1/sites/<siteID>/systems

Where <siteID> is the unique identifier for the site.