Change Updates

Do not miss any Reelables API changes, ever again

Subscribe to the Reelables API changelog to be up to date on recent changes.

RSS

Feb 19, 2025

main
1.3.0
Compare
1.3.0

API structure has changed

15 structure changes including:
15 Modifications
Modified 15 Breaking
DELETE /spaces/{spaceId}/gateways/{gatewayId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • gateway property Modified
        • shortId, deviceId, productName, manufacturer properties Added
GET /consignments/{consignmentId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • gateways property Modified
        • items property Modified
      • workspace property Modified
        • spaces property Modified
GET /consignments/{consignmentId}/gateways
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • isStatic, latitude, hasPendingCommands, rssiFilter, longitude properties Added
GET /spaces/{spaceId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • gateway property Modified
        • shortId, deviceId, productName, manufacturer properties Added
GET /workspaces
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • spaces property Modified
GET /workspaces/{workspaceId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • spaces property Modified
GET /workspaces/{workspaceId}/consignments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • gateways, workspace properties Modified
GET /workspaces/{workspaceId}/spaces
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • gateway property Modified
PATCH /workspaces/{workspaceId}/consignments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • gateways property Modified
        • items property Modified
      • workspace property Modified
        • spaces property Modified
POST /consignments/{consignmentId}/gateways
  • Response
  • 201 response Modified
    • application/json content type Modified
      • items property Modified
        • isStatic, latitude, hasPendingCommands, rssiFilter, longitude properties Added
POST /spaces/{spaceId}/gateways
  • Body
  • application/json content type Modified
    • gatewayId property Modified
      • Property is no longer required
    • shortId, registerGateway, deviceId, productName, string-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • gateway property Modified
        • shortId, deviceId, productName, manufacturer properties Added
POST /workspaces/{workspaceId}/consignments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • items property Modified
        • gateways, workspace properties Modified
POST /workspaces/{workspaceId}/spaces
  • Body
  • application/json content type Modified
    • spaces property Modified
      • object alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • WorkspaceSpaceInput, WorkspaceSpaceInputOLD alternatives Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • items property Modified
        • gateway property Modified
PUT /spaces/{spaceId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • gateway property Modified
        • shortId, deviceId, productName, manufacturer properties Added
PUT /spaces/{spaceId}/gateways/{gatewayId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shortId, deviceId, productName, manufacturer properties Added