Updates sensor information. Limitation: Can't be used to nullify any property. (Auth policies: IotWrite)

patch

https://apis.xbim-dev.net/{region}/iot/2.0/{tenantId}/{assetId}/Sensors({key})

Summary:Updates sensor information. Limitation: Can't be used to nullify any property. (Auth policies: IotWrite).
Return Type: SensorDto

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

uuid

required

Sensor ID

tenantId

string

required

assetId

string

required

region

string

enum

required

Defaults to UK

The data center region the data resides in

Allowed:

Body Params

Edit data

Represents the data required to edit a sensor.

name

string | null

Optional name for the sensor. If the name is provided, it should be used for
the user presentation as the primary name. Otherwise, mapped entity name
should be used, or device serial ID if there is no entity mapping.

measureType

string | null

Gets or sets the measure type of the sensor (e.g., 'humidity').

sensorType

string | null

Gets or sets the sensor type (e.g., 'Air').

externalLinks

array of objects | null

External links to be used when sensor is presented to the user.
Key is a name of the link, value is the URL

externalLinks

unit

int32 | null

Optional unit of sensor measurements

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

application/octet-stream

text/json

200OK

400Bad Request

404Not Found

500Internal Server Error