Versions Compared

Old Version 22

changes.mady.by.user Jeff Slavin

Saved on

compared with

New Version 23

changes.mady.by.user Jeff Slavin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

POST {URL}/api/v/4/webhook/execute/{SystemKey}/cloudiotdevice_devices

Query parameters

Parameters

name

string 

The device’s name. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0

or

projects/p0/locations/us-central1/registries/registry0/devices/{numId}.

The device’s name can be set to the deviceId or numId (i.e., without the project, location, and registry info. prepended).

method

string 

The value must be setState

Header parameters

Parameters

ClearBlade-UserToken

See the note at the start of this document on where to find the token.

Request body

The request body contains data with this structure:

JSON representation

Code Block
{
  "state": {
    object(DeviceState)
  },
  "gatewayInfo": {
    object(GatewayInfo)
  }
}

Fields

state

object(DeviceState)

The device state.

gatewayInfo

object(GatewayInfo)

Set if the message is sent through a gateway or a gateway is making the request on a device’s behalf.

Response status codes

Code

Meaning

204

Success

Response body

If successful, the response body will be empty.

...

The device state reported to ClearBlade IoT Core.

JSON representation

Code Block
{
  "binaryData": string
}

Fields

binaryData

string (bytes format)

Data in binary format.

A base64-encoded string.