Skip to main content

Start pick poses job

POST 
/devices/:deviceId/command/pick-good-poses

Instructs the device to run a job to pick good poses.

Required scope(s): [devices:command]

Request​

Path Parameters

    deviceId stringrequired

    The target sensor.

    Example: G111045

Body

required
    howMany integerrequired

    Target number of poses to pick

    jobId stringrequired

    Job ID

    time integerrequired

    Maximum time to run pick poses job (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...