Update a task

PATCH

/v1/projects/{projectId}/collection-orders/{orderId}/tasks/{taskId}

curl -X PATCH 'https://api.embodiflow.io/v1/projects/{projectId}/collection-orders/{orderId}/tasks/{taskId}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "instructionJson": {
      "en": "string",
      "zh": "string"
    },
    "startCondition": "string",
    "endCondition": "string",
    "allowedVariation": "string",
    "durationMinS": 0,
    "durationMaxS": 0,
    "requiredCameras": "head",
    "requiredModalities": "imu",
    "minHandsVisible": 0,
    "recordingMode": "continuous",
    "orderIndex": 0
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired
orderIdstringrequired
taskIdstringrequired

Request body

Content-Typeapplication/json

namestring
instructionJsonobject
- enstring
- zhstring
startConditionstring
endConditionstring
allowedVariationstring | null
durationMinSnumber | null
durationMaxSnumber | null
requiredCamerasarray<string>
requiredModalitiesarray<string>
minHandsVisiblenumber | null
recordingModestring
Allowed values
continuous
single_task
orderIndexnumber

Responses

Success

dataobjectrequired
- idstringrequired
- orderIdstringrequired
- namestringrequired
- instructionJsonobjectrequired
- demoMediaKeysarray<string>required
- startConditionstringrequired
- endConditionstringrequired
- allowedVariationstring | nullrequired
- durationMinSnumber | nullrequired
- durationMaxSnumber | nullrequired
- requiredCamerasarray<string>required
- requiredModalitiesarray<string>required
- minHandsVisiblenumber | nullrequired
- recordingModestringrequired
  Allowed values
  continuous
  single_task
- orderIndexnumberrequired
- createdAtstringrequired
- updatedAtstringrequired
- rowVersionnumberrequired

Response example

{
  "data": {
    "id": "string",
    "orderId": "string",
    "name": "string",
    "instructionJson": {
      "en": "string",
      "zh": "string"
    },
    "demoMediaKeys": [
      "string"
    ],
    "startCondition": "string",
    "endCondition": "string",
    "allowedVariation": "string",
    "durationMinS": 0,
    "durationMaxS": 0,
    "requiredCameras": "other",
    "requiredModalities": "imu",
    "minHandsVisible": 0,
    "recordingMode": "continuous",
    "orderIndex": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "rowVersion": 0
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1