GatewaysLocation

Gateway location details

Overview

address string read only  
associatedEntityName string read only   filterable   orderable  
associatedEntityType string read only   filterable  
country string read only  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
ignoreGeocode boolean
lastUpdatedBy string autogenerated  
latitude float
locality string read only  
longitude float
state string read only  
timeZoneID string required   read only  

API Resource

/gatewayslocations/id

Parents

/enterprises/id/gatewayslocations
get

Children

/gatewayslocations/id/metadatas
get post
/gatewayslocations/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

address string read only  
Discussion

Formatted address including property number, street name, suite or office number, ...

Charateristics

Format: free
Max length: 255
SDK attribute: address

associatedEntityName string read only   filterable   orderable  
Discussion

The name of the Entity to which a Location instance is tied to.

Charateristics

Format: free
SDK attribute: associatedEntityName

associatedEntityType string read only   filterable  
Discussion

Type of the gateway entity to which the Location instance is attached.

Charateristics

SDK attribute: associatedEntityType

country string read only  
Discussion

Country in which the gateway is instantiated (VM) or installed (Physical).

Charateristics

Format: free
Max length: 255
SDK attribute: country

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

ignoreGeocode boolean
Discussion

Request BSS to perform a geocode on the address - If no value passed, 'ignoreGeocode' will be set to true.

Charateristics

SDK attribute: ignoreGeocode

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

latitude float
Discussion

Latitude in decimal format.

Charateristics

Format: free
Min value: -90.0
Max value: 90.0
SDK attribute: latitude

locality string read only  
Discussion

Locality, City, or County information about where the gateway is installed.

Charateristics

Format: free
Max length: 255
SDK attribute: locality

longitude float
Discussion

Longitude in decimal format.

Charateristics

Format: free
Min value: -180.0
Max value: 180.0
SDK attribute: longitude

state string read only  
Discussion

State, Province, or Region to which the locality in which the gateway is installed belongs.

Charateristics

Format: free
Max length: 255
SDK attribute: state

timeZoneID string required   read only  
Discussion

Time zone in which the Gateway is located. This can be in the form of a UTC/GMT offset, continent/city location, or country/region. The available time zones can be found in /usr/share/zoneinfo on a Linux machine or retrieved with TimeZone.getAvailableIDs() in Java. Refer to the IANA (Internet Assigned Numbers Authority) for a list of time zones. URL : http://www.iana.org/time-zones Default value is UTC (translating to Etc/Zulu)

Charateristics

Default value: UTC
Format: free
SDK attribute: timeZoneID