Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

asset-controller

Unassign asset from edge (unassignAssetFromEdge)

Clears assignment of the asset to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove asset (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove asset locally.

delete/api/edge/{edgeId}/asset/{assetId}

Path parameters

edgeIdstring required

A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

assetIdstring required

A string value representing the asset id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Response

OK

createdTimeinteger

Timestamp of the asset creation, in milliseconds

namestring required

Unique Asset Name in scope of Tenant

typestring

Asset type

labelstring

Label that may be used in widgets

versioninteger
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "ASSET"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "customerId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  "name": "Empire State Building",
  "type": "Building",
  "label": "NY Building",
  "assetProfileId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "ASSET_PROFILE"
  },
  "additionalInfo": {}
}