Skip to main content

Enable/disable schedule

POST 
/devices/:deviceId/command/schedule

Instructs the device to set the schedule on/off, get, or delete it (as per action key).

Required scope(s): [devices:command]

Request​

Path Parameters

    deviceId stringrequired

    The target sensor.

    Example: G111045

Body

required
    action string

    Possible values: [on, off, get, delete]

    Set the schedule 'on' or 'off', 'delete' the schedule or 'get' its current details.

    schedule objectrequired

    Object representing a schedule of commands based on specific times. Keys must be in format "HH:MM" (as per RFC3339) and denote the time that the associated command (value) should be executed.

    property name* CommandDetails
    command stringrequired

    Possible values: [go, stop, pick_good_poses]

    The command to be executed.

    howMany integer

    The target quantity of poses to identify. Required for 'pick_good_poses' command.

    jobId stringrequired

    Identifier for the job associated with the command.

    time integerrequired

    Duration to execute the command for in seconds.

    usePastPoses boolean

    Default value: true

    If true, then past poses will be reconsidered in the upcoming pick poses search. To disable, set to false. Only supported for 'pick_good_poses' command.

Responses​

Your request was successful.

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.

Loading...