Space Gateways

Link a Gateway to a Space

post/spaces/{spaceId}/gateways

Request

  • Base URL: https://api.reelables.com/v1
  • URL: https://api.reelables.com/v1/spaces/{spaceId}/gateways
  • Auth: OAuth 2 (client credentials, token URL https://auth.reelables.com/oauth2/token, scopes: https://auth.reelables.com/full-access)

Path parameters

spaceIdstring required

The identifier of the Space

Headers

request-idstring

Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00

Request body

shortIdstring

Short human-readable Gateway identifier. Example: 'AB1D'

isStaticboolean

Indicate whether the Gateway is statically located. If so, then longitude and latitude are required.

registerGatewayboolean

Indicates whether the gateway should be registered. True - will register a new gateway (productName is required) False - indicates that the gateway has already been registered

replaceExistingGatewayboolean

Indicate whether to replace the existig Gateway, in the case where the Space is already linked to a Gateway

latitudenumber float

Latitude value of the coordinate. Example: 51.123

deviceIdstring

Manufacturer identifier for the Gateway device. Example: 'e10fce301222e588e1d7482b'

gatewayIdstring

Gateway identifier, which is a combination of manufacturer and deviceId. Example: 'sysLoco_e10fce301222e588e1d7482b'

productNamestring

Name of Gateway product. Example: 'HGD4'

manufacturer'hpeAruba' | 'cassiaNetworks' | 'particle' | 'sysLoco' | 'versa'

Gateway manufacturer. Example: 'sysLoco'. If you want us to support a new manufacturer, please contact us at support@reelables.com

longitudenumber float

Longitude value of the coordinate. Example: -0.123

Response

200 response

numberAssetsInSpaceinteger

The total number of Assets currently in the Space

facilityIdstring uuid

Unique identifier of the Facility. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

namestring required

The name of the Space

idstring required

Unique identifier of the Space. Example: '00Es43YBJfNRXNSvLmni'

createdOnstring date-time

Date that the Space was created, in UTC. Example: '2019-07-21T17:32:28Z'

workspaceIdstring uuid required

Unique identifier of the workspace. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

Changes

No recorded changes to this operation across all 1 revision of this API.