Set Measurement Point

Measurement point setting interface.

This interface can execute cached commands or instant commands. When executing instant commands, the interface response data is returned after the device returns the measurement point setting results. If the device does not return the service invocation results within the specified measurement point setting timeout period, the EnOS service invocation will wait for the timeout and then return the interface timeout response.

When executing cached commands, it will be returned directly after being cached.

Operation Permissions

Required Authorization

Required Operation Permission

Asset

Control

Request Format

POST https://{apigw-address}/connect-service/v2.1/commands?action=setMeasurepoint

Request Parameters (URI)

Note

In the following non-required fields, you must provide assetId or a combination of productKey and deviceKey to specify the device.

Name

Location (Path/Query)

Required or Not

Data Type

Description

orgId

Query

True

String

Organization ID which the asset belongs to. How to get orgId>>

assetId

Query

False

String

Asset ID. How to get assetId>>

productKey

Query

False

String

Product Key

deviceKey

Query

False

String

Device Key

measurepointId

Query

True

String

Asset measurement point. How to get pointId>>

pendingTtl

Query

False

Integer

Cache storage time. Its unit is second and its range is [0 - 172800 (i.e. 48 hours)], which is 0 by default. If the pendingTtl is 0, it indicates that the commands will be executed immediately.

timeout

Query

False

Integer

Timeout period of service execution in seconds. Its range is [1-60], which is set as 30 seconds by default.

Request Parameters (Body)

Name

Required or Not

Data Type

Description

value

True

String, Number, Array or Object

Parameter value for measurement point setting, which must conform to the definition of ThingModel.

Response Parameters

Name

Data Type

Description

data

Measurement point setting return struct

Measurement point setting results. See Measurement Point Setting Return Struct.

Measurement Point Setting Return Struct

Name

Data Type

Description

commandId

String

Command ID

Error Codes

Code

Description

11904

Command is not sent, and instant command timed out.

11915

Command is sent, but response timed out.

11902

The number of cached commands reaches the upper limit.

11900

The device is offline and the instant command cannot be sent.

11810

The command can not be encoded into the product-customized format when the product supports custom data formats.

11888

The device is not activated and the instant command cannot be sent.

Sample 1

Request Sample

https://{apigw-address}/connect-service/v2.1/commands?measurepointId=measurepoint1&action=setMeasurepoint&deviceKey=zBAofs6D4s&pendingTtl=1000&productKey=6Bt59ySj&orgId=o15535059999891&timeout=30
method: POST
requestBody: {"value":1.0}

Return Sample

{
    "code": 0,
    "msg": "Success",
    "submsg": null,
    "requestId": "7d863d517eae4f18a2776452eb1305bb",
    "data": {
        "commandId": "2078724684846989312",
     }
}