Link Search Menu Expand Document

Gateway Bridge

Jan 1 2022 at 12:00 AM

  1. APIs within Gateway Bridge
    1. EntityCalendar
      1. API Calls

Provides functionality for creating a “bridge” between 2 tenants/environments 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 Bridge

EntityCalendar

API Calls

AddFilters

POST

Permission

full_access

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/GatewayBridge/AddFilters

URL Params

None

Data Params

{
    "filters":["string","string"]
}
  • filters: 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

RemoveFilters

POST

Permission

full_access

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/GatewayBridge/RemoveFilters

URL Params

None

Data Params

{
    "filters":["string","string"]
}
  • filters: 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

GetFilters

GET

Permission

full_access

Accessible

Tenant only.See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/GatewayBridge/GetFilters

URL Params

None

Data Params

None

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