Reelables Consignment Gateways API
The Consignment Gateways API from Reelables — 2 operation(s) for consignment gateways.
OpenAPI Specification
openapi: 3.0.1
info:
title: Reelables Gateway Asset Facilities Consignment Gateways API
description: RESTful API for partners to send data to the Reelables platform from Gateway devices
contact:
email: team@reelables.com
version: 1.1.1
servers:
- url: https://api.reelables.com/{basePath}
variables:
basePath:
default: gateway
description: The production URL for sending requests to the Reelables Gateway API.
tags:
- name: Consignment Gateways
paths:
/consignments/{consignmentId}/gateways:
get:
tags:
- Consignment Gateways
summary: List Gateways in a Consignment
parameters:
- name: request-id
in: header
description: 'Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00'
schema:
type: string
- name: consignmentId
in: path
description: The identifier of the Consignment
required: true
schema:
type: string
- name: limit
in: query
description: 'Number of items to return. Default: 10. Maximum: 10000'
schema:
type: string
- name: nextToken
in: query
description: Pagination token to get next page of items
schema:
type: string
responses:
'200':
description: 200 response
content:
application/json:
schema:
$ref: '#/components/schemas/ConsignmentGateways'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Consignment not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- AuthEndpoint:
- https://auth.reelables.com/full-access
post:
tags:
- Consignment Gateways
summary: Add Gateways to a Consignment
parameters:
- name: request-id
in: header
description: 'Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00'
schema:
type: string
- name: consignmentId
in: path
description: The identifier of the Consignment
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConsignmentGatewaysInput'
required: true
responses:
'201':
description: 201 response
content:
application/json:
schema:
$ref: '#/components/schemas/ConsignmentGateways'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Consignment not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- AuthEndpoint:
- https://auth.reelables.com/full-access
/consignments/{consignmentId}/gateways/{gatewayId}:
delete:
tags:
- Consignment Gateways
summary: Remove a Gateway from a Consignment
parameters:
- name: request-id
in: header
description: 'Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00'
schema:
type: string
- name: consignmentId
in: path
description: The identifier of the Consignment
required: true
schema:
type: string
- name: gatewayId
in: path
description: The identifier of the Gateway
required: true
schema:
type: string
responses:
'204':
description: 204 response
content: {}
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Gateway not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- AuthEndpoint:
- https://auth.reelables.com/full-access
components:
schemas:
Gateway:
required:
- gatewayId
- manufacturer
type: object
properties:
shortId:
maxLength: 10
pattern: ^[-_A-Za-z0-9]*$
type: string
description: 'Short human-readable Gateway identifier. Example: ''AB1D'''
isStatic:
type: boolean
description: Indicate whether the Gateway is statically located. If so, then longitude and latitude are required.
latitude:
maximum: 90
minimum: -90
type: number
description: 'Latitude value of the coordinate. Example: 51.123'
format: float
hasPendingCommands:
type: boolean
description: Indicate whether there are pending commands for the Gateway
rssiFilter:
description: The RSSI filter value for the Gateway BLE receiver (setting RSSI Filter via the API is only currently supported for Particle Gateways)
oneOf:
- type: string
enum:
- FAR
- NEAR
- VERY_NEAR
- maximum: 0
minimum: -127
type: integer
format: int32
deviceId:
maxLength: 100
pattern: ^[-_A-Za-z0-9]*$
type: string
description: 'Manufacturer identifier for the Gateway device. Example: ''e10fce301222e588e1d7482b'''
gatewayId:
maxLength: 100
pattern: ^[-_A-Za-z0-9]*$
type: string
description: 'Gateway identifier, which is a combination of manufacturer and deviceId. Example: ''sysLoco_e10fce301222e588e1d7482b'''
productName:
maxLength: 100
pattern: ^[a-zA-Z0-9!@#$&()\-`.+,/" ]*$
type: string
description: 'Name of Gateway product. Example: ''HGD4'''
addedOn:
maxLength: 20
pattern: ^[0-9TZ:-]*$
type: string
description: 'ISO Timestamp of when the Gateway was linked, in UTC. Example: ''2023-07-21T17:32:28Z'''
format: date-time
manufacturer:
maxLength: 100
pattern: ^[-_A-Za-z0-9]*$
type: string
description: 'Gateway manufacturer. Example: ''sysLoco'''
longitude:
maximum: 180
minimum: -180
type: number
description: 'Longitude value of the coordinate. Example: -0.123'
format: float
additionalProperties: false
ConsignmentGatewaysInput:
maxItems: 1
type: array
description: Gateways to add to a Consignment
items:
required:
- deviceId
- manufacturer
type: object
properties:
registerGateway:
type: boolean
description: 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
deviceId:
maxLength: 100
pattern: ^[-_A-Za-z0-9]*$
type: string
description: 'Manufacturer identifier for the Gateway device. Example: ''e10fce301222e588e1d7482b'''
productName:
maxLength: 100
pattern: ^[a-zA-Z0-9!@#$&()\-`.+,/" ]*$
type: string
description: 'Name of Gateway product. Example: ''HGD4'''
manufacturer:
oneOf:
- type: string
description: 'Gateway manufacturer. Example: ''sysLoco''. If you want us to support a new manufacturer, please contact us at support@reelables.com'
enum:
- hpeAruba
- cassiaNetworks
- particle
- sysLoco
- versa
additionalProperties: false
ConsignmentGateways:
required:
- items
type: object
properties:
nextToken:
maxLength: 5000
pattern: ^[a-zA-Z0-9!@#$&()\-`.+,/"]*$
type: string
description: Pagination token
items:
type: array
items:
$ref: '#/components/schemas/Gateway'
additionalProperties: false
description: Gateways in the Consignment
ErrorResponse:
required:
- errors
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
maxLength: 100
pattern: ^[a-zA-Z0-9!@#$&()\-`.+,/"]*$
type: string
description: An application-specific error code, expressed as a string value
id:
maxLength: 100
pattern: ^[a-zA-Z0-9!@#$&()\-`.+,/"]*$
type: string
description: A unique identifier for this particular occurrence of the problem
detail:
maxLength: 500
pattern: ^[a-zA-Z0-9!@#$&()\-`.+,/" ]*$
type: string
description: A human-readable explanation specific to this occurrence of the problem
title:
maxLength: 100
pattern: ^[a-zA-Z0-9!@#$&()\-`.+,/" ]*$
type: string
description: A short, human-readable summary of the problem
status:
maxLength: 3
pattern: ^[0-9]*$
type: string
description: The HTTP status code applicable to this problem, expressed as a string value
additionalProperties: false
additionalProperties: false
description: This is an error
securitySchemes:
api_key:
type: apiKey
name: x-api-key
in: header