跳至主要内容

Replace a data stream bridge

PUT 
/api/v1/orgs/{orgId}/data-bridges/{bridgeId}

Replace the bridge definition using the same nested request body as create bridge.

Use:

  • mqtt.mqttBrokerConfigId, mqtt.outputTopic, mqtt.qos
  • assemblyPolicy.queueLimit, assemblyPolicy.timeoutSeconds, assemblyPolicy.onTimeout
  • bindings[].deviceId, bindings[].dataStreamId, bindings[].targetJsonPath, bindings[].requiredForAssembly

Defaults and finite values are the same as create bridge:

  • mqtt.qos: 0, 1, 2; default 0
  • assemblyPolicy: optional; omit it to use all assembly defaults
  • assemblyPolicy.onTimeout: PublishPartial, DropPartial; default PublishPartial
  • bindings[].deviceId: required; source device identifier (metadata)
  • bindings[].dataStreamId: required; unique data stream identifier (GUID)
  • bindings[].sourceFieldName: default valueObject
  • bindings[].dataType: optional runtime type hint; omit to use source payload valueType. Supported values (case-insensitive): number, double, float, decimal, integer, int, long, boolean, bool, datetime, string. Unrecognized values keep the original JSON value
  • bindings[].requiredForAssembly: true, false; default false

Example:

{
  "name": "bridge updated",
  "mqtt": {
    "mqttBrokerConfigId": "{{mqttConfigId}}",
    "outputTopic": "factory/site1/gpu-cpu",
    "qos": 1
  },
  "assemblyPolicy": {
    "queueLimit": 100,
    "timeoutSeconds": 30,
    "onTimeout": "PublishPartial"
  },
  "bindings": [
    {
      "deviceId": "{{deviceId}}",
      "dataStreamId": "e033b4b3-36e0-4dbc-a6e4-1e77185402f4",
      "sourceFieldName": "valueObject",
      "targetJsonPath": "$.cpuTemp",
      "dataType": "number",
      "requiredForAssembly": true
    }
  ]
}

Request​

Responses​

OK