exportRequest

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-export-request-schema.json",
  "title": "exportRequest",
  "description": "Necessary data to start export process",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-mod-data-export-openapi.yml#/components/schemas/exportRequest",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "fileDefinitionId": {
      "description": "File definition id",
      "type": "string",
      "format": "uuid"
    },
    "jobProfileId": {
      "description": "Related Job profile id",
      "type": "string",
      "format": "uuid"
    },
    "recordType": {
      "description": "Defines a type of records to search by criteria or UUIDs",
      "type": "string",
      "enum": [
        "INSTANCE",
        "HOLDINGS",
        "ITEM",
        "AUTHORITY",
        "LINKED_DATA"
      ]
    },
    "idType": {
      "description": "Type of provided uuids",
      "type": "string",
      "enum": [
        "instance",
        "holding",
        "authority"
      ],
      "default": "instance"
    },
    "all": {
      "description": "True if all IDs of idType need to be exported, otherwise false",
      "type": "boolean",
      "default": false
    },
    "quick": {
      "description": "True if quick export, otherwise false",
      "type": "boolean",
      "default": false
    },
    "deletedRecords": {
      "description": "True if need to include deleted records, otherwise false",
      "type": "boolean",
      "default": true
    },
    "suppressedFromDiscovery": {
      "description": "True if need to include suppressed from discovery records, otherwise false",
      "type": "boolean",
      "default": false
    },
    "lastSlice": {
      "description": "True if within the current export the current slice from ID to ID is the last one",
      "type": "boolean",
      "default": false
    },
    "lastExport": {
      "description": "True the current export is the last one",
      "type": "boolean",
      "default": false
    },
    "metadata": {
      "description": "Meta information ",
      "type": "object",
      "$ref": "#/$defs/metadata"
    }
  },
  "required": [
    "fileDefinitionId",
    "jobProfileId",
    "idType"
  ],
  "$defs": {
    "metadata": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "type": "object",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  }
}