Gateway API

Jan 1 2022 at 12:00 AM

APIs within Gateway API
1. Gateway
  1. API Calls

The Gateway Bridge provides functionality for creating a “bridge” between two tenants or environments. It does so by subscribing to all gateway telemetry from one tenant, applying filtering based on gateway, and publising it onto the other tenants gateway telemetry queue.

Only gateways for which filters have been set, are relayed onto the receiving tenant’s gateway telemetry queue.

APIs within Gateway API

Gateway

API Calls

GetGateway

Permission

GATEWAYS_GET on Client Id.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/GetGateway

URL Params

None

Data Params

{
  "gatewayId": ""
}

gatewayId: text (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

SetGatewayIoTHubEnabled

Permission

GATEWAYS_GET on Client Id.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/SetGatewayIoTHubEnabled

URL Params

None

Data Params

{
  "gatewayId": ""	,
  "ioTHubEnabled": ""
}

gatewayId: text (Required)
ioTHubEnabled: bool (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

SubscribeToGatewayEvents

Permission

GATEWAYS_GET on Client Id.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/SubscribeToGatewayEvents

URL Params

None

Data Params

{
  "clientId": ""
}

clientId: text (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

UnsubscribeFromGatewayEvents

Permission

GATEWAYS_GET on Client Id.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/UnsubscribeFromGatewayEvents

URL Params

None

Data Params

{
  "clientId": ""
}

clientId: text (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

SearchGateways

Permission

GATEWAYS_GET

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/SearchGateways

URL Params

None

Data Params

{
  "searchFilter" : 
  {
    "Limit": number,
    "Skip": number,
    "SearchOperator": "enum",
    "GatewayIdSearchText": "*",
    "GatewayFriendlyNameSearchText": "*"
  }

}

Further Information

Search operator options: [ Contains, DoesNotContain, Equals, DoesNotEqual, StartsWith, EndsWith ]
Default values:
- Limit: 100
- SearchOperator: Contains
- GatewayIdSearchText: *
- GatewayFriendlyNameSearchText: *
SearchFilter: PaginatedGatewaySearchFilter (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

SearchDevices

Permission

GATEWAYS_GET

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/SearchDevices

URL Params

None

Data Params

{
  "searchFilter" : 
  {
    "Limit": number,
    "Skip": number,
    "SearchOperator": "enum",
    "GatewayIdSearchText": "*",
    "GatewayFriendlyNameSearchText": "*",
    "DeviceIdSearchText": "*",

  }

}

Further Information

Search operator options: [ Contains, DoesNotContain, Equals, DoesNotEqual, StartsWith, EndsWith ]
Default values:
- Limit: 100
- SearchOperator: Contains
- GatewayIdSearchText: *
- GatewayFriendlyNameSearchText: *
- DeviceIdSearchText: *
SearchFilter: PaginatedDeviceSearchFilter (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

SearchDeviceProperties

Permission

GATEWAYS_GET

Accessible

Tenant only. See response and accessiblity information for more.

URL

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

URL Params

None

Data Params

{
"searchFilter" : 
  {
    "Limit":100,
    "Skip":100,
    "_searchOperator": "Contains {enum}"
  }
}

searchFilter : PaginatedDevicePropertySearchFilter (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

GetGatewayFilterCount

Permission

GATEWAYS_GET

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/GetGatewayFilterCount

URL Params

None

Data Params

{
"searchFilter" : 
  {
    "Limit":100,
    "Skip":100
  }
}

searchFilter : GatewaySearchFilter (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

RegisterGatewayFromUser

Permission

gateways:register

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/RegisterGatewayFromUser

URL Params

None

Data Params

{
  "gatewayId" : "text",
  "secret": "text"
}

gatewayId : text (Required)
secret: string (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

UpdateGatewaySecret

Permission

gateways:edit

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/UpdateGatewaySecret

URL Params

None

Data Params

{
  "gatewayId": "text",
  "newHashedSecret": "string"
}

gatewayId: text (Required)
newHashedSecret: string (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

UndoGatewaySecret

Permission

gateways:edit

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/UndoGatewaySecret

URL Params

None

Data Params

{
  "gatewayId" : "text"
}

gatewayId : text (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

GetGatewayPropertiesByRegex

Permission

gateways:get

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/GetGatewayPropertiesByRegex

URL Params

None

Data Params

{
  "gatewayId": "text",
  "regularExpressions": ["string", "string"]

}

gatewayId: text (Required)
regularExpressions: List (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

GetGatewayIdsBatched

Permission

gateways:get

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/Gateway/GetGatewayIdsBatched

URL Params

None

Data Params

{
  " pagingOptions ": 
{
"Limit":100,
"Skip":100
}
}

pagingOptions: PagingOptions (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Pesponse. 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 Pesponse. See response and accessiblity information for more.

Notes

None

Gateway API

APIs within Gateway API

Gateway

API Calls

Continue reading

Community

Questions

Website