GET api/access/v1/plants/{plantId}/zones

List zones for a specific plant

Request Information

Requires Authorization!

In order to make a request to work 2 headers are required, a ClientId and a ClientSecret

URI Parameters

NameDescriptionTypeAdditional information
plantId

Id of the plant

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

List of zones for the specified plant

Collection of Zone
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

None.

Description

string

None.

IsExternal

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "da2976c7-2e96-4e9d-aeb6-ab5bd76a1509",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "IsExternal": true
  },
  {
    "Id": "da2976c7-2e96-4e9d-aeb6-ab5bd76a1509",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "IsExternal": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfZone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSG.Endpoints.ITOps.DataAPI.Logic.Models.Access">
  <Zone>
    <Description>sample string 3</Description>
    <Id>da2976c7-2e96-4e9d-aeb6-ab5bd76a1509</Id>
    <IsExternal>true</IsExternal>
    <Name>sample string 2</Name>
  </Zone>
  <Zone>
    <Description>sample string 3</Description>
    <Id>da2976c7-2e96-4e9d-aeb6-ab5bd76a1509</Id>
    <IsExternal>true</IsExternal>
    <Name>sample string 2</Name>
  </Zone>
</ArrayOfZone>