Create a opening

POST

/v1/projects/{projectId}/collection-orders/{orderId}/openings

curl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/collection-orders/{orderId}/openings' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "unused": {}
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired
orderIdstringrequired

Header parameters

Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

Request body

Content-Typeapplication/json

unusedobject | 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