Link Search Menu Expand Document

Gateway Replacement API

Jan 1 2022 at 12:00 AM

  1. Prerequisites
  2. APIs within Gateway Replacement Api
    1. GatewayReplacement
      1. API Calls

Provides API calls for replacing gateways with other gateways.

Prerequisites

You need at least two gateways, each with devices and properties, linked to endpoints, to test this service.

APIs within Gateway Replacement Api

GatewayReplacement

API Calls

ReplaceGateway

POST

Permission

GATEWAYS_GET on Client Id

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GatewayReplacement/ReplaceGateway

URL Params

None

Data Params

data: 
{ 
    "clientid": "string", 
    "replacementMap":
    [ 
        "OriginalGatewayId", 
        "ReplacementGatewayId", 
        "PropertyMaps", 
        "ValidateMap" 
    ]
}

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None