ProjectDataJobRead

Fields

One export / import job. storage_key is NEVER part of it.

22 fields

bytes

integer or null

counts

object

download_path

string or null

error

ProjectDataError or null

expires_at

string (date-time) or null

file_count

integer or null

finished_at

string (date-time) or null

id · required

string (uuid)

import_report

ProjectDataImportReport or null

kind · required

string

manifest_sha256

string or null

options

ProjectDataOptions or null

progress

ProjectDataProgress or null

project_id

string (uuid) or null

project_name

string or null

requested_at · required

string (date-time)

requested_by_name

string or null

schema_version

integer or null

signature

string or null

started_at

string (date-time) or null

status · required

string

upload

ProjectDataUpload or null

Raw schema (JSON)

{
  "description": "One export / import job. ``storage_key`` is NEVER part of it.",
  "properties": {
    "bytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bytes"
    },
    "counts": {
      "additionalProperties": {
        "type": "integer"
      },
      "default": {},
      "title": "Counts",
      "type": "object"
    },
    "download_path": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Download Path"
    },
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ProjectDataError"
        },
        {
          "type": "null"
        }
      ]
    },
    "expires_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expires At"
    },
    "file_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "File Count"
    },
    "finished_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Finished At"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "import_report": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ProjectDataImportReport"
        },
        {
          "type": "null"
        }
      ]
    },
    "kind": {
      "title": "Kind",
      "type": "string"
    },
    "manifest_sha256": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Manifest Sha256"
    },
    "options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ProjectDataOptions"
        },
        {
          "type": "null"
        }
      ]
    },
    "progress": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ProjectDataProgress"
        },
        {
          "type": "null"
        }
      ]
    },
    "project_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id"
    },
    "project_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Name"
    },
    "requested_at": {
      "format": "date-time",
      "title": "Requested At",
      "type": "string"
    },
    "requested_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Requested By Name"
    },
    "schema_version": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Schema Version"
    },
    "signature": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Signature"
    },
    "started_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Started At"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "upload": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ProjectDataUpload"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id",
    "kind",
    "status",
    "requested_at"
  ],
  "title": "ProjectDataJobRead",
  "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
• POST /api/v1/project-imports/uploads — Start Import Upload
• POST /api/v1/project-imports/uploads/{data_job_id}/complete — Complete Import Upload
• POST /api/v1/projects/{project_id}/export — Start Project Export
• POST /api/v1/projects/import — Start Project Import
• GET /api/v1/project-imports — List My Project Imports
• GET /api/v1/projects/{project_id}/data-jobs — List Project Exports

Used by schemas

• ProjectDataJobList

More details

• Specification: OpenAPI JSON