Start measurement job

POST 
/devices/:deviceId/command/go

Instructs the device to take a continuous running measurement.

Required scope(s): [devices:command]

Request

Path Parameters

deviceId stringrequired
The target sensor.
Example: G111045

application/json

Body

required

jobId stringrequired

Identifier for the job to start measuring.

time integerrequired

Duration to run measurement job for in seconds.

Responses

200

Your request was successful.

application/json

Schema

Schema

clientId stringrequired

Unique identifier for the client making the request.

res objectrequired

Container for additional response details.

ack integer

Acknowledgment status; will always have a value of 1, indicating successful receipt of the request by the API and/or device.

code string

Response status from sensor, represented as HTTP status code.

message string

Status message from sensor.

messageId string

Unique ID (ULID) for the response message.

sessionId stringrequired

Session ID (ULID) associated with the client's request, providing context and traceability.

Example (from schema)

{
  "clientId": "jdppdzf4l0",
  "res": {
    "ack": 1,
    "code": "200",
    "message": "Request executed successfully",
    "messageId": "01H7B0YXPAMMSKX401J1CXCQBP"
  },
  "sessionId": "01H7B0YVB9PQJ3086GNX5XVA94"
}

404

You are operating on a resource that does not exist. A message is returned explaining the issue.

application/json

Schema

Schema

object

Example (from schema)

{}

500

An internal server error. Please contact Gardin Support for further assistance.

application/json

Schema

Schema

object

Example (from schema)

{}

Loading...