SiteListResponseSchema

Properties

@odata.nextLink

• type: string
• description: URL if the page length and number of items match (optional).

supplemental

• type: object (ListResponseSupplementalSchema)
• description: Supplemental info (required).

count

• type: integer
• description: Number of items returned (required).

kind

• type: string
• description: Type of items in the list (required).

operation

• type: string
• description: Operation type. Should always say 'list' (required).

pagination

• type: object (PaginationInfoSchema)
• description: Pagination info (required).

Pagination Properties

• end (integer): Position of the last item in the list (required).
• records (integer): Total number of items returned in the list (required).
• start (integer): Position of the first item in the list (required).
• total (integer): Total number of items in the project (required).

subscription

• type: object (ProjectInfoSchema)
• description: Project info (optional).

Project Properties

• id (string): Project ID (required).
• name (string): Project name (required).

valuelist

• type: list of objects (SiteGetSchema)
• description: A list of sites (required).

Site Properties

• kind (string): The kind of record (required).

metadata

• type: object (MetadataSchema)
• description: Site metadata (required).

Metadata Properties

• created (string, optional): The time when the resource was created (format: date-time).
• createdBy (string, optional): ID of the user who created the resource (format: uuid).
• createdByEmail (string, optional): Email of the user who created the resource.
• displayName (string, optional): The display name of the resource.
• id (string, required): The ID of the resource (format: uuid).
• labels (map): A dictionary of labels associated with the resource (optional).
• name (string, optional): The name of the resource.
• updated (string, optional): The time when the resource was last updated (format: date-time).
• updatedBy (string, optional): ID of the user who last updated the resource (format: uuid).
• updatedByEmail (string, optional): Email of the user who last updated the resource.

spec

• type: object (SiteBodySpec)
• description: Site specification (required).

Site Specification Properties

• geolocation (object, optional): Optional geolocation data for the site.

Geolocation Properties

• coordinates (list of doubles, required): Co-ordinates that describe the geolocation (ISO 6709).
• routes (list of objects, optional): The routes that connect the network to sites.

Route Properties

• defaultTransport (object, optional): Settings used to influence the transport.

Default Transport Properties

• cidr (string, optional): The IP address range to choose from for transport settings.
• type (enum, required): The type of transport to use for sending content.
• networkName (string, required): The name of the network connected to the site.

status

• type: object (SiteBodyStatus)
• description: Site status (required).

Status Properties

• locationDisplayName (string, optional): Display name of the location of this site.
• locationName (string, optional): Name of the location of this site.
• owner (enum, required): Indicates whether the site was automatically created by the system.