List collection delivery batches

GET

/v1/collection-delivery-batches

curl -X GET 'https://api.embodiflow.io/v1/collection-delivery-batches' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Query parameters

pageSizenumber
Page size. Default 25, maximum 100. Values above the maximum are refused.
pageTokenstring
Opaque page token from the previous response's `nextPageToken`.
projectIdstring (uuid)
collectionOrderIdstring (uuid)
statusstring
Allowed values
draft
uploading
submitted
under_review
accepted
partially_accepted
rejected
cancelled

Responses

Success

dataarray<CollectionDeliveryBatchDto>required
- idstringrequired
- tenantIdstringrequired
- projectIdstringrequired
- collectionOrderIdstringrequired
- supplierProjectMembershipIdstringrequired
- deliveryNumberstringrequired
- statusstringrequired
- attemptGroupKeystringrequired
- attemptNumbernumberrequired
- supersedesDeliveryBatchIdstring | nullrequired
- reviewTaskIdstring | nullrequired
- sourceMetadataobject | nullrequired
- declaredContentobject | nullrequired
- machineVerdictobjectrequired
- acceptanceDecisionobjectrequired
- linkedUploadBatchIdsarray<string>required
- attemptCountnumberrequired
- outstandingReworkCountnumberrequired
- outstandingReworkarray<CollectionDeliveryOutstandingReworkDto>required
- createdAtstringrequired
- updatedAtstringrequired
- rowVersionnumberrequired
metaobjectrequired
- pageSizenumberrequired
- requestIdstring
nextPageTokenstring
Opaque AIP-158 page token. Omitted when the collection is exhausted.

Response example

{
  "data": [
    {
      "id": "string",
      "tenantId": "string",
      "projectId": "string",
      "collectionOrderId": "string",
      "supplierProjectMembershipId": "string",
      "deliveryNumber": "string",
      "status": "string",
      "attemptGroupKey": "string",
      "attemptNumber": 0,
      "supersedesDeliveryBatchId": "string",
      "reviewTaskId": "string",
      "sourceMetadata": {},
      "declaredContent": {},
      "machineVerdict": {
        "contractVersion": "embodiflow-collection-delivery/v1",
        "criteriaId": "embodiflow-collection-delivery/v1",
        "criteriaVersion": 0,
        "criteriaHash": "string",
        "generatedAt": "string",
        "sourceWorkflowRunId": "string",
        "sourceDatasetVersionId": "string",
        "overall": "error",
        "quality": {
          "status": "warn",
          "blockingFailCount": 0,
          "summaries": [
            {}
          ]
        },
        "alignment": {
          "status": "warn",
          "checkIds": [
            "string"
          ]
        },
        "composition": {
          "status": "warn",
          "profileId": "string",
          "inputDigest": "string"
        }
      },
      "acceptanceDecision": {
        "contractVersion": "embodiflow-collection-delivery/v1",
        "reviewTaskId": "string",
        "reviewerProjectMembershipId": "string",
        "decision": "approve",
        "batchStatus": "accepted",
        "comment": "string",
        "waiverReason": "string",
        "acceptedItemIds": [
          "string"
        ],
        "rejectedItemIds": [
          "string"
        ],
        "rejectedQueryDescriptors": [
          "string"
        ],
        "criteriaHash": "string",
        "criteriaVersion": 0,
        "machineOverall": "error"
      },
      "linkedUploadBatchIds": [
        "string"
      ],
      "attemptCount": 0,
      "outstandingReworkCount": 0,
      "outstandingRework": [
        {
          "repairTaskId": "string",
          "sourceId": "string",
          "status": "string",
          "severity": "string"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "rowVersion": 0
    }
  ],
  "meta": {
    "pageSize": 0,
    "requestId": "string"
  },
  "nextPageToken": "string"
}

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

{ "data": [ { "id": "string", "tenantId": "string", "projectId": "string", "collectionOrderId": "string", "supplierProjectMembershipId": "string", "deliveryNumber": "string", "status": "string", "attemptGroupKey": "string", "attemptNumber": 0, "supersedesDeliveryBatchId": "string", "reviewTaskId": "string", "sourceMetadata": {}, "declaredContent": {}, "machineVerdict": { "contractVersion": "embodiflow-collection-delivery/v1", "criteriaId": "embodiflow-collection-delivery/v1", "criteriaVersion": 0, "criteriaHash": "string", "generatedAt": "string", "sourceWorkflowRunId": "string", "sourceDatasetVersionId": "string", "overall": "error", "quality": { "status": "warn", "blockingFailCount": 0, "summaries": [ {} ] }, "alignment": { "status": "warn", "checkIds": [ "string" ] }, "composition": { "status": "warn", "profileId": "string", "inputDigest": "string" } }, "acceptanceDecision": { "contractVersion": "embodiflow-collection-delivery/v1", "reviewTaskId": "string", "reviewerProjectMembershipId": "string", "decision": "approve", "batchStatus": "accepted", "comment": "string", "waiverReason": "string", "acceptedItemIds": [ "string" ], "rejectedItemIds": [ "string" ], "rejectedQueryDescriptors": [ "string" ], "criteriaHash": "string", "criteriaVersion": 0, "machineOverall": "error" }, "linkedUploadBatchIds": [ "string" ], "attemptCount": 0, "outstandingReworkCount": 0, "outstandingRework": [ { "repairTaskId": "string", "sourceId": "string", "status": "string", "severity": "string" } ], "createdAt": "string", "updatedAt": "string", "rowVersion": 0 } ], "meta": { "pageSize": 0, "requestId": "string" }, "nextPageToken": "string" }