FOLIO Export API

The Export API from FOLIO — 4 operation(s) for export.

Operations 5

GET /export Export all entitled resources as JSON #
POST /export Post data export #
GET /export/{format} Export all entitled resources in a specified format #
GET /export/current Export currently entitled resources as JSON #
GET /export/current/{format} Export currently entitled resources in a specified format #

Documentation

📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-caiasoft/s/edge-caiasoft.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-courses/s/edge-courses.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-dcb/s/edge-dcb.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-dematic/s/edge-dematic.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-erm/s/edge-erm.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-fqm/s/edge-fqm.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-ill/s/edge-ill.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-inn-reach/s/edge-inn-reach.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-inventory/s/edge-inventory.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-rtac/s/edge-rtac.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-users/s/edge-users.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/folio-query-tool-metadata/s/queryTool.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/folio-spring-support/s/tenant.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/folio-vertx-lib/s/tenant-2.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mgr-applications/s/am.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mgr-tenant-entitlements/s/mgr-tenant-entitlements.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mgr-tenants/s/mgr-tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-agreements/s/agreements.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-authtoken/s/token-1.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-batch-print/s/batchPrint.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-bulk-operations/s/bulk-operations.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-calendar/s/calendar.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-camunda/s/openapi.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-circulation-bff/s/circulationBff.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-circulation-item/s/circulation-item.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/consortia.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/consortia_configuration.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/kafka_message_schemas.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/publications.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/self.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/sharing_instances.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/sharing_policies.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/sharing_roles.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/sharing_settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/user_tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/consortia.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/consortia_configuration.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/kafka_message_schemas.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/publications.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/self.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/sharing_instances.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/sharing_settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/user_tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-spring/s/export-configs.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-spring/s/job-deletion-intervals.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-spring/s/jobs.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/authority-control.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/bursar-export.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/circulation-log.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/e-holdings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/email.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/order-export.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/refresh-presigned-url.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export/s/data-export.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-dcb/s/dcb_transaction.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-ebsconet/s/ebsconet.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-entities-links/s/mod-entities-links.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-entities-links/s/tenant-settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-eusage-reports/s/eusage-reports-1.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-fqm-manager/s/mod-fqm-manager.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inn-reach/s/circulation.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inn-reach/s/contribution.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inn-reach/s/settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inventory-update/s/inventory-import-1.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inventory-update/s/inventory-update-5.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-licenses/s/licenses.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-linked-data-import/s/mod-linked-data-import.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-linked-data/s/mod-linked-data.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-lists/s/list.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-locations/s/mod-locations.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-login-keycloak/s/mod-login-keycloak.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-marc-migrations/s/marc-migrations.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-mosaic/s/mosaic.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-notes/s/notes.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-oa/s/oa.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-okapi-facade/s/okapi-facade.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-password-validator/s/password-validator.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-password-validator/s/validator-registry.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-quick-marc/s/marc-specifications.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-quick-marc/s/records-editor.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-reading-room/s/patron_permission.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-reading-room/s/reading_room.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-record-specifications/s/mod-record-specifications.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-remote-storage/s/remote-storage.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-requests-mediated/s/requests-mediated.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-roles-keycloak/s/mod-roles-keycloak.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-rtac-cache/s/mod-rtac-cache.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-scheduler/s/mod-scheduler.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-search/s/mod-search.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-serials-management/s/serials-management.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-settings/s/settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tags/s/tags.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/allowed-service-points.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/ecs-loans.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/ecs-request-external.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/ecs-tlr.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/staff-slips.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/tlr-settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-users-keycloak/s/users-keycloak.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-workflow/s/openapi.html

Specifications

SDKs

📦
GitHubRepository
https://github.com/folio-org/edge-caiasoft
📦
GitHubRepository
https://github.com/folio-org/edge-courses
📦
GitHubRepository
https://github.com/folio-org/edge-dcb
📦
GitHubRepository
https://github.com/folio-org/edge-dematic
📦
GitHubRepository
https://github.com/folio-org/edge-erm
📦
GitHubRepository
https://github.com/folio-org/edge-fqm
📦
GitHubRepository
https://github.com/folio-org/edge-ill
📦
GitHubRepository
https://github.com/folio-org/edge-inn-reach
📦
GitHubRepository
https://github.com/folio-org/edge-inventory
📦
GitHubRepository
https://github.com/folio-org/edge-rtac
📦
GitHubRepository
https://github.com/folio-org/edge-users
📦
GitHubRepository
https://github.com/folio-org/folio-query-tool-metadata
📦
GitHubRepository
https://github.com/folio-org/folio-spring-support
📦
GitHubRepository
https://github.com/folio-org/folio-vertx-lib
📦
GitHubRepository
https://github.com/folio-org/mgr-applications
📦
GitHubRepository
https://github.com/folio-org/mgr-tenant-entitlements
📦
GitHubRepository
https://github.com/folio-org/mgr-tenants
📦
GitHubRepository
https://github.com/folio-org/mod-agreements
📦
GitHubRepository
https://github.com/folio-org/mod-authtoken
📦
GitHubRepository
https://github.com/folio-org/mod-batch-print
📦
GitHubRepository
https://github.com/folio-org/mod-bulk-operations
📦
GitHubRepository
https://github.com/folio-org/mod-calendar
📦
GitHubRepository
https://github.com/folio-org/mod-camunda
📦
GitHubRepository
https://github.com/folio-org/mod-circulation-bff
📦
GitHubRepository
https://github.com/folio-org/mod-circulation-item
📦
GitHubRepository
https://github.com/folio-org/mod-consortia-keycloak
📦
GitHubRepository
https://github.com/folio-org/mod-consortia
📦
GitHubRepository
https://github.com/folio-org/mod-data-export-spring
📦
GitHubRepository
https://github.com/folio-org/mod-data-export-worker
📦
GitHubRepository
https://github.com/folio-org/mod-data-export
📦
GitHubRepository
https://github.com/folio-org/mod-dcb
📦
GitHubRepository
https://github.com/folio-org/mod-ebsconet
📦
GitHubRepository
https://github.com/folio-org/mod-entities-links
📦
GitHubRepository
https://github.com/folio-org/mod-eusage-reports
📦
GitHubRepository
https://github.com/folio-org/mod-fqm-manager
📦
GitHubRepository
https://github.com/folio-org/mod-inn-reach
📦
GitHubRepository
https://github.com/folio-org/mod-inventory-update
📦
GitHubRepository
https://github.com/folio-org/mod-licenses
📦
GitHubRepository
https://github.com/folio-org/mod-linked-data-import
📦
GitHubRepository
https://github.com/folio-org/mod-linked-data
📦
GitHubRepository
https://github.com/folio-org/mod-lists
📦
GitHubRepository
https://github.com/folio-org/mod-locations
📦
GitHubRepository
https://github.com/folio-org/mod-login-keycloak
📦
GitHubRepository
https://github.com/folio-org/mod-marc-migrations
📦
GitHubRepository
https://github.com/folio-org/mod-mosaic
📦
GitHubRepository
https://github.com/folio-org/mod-notes
📦
GitHubRepository
https://github.com/folio-org/mod-oa
📦
GitHubRepository
https://github.com/folio-org/mod-okapi-facade
📦
GitHubRepository
https://github.com/folio-org/mod-password-validator
📦
GitHubRepository
https://github.com/folio-org/mod-quick-marc
📦
GitHubRepository
https://github.com/folio-org/mod-reading-room
📦
GitHubRepository
https://github.com/folio-org/mod-record-specifications
📦
GitHubRepository
https://github.com/folio-org/mod-remote-storage
📦
GitHubRepository
https://github.com/folio-org/mod-requests-mediated
📦
GitHubRepository
https://github.com/folio-org/mod-roles-keycloak
📦
GitHubRepository
https://github.com/folio-org/mod-rtac-cache
📦
GitHubRepository
https://github.com/folio-org/mod-scheduler
📦
GitHubRepository
https://github.com/folio-org/mod-search
📦
GitHubRepository
https://github.com/folio-org/mod-serials-management
📦
GitHubRepository
https://github.com/folio-org/mod-settings
📦
GitHubRepository
https://github.com/folio-org/mod-tags
📦
GitHubRepository
https://github.com/folio-org/mod-tlr
📦
GitHubRepository
https://github.com/folio-org/mod-users-keycloak
📦
GitHubRepository
https://github.com/folio-org/mod-workflow

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-accession-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-return-item-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-instructors-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-asr-requests-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-asr-items-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-update-asr-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-license-terms-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-license-terms-batch-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-request-ids-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-entity-type-summaries-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-test-document-delivery-offer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-test-document-delivery-register-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-access-token-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-batch-holdings-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-rtac-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-instance-holdings-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-userdata-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-user-results-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-patron-pin-with-id-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-entity-type-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-query-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-custom-entity-type-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-contents-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-submit-query-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-update-used-by-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-tenant-attributes-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-tenant-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-application-descriptor-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-application-cleanup-result-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-application-descriptors-validation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-module-discoveries-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-application-discoveries-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-application-descriptors-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-flow-stage-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-application-flow-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-flow-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-module-reinstall-request-body-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-extended-entitlements-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-desired-state-request-body-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-tenant-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-tenant-attribute-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-tenants-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-export-entry-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-agreement-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-dashboard-widget-definition-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-kb-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-erm-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-persistent-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-token-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-sign-token-payload-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-sign-refresh-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-refresh-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-token-response-legacy-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-message-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-entry-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-entries-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-message-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-bulk-operation-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-profile-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-calendar-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-calendar-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-surrounding-openings-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-single-day-opening-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-workflow-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-link-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-response-errors-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-circulation-loan-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-mediated-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-check-in-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-bff-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-check-out-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-circulation-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-circulation-items-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-export-config-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-export-config-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-mapping-profile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-export-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-job-profile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-quick-export-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-file-definition-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-export-all-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-setting-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-settings-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-ebsconet-order-line-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-validation-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-authority-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-authority-source-file-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-authority-stats-dto-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-parsed-record-content-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-authority-source-file-dto-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-authority-note-type-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-report-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-report-cost-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-report-status-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-title-data-entries-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-report-titles-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-report-data-entries-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-purged-queries-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-data-refresh-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-query-status-summaries-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-paging-slips-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-transaction-hold-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-local-hold-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-item-shipped-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-inn-reach-transaction-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-base-circ-request-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-failed-record-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-channel-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-import-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-transformation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-transformation-step-association-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-step-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-license-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-policies-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-custom-property-definition-schema.json

Other Resources

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/folio:folio-export-api"
All apis
curl "https://apis.io/api/v1/apis?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.

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

OpenAPI Specification

folio-export-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Folio Export API
  version: '1.0'
  description: 'Operations tagged Export across 4 of this provider''s published API definitions: folio-mod-agreements-openapi.json, folio-mod-data-export-openapi.json, folio-mod-agreements-openapi.yml, folio-mod-data-export-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://folio-snapshot-okapi.dev.folio.org
- url: https://folio-snapshot-2-okapi.dev.folio.org
- url: https://folio-etesting-snapshot-kong.ci.folio.org
- url: /data-export/
tags:
- name: Export
paths:
  /export:
    description: Exports resources entitled (directly or via a package) across every agreement in the tenant. To scope this to a single agreement instead, use `/erm/sas/{agreementId}/resources/export/all/{format}`.
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    - in: query
      name: subscriptionAgreementId
      description: Undocumented in the module descriptor, but honoured by the implementation -- if supplied, scopes the export to this one agreement, equivalent to using the agreement-scoped export path.
      required: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Export
      summary: Export all entitled resources as JSON
      operationId: exportAll
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExportEntry'
        '400':
          description: Bad request error
        '403':
          description: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
    post:
      description: Starts the export process
      operationId: postDataExport
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/exportRequest'
            example:
              fileDefinitionId: e5f54eb6-6d11-11ea-bc55-0242ac130003
              jobProfileId: 2fd2bf30-9d03-4f7e-9393-df55eaef2c2f
              idType: instance
              recordType: INSTANCE
              metadata:
                createdDate: '2019-07-22T11:22:07Z'
                createdByUserId: dee12548-9cee-45fa-bbae-675c1cc0ce3b
                createdByUsername: janedoeuser
                updatedDate: '2019-07-27T13:28:54Z'
                updatedByUserId: dee12548-9cee-45fa-bbae-675c1cc0ce3b
                updatedByUsername: ''
      responses:
        '204':
          description: Data export started
        '400':
          description: Bad request
          content:
            text/plain:
              example: malformed parameter 'query', syntax error at column 6
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors'
        '500':
          description: Internal server errors, e.g. due to misconfiguration
          content:
            text/plain:
              example: Internal server error
      tags:
      - Export
      security:
      - accessToken: []
      - okapiToken: []
      summary: Post data export
      x-summary-source: derived
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /export/{format}:
    description: Exports resources entitled (directly or via a package) across every agreement in the tenant, in the given format. To scope this to a single agreement instead, use `/erm/sas/{agreementId}/resources/export/all/{format}`.
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    - $ref: '#/components/parameters/format'
    - in: query
      name: subscriptionAgreementId
      description: Undocumented in the module descriptor, but honoured by the implementation -- if supplied, scopes the export to this one agreement, equivalent to using the agreement-scoped export path.
      required: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Export
      summary: Export all entitled resources in a specified format
      description: '`format: kbart` returns a tab-separated KBART file (one row per Package Content Item; Platform Title Instances and directly-entitled Title Instances are silently skipped). Any other `format` value returns the same JSON shape as the plain `/export` path.'
      operationId: exportAllFormat
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExportEntry'
            text/tab-separated-value;charset=UTF-8:
              schema:
                type: string
                description: KBART-formatted TSV, with a header row followed by one row per Package Content Item.
        '400':
          description: Bad request error
        '403':
          description: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /export/current:
    description: Exports resources currently entitled (directly or via a package) across every agreement in the tenant -- i.e. `coverage`/`accessStart`/`accessEnd` windows that are active today. To scope this to a single agreement instead, use `/erm/sas/{agreementId}/resources/export/current/{format}`.
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    - in: query
      name: subscriptionAgreementId
      description: Undocumented in the module descriptor, but honoured by the implementation -- if supplied, scopes the export to this one agreement, equivalent to using the agreement-scoped export path.
      required: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Export
      summary: Export currently entitled resources as JSON
      operationId: exportCurrent
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExportEntry'
        '400':
          description: Bad request error
        '403':
          description: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /export/current/{format}:
    description: Exports resources currently entitled (directly or via a package) across every agreement in the tenant, in the given format. To scope this to a single agreement instead, use `/erm/sas/{agreementId}/resources/export/current/{format}`.
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    - $ref: '#/components/parameters/format'
    - in: query
      name: subscriptionAgreementId
      description: Undocumented in the module descriptor, but honoured by the implementation -- if supplied, scopes the export to this one agreement, equivalent to using the agreement-scoped export path.
      required: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Export
      summary: Export currently entitled resources in a specified format
      description: '`format: kbart` returns a tab-separated KBART file (one row per Package Content Item; Platform Title Instances and directly-entitled Title Instances are silently skipped). Any other `format` value returns the same JSON shape as the plain `/export/current` path.'
      operationId: exportCurrentFormat
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExportEntry'
            text/tab-separated-value;charset=UTF-8:
              schema:
                type: string
                description: KBART-formatted TSV, with a header row followed by one row per Package Content Item.
        '400':
          description: Bad request error
        '403':
          description: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
      security:
      - accessToken: []
      - okapiToken: []
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
components:
  schemas:
    IdentifierOccurrence:
      type: object
      properties:
        title:
          type: object
          properties:
            id:
              type: string
              format: uuid
        identifier:
          $ref: '#/components/schemas/Identifier'
        status:
          $ref: '#/components/schemas/Refdata'
    Embargo:
      type: object
      properties:
        id:
          type: string
          format: uuid
        movingWallStart:
          $ref: '#/components/schemas/EmbargoStatement'
        movingWallEnd:
          $ref: '#/components/schemas/EmbargoStatement'
    ExportEntry:
      type: object
      description: One exported resource, paired with the agreement entitlement (and, if entitled via a package, the package) it was exported for. The same resource can appear more than once if it is entitled through more than one package/agreement, or both directly and via a package.
      required:
      - agreementLine
      - title
      - coverage
      - customCoverage
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        package:
          type: object
          description: Present only when this resource was reached via a package entitlement.
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            identifiers:
              type: array
              items:
                $ref: '#/components/schemas/IdentifierOccurrence'
        agreementLine:
          type: object
          description: The entitlement (agreement line) this row was exported for. Only a minimal subset of the entitlement is included here -- for the full record, look it up via `id` against `/erm/entitlements/{entitlementId}`.
          properties:
            id:
              type: string
              format: uuid
            suppressFromDiscovery:
              type: boolean
            tags:
              type: array
              items:
                $ref: '#/components/schemas/Tag'
        platform:
          allOf:
          - $ref: '#/components/schemas/Platform'
          description: Present when the resource is a Platform Title Instance or Package Content Item.
        suppressFromDiscovery:
          type: boolean
          description: Present when the resource is a Platform Title Instance or Package Content Item.
        embargo:
          allOf:
          - $ref: '#/components/schemas/Embargo'
          description: Present only for Package Content Item resources with an embargo.
        note:
          type: string
          description: Present only for Package Content Item resources with a note.
        url:
          type: string
          description: Present when the resource is a Platform Title Instance or Package Content Item and has a URL.
        templatedUrls:
          type: array
          description: URLs generated from String Templates (see `/erm/sts`) applicable to this resource's platform. Present when the resource is a Platform Title Instance or Package Content Item.
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              url:
                type: string
        depth:
          type: string
          description: Present only for Package Content Item resources.
        coverage:
          type: array
          description: Coverage statements for this resource, or a custom coverage override if one applies (see `customCoverage`). Empty if there is no coverage.
          items:
            $ref: '#/components/schemas/CoverageStatement'
        customCoverage:
          type: boolean
          description: True if `coverage` is a custom override rather than the resource's own coverage statements.
        relatedTitles:
          type: array
          description: Related title instances, present only if the title has any.
          items:
            allOf:
            - $ref: '#/components/schemas/TitleInstance'
            description: A minimal title representation -- only id, name, type, publicationType, subType, identifiers and longName are populated.
        title:
          allOf:
          - $ref: '#/components/schemas/TitleInstance'
          description: The title instance for this resource. The `entitlements`, `coverage`, `work` and `platformInstances` relations are always omitted here, even where the full TitleInstance representation would include them.
    PackageDescriptionUrl:
      type: object
      required:
      - id
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          format: uri
    TitleInstanceRef:
      description: A lightweight representation of a title instance, used where a title references another title (e.g. `TitleInstance.relatedTitles`). Unlike the full `TitleInstance` representation, fields such as `class`, `dateCreated` and `coverage` are not populated on this partial view, and it does not nest further `relatedTitles`.
      allOf:
      - $ref: '#/components/schemas/ErmResource'
      - properties:
          dateMonographPublished:
            type: string
            pattern: ^\d{4}(-((0[0-9])|(1[0-2]))(-(([0-2][0-9])|3[0-1]))?)?\$
          firstAuthor:
            type: string
          firstEditor:
            type: string
          longName:
            type: string
            readOnly: true
          monographEdition:
            type: string
          monographVolume:
            type: string
          work:
            type: object
            properties:
              id:
                type: string
                format: uuid
    GrailsErrorResponse:
      type: object
      description: Error-handler body for an uncaught exception raised during request processing. `exception` and `stackTrace` usually suppressed in production systems
      required:
      - error
      - timestamp
      - message
      properties:
        error:
          type: integer
          description: HTTP status code
        timestamp:
          type: string
          format: date-time
        message:
          type: string
        exception:
          type: string
          description: Exception class and message.
        stackTrace:
          type: array
          items:
            type: string
    Package:
      type: object
      required:
      - name
      - source
      - reference
      - class
      allOf:
      - $ref: '#/components/schemas/ErmResource'
      - properties:
          class:
            enum:
            - org.olf.kb.Pkg
          source:
            type: string
          sourceDataCreated:
            type: string
            format: date-time
          sourceDataUpdated:
            type: string
            format: date-time
          sourceTitleCount:
            type: integer
          syncContentsFromSource:
            type: boolean
          reference:
            type: string
          nominalPlatform:
            $ref: '#/components/schemas/Platform'
          vendor:
            $ref: '#/components/schemas/Organisation'
          lifecycleStatus:
            oneOf:
            - type: string
            - $ref: '#/components/schemas/Refdata'
          availabilityScope:
            oneOf:
            - type: string
            - $ref: '#/components/schemas/Refdata'
          packageDescriptionUrls:
            type: array
            items:
              $ref: '#/components/schemas/PackageDescriptionUrl'
          contentTypes:
            type: array
            items:
              $ref: '#/components/schemas/ContentType'
          availabilityConstraints:
            type: array
            items:
              $ref: '#/components/schemas/AvailabilityConstraint'
          resourceCount:
            type: integer
    AlternateResourceName:
      type: object
      required:
      - id
      - name
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    ErmResource:
      type: object
      properties:
        id:
          type: string
          format: uuid
        class:
          type: string
          enum:
          - org.olf.kb.TitleInstance
          - org.olf.kb.PlatformTitleInstance
          - org.olf.kb.PackageContentItem
          - org.olf.kb.Pkg
        coverage:
          type: array
          items:
            $ref: '#/components/schemas/CoverageStatement'
        customCoverage:
          type: boolean
        dateCreated:
          type: string
          format: date-time
        lastUpdated:
          type: string
          format: date-time
        name:
          type: string
        normalizedName:
          type: string
          readOnly: true
        description:
          type: string
        publicationType:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/Refdata'
        suppressFromDiscovery:
          type: boolean
        subType:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/Refdata'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        type:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/Refdata'
        alternateResourceNames:
          type: array
          items:
            $ref: '#/components/schemas/AlternateResourceName'
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/IdentifierOccurrence'
        _object:
          description: The full, type-specific representation of this resource (fields vary depending on `class`)
          oneOf:
          - $ref: '#/components/schemas/TitleInstance'
          - $ref: '#/components/schemas/PlatformTitleInstance'
          - $ref: '#/components/schemas/PackageContentItem'
          - $ref: '#/components/schemas/Package'
          discriminator:
            propertyName: class
            mapping:
              org.olf.kb.TitleInstance: '#/components/schemas/TitleInstance'
              org.olf.kb.PlatformTitleInstance: '#/components/schemas/PlatformTitleInstance'
              org.olf.kb.PackageContentItem: '#/components/schemas/PackageContentItem'
              org.olf.kb.Pkg: '#/components/schemas/Package'
    TitleInstance:
      type: object
      required:
      - name
      - class
      allOf:
      - $ref: '#/components/schemas/ErmResource'
      - properties:
          class:
            enum:
            - org.olf.kb.TitleInstance
          dateMonographPublished:
            type: string
            pattern: ^\d{4}(-((0[0-9])|(1[0-2]))(-(([0-2][0-9])|3[0-1]))?)?\$
          firstAuthor:
            type: string
          firstEditor:
            type: string
          identifiers:
            type: array
            items:
              $ref: '#/components/schemas/IdentifierOccurrence'
          longName:
            type: string
            readOnly: true
          monographEdition:
            type: string
          monographVolume:
            type: string
          work:
            type: object
            properties:
              id:
                type: string
                format: uuid
          relatedTitles:
            type: array
            readOnly: true
            items:
              $ref: '#/components/schemas/TitleInstanceRef'
    CoverageStatement:
      type: object
      properties:
        id:
          type: string
          format: uuid
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        summary:
          type: string
        startVolume:
          type: string
        startIssue:
          type: string
        endVolume:
          type: string
        endIssue:
          type: string
    PackageContentItem:
      type: object
      required:
      - class
      allOf:
      - $ref: '#/components/schemas/ErmResource'
      - properties:
          class:
            enum:
            - org.olf.kb.PackageContentItem
          accessStart:
            type: string
            format: date
          accessEnd:
            type: string
            format: date
          addedTimestamp:
            type: integer
          depth:
            type: string
          lastSeenTimestamp:
            type: integer
          longName:
            type: string
          note:
            type: string
          removedTimestamp:
            type: integer
          embargo:
            $ref: '#/components/schemas/Embargo'
          pkg:
            $ref: '#/components/schemas/Package'
          pti:
            $ref: '#/components/schemas/PlatformTitleInstance'
    PlatformTitleInstance:
      type: object
      required:
      - platform
      - titleInstance
      - class
      allOf:
      - $ref: '#/components/schemas/ErmResource'
      - properties:
          class:
            enum:
            - org.olf.kb.PlatformTitleInstance
          longName:
            type: string
          platform:
            $ref: '#/components/schemas/Platform'
          titleInstance:
            $ref: '#/components/schemas/TitleInstance'
          url:
            type: string
            format: uri
    Refdata:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        value:
          type: string
    EmbargoStatement:
      type: object
      properties:
        unit:
          type: string
          enum:
          - days
          - months
          - years
        length:
          type: integer
    AvailabilityConstraint:
      type: object
      required:
      - id
      - body
      properties:
        id:
          type: string
          format: uuid
        body:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/Refdata'
    ContentType:
      type: object
      required:
      - id
      - contentType
      properties:
        id:
          type: string
          format: uuid
        contentType:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/Refdata'
    Platform:
      type: object
      required:
      - name
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        dateCreated:
          type: string
          format: date-time
        lastUpdated:
          type: string
          format: date-time
        locators:
          type: array
          items:
            type: object
            properties:
              domainName:
                type: string
              id:
                type: string
                format: uuid
    Tag:
      type: object
      properties:
        id:
          type: integer
        normValue:
          type: string
        value:
          type: string
    Identifier:
      type: object
      properties:
        ns:
          type: object
          properties:
            value:
              type: string
        value:
          type: string
    Organisation:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        orgsUuid:
          type: string
          format: uuid
        orgsUuid_object:
          type: object
    exportRequest:
      $schema: http://json-schema.org/draft-04/schema#
      description: Necessary data to start export process
      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: '#/components/schemas/metadata'
      required:
      - fileDefinitionId
      - jobProfileId
      - idType
    error:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Error
      properties:
        message:
          description: Error message
          type: string
        type:
          description: Error type
          type: string
        code:
          description: Error code
          type: string
        parameters:
          description: Error parameters
          type: object
          $ref: '#/components/schemas/parameters'
      required:
      - message
    errors:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Error collection
      properties:
        errors:
          description: list of errors
          id: errors
          type: array
          items:
            type: object
            $ref: '#/components/schemas/error'
        total_records:
          description: Total records
          type: integer
    parameters:
      $schema: http://json-schema.org/draft-04/schema#
      type: array
      description: Error parameters
      items:
        type: object
        properties:
          key:
            type: string
          value:
            type: string
    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
  parameters:
    format:
      in: path
      name: format
      required: true
      schema:
        type: string
        enum:
        - json
        - kbart
    x-okapi-tenant:
      in: header
      name: x-okapi-tenant
      required: true
      schema:
        type: string
  securitySchemes:
    okapiToken:
      type: apiKey
      in: header
      name: x-okapi-token
    accessToken:
      type: apiKey
      in: cookie
      name: folioAccessToken
x-refined-from:
- folio-mod-agreements-openapi.json
- folio-mod-data-export-openapi.json
- folio-mod-agreements-openapi.yml
- folio-mod-data-export-openapi.yml