Update a collection order
PATCH
/v1/projects/{projectId}/collection-orders/{orderId}curl -X PATCH 'https://api.embodiflow.io/v1/projects/{projectId}/collection-orders/{orderId}' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"title": "string",
"description": "string",
"acceptanceRules": {},
"segmentationJobId": "00000000-0000-0000-0000-000000000000",
"deadlineAt": "string"
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Path parameters
- projectIdstringrequired
- orderIdstringrequired
Header parameters
- If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.
Request body
Content-Typeapplication/json
- titlestring
- descriptionstring | null
- acceptanceRulesobject
- segmentationJobIdstring (uuid) | null
- deadlineAtstring | null
Responses
Success
- dataobjectrequired
- tasksarray<CollectionTaskDto>required
- scenesarray<CollectionSceneDto>required
- quotasarray<CollectionQuotaDto>required
- consentsarray<CollectionConsentDto>required
- estimateobjectrequired
- idstringrequired
- tenantIdstringrequired
- projectIdstringrequired
- orderNumberstringrequired
- titlestringrequired
- descriptionstring | nullrequired
- statusstringrequired
- targetSkillsJsonobjectrequired
- targetEmbodimentJsonobjectrequired
- targetSceneJsonobjectrequired
- sourceMetadataSchemaJsonobject | nullrequired
- acceptanceRulesobjectrequired
- templateIdstring | nullrequired
- segmentationJobIdstring | nullrequired
- deadlineAtstring | nullrequired
- acceptedQuantitynumberrequired
- targetQuantitynumber | nullrequired
- outstandingReworkCountnumberrequired
- outstandingReworkarray<CollectionDeliveryOutstandingReworkDto>required
- openedAtstring | nullrequired
- closedAtstring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
- rowVersionnumberrequired
Response example
{
"data": {
"tasks": [
{
"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
}
],
"scenes": [
{
"id": "string",
"orderId": "string",
"name": "string",
"description": "string",
"photoKeys": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"rowVersion": 0
}
],
"quotas": [
{
"id": "string",
"orderId": "string",
"taskId": "string",
"sceneId": "string",
"targetHours": 0,
"targetSubmissions": 0,
"perCollectorCap": 0,
"createdAt": "string",
"updatedAt": "string",
"rowVersion": 0
}
],
"consents": [
{
"id": "string",
"orderId": "string",
"version": 0,
"textMd": "string",
"createdAt": "string"
}
],
"estimate": {
"recordedSeconds": 0,
"labelledAsEstimate": true,
"durationSeconds": 0,
"units": [
{
"meterCode": "string",
"quantity": 0
}
],
"price": {
"amountMinor": 0,
"currency": "string"
},
"basis": "coefficient",
"evidence": [
"string"
],
"limitCheck": {
"wouldExceed": false,
"remainingBytes": 0
}
},
"id": "string",
"tenantId": "string",
"projectId": "string",
"orderNumber": "string",
"title": "string",
"description": "string",
"status": "string",
"targetSkillsJson": {},
"targetEmbodimentJson": {},
"targetSceneJson": {},
"sourceMetadataSchemaJson": {},
"acceptanceRules": {
"blockingChecks": [
"string"
],
"thresholds": {},
"sampling": {
"rate": 0,
"firstPerCollector": 0
},
"rerecordOnReject": false
},
"templateId": "string",
"segmentationJobId": "string",
"deadlineAt": "string",
"acceptedQuantity": 0,
"targetQuantity": 0,
"outstandingReworkCount": 0,
"outstandingRework": [
{
"repairTaskId": "string",
"sourceId": "string",
"status": "string",
"severity": "string"
}
],
"openedAt": "string",
"closedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"rowVersion": 0
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1