List dataset plan for a upload batche

GET

/v1/upload-batches/{batchId}/dataset-plan

curl -X GET 'https://api.embodiflow.io/v1/upload-batches/{batchId}/dataset-plan' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

batchIdstringrequired

Responses

Success

dataobjectrequired
- statusstringrequired
  Allowed values
  ready
  empty
  needs-attention
- projectTypestringrequired
- sourceTypestringrequired
- fileCountnumberrequired
- totalBytesnumberrequired
- datasetsarray<UploadDatasetPlanDatasetDto>required
- issuesarray<UploadDatasetPlanIssueDto>required
- ignoredFilesarray<string>

Response example

{
  "data": {
    "status": "ready",
    "projectType": "string",
    "sourceType": "string",
    "fileCount": 0,
    "totalBytes": 0,
    "datasets": [
      {
        "key": "string",
        "name": "string",
        "sourceType": "string",
        "fileCount": 0,
        "totalBytes": 0,
        "files": [
          {
            "originalFilename": "string",
            "relativePath": "string",
            "contentType": "string",
            "sizeBytes": 0,
            "checksumExpected": "string"
          }
        ],
        "groupingMode": "directory",
        "rootPath": "string",
        "captureSession": {
          "id": "string",
          "name": "string",
          "role": "other"
        }
      }
    ],
    "issues": [
      {
        "code": "string",
        "severity": "warning",
        "message": "string",
        "relativePaths": [
          "string"
        ]
      }
    ],
    "ignoredFiles": [
      "string"
    ]
  }
}

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

{ "data": { "status": "ready", "projectType": "string", "sourceType": "string", "fileCount": 0, "totalBytes": 0, "datasets": [ { "key": "string", "name": "string", "sourceType": "string", "fileCount": 0, "totalBytes": 0, "files": [ { "originalFilename": "string", "relativePath": "string", "contentType": "string", "sizeBytes": 0, "checksumExpected": "string" } ], "groupingMode": "directory", "rootPath": "string", "captureSession": { "id": "string", "name": "string", "role": "other" } } ], "issues": [ { "code": "string", "severity": "warning", "message": "string", "relativePaths": [ "string" ] } ], "ignoredFiles": [ "string" ] } }