Dispatches a mission for execution

Dispatches a mission for execution. It can use a previously-defined mission (see Mission Definition), identified by missionDefinitionId or a one-off mission definition provided in the dispatch API call.

POST /mission-dispatch

cURL

one-off

curl --request POST \
  --url https://api.inorbit.ai/mission-dispatch \
  --header 'Content-Type: application/json' \
  --header 'x-auth-inorbit-app-key: <api-key>' \
  --data @- <<EOF
{
  "selector": {
    "robotId": "amr-picker-87"
  },
  "arguments": {
    "skuCode": "AFG233",
    "quantity": 5
  },
  "missionDefinition": {
    "label": "Pick items for order DN1238923",
    "steps": [
      {
        "label": "Go to bin",
        "timeoutSecs": 120,
        "waypoint": "nw-bin-450"
      },
      {
        "label": "Display item to pick on screen for picking operator",
        "runAction": {
          "actionId": "display_item",
          "arguments": {
            "sku": {
              "_arguments": "skuCode"
            },
            "quantity": {
              "_arguments": "quantity"
            }
          }
        }
      },
      {
        "label": "Wait until item is picked",
        "timeoutSecs": 300,
        "waitUntil": {
          "expression": "getValue('item_picked_btn_pressed')"
        }
      },
      {
        "label": "Go to packing station",
        "timeoutSecs": 120,
        "waypoint": "nw-packing-station-1"
      }
    ]
  }
}
EOF

200

{
  "missionId": "<string>"
}

Authorizations

x-auth-inorbit-app-key · string · header · required

InOrbit appKey authenticates API requests using a token.

You can obtain your appKey in the Authentication docs.

Body

application/json

Mission object to be created

Option 1

Option 2

missionDefinitionId · string · required

Identifies a previously created mission definition, to be executed.

selector · object

Criteria to select a robot to execute the mission. Currently, only robot criteria are permitted, being an object with one or more the following: robotId (a specific robot), robotIds (a list of robots) or tagIds (a list of tags, e.g. robot models, or versions, to obtain the list of possible robots). In case of multiple robots, the platform which decide which robot is the best to execute the mission.

Show child attributes

arguments · object

Optional. A key-value dictionary of user-defined parameters for this mission.

Response

200

application/json

A Mission was dispatched to a robot. This does not mean the mission has started yet. Its status can be queried using mission-tracking APIs, using the missionId included in the response.

missionId · string

Unique id of mission created. It can be tracked using Mission Tracking API.s