ProjectDataProgress

Fields

5 fields

done · required: integer
phase: string or null
phase_done: integer or null
phase_total: integer or null
total · required: integer

Raw schema (JSON)

{
  "properties": {
    "done": {
      "minimum": 0,
      "title": "Done",
      "type": "integer"
    },
    "phase": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Phase"
    },
    "phase_done": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Phase Done"
    },
    "phase_total": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Phase Total"
    },
    "total": {
      "minimum": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "done",
    "total"
  ],
  "title": "ProjectDataProgress",
  "type": "object"
}

Used by endpoints

7 endpoints send or return this schema, on its own or inside another schema.

GET /api/v1/project-data-jobs/{data_job_id} — Get Project Data Job
GET /api/v1/project-imports — List My Project Imports
POST /api/v1/project-imports/uploads — Start Import Upload
POST /api/v1/project-imports/uploads/{data_job_id}/complete — Complete Import Upload
GET /api/v1/projects/{project_id}/data-jobs — List Project Exports
POST /api/v1/projects/{project_id}/export — Start Project Export
POST /api/v1/projects/import — Start Project Import

Used by schemas

ProjectDataJobRead

More details

Specification: OpenAPI JSON