Sign in

v7

latestSwagger 2.02026-07-13186148695.0 KB
Zones

Gets a specified zone resource under a particular party.

get/parties/{partyId}/zones/{zoneId}

Path parameters

partyIdstring required

Id of the associated party.

zoneIdstring required

Id of the zone.

Query parameters

api-versionstring required

The requested API version

Response

Success

partyIdstring

Party Id associated with the Zone.

typestring

Type of the Zone.

managementZoneIdstring

Management Zone Id associated with the Zone.

idstring

Unique resource ID.

eTagstring

The ETag value to implement optimistic concurrency.

statusstring

Status of the resource.

createdDateTimestring date-time

Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.

modifiedDateTimestring date-time

Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.

sourcestring

Source of the resource.

namestring

Name to identify resource.

descriptionstring

Textual description of the resource.

createdBystring

Created by user/tenant id.

modifiedBystring

Modified by user/tenant id.

propertiesobject

A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.

Example response

{
  "createdDateTime": "2020-12-31T11:10:21Z",
  "modifiedDateTime": "2020-12-31T11:10:21Z",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}