FOLIO · Schema

PersistentJob

CompanyLibrariesLibrary Services PlatformOpen SourceMicroservicesEducation

Properties

Name	Type	Description
id	string
class	string	Fully-qualified class name identifying the concrete job type
name	string
runnerId	string	Only present for comparison jobs (class ComparisonJob)
dateCreated	integer
started	integernull	Null until the job begins running
ended	integernull	Null until the job finishes
status	object
result	object	Null until the job finishes
fileUpload	object	Present only for job types that accept a file upload (e.g. packageImport, kbartImport)
fullLogCount	integer
errorLogCount	integer
infoLogCount	integer
comparisonPoints	array	Only present for comparison jobs (class ComparisonJob)

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-persistent-job-schema.json",
  "title": "PersistentJob",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-mod-agreements-openapi.yml#/components/schemas/PersistentJob",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "class": {
      "type": "string",
      "description": "Fully-qualified class name identifying the concrete job type",
      "enum": [
        "org.olf.general.jobs.ComparisonJob",
        "org.olf.general.jobs.CoverageRegenerationJob",
        "org.olf.general.jobs.PackageImportJob",
        "org.olf.general.jobs.KbartImportJob",
        "org.olf.general.jobs.PackageIngestJob",
        "org.olf.general.jobs.SupplementaryDocumentsCleaningJob",
        "org.olf.general.jobs.ExternalEntitlementSyncJob",
        "org.olf.general.jobs.PackageTriggerResyncJob",
        "org.olf.general.jobs.TitleIngestJob",
        "org.olf.general.jobs.ResourceDeletionJob",
        "org.olf.general.jobs.EHoldingsEntitlementSyncJob",
        "org.olf.general.jobs.IdentifierReassignmentJob"
      ]
    },
    "name": {
      "type": "string"
    },
    "runnerId": {
      "description": "Only present for comparison jobs (class ComparisonJob)",
      "type": "string"
    },
    "dateCreated": {
      "type": "integer"
    },
    "started": {
      "description": "Null until the job begins running",
      "type": [
        "integer",
        "null"
      ]
    },
    "ended": {
      "description": "Null until the job finishes",
      "type": [
        "integer",
        "null"
      ]
    },
    "status": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "$ref": "#/$defs/Refdata"
        }
      ]
    },
    "result": {
      "description": "Null until the job finishes",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "$ref": "#/$defs/Refdata"
        },
        {
          "type": "null"
        }
      ]
    },
    "fileUpload": {
      "description": "Present only for job types that accept a file upload (e.g. packageImport, kbartImport)",
      "oneOf": [
        {
          "$ref": "#/$defs/File"
        },
        {
          "type": "null"
        }
      ]
    },
    "fullLogCount": {
      "type": "integer"
    },
    "errorLogCount": {
      "type": "integer"
    },
    "infoLogCount": {
      "type": "integer"
    },
    "comparisonPoints": {
      "description": "Only present for comparison jobs (class ComparisonJob)",
      "type": "array",
      "items": {
        "$ref": "#/$defs/ComparisonPoint"
      }
    }
  },
  "$defs": {
    "ComparisonPoint": {
      "type": "object",
      "properties": {
        "titleList": {
          "type": "string",
          "format": "uuid"
        },
        "date": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "File": {
      "type": "object",
      "required": [
        "id",
        "name",
        "size"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "readOnly": true
        },
        "contentType": {
          "type": "string",
          "description": "MIME type of the uploaded file"
        },
        "modified": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "Original filename of the uploaded file"
        },
        "size": {
          "type": "integer",
          "description": "Size of the uploaded file in bytes"
        }
      }
    },
    "Refdata": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/folio-persistent-job"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.