Docs API schemas

neoserver 0.1.2

ImportJob

ImportJob schema for the neoserver management API.

← All schemas

object
cancel_requested boolean
completed_at string · date-time
created_at string · date-time required
created_by string
error_message string
id string required
name string required
phase string required
Allowed values
["acquire","discover","validate","transform","preview","publish","rollback"]
processed_bytes integer · int64
processed_features integer · int64
processed_layers integer
retry_count integer
rollback_operation_id string
service_id string
source_filename string
source_kind string required
source_locator string
started_at string · date-time
status string required
Allowed values
["queued","running","awaiting_plan","ready_to_publish","publishing","published","cancelling","cancelled","failed","rolling_back","rolled_back"]
total_layers integer
updated_at string · date-time required
workspace_id string required
OpenAPI schema definition
{
  "properties": {
    "cancel_requested": {
      "type": "boolean"
    },
    "completed_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "discovery": {
      "$ref": "#/components/schemas/ImportDiscovery"
    },
    "error_message": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "phase": {
      "enum": [
        "acquire",
        "discover",
        "validate",
        "transform",
        "preview",
        "publish",
        "rollback"
      ],
      "type": "string"
    },
    "plan": {
      "$ref": "#/components/schemas/ImportPlan"
    },
    "processed_bytes": {
      "format": "int64",
      "type": "integer"
    },
    "processed_features": {
      "format": "int64",
      "type": "integer"
    },
    "processed_layers": {
      "type": "integer"
    },
    "retry_count": {
      "type": "integer"
    },
    "rollback_operation_id": {
      "type": "string"
    },
    "service_id": {
      "type": "string"
    },
    "source_filename": {
      "type": "string"
    },
    "source_kind": {
      "type": "string"
    },
    "source_locator": {
      "type": "string"
    },
    "started_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "queued",
        "running",
        "awaiting_plan",
        "ready_to_publish",
        "publishing",
        "published",
        "cancelling",
        "cancelled",
        "failed",
        "rolling_back",
        "rolled_back"
      ],
      "type": "string"
    },
    "total_layers": {
      "type": "integer"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "workspace_id": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "workspace_id",
    "name",
    "source_kind",
    "status",
    "phase",
    "created_at",
    "updated_at"
  ],
  "type": "object"
}

Search documentation

Type to search guides and reference pages.