Gateway
Object
Contains the details about the gateway.
type Gateway {
active: GatewayActiveDetails
assignment: GatewayAssignmentDetails
firstBoot: GatewayFirstBootDetails
gatewayId: String
organization: Org
provisioning: GatewayProvisioningDetails
registration: GatewayRegistrationDetails
rma: GatewayRMADetails
shipping: GatewayShippingDetails
state: GatewayLifecycleState
stateTime: DateTime
suspension: GatewaySuspensionDetails
termination: GatewayTerminationDetails
}
Fields
| Field | Type | Description |
|---|---|---|
active | GatewayActiveDetails | If the gateway is in an active state, this will contain the last seen time value. |
assignment | GatewayAssignmentDetails | Contains the gateway place assignment details, including place IDs and system types. |
firstBoot | GatewayFirstBootDetails | This contains the timestamp for the gateway's first boot. |
gatewayId | String | The unique ID of the gateway. |
organization | Org | Contains the details about the organization associated with this gateway. |
provisioning | GatewayProvisioningDetails | Contains the timestamp for the gateway's initial provisioning to the organization. |
registration | GatewayRegistrationDetails | Contains gateway registration details, including serial number and IMEI information. |
rma | GatewayRMADetails | If the gateway needs to be returned, this will contain details like the RMA reason along with any explanatory notes. |
shipping | GatewayShippingDetails | If the gateway is currently in a SHIPPED state, details about the shipment will show here, including carrier and tracking number. |
state | GatewayLifecycleState | The current state of the gateway - many states are transitory, like FIRST_BOOT; the more common states will be ACTIVE, ASSIGNED, PROVISIONING and SHIPPED as those exist for longer windows. |
stateTime | DateTime | Timestamp for the start of the current state. |
suspension | GatewaySuspensionDetails | If the gateway was suspended, this will contain details like the suspension reason along with any explanatory notes. |
termination | GatewayTerminationDetails | If the gateway was terminated, this will contain details like the suspension reason along with any explanatory notes. This differs from suspenson as the gateway cannot be returned to active once terminated. |
Used by
gateways(query)Org.gateways(field)