跳至主要内容

API Changes — v1.1.0

API changes from v1.0.0 to v1.1.0 that affect client code, one row per endpoint, grouped by API category. For a narrative summary of this release, see v1.1.0.

  • Paths are relative to /api/v1.
  • Client Impact: Breaking — existing client code must change · Additive — new or backward-compatible; adopt only if you want the new capability.
  • Change types: Added (new endpoint) · Path changed (same operation, new path; old route deprecated) · Modified (request/response contract changed, same path) · Removed (temp) (not available this version; returns in a future release).
  • This page lists only endpoints with real contract impact. Endpoints with documentation/example-only or purely behavioral changes are omitted.
No API contract change

Container Management, Notifications, and Tunnels have no API contract changes in v1.1.0 (verified by resolved-schema comparison of the specs). Any runtime/behavioral improvements in those areas are described in the v1.1.0 release notes, not here.


Identity & Access

API NameMethodEndpointChangeImpactDetails
Retrieve all organization roles linked to the specified userGET/users/{userId}/orgsModifiedBreakingResponse changed from a top-level array to a paged object { items[], totalCount } — the list is now nested under items

Devices

API NameMethodEndpointChangeImpactDetails
Get device data source definitionsGET/devices/{deviceId}/data-sourceAddedAdditiveNew endpoint
Get device data objectsGET/devices/{deviceId}/data-objectsAddedAdditiveNew endpoint
Get data object by IDGET/devices/{deviceId}/data-objects/{dataObjectId}AddedAdditiveNew endpoint
Get devices with paginationGET/devicesModifiedBreakingResponse items[].name renamed to deviceName
Update a devicePATCH/devices/{deviceId}ModifiedAdditiveNew optional request field deviceName; response adds deviceName
Update device statusPOST/devices/{deviceId}:{status}ModifiedAdditive{status} path value adds activate (was deactivate only); response adds deviceName
List Weda Nodes by OrganizationGET/orgs/{orgId}/devicesModifiedAdditiveResponse adds deviceName
Register a device to an organizationPOST/orgs/{orgId}/devicesModifiedAdditiveNew optional request field deviceName; response adds deviceName

Batch Tasks

The entire Tasks and Batches feature set is removed in v1.1.0 (temporary; returns in a future release). Clients using any of these must migrate off Batch Tasks.

API NameMethodEndpointChangeImpactDetails
Get a paginated list of tasks by organizationGET/orgs/{orgId}/tasksRemoved (temp)BreakingReturns in a future version
Create a new task under an organizationPOST/orgs/{orgId}/tasksRemoved (temp)BreakingReturns in a future version
Get a task by IDGET/orgs/{orgId}/tasks/{taskId}Removed (temp)BreakingReturns in a future version
Update a taskPUT/orgs/{orgId}/tasks/{taskId}Removed (temp)BreakingReturns in a future version
Delete a taskDELETE/orgs/{orgId}/tasks/{taskId}Removed (temp)BreakingReturns in a future version
Get batch list of an OrgGET/orgs/{orgId}/batchesRemoved (temp)BreakingReturns in a future version
Create a new batch under orgPOST/orgs/{orgId}/batchesRemoved (temp)BreakingReturns in a future version
Get a batch by IDGET/orgs/{orgId}/batches/{batchId}Removed (temp)BreakingReturns in a future version
Update an existing batchPUT/orgs/{orgId}/batches/{batchId}Removed (temp)BreakingReturns in a future version
Update only actions of a batchPATCH/orgs/{orgId}/batches/{batchId}Removed (temp)BreakingReturns in a future version
Delete a batch safelyDELETE/orgs/{orgId}/batches/{batchId}Removed (temp)BreakingReturns in a future version
Trigger a batch executionPOST/orgs/{orgId}/batches/{batchId}:startRemoved (temp)BreakingReturns in a future version
Enable or disable an existing batchPUT/orgs/{orgId}/batches/{batchId}/statusRemoved (temp)BreakingReturns in a future version
Get results of a batchGET/orgs/{orgId}/batches/{batchId}/resultsRemoved (temp)BreakingReturns in a future version
Get trigger list for a batchGET/orgs/{orgId}/batches/{batchId}/triggersRemoved (temp)BreakingReturns in a future version
Get devices associated with a batchGET/orgs/{orgId}/batches/{batchId}/devicesRemoved (temp)BreakingReturns in a future version

Data Objects

API NameMethodEndpointChangeImpactDetails
Retrieve the latest value of a specific data objectGET/devices/{deviceId}/data-objects/{dataObjectId}/values/latestAddedAdditiveNew endpoint
Get assigned device binary dataGET/devices/{deviceId}/data-objects/{dataObjectId}/blobs/{blobKey}AddedAdditiveNew endpoint (binary / image data)
Get data historyGET/devices/{deviceId}/data-objects/{dataObjectId}/values/historicalPath changedBreakingwas /devices/{deviceId}/data-objects/values; now requires dataObjectId
List alert rulesGET/devices/{deviceId}/data-objects/{dataObjectId}/alert-rulesPath changedBreakingwas /devices/{deviceId}/data-objects/alert-rules; now requires dataObjectId. Response adds dataObjectId
Create alert rulePOST/devices/{deviceId}/data-objects/{dataObjectId}/alert-rulesPath changedBreakingwas /devices/{deviceId}/data-objects/alert-rules; now requires dataObjectId. Response adds dataObjectId
Get alert rule by IDGET/devices/{deviceId}/data-objects/{dataObjectId}/alert-rules/{alertRuleId}Path changedBreakingwas .../data-objects/alert-rules/{alertRuleId}; now requires dataObjectId. Response adds dataObjectId
Update alert rulePATCH/devices/{deviceId}/data-objects/{dataObjectId}/alert-rules/{alertRuleId}Path changedBreakingwas .../data-objects/alert-rules/{alertRuleId}; now requires dataObjectId. Response adds dataObjectId
Delete alert ruleDELETE/devices/{deviceId}/data-objects/{dataObjectId}/alert-rules/{alertRuleId}Path changedBreakingwas .../data-objects/alert-rules/{alertRuleId}; now requires dataObjectId
Update alert rule statusPUT/devices/{deviceId}/data-objects/{dataObjectId}/alert-rules/{alertRuleId}/statusPath changedBreakingwas .../data-objects/alert-rules/{alertRuleId}/status; now requires dataObjectId. Response adds dataObjectId
List transfer functionsGET/devices/{deviceId}/inputs/data-objects/transfer-functionsPath changedBreakingwas /devices/{deviceId}/data-objects/transfer-functions. Response field dataObjectName renamed to outputDataObjectName
Create transfer functionPOST/devices/{deviceId}/inputs/data-objects/transfer-functionsPath changedBreakingwas /devices/{deviceId}/data-objects/transfer-functions. Request expression now required; response dataObjectName renamed to outputDataObjectName
Get transfer functionGET/devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId}Path changedBreakingwas .../data-objects/transfer-functions/{transferFunctionId}. Response dataObjectName renamed to outputDataObjectName
Update transfer functionPATCH/devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId}Path changedBreakingwas .../data-objects/transfer-functions/{transferFunctionId}. Response dataObjectName renamed to outputDataObjectName
Delete transfer functionDELETE/devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId}Path changedBreakingwas .../data-objects/transfer-functions/{transferFunctionId}
Update transfer function statusPATCH/devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId}/statusPath changedBreakingwas .../data-objects/transfer-functions/{transferFunctionId}/status. Response dataObjectName renamed to outputDataObjectName

Reports

The Subscriptions feature is removed in v1.1.0 (temporary; returns in a future release).

API NameMethodEndpointChangeImpactDetails
Get all SubscriptionsGET/reports/subscriptionsRemoved (temp)BreakingReturns in a future version
Create a new SubscriptionPOST/reports/subscriptionsRemoved (temp)BreakingReturns in a future version
Get a SubscriptionGET/reports/subscriptions/{subscriptionId}Removed (temp)BreakingReturns in a future version
Update a SubscriptionPUT/reports/subscriptions/{subscriptionId}Removed (temp)BreakingReturns in a future version
Delete a SubscriptionDELETE/reports/subscriptions/{subscriptionId}Removed (temp)BreakingReturns in a future version
Get Subscription DeliveriesGET/reports/subscriptions/{subscriptionId}/deliveriesRemoved (temp)BreakingReturns in a future version
Update Subscription StatusPATCH/reports/subscriptions/{subscriptionId}/statusRemoved (temp)BreakingReturns in a future version
Execute a SubscriptionPOST/reports/subscriptions/{subscriptionId}:executeRemoved (temp)BreakingReturns in a future version
備註

The usage-jobs endpoints are unchanged for clients. Their documented 400/500 error responses were removed from the spec (a Swagger cleanup); the errors still occur at runtime, so no code change is needed.

Model Management

New service in v1.1.0 — all endpoints are new (additive; no existing client is affected).

API NameMethodEndpointChangeImpactDetails
Create ModelPOST/orgs/{orgId}/ai-modelsAddedAdditiveNew endpoint
List Models for an OrganizationGET/orgs/{orgId}/ai-modelsAddedAdditiveNew endpoint
Update Model Basic InfoPATCH/orgs/{orgId}/ai-models/{modelId}AddedAdditiveNew endpoint
Delete a Model and All Its EditionsDELETE/orgs/{orgId}/ai-models/{modelId}AddedAdditiveNew endpoint
List Editions of a ModelGET/orgs/{orgId}/ai-models/{modelId}/editionsAddedAdditiveNew endpoint
Register New Edition of an Existing ModelPOST/orgs/{orgId}/ai-models/{modelId}/editionsAddedAdditiveNew endpoint
Get Model Edition DetailGET/orgs/{orgId}/ai-models/{modelId}/editions/{edition}AddedAdditiveNew endpoint
Update Edition MetadataPATCH/orgs/{orgId}/ai-models/{modelId}/editions/{edition}AddedAdditiveNew endpoint
Delete a Single EditionDELETE/orgs/{orgId}/ai-models/{modelId}/editions/{edition}AddedAdditiveNew endpoint

Model Uploads

API NameMethodEndpointChangeImpactDetails
Create a resumable uploadPOST/orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploadsAddedAdditiveNew endpoint
Upload a file chunkPATCH/orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploads/{uploadId}AddedAdditiveNew endpoint
Get current upload offsetHEAD/orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploads/{uploadId}AddedAdditiveNew endpoint
Terminate an uploadDELETE/orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploads/{uploadId}AddedAdditiveNew endpoint
Get Upload StatusGET/orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploads/{uploadId}/statusAddedAdditiveNew endpoint

Model Deployments

API NameMethodEndpointChangeImpactDetails
Create DeploymentPOST/orgs/{orgId}/ai-models/{modelId}/editions/{edition}:deployAddedAdditiveNew endpoint
List Devices for a Specific Model EditionGET/orgs/{orgId}/ai-models/{modelId}/editions/{edition}/deploymentsAddedAdditiveNew endpoint
Delete Model File from All Deployed DevicesDELETE/orgs/{orgId}/ai-models/{modelId}/editions/{edition}/deploymentsAddedAdditiveNew endpoint
List All AI Models for a Specific DeviceGET/devices/{deviceId}/ai-modelsAddedAdditiveNew endpoint
Delete Model File from a Specific DeviceDELETE/devices/{deviceId}/ai-models/{modelId}/editions/{edition}AddedAdditiveNew endpoint

  • Narrative summary of this release: v1.1.0

Last updated on Jul-15, 2026 | Version 1.1.0