generated: '2026-10-09'
method: derived
generator: derive-vocabulary.py
source:
- openapi/folio-edge-caiasoft-openapi.yml
- openapi/folio-edge-courses-openapi.yml
- openapi/folio-edge-dcb-openapi.yml
- openapi/folio-edge-dematic-openapi.yml
- openapi/folio-edge-erm-openapi.yml
vocabulary:
  name: FOLIO Domain Vocabulary
  description: 'Terms declared by FOLIO''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-09'
  terms:
  - term: Actuator
    definition: Monitor and interact
    tags:
    - Resource Group
    source: openapi/folio-mod-camunda-openapi-openapi.yml
  - term: locations
    definition: Manage locations.
    tags:
    - Resource Group
    source: openapi/folio-mod-locations-openapi.yml
  - term: service-points
    definition: Manage service points.
    tags:
    - Resource Group
    source: openapi/folio-mod-locations-openapi.yml
  - term: service-points-users
    definition: Manage service points users.
    tags:
    - Resource Group
    source: openapi/folio-mod-locations-openapi.yml
  - term: authtoken
    definition: Stub implementation for `authtoken` and `authtoken2` interfaces.
    tags:
    - Resource Group
    source: openapi/folio-mod-login-keycloak-openapi.yml
  - term: marc-migrations
    definition: MARC migration operations
    tags:
    - Resource Group
    source: openapi/folio-mod-marc-migrations-openapi.yml
  - term: marc-specifications
    definition: Operations for retrieving MARC field specifications
    tags:
    - Resource Group
    source: openapi/folio-mod-quick-marc-marc-specifications-openapi.yml
  - term: records-editor
    definition: Operations for managing MARC records
    tags:
    - Resource Group
    source: openapi/folio-mod-quick-marc-records-editor-openapi.yml
  - term: specification-storage
    definition: Provides API for managing specifications.
    tags:
    - Resource Group
    source: openapi/folio-mod-record-specifications-openapi.yml
  - term: specification-storage-fields
    definition: Provides API for managing specification fields.
    tags:
    - Resource Group
    source: openapi/folio-mod-record-specifications-openapi.yml
  - term: specification-storage-indicators
    definition: Provides API for managing specification field indicators.
    tags:
    - Resource Group
    source: openapi/folio-mod-record-specifications-openapi.yml
  - term: specification-storage-subfields
    definition: Provides API for managing specification field subfields.
    tags:
    - Resource Group
    source: openapi/folio-mod-record-specifications-openapi.yml
  - term: browse
    definition: Provides endpoints to browse records (e.g., instances, authorities) in alphabetical order by a specific field, such as call number,
      classification number, subject, or contributor.
    tags:
    - Resource Group
    source: openapi/folio-mod-search-openapi.yml
  - term: config
    definition: Provides endpoints to configure search and browse features, such as enabling/disabling specific features or managing language
      settings.
    tags:
    - Resource Group
    source: openapi/folio-mod-search-openapi.yml
  - term: facets
    definition: Provides endpoints to retrieve aggregated information (facets) about records, such as counts of records by specific fields or
      ranges of values. This can be used for faceted search or browsing.
    tags:
    - Resource Group
    source: openapi/folio-mod-search-openapi.yml
  - term: index-management
    definition: Provides endpoints to manage the search index, including creating or updating mappings, settings, and manually populating the
      index with records from external sources (e.g., inventory).
    tags:
    - Resource Group
    source: openapi/folio-mod-search-openapi.yml
  - term: search
    definition: Provides endpoints to search for records (e.g., instances, authorities) using CQL (Contextual Query Language) queries. Supports
      various search options and retrieval of search results.
    tags:
    - Resource Group
    source: openapi/folio-mod-search-openapi.yml
  - term: search-consortium
    definition: Provides endpoints to search for consolidated records (e.g., holdings, items) across multiple institutions or libraries within
      a consortium.
    tags:
    - Resource Group
    source: openapi/folio-mod-search-openapi.yml
  - term: search-resources-ids
    definition: Provides endpoints to retrieve record IDs by CQL queries, without returning the full record data.
    tags:
    - Resource Group
    source: openapi/folio-mod-search-openapi.yml
  - term: tenant
    definition: the tenant API
    tags:
    - Resource Group
    source: openapi/folio-mod-workflow-openapi-openapi.yml
  - term: accessionItem
    definition: Accession item
    tags:
    - Object
    source: openapi/folio-edge-caiasoft-openapi.yml#/components/schemas/accessionItem
  - term: checkInItem
    definition: Value of item's barcode to check in an item at service points
    tags:
    - Object
    source: openapi/folio-edge-caiasoft-openapi.yml#/components/schemas/checkInItem
  - term: returnItemResponse
    definition: Value of item's barcode to check in an item at service points
    tags:
    - Object
    source: openapi/folio-edge-caiasoft-openapi.yml#/components/schemas/returnItemResponse
  - term: uuid
    definition: Regexp pattern for UUID validation
    tags:
    - Object
    source: openapi/folio-edge-caiasoft-openapi.yml#/components/schemas/uuid
  - term: itemNote
    definition: Accession queue note
    tags:
    - Object
    source: openapi/folio-edge-caiasoft-openapi.yml#/components/schemas/itemNote
  - term: courses
    definition: A collection of course records
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/courses
  - term: RequestQueryParameters
    definition: 'Object declared by the contract with fields: query, limit, offset, lang, expand.'
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/RequestQueryParameters
  - term: Error
    definition: 'Object declared by the contract with fields: code, errorMessage.'
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/Error
  - term: instructor_minimal
    definition: Describes an instructor for a given section
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/instructor_minimal
  - term: instructors
    definition: A collection of records
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/instructors
  - term: Metadata Schema
    definition: Metadata about creation and changes to records, provided by the server (client should not provide)
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/metadata
  - term: department
    definition: The department a course belongs to
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/department
  - term: time-period
    definition: schema for time-period, which contains time interval 'duration' and the time unit
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/time-period
  - term: term
    definition: Temporal periods that listings exist in
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/term
  - term: coursetype
    definition: The type of course a listing is
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/coursetype
  - term: instructor
    definition: Describes an instructor for a given section
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/instructor
  - term: courselisting
    definition: An actual instantiation in time and space of a course
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/courselisting
  - term: course
    definition: A course offered by the institution
    tags:
    - Object
    source: openapi/folio-edge-courses-openapi.yml#/components/schemas/course
  - term: DcbUpdateItem
    definition: Item metadata required for updating the existing transaction
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/DcbUpdateItem
  - term: DcbUpdateTransaction
    definition: 'Object declared by the contract with fields: item.'
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/DcbUpdateTransaction
  - term: Parameter
    definition: List of key/value parameters of an error
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/Parameter
  - term: Parameters
    definition: List of key/value parameters of an error
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/Parameters
  - term: renewalInfo
    definition: 'Object declared by the contract with fields: renewalCount, renewalMaxCount, renewable.'
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/renewalInfo
  - term: DcbItem
    definition: Item metadata required for the transaction
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/DcbItem
  - term: DcbPatron
    definition: Patron metadata required for the transaction
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/DcbPatron
  - term: DcbPickup
    definition: Pickup Location metadata required for the pickup service point
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/DcbPickup
  - term: DcbTransaction
    definition: 'Object declared by the contract with fields: item, patron, pickup, selfBorrowing, role.'
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/DcbTransaction
  - term: TransactionStatus
    definition: 'Object declared by the contract with fields: status, message.'
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/TransactionStatus
  - term: Errors
    definition: A set of errors
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/Errors
  - term: TransactionStatusResponseList
    definition: 'Object declared by the contract with fields: id.'
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/TransactionStatusResponseList
  - term: TransactionStatusResponseCollection
    definition: 'Object declared by the contract with fields: transactions, currentPageNumber, currentPageSize, maximumPageNumber, totalRecords.'
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/TransactionStatusResponseCollection
  - term: DcbAgency
    definition: DCB Agency object
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/DcbAgency
  - term: DcbLocation
    definition: DCB Location object
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/DcbLocation
  - term: ShadowLocationRefreshBody
    definition: 'Object declared by the contract with fields: agencies, locations.'
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/ShadowLocationRefreshBody
  - term: RefreshLocationStatusType
    definition: Status of refresh shadow location
    tags:
    - Enumeration
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/RefreshLocationStatusType
  - term: RefreshLocationStatus
    definition: LocationEntity
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/RefreshLocationStatus
  - term: RefreshLocationUnitsStatus
    definition: 'Object declared by the contract with fields: institutions, campuses, libraries.'
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/RefreshLocationUnitsStatus
  - term: RefreshShadowLocationResponse
    definition: Response for shadow location refresh
    tags:
    - Object
    source: openapi/folio-edge-dcb-openapi.yml#/components/schemas/RefreshShadowLocationResponse
  - term: asrItems
    definition: 'Object declared by the contract with fields: asrItems.'
    tags:
    - Object
    source: openapi/folio-edge-dematic-openapi.yml#/components/schemas/asrItems
  - term: asrItem
    definition: 'Object declared by the contract with fields: author, title, itemNumber, callNumber.'
    tags:
    - Object
    source: openapi/folio-edge-dematic-openapi.yml#/components/schemas/asrItem
  - term: asrRequests
    definition: 'Object declared by the contract with fields: asrRequests.'
    tags:
    - Object
    source: openapi/folio-edge-dematic-openapi.yml#/components/schemas/asrRequests
  - term: asrRequest
    definition: 'Object declared by the contract with fields: holdId, itemBarcode, title, author, callNumber, patronBarcode, patronName, requestDate,
      pickupLocation, requestStatus, requestNote.'
    tags:
    - Object
    source: openapi/folio-edge-dematic-openapi.yml#/components/schemas/asrRequest
  - term: updateAsrItem
    definition: 'Object declared by the contract with fields: itemBarcode, itemStatus, operatorId.'
    tags:
    - Object
    source: openapi/folio-edge-dematic-openapi.yml#/components/schemas/updateAsrItem
  - term: license-term-item
    definition: License term item record
    tags:
    - Object
    source: openapi/folio-edge-erm-openapi.yml#/components/schemas/license-term-item
  - term: license-terms
    definition: License terms values by id
    tags:
    - Object
    source: openapi/folio-edge-erm-openapi.yml#/components/schemas/license-terms
  - term: request-ids
    definition: Request body for batch license term request
    tags:
    - Object
    source: openapi/folio-edge-erm-openapi.yml#/components/schemas/request-ids
  - term: license-terms-batch-item
    definition: License term item response
    tags:
    - Object
    source: openapi/folio-edge-erm-openapi.yml#/components/schemas/license-terms-batch-item
  - term: license-terms-batch
    definition: License terms response
    tags:
    - Object
    source: openapi/folio-edge-erm-openapi.yml#/components/schemas/license-terms-batch
  - term: EntityTypeSummary
    definition: Entity Type Summary
    tags:
    - Object
    source: openapi/folio-edge-fqm-openapi.yml#/components/schemas/EntityTypeSummary
  - term: EntityTypeSummaries
    definition: Entity Type Summary List
    tags:
    - Object
    source: openapi/folio-edge-fqm-openapi.yml#/components/schemas/EntityTypeSummaries
  - term: parameter
    definition: List of key/value parameters of an error
    tags:
    - Object
    source: openapi/folio-edge-ill-openapi.yml#/components/schemas/parameter
  - term: error
    definition: An error
    tags:
    - Object
    source: openapi/folio-edge-ill-openapi.yml#/components/schemas/error
  - term: errors
    definition: A set of errors
    tags:
    - Object
    source: openapi/folio-edge-ill-openapi.yml#/components/schemas/errors
  - term: TestDocumentDeliveryOffer
    definition: 'Object declared by the contract with fields: systemId, url, privateKey, offerReference, documentTitle, pin, documentSecurityLevel,
      offerType, attestationLevel, patronEmail, rawSourceMimeType, workflow. (1 more)'
    tags:
    - Object
    source: openapi/folio-edge-ill-openapi.yml#/components/schemas/TestDocumentDeliveryOffer
  - term: TestDocumentDeliveryRegister
    definition: 'Object declared by the contract with fields: systemCode, url, name, attestationLevel.'
    tags:
    - Object
    source: openapi/folio-edge-ill-openapi.yml#/components/schemas/TestDocumentDeliveryRegister
  - term: accessTokenResponse
    definition: Access token response
    tags:
    - Object
    source: openapi/folio-edge-inn-reach-openapi.yml#/components/schemas/accessTokenResponse
  - term: innReachError
    definition: D2IR error
    tags:
    - Object
    source: openapi/folio-edge-inn-reach-openapi.yml#/components/schemas/innReachError
  - term: innReachResponseDTO
    definition: D2IR response
    tags:
    - Object
    source: openapi/folio-edge-inn-reach-openapi.yml#/components/schemas/innReachResponseDTO
  - term: userTenants
    definition: Response schema for user tenants
    tags:
    - Object
    source: openapi/folio-edge-inventory-openapi.yml#/components/schemas/userTenants
  - term: facetResponse
    definition: Response schema for search holdings tenants
    tags:
    - Object
    source: openapi/folio-edge-inventory-openapi.yml#/components/schemas/facetResponse