openapi: 3.2.0
info:
  title: Folio Search API
  version: v4.1.0
  contact:
    name: Spitfire team
  description: 'Operations tagged search across 2 of this provider''s published API definitions: folio-mod-search-openapi.json, folio-mod-search-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Development environments.
  url: https://{environment}-okapi.ci.folio.org
  variables:
    environment:
      default: folio-dev-spitfire
      enum:
      - folio-dev-spitfire
      - folio-perf-spitfire
- description: Reference environments.
  url: https://folio-{environment}-okapi.dev.folio.org
  variables:
    environment:
      default: snapshot
      enum:
      - snapshot
      - snapshot-2
tags:
- description: 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.
  name: Search
paths:
  /search/instances:
    get:
      description: Get a list of instances for CQL query
      operationId: searchInstances
      parameters:
      - description: X-Okapi-Tenant header value
        in: header
        name: x-okapi-tenant
        required: true
        schema:
          type: string
      - description: "A CQL query string\n<h5 id=\"instance-search-options\">Instance search options</h5>\n  <table>\n  <thead>\n  <tr>\n      <th>Option</th>\n      <th>Type</th>\n      <th>Example</th>\n      <th>Description</th>\n  </tr>\n  </thead>\n  <tbody>\n  <tr>\n      <td>keyword</td>\n      <td>full-text</td>\n      <td>keyword all &quot;web semantic&quot;</td>\n      <td>An alias for: title, alternativeTitles, indexTitle, series, contributors.name</td>\n  </tr>\n  <tr>\n      <td>id</td>\n      <td>term</td>\n      <td>id==&quot;1234567&quot;</td>\n      <td>Matches instance with the id</td>\n  </tr>\n  <tr>\n      <td>hrid</td>\n      <td>term</td>\n      <td>hrid==&quot;hr1*0&quot;</td>\n      <td>Matches instances with given HRID</td>\n  </tr>\n  <tr>\n      <td>source</td>\n      <td>term</td>\n      <td>source==&quot;MARC&quot;</td>\n      <td>Matches instances with given source (FOLIO/MARC)</td>\n  </tr>\n  <tr>\n      <td>title</td>\n      <td>full-text</td>\n      <td>title all &quot;semantic web&quot;</td>\n      <td>Matches instances with the given title, searches against title, alternativeTitles,\n          indexTitle, series fields\n      </td>\n  </tr>\n  <tr>\n      <td>alternativeTitles.alternativeTitle</td>\n      <td>full-text</td>\n      <td>alternativeTitles.alternativeTitle all &quot;semantic web&quot;</td>\n      <td>Matches instances with the given alternative title</td>\n  </tr>\n  <tr>\n      <td>uniformTitle</td>\n      <td>full-text</td>\n      <td>uniformTitle all &quot;semantic web&quot;</td>\n      <td>Matches instances with the given uniform title</td>\n  </tr>\n  <tr>\n      <td>indexTitle</td>\n      <td>full-text</td>\n      <td>indexTitle all &quot;semantic web&quot;</td>\n      <td>Matches instances with the given index title</td>\n  </tr>\n  <tr>\n      <td>series</td>\n      <td>full-text</td>\n      <td>series all &quot;series&quot;</td>\n      <td>Matches instance with given series value</td>\n  </tr>\n  <tr>\n      <td>identifiers.value</td>\n      <td>term</td>\n      <td>identifiers.value = &quot;1023*&quot;</td>\n      <td>Matches instances with the given identifier value</td>\n  </tr>\n  <tr>\n      <td>identifiers.identifierTypeId</td>\n      <td>term</td>\n      <td>identifiers.identifierTypeId==&quot;123&quot; identifiers.value = &quot;1023*&quot;\n      </td>\n      <td>Matches instances that have an identifier of type 123 and ANY\n          identifier with value 1023*\n      </td>\n  </tr>\n  <tr>\n      <td>contributors</td>\n      <td>full-text</td>\n      <td>contributors all &quot;John&quot;</td>\n      <td>Matches instances that have a John contributor</td>\n  </tr>\n  <tr>\n      <td>contributors.name</td>\n      <td>full-text</td>\n      <td>contributors.name all &quot;John&quot;</td>\n      <td>Matches instances that have a primary John contributor</td>\n  </tr>\n  <tr>\n      <td>contributors.contributorTypeId</td>\n      <td>term</td>\n      <td>contributors.contributorTypeId all &quot;1234567&quot;</td>\n      <td>Matches instances that have a contributor type Id 1234567</td>\n  </tr>\n  <tr>\n      <td>contributors.contributorNameTypeId</td>\n      <td>term</td>\n      <td>contributors.contributorNameTypeId all &quot;1234567&quot;</td>\n      <td>Matches instances that have a contributor name type Id 1234567</td>\n  </tr>\n  <tr>\n      <td>contributors.primary</td>\n      <td>term</td>\n      <td>contributors all &quot;John&quot; and contributors.primary==true</td>\n      <td>Matches instances that have a primary John contributor</td>\n  </tr>\n  <tr>\n      <td>contributors.authorityId</td>\n      <td>term</td>\n      <td>contributors.authorityId ==\n          &quot;81ae0f60-f2bc-450c-84c8-5a21096daed9&quot;\n      </td>\n      <td>Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9\n      </td>\n  </tr>\n  <tr>\n      <td>authorityId</td>\n      <td>term</td>\n      <td>authorityId == &quot;81ae0f60-f2bc-450c-84c8-5a21096daed9&quot;</td>\n      <td>Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9\n      </td>\n  </tr>\n  <tr>\n      <td>subjects</td>\n      <td>full-text</td>\n      <td>subjects all &quot;Chemistry&quot;</td>\n      <td>Matches instances that have a Chemistry subject</td>\n  </tr>\n  <tr>\n      <td>instanceTypeId</td>\n      <td>term</td>\n      <td>instanceTypeId == &quot;123&quot;</td>\n      <td>Matches instances with the 123 type</td>\n  </tr>\n  <tr>\n      <td>statusId</td>\n      <td>term</td>\n      <td>statusId == &quot;123&quot;</td>\n      <td>Matches instances with the 123 status</td>\n  </tr>\n  <tr>\n      <td>instanceFormatIds</td>\n      <td>term</td>\n      <td>instanceFormatIds == &quot;123&quot;</td>\n      <td>Matches instances with the 123 format id</td>\n  </tr>\n  <tr>\n      <td>languages</td>\n      <td>term</td>\n      <td>languages == &quot;eng&quot;</td>\n      <td>Matches instances that have eng language</td>\n  </tr>\n  <tr>\n      <td>metadata.createdDate</td>\n      <td>term</td>\n      <td>metadata.createdDate &gt; &quot;2021-03-01T00:00:00.000+00:00&quot;\n      </td>\n      <td>Matches instances that were created after 2020-12-12</td>\n  </tr>\n  <tr>\n      <td>metadata.updatedDate</td>\n      <td>term</td>\n      <td>metadata.updatedDate &gt; &quot;2020-12-12&quot;</td>\n      <td>Matches instances that were updated after 2020-12-12</td>\n  </tr>\n  <tr>\n      <td>modeOfIssuanceId</td>\n      <td>term</td>\n      <td>modeOfIssuanceId==&quot;123&quot;</td>\n      <td>Matches instances that have 123 mode of issuance</td>\n  </tr>\n  <tr>\n      <td>natureOfContentTermIds</td>\n      <td>term</td>\n      <td>natureOfContentTermIds==&quot;123&quot;</td>\n      <td>Matches instances that have 123 nature of content</td>\n  </tr>\n  <tr>\n      <td>publisher</td>\n      <td>full-text</td>\n      <td>publisher all &quot;Publisher of Ukraine&quot;</td>\n      <td>Matches instances that have Publisher of Ukraine publisher</td>\n  </tr>\n  <tr>\n      <td>publication.place</td>\n      <td>full-text</td>\n      <td>publication.place all &quot;Ukraine&quot;</td>\n      <td>Matches instances that have `Ukraine` in publication place</td>\n  </tr>\n  <tr>\n      <td>instanceTags</td>\n      <td>term</td>\n      <td>instanceTags==&quot;important&quot;</td>\n      <td>Matches instances that have important tag</td>\n  </tr>\n  <tr>\n      <td>classifications.classificationNumber</td>\n      <td>term</td>\n      <td>classifications.classificationNumber==&quot;cl1&quot;</td>\n      <td>Matches instances that have cl1 classification number</td>\n  </tr>\n  <tr>\n      <td>classifications.classificationTypeId</td>\n      <td>term</td>\n      <td>classifications.classificationTypeId == &quot;123&quot;</td>\n      <td>Matches instances that have classification type id 123</td>\n  </tr>\n  <tr>\n      <td>electronicAccess</td>\n      <td>full-text</td>\n      <td>electronicAccess any &quot;resource&quot;</td>\n      <td>An alias for electronicAccess fields - uri, linkText, publicNote\n      </td>\n  </tr>\n  <tr>\n      <td>electronicAccess.uri</td>\n      <td>term</td>\n      <td>electronicAccess.uri=&quot;http://folio.org*&quot;</td>\n      <td>Search by electronic access URI</td>\n  </tr>\n  <tr>\n      <td>electronicAccess.linkText</td>\n      <td>full-text</td>\n      <td>electronicAccess.linkText=&quot;Folio website&quot;</td>\n      <td>Search by electronic access link text</td>\n  </tr>\n  <tr>\n      <td>electronicAccess.publicNote</td>\n      <td>full-text</td>\n      <td>electronicAccess.publicNote=&quot;a rare book&quot;</td>\n      <td>Search by electronic access public note</td>\n  </tr>\n  <tr>\n      <td>electronicAccess.relationshipId</td>\n      <td>term</td>\n      <td>electronicAccess.relationshipId=&quot;47d563ed-1ae2-41dc-97f8-8ebefce904f0&quot;</td>\n      <td>Search by electronic access relationship type ID</td>\n  </tr>\n  <tr>\n      <td>staffSuppress</td>\n      <td>term</td>\n      <td>staffSuppress==true</td>\n      <td>Matches instances that are staff suppressed</td>\n  </tr>\n  <tr>\n      <td>discoverySuppress</td>\n      <td>term</td>\n      <td>discoverySuppress==true</td>\n      <td>Matches instances that are suppressed from discovery</td>\n  </tr>\n  <tr>\n      <td>publicNotes</td>\n      <td>full-text</td>\n      <td>publicNotes all &quot;public note&quot;</td>\n      <td>Matches instances that have a public note (i.e. note.staffOnly is\n          false)\n      </td>\n  </tr>\n  <tr>\n      <td>administrativeNotes</td>\n      <td>full-text</td>\n      <td>administrativeNotes all &quot;librarian note&quot;</td>\n      <td>Search by administrative notes</td>\n  </tr>\n  <tr>\n      <td>notes.note</td>\n      <td>full-text</td>\n      <td>notes.note all &quot;librarian note&quot;</td>\n      <td>Search by instance notes (include staffOnly)</td>\n  </tr>\n  <tr>\n      <td>isbn</td>\n      <td>term</td>\n      <td>isbn=&quot;1234*&quot;</td>\n      <td>Matches instances that have an ISBN identifier with the given value</td>\n  </tr>\n  <tr>\n      <td>issn</td>\n      <td>term</td>\n      <td>issn=&quot;1234*&quot;</td>\n      <td>Matches instances that have an ISSN identifier with the given value</td>\n  </tr>\n  <tr>\n      <td>oclc</td>\n      <td>term</td>\n      <td>oclc=&quot;1234*&quot;</td>\n      <td>Matches instances that have an OCLC identifier with the given value</td>\n  </tr>\n  <tr>\n      <td>lccn</td>\n      <td>term</td>\n      <td>lccn = &quot;LCCN&quot;</td>\n      <td>Matches instances with the given lccn</td>\n  </tr>\n  <tr>\n      <td>canceledLccn</td>\n      <td>term</td>\n      <td>lccn = &quot;LCCN-OLD&quot;</td>\n      <td>Matches instances with the given canceled lccn</td>\n  </tr>\n  <tr>\n      <td>normalizedClassificationNumber</td>\n      <td>term</td>\n      <td>normalizedClassificationNumber == &quot;LCCN&quot;</td>\n      <td>Matches instances with the given classification number (normalizes case,\n          whitespaces, special characters, supports leading and trailing wildcard)\n      </td>\n  </tr>\n  <tr>\n      <td>normalizedDate1</td>\n      <td>term</td>\n      <td>normalizedDate1>=1990</td>\n      <td>Matches instances with the given Date1 (normalizes  alpha u characters)</td>\n  </tr>\n  <tr>\n      <td>classificationId</td>\n      <td>term</td>\n      <td>classificationId = &quot;c4f60d7413158e9466856f4c0250d91d312f86cf&quot;</td>\n      <td>Matches instances with the given classificationId</td>\n  </tr>\n  </tbody>\n  </table>\n  <h5 id=\"instance-sort-options\">Instance sort options</h5>\n  <table>\n  <thead>\n  <tr>\n      <th>Option</th>\n      <th>Secondary sort</th>\n      <th>Description</th>\n  </tr>\n  </thead>\n  <tbody>\n  <tr>\n      <td>title</td>\n      <td>relevancy</td>\n      <td>Sort instances by title</td>\n  </tr>\n  <tr>\n      <td>contributors</td>\n      <td>relevancy</td>\n      <td>Sort instances by contributors</td>\n  </tr>\n  <tr>\n      <td>item.status.name</td>\n      <td>title</td>\n      <td>Sort instances by status</td>\n  </tr>\n  <tr>\n      <td>normalizedDate1</td>\n      <td>relevancy</td>\n      <td>Sort instances by normalizedDate1</td>\n  </tr>\n  <tr>\n      <td>metadata.createdDate</td>\n      <td>relevancy</td>\n      <td>Sort instances by created date</td>\n  </tr>\n  <tr>\n      <td>metadata.updatedDate</td>\n      <td>relevancy</td>\n      <td>Sort instances by updated date</td>\n  </tr>\n  </tbody>\n  </table>\n  <h5 id=\"holdings-search-options\">Holdings search options</h5>\n  <table>\n  <thead>\n  <tr>\n      <th>Option</th>\n      <th>Type</th>\n      <th>Example</th>\n      <th>Description</th>\n  </tr>\n  </thead>\n  <tbody>\n  <tr>\n      <td>holdings.id</td>\n      <td>term</td>\n      <td>holdings.id==&quot;1234567&quot;</td>\n      <td>Matches instances that have a holding with the id</td>\n  </tr>\n  <tr>\n      <td>holdings.sourceId</td>\n      <td>term</td>\n      <td>holdings.sourceId==&quot;FOLIO&quot;</td>\n      <td>Matches instances that have a holding with the source FOLIO</td>\n  </tr>\n  <tr>\n      <td>holdings.holdingsTypeId</td>\n      <td>term</td>\n      <td>holdings.holdingsTypeId==&quot;1234567&quot;</td>\n      <td>Matches instances that have a holding with the holdings type id 1234567\n      </td>\n  </tr>\n  <tr>\n      <td>holdings.permanentLocationId</td>\n      <td>term</td>\n      <td>holdings.permanentLocationId==&quot;123765&quot;</td>\n      <td>Matches instances that have holdings with given statisticalCodeId</td>\n  </tr>\n  <tr>\n      <td>holdings.statisticalCodeIds</td>\n      <td>term</td>\n      <td>holdings.statisticalCodeIds==&quot;123765&quot;</td>\n      <td>Matches instances that have holdings with given permanentLocationId</td>\n  </tr>\n  <tr>\n      <td>holdings.discoverySuppress</td>\n      <td>term</td>\n      <td>holdings.discoverySuppress==true</td>\n      <td>Matches instances that have holdings suppressed/not suppressed from discovery</td>\n  </tr>\n  <tr>\n      <td>holdings.hrid</td>\n      <td>term</td>\n      <td>holdings.hrid==&quot;hr10*3&quot;</td>\n      <td>Matches instances that have a holding with given HRID</td>\n  </tr>\n  <tr>\n      <td>holdingsTags</td>\n      <td>term</td>\n      <td>holdingsTags==&quot;important&quot;</td>\n      <td>Matches instances that have holdings with given tags</td>\n  </tr>\n  <tr>\n      <td>holdingsFullCallNumbers</td>\n      <td>term</td>\n      <td>holdingsFullCallNumbers=&quot;cn*434&quot;</td>\n      <td>Matches instances that have holdings with given call number string (prefix + call\n          number + suffix)\n      </td>\n  </tr>\n  <tr>\n      <td>holdingsNormalizedCallNumbers</td>\n      <td>term</td>\n      <td>holdingsNormalizedCallNumbers=&quot;cn434&quot;</td>\n      <td>Matches instances that have holdings with given call number and might not be\n          formatted correctly\n      </td>\n  </tr>\n  <tr>\n      <td>holdings.electronicAccess</td>\n      <td>full-text</td>\n      <td>holdings.electronicAccess any &quot;resource&quot;</td>\n      <td>An alias for electronicAccess fields - uri, linkText, publicNote\n      </td>\n  </tr>\n  <tr>\n      <td>holdings.electronicAccess.uri</td>\n      <td>term</td>\n      <td>holdings.electronicAccess.uri=&quot;http://folio.org*&quot;</td>\n      <td>Search by electronic access URI</td>\n  </tr>\n  <tr>\n      <td>holdings.electronicAccess.linkText</td>\n      <td>full-text</td>\n      <td>holdings.electronicAccess.linkText=&quot;Folio website&quot;</td>\n      <td>Search by electronic access link text</td>\n  </tr>\n  <tr>\n      <td>holdings.electronicAccess.publicNote</td>\n      <td>full-text</td>\n      <td>holdings.electronicAccess.publicNote=&quot;a rare book&quot;</td>\n      <td>Search by electronic access public note</td>\n  </tr>\n  <tr>\n      <td>holdings.electronicAccess.relationshipId</td>\n      <td>term</td>\n      <td>holdings.electronicAccess.relationshipId=&quot;0b460e53-aee9-41a8-a447-0755cdac22ca&quot;</td>\n      <td>Search by holdings electronic access relationship type ID</td>\n  </tr>\n  <tr>\n      <td>holdings.administrativeNotes</td>\n      <td>full-text</td>\n      <td>holdings.administrativeNotes all &quot;librarian note&quot;</td>\n      <td>Search by holdings administrative notes</td>\n  </tr>\n  <tr>\n      <td>holdings.notes.note</td>\n      <td>full-text</td>\n      <td>holdings.notes.note all &quot;librarian note&quot;</td>\n      <td>Search by holdings notes</td>\n  </tr>\n  <tr>\n      <td>holdingsTypeId</td>\n      <td>term</td>\n      <td>holdingsTypeId==&quot;123&quot;</td>\n      <td>Search by holdings type id</td>\n  </tr>\n  <tr>\n      <td>holdingsPublicNotes</td>\n      <td>full-text</td>\n      <td>holdingsPublicNotes all &quot;public note&quot;</td>\n      <td>Search by holdings public notes</td>\n  </tr>\n  <tr>\n      <td>holdingsIdentifiers</td>\n      <td>term</td>\n      <td>holdingsIdentifiers == &quot;ho00000000006&quot;</td>\n      <td>Search by holdings Identifiers: holdings.id, holdings.hrid,\n          holdings.formerIds\n      </td>\n  </tr>\n  <tr>\n      <td>holdings.metadata.createdDate</td>\n      <td>term</td>\n      <td>metadata.createdDate &gt; &quot;2020-12-12&quot;</td>\n      <td>Matches instances with holdings that were created after 2020-12-12</td>\n  </tr>\n  <tr>\n      <td>holdings.metadata.updatedDate</td>\n      <td>term</td>\n      <td>metadata.updatedDate &gt; &quot;2020-12-12&quot;</td>\n      <td>Matches instances with holdings that were updated after 2020-12-12</td>\n  </tr>\n  </tbody>\n  </table>\n  <h5 id=\"item-search-options\">Item search options</h5>\n  <table>\n  <thead>\n  <tr>\n      <th>Option</th>\n      <th>Type</th>\n      <th>Example</th>\n      <th>Description</th>\n  </tr>\n  </thead>\n  <tbody>\n  <tr>\n      <td>item.id</td>\n      <td>term</td>\n      <td>item.id==&quot;1234567&quot;</td>\n      <td>Matches instances that have an item with the id</td>\n  </tr>\n  <tr>\n      <td>item.hrid</td>\n      <td>term</td>\n      <td>item.hrid==&quot;it001&quot;</td>\n      <td>Matches instances that have an item with the HRID</td>\n  </tr>\n  <tr>\n      <td>item.barcode</td>\n      <td>term</td>\n      <td>item.barcode==&quot;10011&quot;</td>\n      <td>Matches instances that have an item with the barcode</td>\n  </tr>\n  <tr>\n      <td>item.effectiveLocationId</td>\n      <td>term</td>\n      <td>item.effectiveLocationId==&quot;1212&quot;</td>\n      <td>Matches instances that have item with the effective location</td>\n  </tr>\n  <tr>\n      <td>item.statisticalCodeIds</td>\n      <td>term</td>\n      <td>item.statisticalCodeIds==&quot;1212&quot;</td>\n      <td>Matches instances that have item with the statistical code Id</td>\n  </tr>\n  <tr>\n      <td>item.status.name</td>\n      <td>term</td>\n      <td>item.status.name==&quot;Available&quot;</td>\n      <td>Matches instances that have item with given status</td>\n  </tr>\n  <tr>\n      <td>item.materialTypeId</td>\n      <td>term</td>\n      <td>item.materialTypeId=&quot;23434&quot;</td>\n      <td>Matches instances that have item with given material type</td>\n  </tr>\n  <tr>\n      <td>item.discoverySuppress</td>\n      <td>term</td>\n      <td>item.discoverySuppress=true</td>\n      <td>Matches instances that have item suppressed/not suppressed from discovery</td>\n  </tr>\n  <tr>\n      <td>itemFullCallNumbers</td>\n      <td>term</td>\n      <td>itemFullCallNumbers=&quot;cn*434&quot;</td>\n      <td>Matches instances that have item with given call number string (prefix + call number\n          + suffix)\n      </td>\n  </tr>\n  <tr>\n      <td>itemNormalizedCallNumbers</td>\n      <td>term</td>\n      <td>itemNormalizedCallNumbers=&quot;cn434&quot;</td>\n      <td>Matches instances that have item with given call number and might not be formatted\n          correctly\n      </td>\n  </tr>\n  <tr>\n      <td>itemLevelCallNumberTypeId</td>\n      <td>term</td>\n      <td>\n          itemLevelCallNumberTypeId=&quot;81ae0f60-f2bc-450c-84c8-5a21096daed9&quot;\n      </td>\n      <td>Matches instances that have item with given call number type id</td>\n  </tr>\n  <tr>\n      <td>itemTags</td>\n      <td>term</td>\n      <td>itemTags=&quot;important&quot;</td>\n      <td>Matches instances that have item with given tag</td>\n  </tr>\n  <tr>\n      <td>item.electronicAccess</td>\n      <td>full-text</td>\n      <td>item.electronicAccess any &quot;resource&quot;</td>\n      <td>An alias for electronicAccess fields - uri, linkText, publicNote\n      </td>\n  </tr>\n  <tr>\n      <td>item.electronicAccess.uri</td>\n      <td>term</td>\n      <td>item.electronicAccess.uri=&quot;http://folio.org*&quot;</td>\n      <td>Search by electronic access URI</td>\n  </tr>\n  <tr>\n      <td>item.electronicAccess.linkText</td>\n      <td>full-text</td>\n      <td>item.electronicAccess.linkText=&quot;Folio website&quot;</td>\n      <td>Search by electronic access link text</td>\n  </tr>\n  <tr>\n      <td>item.electronicAccess.publicNote</td>\n      <td>full-text</td>\n      <td>item.electronicAccess.publicNote=&quot;a rare book&quot;</td>\n      <td>Search by electronic access public note</td>\n  </tr>\n  <tr>\n      <td>item.electronicAccess.relationshipId</td>\n      <td>term</td>\n      <td>item.electronicAccess.relationshipId=&quot;0b460e53-aee9-41a8-a447-0755cdac22ca&quot;</td>\n      <td>Search by item electronic access relationship type ID</td>\n  </tr>\n  <tr>\n      <td>item.administrativeNotes</td>\n      <td>full-text</td>\n      <td>item.administrativeNotes all &quot;librarian note&quot;</td>\n      <td>Search by item administrative notes</td>\n  </tr>\n  <tr>\n      <td>item.notes.note</td>\n      <td>full-text</td>\n      <td>item.notes.note all &quot;librarian note&quot;</td>\n      <td>Search by item notes and circulation notes</td>\n  </tr>\n  <tr>\n      <td>item.circulationNotes.note</td>\n      <td>full-text</td>\n      <td>item.circulationNotes.note all &quot;circulation note&quot;</td>\n      <td>Search by item circulation notes</td>\n  </tr>\n  <tr>\n      <td>itemPublicNotes</td>\n      <td>full-text</td>\n      <td>itemPublicNotes all &quot;public note&quot;</td>\n      <td>Search by item public notes and circulation notes</td>\n  </tr>\n  <tr>\n      <td>itemIdentifiers</td>\n      <td>term</td>\n      <td>itemIdentifiers all &quot;81ae0f60-f2bc-450c-84c8-5a21096daed9&quot;\n      </td>\n      <td>Search by item Identifiers: item.id, item.hrid, item.formerIds,\n          item.accessionNumber, item.itemIdentifier\n      </td>\n  </tr>\n  <tr>\n      <td>item.metadata.createdDate</td>\n      <td>term</td>\n      <td>item.metadata.createdDate &gt; &quot;2020-12-12&quot;</td>\n      <td>Matches instances with item that were created after 2020-12-12</td>\n  </tr>\n  <tr>\n      <td>item.metadata.updatedDate</td>\n      <td>term</td>\n      <td>item.metadata.updatedDate &gt; &quot;2020-12-12&quot;</td>\n      <td>Matches instances with item that were updated after 2020-12-12</td>\n  </tr>\n  <tr>\n      <td>callNumberType</td>\n      <td>term</td>\n      <td>callNumberType = &quot;lc&quot;</td>\n      <td>Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local.</td>\n  </tr>\n  </tbody>\n  </table>\n"
        in: query
        name: query
        required: true
        schema:
          type: string
      - description: Limit the number of elements returned in the response.
        in: query
        name: limit
        schema:
          default: 100
          maximum: 500
          minimum: 0
          type: integer
      - description: Skip over a number of elements by specifying an offset value for the query.
        in: query
        name: offset
        schema:
          default: 0
          maximum: 9999
          minimum: 0
          type: integer
      - description: Whether to return only basic properties or entire instance.
        in: query
        name: expandAll
        schema:
          default: false
          type: boolean
      - description: Retrieves the fields listed in the specified parameter.
        in: query
        name: include
        required: false
        schema:
          example: notes,subjects
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                searchResult:
                  $ref: '#/components/examples/instanceSearchResult'
              schema:
                $ref: '#/components/schemas/instanceSearchResult'
          description: Instance search result
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '500':
          content:
            application/json:
              examples:
                unknownError:
                  $ref: '#/components/examples/unknownError'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: When unhandled exception occurred during code execution, e.g. NullPointerException.
      summary: Search Instances
      tags:
      - Search
    servers:
    - description: Development environments.
      url: https://{environment}-okapi.ci.folio.org
      variables:
        environment:
          default: folio-dev-spitfire
          enum:
          - folio-dev-spitfire
          - folio-perf-spitfire
    - description: Reference environments.
      url: https://folio-{environment}-okapi.dev.folio.org
      variables:
        environment:
          default: snapshot
          enum:
          - snapshot
          - snapshot-2
  /search/authorities:
    get:
      description: Get a list of authorities for CQL query
      operationId: searchAuthorities
      parameters:
      - description: X-Okapi-Tenant header value
        in: header
        name: x-okapi-tenant
        required: true
        schema:
          type: string
      - description: A CQL query string with search conditions.
        in: query
        name: query
        required: true
        schema:
          type: string
      - description: Limit the number of elements returned in the response.
        in: query
        name: limit
        schema:
          default: 100
          maximum: 500
          minimum: 0
          type: integer
      - description: Skip over a number of elements by specifying an offset value for the query.
        in: query
        name: offset
        schema:
          default: 0
          maximum: 9999
          minimum: 0
          type: integer
      - description: Whether to return only basic properties or entire instance.
        in: query
        name: expandAll
        schema:
          default: false
          type: boolean
      - description: Whether to perform a search for a number of linked instances.
        in: query
        name: includeNumberOfTitles
        schema:
          default: true
          type: boolean
      - description: Retrieves the fields listed in the specified parameter.
        in: query
        name: include
        required: false
        schema:
          example: notes,subjects
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                searchResult:
                  $ref: '#/components/examples/authoritySearchResult'
              schema:
                $ref: '#/components/schemas/authoritySearchResult'
          description: Authorities search result
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '500':
          content:
            application/json:
              examples:
                unknownError:
                  $ref: '#/components/examples/unknownError'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: When unhandled exception occurred during code execution, e.g. NullPointerException.
      summary: Search Authorities
      tags:
      - Search
    servers:
    - description: Development environments.
      url: https://{environment}-okapi.ci.folio.org
      variables:
        environment:
          default: folio-dev-spitfire
          enum:
          - folio-dev-spitfire
          - folio-perf-spitfire
    - description: Reference environments.
      url: https://folio-{environment}-okapi.dev.folio.org
      variables:
        environment:
          default: snapshot
          enum:
          - snapshot
          - snapshot-2
  /search/linked-data/works:
    get:
      description: Get a list of linked data records for CQL query
      operationId: searchLinkedDataWorks
      parameters:
      - description: X-Okapi-Tenant header value
        in: header
        name: x-okapi-tenant
        required: true
        schema:
          type: string
      - description: A CQL query string with search conditions.
        in: query
        name: query
        required: true
        schema:
          type: string
      - description: Limit the number of elements returned in the response.
        in: query
        name: limit
        schema:
          default: 10
          maximum: 100
          minimum: 0
          type: integer
      - description: Skip over a number of elements by specifying an offset value for the query.
        in: query
        name: offset
        schema:
          default: 0
          maximum: 9999
          minimum: 0
          type: integer
      - description: Whether to omit instances from a Work search result set
        in: query
        name: omitInstances
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              examples:
                searchResult:
                  $ref: '#/components/examples/linkedDataWorkSearchResult'
              schema:
                $ref: '#/components/schemas/linkedDataWorkSearchResult'
          description: Linked data works search result
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '500':
          content:
            application/json:
              examples:
                unknownError:
                  $ref: '#/components/examples/unknownError'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: When unhandled exception occurred during code execution, e.g. NullPointerException.
      summary: Search Linked Data Works
      tags:
      - Search
    servers:
    - description: Development environments.
      url: https://{environment}-okapi.ci.folio.org
      variables:
        environment:
          default: folio-dev-spitfire
          enum:
          - folio-dev-spitfire
          - folio-perf-spitfire
    - description: Reference environments.
      url: https://folio-{environment}-okapi.dev.folio.org
      variables:
        environment:
          default: snapshot
          enum:
          - snapshot
          - snapshot-2
  /search/linked-data/hubs:
    get:
      description: Get a list of linked data Hubs records for CQL query
      operationId: searchLinkedDataHubs
      parameters:
      - description: X-Okapi-Tenant header value
        in: header
        name: x-okapi-tenant
        required: true
        schema:
          type: string
      - description: A CQL query string with search conditions.
        in: query
        name: query
        required: true
        schema:
          type: string
      - description: Limit the number of elements returned in the response.
        in: query
        name: limit
        schema:
          default: 10
          maximum: 100
          minimum: 0
          type: integer
      - description: Skip over a number of elements by specifying an offset value for the query.
        in: query
        name: offset
        schema:
          default: 0
          maximum: 9999
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                searchResult:
                  $ref: '#/components/examples/linkedDataHubSearchResult'
              schema:
                $ref: '#/components/schemas/linkedDataHubSearchResult'
          description: Linked data Hubs search result
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '500':
          content:
            application/json:
              examples:
                unknownError:
                  $ref: '#/components/examples/unknownError'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: When unhandled exception occurred during code execution, e.g. NullPointerException.
      summary: Search Linked Data Hubs
      tags:
      - Search
    servers:
    - description: Development environments.
      url: https://{environment}-okapi.ci.folio.org
      variables:
        environment:
          default: folio-dev-spitfire
          enum:
          - folio-dev-spitfire
          - folio-perf-spitfire
    - description: Reference environments.
      url: https://folio-{environment}-okapi.dev.folio.org
      variables:
        environment:
          default: snapshot
          enum:
          - snapshot
          - snapshot-2
  /search/linked-data/authorities:
    get:
      description: Get a list of linked data authority records for CQL query
      operationId: searchLinkedDataAuthorities
      parameters:
      - description: X-Okapi-Tenant header value
        in: header
        name: x-okapi-tenant
        required: true
        schema:
          type: string
      - description: A CQL query string with search conditions.
        in: query
        name: query
        required: true
        schema:
          type: string
      - description: Limit the number of elements returned in the response.
        in: query
        name: limit
        schema:
          default: 10
          maximum: 100
          minimum: 0
          type: integer
      - description: Skip over a number of elements by specifying an offset value for the query.
        in: query
        name: offset
        schema:
          default: 0
          maximum: 9999
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                searchResult:
                  $ref: '#/components/examples/linkedDataAuthoritySearchResult'
              schema:
                $ref: '#/components/schemas/linkedDataAuthoritySearchResult'
          description: Linked data authority search result
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '500':
          content:
            application/json:
              examples:
                unknownError:
                  $ref: '#/components/examples/unknownError'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: When unhandled exception occurred during code execution, e.g. NullPointerException.
      summary: Search Linked Data Authorities
      tags:
      - Search
    servers:
    - description: Development environments.
      url: https://{environment}-okapi.ci.folio.org
      variables:
        environment:
          default: folio-dev-spitfire
          enum:
          - folio-dev-spitfire
          - folio-perf-spitfire
    - description: Reference environments.
      url: https://folio-{environment}-okapi.dev.folio.org
      variables:
        environment:
          default: snapshot
          enum:
          - snapshot
          - snapshot-2
components:
  schemas:
    parameter:
      description: List of key/value parameters of an error
      example:
        key: source
        value: 'null'
      properties:
        key:
          description: Parameter key
          type: string
        value:
          description: Parameter value
          type: string
      type: object
    linkedDataClassification:
      description: Linked data Classification DTO, contains type and numbers
      example:
        type: ddc
        number: number
        additionalNumber: additionalNumber
      properties:
        type:
          description: The type of the classification number
          enum:
          - ddc
          - lc
          type: string
        number:
          description: Classification number
          type: string
        additionalNumber:
          description: Additional classification number
          type: string
      required:
      - number
      - type
      type: object
    identifier:
      additionalProperties: false
      description: Resource identifier
      example:
        value: value
        identifierTypeId: identifierTypeId
      properties:
        value:
          description: Resource identifier value
          type: string
        identifierTypeId:
          description: Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)
          type: string
      type: object
    dates:
      additionalProperties: false
      description: Instance Dates
      properties:
        dateTypeId:
          description: Date type ID
          type: string
        date1:
          description: Date1 value
          type: string
        date2:
          description: Date2 value
          type: string
      type: object
    linkedDataInstanceOnly_suppress:
      description: Suppress flags
      example:
        fromDiscovery: true
        staff: true
      properties:
        fromDiscovery:
          type: boolean
        staff:
          type: boolean
      type: object
    linkedDataWorkOnly:
      description: Linked Data Work DTO, contains only Work fields
      properties:
        id:
          description: The Linked Data ID of a Work
          type: string
        tenantId:
          description: Tenant ID
          type: string
        classifications:
          description: List of classification items
          items:
            $ref: '#/components/schemas/linkedDataClassification'
          type: array
        contributors:
          description: Contributor array
          items:
            $ref: '#/components/schemas/linkedDataContributor'
          type: array
        hubLabels:
          description: Linked Data Hub labels array
          items:
            type: string
          type: array
        languages:
          description: Language array
          items:
            type: string
          type: array
        notes:
          description: Notes array
          items:
            $ref: '#/components/schemas/linkedDataNote'
          type: array
        subjects:
          description: Subject label array
          items:
            type: string
          type: array
        titles:
          description: Title array
          items:
            $ref: '#/components/schemas/linkedDataTitle'
          type: array
      required:
      - id
      type: object
    tags:
      additionalProperties: false
      description: List of simple tags that can be added to an object
      example:
        tagList:
        - tagList
        - tagList
      properties:
        tagList:
          description: List of tags
          items:
            type: string
          type: array
      title: tags
      type: object
    linkedDataAuthoritySearchResult:
      description: Linked data Authority search result response
      example:
        searchQuery: searchQuery
        content:
        - id: id
          tenantId: tenantId
          label: label
          identifiers:
          - value: value
            type: type
          - value: value
            type: type
          types:
          - types
          - types
        - id: id
          tenantId: tenantId
          label: label
          identifiers:
          - value: value
            type: type
          - value: value
            type: type
          types:
          - types
          - types
        pageNumber: 0
        totalPages: 6
        totalRecords: 1
      properties:
        searchQuery:
          description: Initial search query
          type: string
        content:
          description: List of linked data records found
          items:
            $ref: '#/components/schemas/linkedDataAuthority'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
        pageNumber:
          description: Current results page number, 0 by default
          type: integer
        totalPages:
          description: Total pages count
          type: integer
        totalRecords:
          description: Total results count
          type: integer
      type: object
    linkedDataWorkSearchResult:
      description: Linked data Work search result response
      example:
        searchQuery: searchQuery
        content:
        - id: id
          tenantId: tenantId
          classifications:
          - type: ddc
            number: number
            additionalNumber: additionalNumber
          - type: ddc
            number: number
            additionalNumber: additionalNumber
          contributors:
          - name: name
            type: Family
            isCreator: true
          - name: name
            type: Family
            isCreator: true
          hubLabels:
          - hubLabels
          - hubLabels
          languages:
          - languages
          - languages
          notes:
          - value: value
            type: type
          - value: value
            type: type
          subjects:
          - subjects
          - subjects
          titles:
          - value: value
            type: Main
          - value: value
            type: Main
          instances:
          - id: id
            tenantId: tenantId
            contributors:
            - name: name
              type: Family
              isCreator: true
            - name: name
              type: Family
              isCreator: true
            editionStatements:
            - editionStatements
            - editionStatements
            format: format
            identifiers:
            - value: value
              type: type
            - value: value
              type: type
            notes:
            - value: value
              type: type
            - value: value
              type: type
            publications:
            - name: name
              date: date
            - name: name
              date: date
            suppress:
              fromDiscovery: true
              staff: true
            titles:
            - value: value
              type: Main
            - value: value
              type: Main
          - id: id
            tenantId: tenantId
            contributors:
            - name: name
              type: Family
              isCreator: true
            - name: name
              type: Family
              isCreator: true
            editionStatements:
            - editionStatements
            - editionStatements
            format: format
            identifiers:
            - value: value
              type: type
            - value: value
              type: type
            notes:
            - value: value
              type: type
            - value: value
              type: type
            publications:
            - name: name
              date: date
            - name: name
              date: date
            suppress:
              fromDiscovery: true
              staff: true
            titles:
            - value: value
              type: Main
            - value: value
              type: Main
        - id: id
          tenantId: tenantId
          classifications:
          - type: ddc
            number: number
            additionalNumber: additionalNumber
          - type: ddc
            number: number
            additionalNumber: additionalNumber
          contributors:
          - name: name
            type: Family
            isCreator: true
          - name: name
            type: Family
            isCreator: true
          hubLabels:
          - hubLabels
          - hubLabels
          languages:
          - languages
          - languages
          notes:
          - value: value
            type: type
          - value: value
            type: type
          subjects:
          - subjects
          - subjects
          titles:
          - value: value
            type: Main
          - value: value
            type: Main
          instances:
          - id: id
            tenantId: tenantId
            contributors:
            - name: name
              type: Family
              isCreator: true
            - name: name
              type: Family
              isCreator: true
            editionStatements:
            - editionStatements
            - editionStatements
            format: format
            identifiers:
            - value: value
              type: type
            - value: value
              type: type
            notes:
            - value: value
              type: type
            - value: value
              type: type
            publications:
            - name: name
              date: date
            - name: name
              date: date
            suppress:
              fromDiscovery: true
              staff: true
            titles:
            - value: value
              type: Main
            - value: value
              type: Main
          - id: id
            tenantId: tenantId
            contributors:
            - name: name
              type: Family
              isCreator: true
            - name: name
              type: Family
              isCreator: true
            editionStatements:
            - editionStatements
            - editionStatements
            format: format
            identifiers:
            - value: value
              type: type
            - value: value
              type: type
            notes:
            - value: value
              type: type
            - value: value
              type: type
            publications:
            - name: name
              date: date
            - name: name
              date: date
            suppress:
              fromDiscovery: true
              staff: true
            titles:
            - value: value
              type: Main
            - value: value
              type: Main
        pageNumber: 0
        totalPages: 6
        totalRecords: 1
      properties:
        searchQuery:
          description: Initial search query
          type: string
        content:
          description: List of linked data records found
          items:
            $ref: '#/components/schemas/linkedDataWork'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
        pageNumber:
          description: Current results page number, 0 by default
          type: integer
        totalPages:
          description: Total pages count
          type: integer
        totalRecords:
          description: Total results count
          type: integer
      type: object
    item_effectiveCallNumberComponents:
      description: Elements of a full call number generated from the item or holding
      example:
        callNumber: callNumber
        prefix: prefix
        suffix: suffix
        typeId: typeId
      properties:
        callNumber:
          description: Effective Call Number is an identifier assigned to an item or its holding and associated with the item.
          type: string
        prefix:
          description: Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.
          type: string
        suffix:
          description: Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.
          type: string
        typeId:
          description: Effective Call Number Type Id is the call number type id of the item, if available, otherwise that of the holding.
          type: string
      type: object
    linkedDataIdentifier:
      description: Linked data Identifier DTO, contains value and type
      example:
        value: value
        type: type
      properties:
        value:
          description: Value of Identifier
          type: string
        type:
          type: string
      required:
      - type
      - value
      type: object
    metadata:
      additionalProperties: false
      description: Record metadata
      example:
        createdDate: createdDate
        createdByUserId: createdByUserId
        updatedDate: updatedDate
        updatedByUserId: updatedByUserId
      properties:
        createdDate:
          description: Date and time when the record was created
          type: string
        createdByUserId:
          description: ID of the user who created the record (when available)
          type: string
        updatedDate:
          description: Date and time when the record was last updated
          type: string
        updatedByUserId:
          description: ID of the user who last updated the record (when available)
          type: string
      type: object
    authoritySearchResult:
      description: Authority search result response
      example:
        totalRecords: 0
        authorities:
        - id: id
          tenantId: tenantId
          shared: true
          source: source
          sourceFileId: sourceFileId
          naturalId: naturalId
          personalName: personalName
          sftPersonalName:
          - sftPersonalName
          - sftPersonalName
          saftPersonalName:
          - saftPersonalName
          - saftPersonalName
          personalNameTitle: personalNameTitle
          sftPersonalNameTitle:
          - sftPersonalNameTitle
          - sftPersonalNameTitle
          saftPersonalNameTitle:
          - saftPersonalNameTitle
          - saftPersonalNameTitle
          corporateName: corporateName
          sftCorporateName:
          - sftCorporateName
          - sftCorporateName
          saftCorporateName:
          - saftCorporateName
          - saftCorporateName
          corporateNameTitle: corporateNameTitle
          sftCorporateNameTitle:
          - sftCorporateNameTitle
          - sftCorporateNameTitle
          saftCorporateNameTitle:
          - saftCorporateNameTitle
          - saftCorporateNameTitle
          meetingName: meetingName
          sftMeetingName:
          - sftMeetingName
          - sftMeetingName
          saftMeetingName:
          - saftMeetingName
          - saftMeetingName
          meetingNameTitle: meetingNameTitle
          sftMeetingNameTitle:
          - sftMeetingNameTitle
          - sftMeetingNameTitle
          saftMeetingNameTitle:
          - saftMeetingNameTitle
          - saftMeetingNameTitle
          uniformTitle: uniformTitle
          sftUniformTitle:
          - sftUniformTitle
          - sftUniformTitle
          saftUniformTitle:
          - saftUniformTitle
          - saftUniformTitle
          namedEvent: namedEvent
          sftNamedEvent:
          - sftNamedEvent
          - sftNamedEvent
          saftNamedEvent:
          - saftNamedEvent
          - saftNamedEvent
          generalSubdivision: generalSubdivision
          sftGeneralSubdivision:
          - sftGeneralSubdivision
          - sftGeneralSubdivision
          saftGeneralSubdivision:
          - saftGeneralSubdivision
          - saftGeneralSubdivision
          topicalTerm: topicalTerm
          sftTopicalTerm:
          - sftTopicalTerm
          - sftTopicalTerm
          saftTopicalTerm:
          - saftTopicalTerm
          - saftTopicalTerm
          subjectHeadings: subjectHeadings
          geographicName: geographicName
          sftGeographicName:
          - sftGeographicName
          - sftGeographicName
          saftGeographicName:
          - saftGeographicName
          - saftGeographicName
          genreTerm: genreTerm
          sftGenreTerm:
          - sftGenreTerm
          - sftGenreTerm
          saftGenreTerm:
          - saftGenreTerm
          - saftGenreTerm
          chronTerm: chronTerm
          sftChronTerm:
          - sftChronTerm
          - sftChronTerm
          saftChronTerm:
          - saftChronTerm
          - saftChronTerm
          mediumPerfTerm: mediumPerfTerm
          sftMediumPerfTerm:
          - sftMediumPerfTerm
          - sftMediumPerfTerm
          saftMediumPerfTerm:
          - saftMediumPerfTerm
          - saftMediumPerfTerm
          geographicSubdivision: geographicSubdivision
          sftGeographicSubdivision:
          - sftGeographicSubdivision
          - sftGeographicSubdivision
          saftGeographicSubdivision:
          - saftGeographicSubdivision
          - saftGeographicSubdivision
          chronSubdivision: chronSubdivision
          sftChronSubdivision:
          - sftChronSubdivision
          - sftChronSubdivision
          saftChronSubdivision:
          - saftChronSubdivision
          - saftChronSubdivision
          formSubdivision: formSubdivision
          sftFormSubdivision:
          - sftFormSubdivision
          - sftFormSubdivision
          saftFormSubdivision:
          - saftFormSubdivision
          - saftFormSubdivision
          identifiers:
          - value: value
            identifierTypeId: identifierTypeId
          - value: value
            identifierTypeId: identifierTypeId
          notes:
          - noteTypeId: '{}'
            note: note
          - noteTypeId: '{}'
            note: note
          metadata:
            createdDate: createdDate
            createdByUserId: createdByUserId
            updatedDate: updatedDate
            updatedByUserId: updatedByUserId
          headingType: headingType
          authRefType: authRefType
          headingRef: headingRef
          numberOfTitles: 6
        - id: id
          tenantId: tenantId
          shared: true
          source: source
          sourceFileId: sourceFileId
          naturalId: naturalId
          personalName: personalName
          sftPersonalName:
          - sftPersonalName
          - sftPersonalName
          saftPersonalName:
          - saftPersonalName
          - saftPersonalName
          personalNameTitle: personalNameTitle
          sftPersonalNameTitle:
          - sftPersonalNameTitle
          - sftPersonalNameTitle
          saftPersonalNameTitle:
          - saftPersonalNameTitle
          - saftPersonalNameTitle
          corporateName: corporateName
          sftCorporateName:
          - sftCorporateName
          - sftCorporateName
          saftCorporateName:
          - saftCorporateName
          - saftCorporateName
          corporateNameTitle: corporateNameTitle
          sftCorporateNameTitle:
          - sftCorporateNameTitle
          - sftCorporateNameTitle
          saftCorporateNameTitle:
          - saftCorporateNameTitle
          - saftCorporateNameTitle
          meetingName: meetingName
          sftMeetingName:
          - sftMeetingName
          - sftMeetingName
          saftMeetingName:
          - saftMeetingName
          - saftMeetingName
          meetingNameTitle: meetingNameTitle
          sftMeetingNameTitle:
          - sftMeetingNameTitle
          - sftMeetingNameTitle
          saftMeetingNameTitle:
          - saftMeetingNameTitle
          - saftMeetingNameTitle
          uniformTitle: uniformTitle
          sftUniformTitle:
          - sftUniformTitle
          - sftUniformTitle
          saftUniformTitle:
          - saftUniformTitle
          - saftUniformTitle
          namedEvent: namedEvent
          sftNamedEvent:
          - sftNamedEvent
          - sftNamedEvent
          saftNamedEvent:
          - saftNamedEvent
          - saftNamedEvent
          generalSubdivision: generalSubdivision
          sftGeneralSubdivision:
          - sftGeneralSubdivision
          - sftGeneralSubdivision
          saftGeneralSubdivision:
          - saftGeneralSubdivision
          - saftGeneralSubdivision
          topicalTerm: topicalTerm
          sftTopicalTerm:
          - sftTopicalTerm
          - sftTopicalTerm
          saftTopicalTerm:
          - saftTopicalTerm
          - saftTopicalTerm
          subjectHeadings: subjectHeadings
          geographicName: geographicName
          sftGeographicName:
          - sftGeographicName
          - sftGeographicName
          saftGeographicName:
          - saftGeographicName
          - saftGeographicName
          genreTerm: genreTerm
          sftGenreTerm:
          - sftGenreTerm
          - sftGenreTerm
          saftGenreTerm:
          - saftGenreTerm
          - saftGenreTerm
          chronTerm: chronTerm
          sftChronTerm:
          - sftChronTerm
          - sftChronTerm
          saftChronTerm:
          - saftChronTerm
          - saftChronTerm
          mediumPerfTerm: mediumPerfTerm
          sftMediumPerfTerm:
          - sftMediumPerfTerm
          - sftMediumPerfTerm
          saftMediumPerfTerm:
          - saftMediumPerfTerm
          - saftMediumPerfTerm
          geographicSubdivision: geographicSubdivision
          sftGeographicSubdivision:
          - sftGeographicSubdivision
          - sftGeographicSubdivision
          saftGeographicSubdivision:
          - saftGeographicSubdivision
          - saftGeographicSubdivision
          chronSubdivision: chronSubdivision
          sftChronSubdivision:
          - sftChronSubdivision
          - sftChronSubdivision
          saftChronSubdivision:
          - saftChronSubdivision
          - saftChronSubdivision
          formSubdivision: formSubdivision
          sftFormSubdivision:
          - sftFormSubdivision
          - sftFormSubdivision
          saftFormSubdivision:
          - saftFormSubdivision
          - saftFormSubdivision
          identifiers:
          - value: value
            identifierTypeId: identifierTypeId
          - value: value
            identifierTypeId: identifierTypeId
          notes:
          - noteTypeId: '{}'
            note: note
          - noteTypeId: '{}'
            note: note
          metadata:
            createdDate: createdDate
            createdByUserId: createdByUserId
            updatedDate: updatedDate
            updatedByUserId: updatedByUserId
          headingType: headingType
          authRefType: authRefType
          headingRef: headingRef
          numberOfTitles: 6
      properties:
        totalRecords:
          description: Amount of authorities found
          type: integer
        authorities:
          description: List of authorities found
          items:
            $ref: '#/components/schemas/authority'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
      type: object
    errorResponse:
      description: A set of errors
      example:
        errors:
        - message: Illegal argument error
          type: IllegalArgumentException
          code: unknown_error
        total_records: 1
      properties:
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/error'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
        total_records:
          description: Total number of errors
          type: integer
      type: object
    alternativeTitle:
      additionalProperties: false
      description: An alternative title description
      example:
        alternativeTitleTypeId: alternativeTitleTypeId
        alternativeTitle: alternativeTitle
        authorityId: authorityId
      properties:
        alternativeTitleTypeId:
          description: UUID for an alternative title qualifier
          type: string
        alternativeTitle:
          description: An alternative title for the resource
          type: string
        authorityId:
          description: UUID of authority record that controls an alternative title
          type: string
      type: object
    note:
      description: Bibliographic or administrative note for instance/item/holding
      example:
        note: note
        staffOnly: false
      properties:
        note:
          description: Text content of the note
          type: string
        staffOnly:
          default: false
          description: If true, determines that the note should not be visible for others than staff
          type: boolean
      type: object
    electronicAccess:
      description: Electronic access object
      example:
        uri: uri
        linkText: linkText
        materialsSpecification: materialsSpecification
        publicNote: publicNote
        relationshipId: relationshipId
      properties:
        uri:
          description: Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources
          type: string
        linkText:
          description: 'The value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated'
          type: string
        materialsSpecification:
          description: Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)
          type: string
        publicNote:
          description: URL public note to be displayed in the discovery
          type: string
        relationshipId:
          description: UUID for the type of relationship between the electronic resource at the location identified and the item described in the record as a whole
          type: string
      type: object
    subject:
      additionalProperties: false
      description: A subject heading description
      example:
        value: value
        authorityId: authorityId
        sourceId: sourceId
        typeId: typeId
      properties:
        value:
          description: Subject heading value
          type: string
        authorityId:
          description: UUID of authority record that controls a subject heading
          type: string
        sourceId:
          description: UUID of subject source
          type: string
        typeId:
          description: UUID of subject type
          type: string
      type: object
    linkedDataInstanceOnly_publications_inner:
      example:
        name: name
        date: date
      properties:
        name:
          description: Name of publisher, distributor, etc.
          type: string
        date:
          description: Date (year YYYY) of publication, distribution, etc.
          type: string
      type: object
    linkedDataInstanceOnly:
      description: Linked Data Instance dto, contains only Instance fields
      example:
        id: id
        tenantId: tenantId
        contributors:
        - name: name
          type: Family
          isCreator: true
        - name: name
          type: Family
          isCreator: true
        editionStatements:
        - editionStatements
        - editionStatements
        format: format
        identifiers:
        - value: value
          type: type
        - value: value
          type: type
        notes:
        - value: value
          type: type
        - value: value
          type: type
        publications:
        - name: name
          date: date
        - name: name
          date: date
        suppress:
          fromDiscovery: true
          staff: true
        titles:
        - value: value
          type: Main
        - value: value
          type: Main
      properties:
        id:
          description: The Linked Data ID of an Instance
          type: string
        tenantId:
          description: Tenant ID
          type: string
        contributors:
          description: Contributor array
          items:
            $ref: '#/components/schemas/linkedDataContributor'
          type: array
        editionStatements:
          description: Edition statement array
          items:
            type: string
          type: array
        format:
          description: Format of an Instance e.g. physical monographs vs. ebooks
          type: string
        identifiers:
          description: Resource identifier array
          items:
            $ref: '#/components/schemas/linkedDataIdentifier'
          type: array
        notes:
          description: Notes array
          items:
            $ref: '#/components/schemas/linkedDataNote'
          type: array
        publications:
          description: List of publication items
          items:
            $ref: '#/components/schemas/linkedDataInstanceOnly_publications_inner'
          type: array
        suppress:
          $ref: '#/components/schemas/linkedDataInstanceOnly_suppress'
        titles:
          description: Title array
          items:
            $ref: '#/components/schemas/linkedDataTitle'
          type: array
      required:
      - id
      type: object
    holding:
      description: Holding description
      example:
        id: id
        tenantId: tenantId
        permanentLocationId: permanentLocationId
        discoverySuppress: true
        hrid: hrid
        sourceId: sourceId
        formerIds:
        - formerIds
        - formerIds
        statisticalCodeIds:
        - statisticalCodeIds
        - statisticalCodeIds
        tags:
          tagList:
          - tagList
          - tagList
        holdingsTypeId: holdingsTypeId
        callNumberPrefix: callNumberPrefix
        callNumber: callNumber
        callNumberSuffix: callNumberSuffix
        copyNumber: copyNumber
        electronicAccess:
        - uri: uri
          linkText: linkText
          materialsSpecification: materialsSpecification
          publicNote: publicNote
          relationshipId: relationshipId
        - uri: uri
          linkText: linkText
          materialsSpecification: materialsSpecification
          publicNote: publicNote
          relationshipId: relationshipId
        administrativeNotes:
        - administrativeNotes
        - administrativeNotes
        notes:
        - note: note
          staffOnly: false
        - note: note
          staffOnly: false
        metadata:
          createdDate: createdDate
          createdByUserId: createdByUserId
          updatedDate: updatedDate
          updatedByUserId: updatedByUserId
      properties:
        id:
          description: Unique ID of the holding record
          type: string
        tenantId:
          description: Tenant ID
          type: string
        permanentLocationId:
          description: The permanent shelving location in which an item resides.
          type: string
        discoverySuppress:
          description: Indicates that the record should not be displayed in a discovery system
          type: boolean
        hrid:
          description: the human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID
          type: string
        sourceId:
          description: (A reference to) the source of a holdings record
          type: string
        formerIds:
          description: Previous identifiers assigned to the holding
          items:
            type: string
          type: array
        statisticalCodeIds:
          description: List of statistical code IDs
          items:
            description: UUID for a statistical code
            type: string
          type: array
        tags:
          $ref: '#/components/schemas/tags'
        holdingsTypeId:
          description: unique ID for the type of this holdings record, a UUID
          type: string
        callNumberPrefix:
          description: Prefix of the call number on the holding level.
          type: string
        callNumber:
          description: Call Number is an identifier assigned to an item, usually printed on a label attached to the item.
          type: string
        callNumberSuffix:
          description: Suffix of the call number on the holding level.
          type: string
        copyNumber:
          description: Item/Piece ID (usually barcode) for systems that do not use item records.
          type: string
        electronicAccess:
          description: List of electronic access items
          items:
            $ref: '#/components/schemas/electronicAccess'
          type: array
        administrativeNotes:
          description: Administrative notes
          items:
            type: string
          type: array
        notes:
          description: Notes about action, copy, binding etc.
          items:
            $ref: '#/components/schemas/note'
          type: array
        metadata:
          $ref: '#/components/schemas/metadata'
      required:
      - electronicAccess
      - notes
      type: object
    seriesItem:
      additionalProperties: false
      description: A series item description
      example:
        value: value
        authorityId: authorityId
      properties:
        value:
          description: Series title value
          type: string
        authorityId:
          description: UUID of authority record that controls a series title
          type: string
      type: object
    item:
      description: Item description
      example:
        id: id
        tenantId: tenantId
        holdingsRecordId: holdingsRecordId
        hrid: hrid
        accessionNumber: accessionNumber
        formerIds:
        - formerIds
        - formerIds
        itemIdentifier: itemIdentifier
        barcode: barcode
        effectiveLocationId: effectiveLocationId
        status:
          name: name
        materialTypeId: materialTypeId
        discoverySuppress: true
        effectiveCallNumberComponents:
          callNumber: callNumber
          prefix: prefix
          suffix: suffix
          typeId: typeId
        volume: volume
        enumeration: enumeration
        chronology: chronology
        copyNumber: copyNumber
        itemLevelCallNumberTypeId: itemLevelCallNumberTypeId
        tags:
          tagList:
          - tagList
          - tagList
        electronicAccess:
        - uri: uri
          linkText: linkText
          materialsSpecification: materialsSpecification
          publicNote: publicNote
          relationshipId: relationshipId
        - uri: uri
          linkText: linkText
          materialsSpecification: materialsSpecification
          publicNote: publicNote
          relationshipId: relationshipId
        administrativeNotes:
        - administrativeNotes
        - administrativeNotes
        notes:
        - note: note
          staffOnly: false
        - note: note
          staffOnly: false
        statisticalCodeIds:
        - statisticalCodeIds
        - statisticalCodeIds
        circulationNotes:
        - note: note
          staffOnly: false
        - note: note
          staffOnly: false
        metadata:
          createdDate: createdDate
          createdByUserId: createdByUserId
          updatedDate: updatedDate
          updatedByUserId: updatedByUserId
      properties:
        id:
          description: Unique ID of the item record
          type: string
        tenantId:
          description: Tenant ID
          type: string
        holdingsRecordId:
          description: Holdings record ID
          type: string
        hrid:
          description: The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID
          type: string
        accessionNumber:
          description: Also called inventory number
          type: string
        formerIds:
          description: Previous identifiers assigned to the item
          items:
            type: string
          type: array
        itemIdentifier:
          description: Item identifier number, e.g. imported from the union catalogue (read only).
          type: string
        barcode:
          description: Unique inventory control number for physical resources, used largely for circulation purposes
          type: string
        effectiveLocationId:
          description: Read only current home location for the item.
          type: string
        status:
          $ref: '#/components/schemas/item_status'
        materialTypeId:
          description: Material type, term. Define what type of thing the item is.
          type: string
        discoverySuppress:
          description: Records the fact that the record should not be displayed in a discovery system
          type: boolean
        effectiveCallNumberComponents:
          $ref: '#/components/schemas/item_effectiveCallNumberComponents'
        volume:
          type: string
        enumeration:
          type: string
        chronology:
          type: string
        copyNumber:
          type: string
        itemLevelCallNumberTypeId:
          description: Call number type id
          type: string
        tags:
          $ref: '#/components/schemas/tags'
        electronicAccess:
          description: List of electronic access items
          items:
            $ref: '#/components/schemas/electronicAccess'
          type: array
        administrativeNotes:
          description: Administrative notes
          items:
            type: string
          type: array
        notes:
          description: Notes about action, copy, binding etc.
          items:
            $ref: '#/components/schemas/note'
          type: array
        statisticalCodeIds:
          description: List of statistical code IDs
          items:
            description: UUID for a statistical code
            type: string
          type: array
        circulationNotes:
          description: Notes to be displayed in circulation processes.
          items:
            $ref: '#/components/schemas/circulationNote'
          type: array
        metadata:
          $ref: '#/components/schemas/metadata'
      required:
      - notes
      type: object
    authority:
      description: An authority description
      example:
        id: id
        tenantId: tenantId
        shared: true
        source: source
        sourceFileId: sourceFileId
        naturalId: naturalId
        personalName: personalName
        sftPersonalName:
        - sftPersonalName
        - sftPersonalName
        saftPersonalName:
        - saftPersonalName
        - saftPersonalName
        personalNameTitle: personalNameTitle
        sftPersonalNameTitle:
        - sftPersonalNameTitle
        - sftPersonalNameTitle
        saftPersonalNameTitle:
        - saftPersonalNameTitle
        - saftPersonalNameTitle
        corporateName: corporateName
        sftCorporateName:
        - sftCorporateName
        - sftCorporateName
        saftCorporateName:
        - saftCorporateName
        - saftCorporateName
        corporateNameTitle: corporateNameTitle
        sftCorporateNameTitle:
        - sftCorporateNameTitle
        - sftCorporateNameTitle
        saftCorporateNameTitle:
        - saftCorporateNameTitle
        - saftCorporateNameTitle
        meetingName: meetingName
        sftMeetingName:
        - sftMeetingName
        - sftMeetingName
        saftMeetingName:
        - saftMeetingName
        - saftMeetingName
        meetingNameTitle: meetingNameTitle
        sftMeetingNameTitle:
        - sftMeetingNameTitle
        - sftMeetingNameTitle
        saftMeetingNameTitle:
        - saftMeetingNameTitle
        - saftMeetingNameTitle
        uniformTitle: uniformTitle
        sftUniformTitle:
        - sftUniformTitle
        - sftUniformTitle
        saftUniformTitle:
        - saftUniformTitle
        - saftUniformTitle
        namedEvent: namedEvent
        sftNamedEvent:
        - sftNamedEvent
        - sftNamedEvent
        saftNamedEvent:
        - saftNamedEvent
        - saftNamedEvent
        generalSubdivision: generalSubdivision
        sftGeneralSubdivision:
        - sftGeneralSubdivision
        - sftGeneralSubdivision
        saftGeneralSubdivision:
        - saftGeneralSubdivision
        - saftGeneralSubdivision
        topicalTerm: topicalTerm
        sftTopicalTerm:
        - sftTopicalTerm
        - sftTopicalTerm
        saftTopicalTerm:
        - saftTopicalTerm
        - saftTopicalTerm
        subjectHeadings: subjectHeadings
        geographicName: geographicName
        sftGeographicName:
        - sftGeographicName
        - sftGeographicName
        saftGeographicName:
        - saftGeographicName
        - saftGeographicName
        genreTerm: genreTerm
        sftGenreTerm:
        - sftGenreTerm
        - sftGenreTerm
        saftGenreTerm:
        - saftGenreTerm
        - saftGenreTerm
        chronTerm: chronTerm
        sftChronTerm:
        - sftChronTerm
        - sftChronTerm
        saftChronTerm:
        - saftChronTerm
        - saftChronTerm
        mediumPerfTerm: mediumPerfTerm
        sftMediumPerfTerm:
        - sftMediumPerfTerm
        - sftMediumPerfTerm
        saftMediumPerfTerm:
        - saftMediumPerfTerm
        - saftMediumPerfTerm
        geographicSubdivision: geographicSubdivision
        sftGeographicSubdivision:
        - sftGeographicSubdivision
        - sftGeographicSubdivision
        saftGeographicSubdivision:
        - saftGeographicSubdivision
        - saftGeographicSubdivision
        chronSubdivision: chronSubdivision
        sftChronSubdivision:
        - sftChronSubdivision
        - sftChronSubdivision
        saftChronSubdivision:
        - saftChronSubdivision
        - saftChronSubdivision
        formSubdivision: formSubdivision
        sftFormSubdivision:
        - sftFormSubdivision
        - sftFormSubdivision
        saftFormSubdivision:
        - saftFormSubdivision
        - saftFormSubdivision
        identifiers:
        - value: value
          identifierTypeId: identifierTypeId
        - value: value
          identifierTypeId: identifierTypeId
        notes:
        - noteTypeId: '{}'
          note: note
        - noteTypeId: '{}'
          note: note
        metadata:
          createdDate: createdDate
          createdByUserId: createdByUserId
          updatedDate: updatedDate
          updatedByUserId: updatedByUserId
        headingType: headingType
        authRefType: authRefType
        headingRef: headingRef
        numberOfTitles: 6
      properties:
        id:
          description: Authority UUID
          type: string
        tenantId:
          description: Tenant ID
          type: string
        shared:
          description: Indicate if it shared record
          type: boolean
        source:
          description: The metadata source and its format of the underlying record to the authority record
          type: string
        sourceFileId:
          description: Authority source file id; UUID
          type: string
        naturalId:
          description: Authority Natural ID
          type: string
        personalName:
          description: Heading personal name
          type: string
        sftPersonalName:
          description: See from tracing personal names
          items:
            description: See from tracing personal name
            type: string
          type: array
        saftPersonalName:
          description: See also from tracing personal names
          items:
            description: See also from tracing personal name
            type: string
          type: array
        personalNameTitle:
          description: Heading personal name title
          type: string
        sftPersonalNameTitle:
          description: See from tracing personal name title
          items:
            type: string
          type: array
        saftPersonalNameTitle:
          description: See also from tracing personal name title
          items:
            type: string
          type: array
        corporateName:
          description: Heading corporate name
          type: string
        sftCorporateName:
          description: See from tracing corporate names
          items:
            description: See from tracing corporate name
            type: string
          type: array
        saftCorporateName:
          description: See also from tracing corporate names
          items:
            description: See also from tracing corporate name
            type: string
          type: array
        corporateNameTitle:
          description: Heading corporate name title
          type: string
        sftCorporateNameTitle:
          description: See from tracing corporate name title
          items:
            type: string
          type: array
        saftCorporateNameTitle:
          description: See also from tracing corporate name title
          items:
            type: string
          type: array
        meetingName:
          description: Heading meeting name
          type: string
        sftMeetingName:
          description: See from tracing meeting names
          items:
            description: See from tracing meeting name
            type: string
          type: array
        saftMeetingName:
          description: See also from tracing meeting names
          items:
            description: See also from tracing meeting name
            type: string
          type: array
        meetingNameTitle:
          description: Heading meeting name title
          type: string
        sftMeetingNameTitle:
          description: See from tracing meeting name title
          items:
            type: string
          type: array
        saftMeetingNameTitle:
          description: See also from tracing meeting name title
          items:
            type: string
          type: array
        uniformTitle:
          description: Heading uniform title
          type: string
        sftUniformTitle:
          description: See from tracing uniform titles
          items:
            description: See from tracing uniform title
            type: string
          type: array
        saftUniformTitle:
          description: See also from tracing uniform titles
          items:
            description: See also from tracing uniform title
            type: string
          type: array
        namedEvent:
          description: Heading named event
          type: string
        sftNamedEvent:
          description: See from tracing named event
          items:
            type: string
          type: array
        saftNamedEvent:
          description: See also from tracing named event
          items:
            type: string
          type: array
        generalSubdivision:
          description: Heading general subdivision
          type: string
        sftGeneralSubdivision:
          description: See from tracing general subdivision
          items:
            type: string
          type: array
        saftGeneralSubdivision:
          description: See also from tracing general subdivision
          items:
            type: string
          type: array
        topicalTerm:
          description: Heading topical term
          type: string
        sftTopicalTerm:
          description: See from tracing topical terms
          items:
            description: See from tracing topical term
            type: string
          type: array
        saftTopicalTerm:
          description: See also from tracing topical terms
          items:
            description: See also from tracing topical term
            type: string
          type: array
        subjectHeadings:
          description: Children's subject headings
          type: string
        geographicName:
          description: Heading geographic name
          type: string
        sftGeographicName:
          description: See from tracing geographic names
          items:
            description: See from tracing geographic name
            type: string
          type: array
        saftGeographicName:
          description: See also from tracing geographic names
          items:
            description: See also from tracing geographic name
            type: string
          type: array
        genreTerm:
          description: Heading genre/form term
          type: string
        sftGenreTerm:
          description: See from tracing genre/form terms
          items:
            description: See from tracing genre/form term
            type: string
          type: array
        saftGenreTerm:
          description: See also from tracing genre/form terms
          items:
            description: See also from tracing genre/form term
            type: string
          type: array
        chronTerm:
          description: Heading chronological term
          type: string
        sftChronTerm:
          description: See from tracing chronological terms
          items:
            description: See from tracing chronological term
            type: string
          type: array
        saftChronTerm:
          description: See also from tracing chronological terms
          items:
            description: See also from tracing chronological term
            type: string
          type: array
        mediumPerfTerm:
          description: Heading medium of performance term
          type: string
        sftMediumPerfTerm:
          description: See from tracing medium of performance terms
          items:
            description: See from tracing medium of performance term
            type: string
          type: array
        saftMediumPerfTerm:
          description: See also from tracing medium of performance terms
          items:
            description: See also from tracing medium of performance term
            type: string
          type: array
        geographicSubdivision:
          description: Heading geographic subdivision
          type: string
        sftGeographicSubdivision:
          description: See from tracing geographic subdivisions
          items:
            description: See from tracing geographic subdivision
            type: string
          type: array
        saftGeographicSubdivision:
          description: See also from tracing geographic subdivisions
          items:
            description: See also from tracing geographic subdivision
            type: string
          type: array
        chronSubdivision:
          description: Heading chronological subdivision
          type: string
        sftChronSubdivision:
          description: See from tracing chronological subdivisions
          items:
            description: See from tracing chronological subdivision
            type: string
          type: array
        saftChronSubdivision:
          description: See also from tracing chronological subdivisions
          items:
            description: See also from tracing chronological subdivision
            type: string
          type: array
        formSubdivision:
          description: Heading form subdivision
          type: string
        sftFormSubdivision:
          description: See from tracing form subdivisions
          items:
            description: See from tracing form subdivision
            type: string
          type: array
        saftFormSubdivision:
          description: See also from tracing form subdivisions
          items:
            description: See also from tracing form subdivision
            type: string
          type: array
        identifiers:
          description: An extensible set of name-value pairs of identifiers associated with the resource
          items:
            $ref: '#/components/schemas/identifier'
          type: array
        notes:
          description: Notes (e.g. nonpublic general note)
          items:
            $ref: '#/components/schemas/authorityNote'
          type: array
        metadata:
          $ref: '#/components/schemas/metadata'
        headingType:
          description: Generated field by mod-search, used to easily identity the heading type of the record that provides authority information
          type: string
        authRefType:
          description: Generated field by mod-search, used to easily identity the authorized/reference type of the record that provides authority information
          type: string
        headingRef:
          description: Generated field by mod-search, used to easily identity the heading/reference of the record that provides authority information
          type: string
        numberOfTitles:
          description: Generated field by mod-search, used to count the total number of bib records linked to this authority record
          type: integer
      type: object
    linkedDataHubSearchResult:
      description: Linked data Hub search result response
      example:
        searchQuery: searchQuery
        content:
        - id: id
          originalId: originalId
          tenantId: tenantId
          label: label
        - id: id
          originalId: originalId
          tenantId: tenantId
          label: label
        pageNumber: 0
        totalPages: 6
        totalRecords: 1
      properties:
        searchQuery:
          description: Initial search query
          type: string
        content:
          description: List of linked data hub records found
          items:
            $ref: '#/components/schemas/linkedDataHub'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
        pageNumber:
          description: Current results page number, 0 by default
          type: integer
        totalPages:
          description: Total pages count
          type: integer
        totalRecords:
          description: Total results count
          type: integer
      type: object
    classification:
      description: Classification object
      example:
        classificationNumber: classificationNumber
        classificationTypeId: classificationTypeId
      properties:
        classificationNumber:
          description: Classification (e.g. classification scheme, classification schedule)
          type: string
        classificationTypeId:
          description: Classification type ID
          type: string
      type: object
    linkedDataAuthority:
      description: Linked Data Authority search dto
      example:
        id: id
        tenantId: tenantId
        label: label
        identifiers:
        - value: value
          type: type
        - value: value
          type: type
        types:
        - types
        - types
      properties:
        id:
          description: The Linked Data ID of an Authority
          type: string
        tenantId:
          description: Tenant ID
          type: string
        label:
          description: Label of an Authority
          type: string
        identifiers:
          description: Resource identifier array
          items:
            $ref: '#/components/schemas/linkedDataIdentifier'
          type: array
        types:
          description: Array of authority types
          items:
            type: string
          type: array
      required:
      - id
      type: object
    circulationNote:
      description: Circulations note for item
      example:
        note: note
        staffOnly: false
      properties:
        note:
          description: Text to display
          type: string
        staffOnly:
          default: false
          description: Flag to restrict display of this note
          type: boolean
      type: object
    linkedDataNote:
      description: Linked data Note DTO, contains value and type
      example:
        value: value
        type: type
      properties:
        value:
          description: Value of a note
          type: string
        type:
          description: Type of a note
          type: string
      required:
      - type
      - value
      type: object
    linkedDataTitle:
      description: Linked data Title DTO, contains value and type
      example:
        value: value
        type: Main
      properties:
        value:
          description: Value of Title
          type: string
        type:
          enum:
          - Main
          - Sub
          - Main Parallel
          - Sub Parallel
          - Main Variant
          - Sub Variant
          type: string
      required:
      - type
      - value
      type: object
    authorityNote:
      example:
        noteTypeId: '{}'
        note: note
      properties:
        noteTypeId:
          description: ID of the type of note
          type: object
        note:
          description: Text content of the note
          type: string
      type: object
    instance:
      description: instance description
      example:
        id: id
        tenantId: tenantId
        shared: true
        hrid: hrid
        source: source
        statisticalCodeIds:
        - statisticalCodeIds
        - statisticalCodeIds
        statusId: statusId
        title: title
        indexTitle: indexTitle
        series:
        - value: value
          authorityId: authorityId
        - value: value
          authorityId: authorityId
        alternativeTitles:
        - alternativeTitleTypeId: alternativeTitleTypeId
          alternativeTitle: alternativeTitle
          authorityId: authorityId
        - alternativeTitleTypeId: alternativeTitleTypeId
          alternativeTitle: alternativeTitle
          authorityId: authorityId
        identifiers:
        - value: value
          identifierTypeId: identifierTypeId
        - value: value
          identifierTypeId: identifierTypeId
        contributors:
        - name: name
          contributorTypeId: contributorTypeId
          contributorTypeText: contributorTypeText
          contributorNameTypeId: contributorNameTypeId
          authorityId: authorityId
          primary: true
        - name: name
          contributorTypeId: contributorTypeId
          contributorTypeText: contributorTypeText
          contributorNameTypeId: contributorNameTypeId
          authorityId: authorityId
          primary: true
        subjects:
        - value: value
          authorityId: authorityId
          sourceId: sourceId
          typeId: typeId
        - value: value
          authorityId: authorityId
          sourceId: sourceId
          typeId: typeId
        dates: '{}'
        instanceTypeId: instanceTypeId
        instanceFormatIds:
        - instanceFormatIds
        - instanceFormatIds
        languages:
        - languages
        - languages
        metadata:
          createdDate: createdDate
          createdByUserId: createdByUserId
          updatedDate: updatedDate
          updatedByUserId: updatedByUserId
        administrativeNotes:
        - administrativeNotes
        - administrativeNotes
        modeOfIssuanceId: modeOfIssuanceId
        natureOfContentTermIds:
        - natureOfContentTermIds
        - natureOfContentTermIds
        publication:
        - publisher: publisher
          dateOfPublication: dateOfPublication
          place: place
        - publisher: publisher
          dateOfPublication: dateOfPublication
          place: place
        staffSuppress: true
        discoverySuppress: true
        isBoundWith: true
        tags:
          tagList:
          - tagList
          - tagList
        classifications:
        - classificationNumber: classificationNumber
          classificationTypeId: classificationTypeId
        - classificationNumber: classificationNumber
          classificationTypeId: classificationTypeId
        electronicAccess:
        - uri: uri
          linkText: linkText
          materialsSpecification: materialsSpecification
          publicNote: publicNote
          relationshipId: relationshipId
        - uri: uri
          linkText: linkText
          materialsSpecification: materialsSpecification
          publicNote: publicNote
          relationshipId: relationshipId
        notes:
        - note: note
          staffOnly: false
        - note: note
          staffOnly: false
        items:
        - id: id
          tenantId: tenantId
          holdingsRecordId: holdingsRecordId
          hrid: hrid
          accessionNumber: accessionNumber
          formerIds:
          - formerIds
          - formerIds
          itemIdentifier: itemIdentifier
          barcode: barcode
          effectiveLocationId: effectiveLocationId
          status:
            name: name
          materialTypeId: materialTypeId
          discoverySuppress: true
          effectiveCallNumberComponents:
            callNumber: callNumber
            prefix: prefix
            suffix: suffix
            typeId: typeId
          volume: volume
          enumeration: enumeration
          chronology: chronology
          copyNumber: copyNumber
          itemLevelCallNumberTypeId: itemLevelCallNumberTypeId
          tags:
            tagList:
            - tagList
            - tagList
          electronicAccess:
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          administrativeNotes:
          - administrativeNotes
          - administrativeNotes
          notes:
          - note: note
            staffOnly: false
          - note: note
            staffOnly: false
          statisticalCodeIds:
          - statisticalCodeIds
          - statisticalCodeIds
          circulationNotes:
          - note: note
            staffOnly: false
          - note: note
            staffOnly: false
          metadata:
            createdDate: createdDate
            createdByUserId: createdByUserId
            updatedDate: updatedDate
            updatedByUserId: updatedByUserId
        - id: id
          tenantId: tenantId
          holdingsRecordId: holdingsRecordId
          hrid: hrid
          accessionNumber: accessionNumber
          formerIds:
          - formerIds
          - formerIds
          itemIdentifier: itemIdentifier
          barcode: barcode
          effectiveLocationId: effectiveLocationId
          status:
            name: name
          materialTypeId: materialTypeId
          discoverySuppress: true
          effectiveCallNumberComponents:
            callNumber: callNumber
            prefix: prefix
            suffix: suffix
            typeId: typeId
          volume: volume
          enumeration: enumeration
          chronology: chronology
          copyNumber: copyNumber
          itemLevelCallNumberTypeId: itemLevelCallNumberTypeId
          tags:
            tagList:
            - tagList
            - tagList
          electronicAccess:
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          administrativeNotes:
          - administrativeNotes
          - administrativeNotes
          notes:
          - note: note
            staffOnly: false
          - note: note
            staffOnly: false
          statisticalCodeIds:
          - statisticalCodeIds
          - statisticalCodeIds
          circulationNotes:
          - note: note
            staffOnly: false
          - note: note
            staffOnly: false
          metadata:
            createdDate: createdDate
            createdByUserId: createdByUserId
            updatedDate: updatedDate
            updatedByUserId: updatedByUserId
        holdings:
        - id: id
          tenantId: tenantId
          permanentLocationId: permanentLocationId
          discoverySuppress: true
          hrid: hrid
          sourceId: sourceId
          formerIds:
          - formerIds
          - formerIds
          statisticalCodeIds:
          - statisticalCodeIds
          - statisticalCodeIds
          tags:
            tagList:
            - tagList
            - tagList
          holdingsTypeId: holdingsTypeId
          callNumberPrefix: callNumberPrefix
          callNumber: callNumber
          callNumberSuffix: callNumberSuffix
          copyNumber: copyNumber
          electronicAccess:
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          administrativeNotes:
          - administrativeNotes
          - administrativeNotes
          notes:
          - note: note
            staffOnly: false
          - note: note
            staffOnly: false
          metadata:
            createdDate: createdDate
            createdByUserId: createdByUserId
            updatedDate: updatedDate
            updatedByUserId: updatedByUserId
        - id: id
          tenantId: tenantId
          permanentLocationId: permanentLocationId
          discoverySuppress: true
          hrid: hrid
          sourceId: sourceId
          formerIds:
          - formerIds
          - formerIds
          statisticalCodeIds:
          - statisticalCodeIds
          - statisticalCodeIds
          tags:
            tagList:
            - tagList
            - tagList
          holdingsTypeId: holdingsTypeId
          callNumberPrefix: callNumberPrefix
          callNumber: callNumber
          callNumberSuffix: callNumberSuffix
          copyNumber: copyNumber
          electronicAccess:
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          administrativeNotes:
          - administrativeNotes
          - administrativeNotes
          notes:
          - note: note
            staffOnly: false
          - note: note
            staffOnly: false
          metadata:
            createdDate: createdDate
            createdByUserId: createdByUserId
            updatedDate: updatedDate
            updatedByUserId: updatedByUserId
      properties:
        id:
          description: The unique ID of the instance record; a UUID
          type: string
        tenantId:
          description: Tenant ID
          type: string
        shared:
          description: Indicate if it shared record
          type: boolean
        hrid:
          description: The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID
          type: string
        source:
          description: The metadata source and its format of the underlying record to the instance record. (e.g. FOLIO if it's a record created in Inventory;  MARC if it's a MARC record created in MARCcat or EPKB if it's a record coming from eHoldings)
          type: string
        statisticalCodeIds:
          description: List of statistical code IDs
          items:
            description: UUID for a statistical code
            type: string
          type: array
        statusId:
          description: UUID for the Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)
          type: string
        title:
          description: The primary title (or label) associated with the resource
          type: string
        indexTitle:
          description: Title normalized for browsing and searching; based on the title with articles removed
          type: string
        series:
          description: List of series titles associated with the resource (e.g. Harry Potter)
          items:
            $ref: '#/components/schemas/seriesItem'
          type: array
        alternativeTitles:
          description: List of alternative titles for the resource (e.g. original language version title of a movie)
          items:
            $ref: '#/components/schemas/alternativeTitle'
          type: array
        identifiers:
          description: Resource identifier value array
          items:
            $ref: '#/components/schemas/identifier'
          type: array
        contributors:
          description: List of contributors names
          items:
            $ref: '#/components/schemas/contributor'
          type: array
        subjects:
          description: List of subject headings
          items:
            $ref: '#/components/schemas/subject'
          type: array
        dates:
          allOf:
          - $ref: '#/components/schemas/dates'
          description: Instance Dates
        instanceTypeId:
          description: UUID of the unique term for the resource type whether it's from the RDA content term list of locally defined
          type: string
        instanceFormatIds:
          description: UUIDs for the unique terms for the format whether it's from the RDA carrier term list of locally defined
          items:
            type: string
          type: array
        languages:
          description: The set of languages used by the resource
          items:
            type: string
          type: array
        metadata:
          $ref: '#/components/schemas/metadata'
        administrativeNotes:
          description: Administrative notes
          items:
            type: string
          type: array
        modeOfIssuanceId:
          description: UUID of the RDA mode of issuance, a categorization reflecting whether a resource is issued in one or more parts, the way it is updated, and whether its termination is predetermined or not (e.g. monograph,  sequential monograph, serial; integrating Resource, other)
          type: string
        natureOfContentTermIds:
          description: Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)
          items:
            description: Single UUID for the Instance nature of content
            type: string
          type: array
        publication:
          description: List of publication items
          items:
            $ref: '#/components/schemas/publication'
          type: array
        staffSuppress:
          description: Records the fact that the record should not be displayed for others than catalogers
          type: boolean
        discoverySuppress:
          description: Records the fact that the record should not be displayed in a discovery system
          type: boolean
        isBoundWith:
          description: Indicates if this instance is included in a bound-with
          type: boolean
        tags:
          $ref: '#/components/schemas/tags'
        classifications:
          description: List of classifications
          items:
            $ref: '#/components/schemas/classification'
          type: array
        electronicAccess:
          description: List of electronic access items
          items:
            $ref: '#/components/schemas/electronicAccess'
          type: array
        notes:
          description: Bibliographic notes (e.g. general notes, specialized notes), and administrative notes
          items:
            $ref: '#/components/schemas/note'
          type: array
        items:
          description: List of instance items
          items:
            $ref: '#/components/schemas/item'
          type: array
        holdings:
          description: List of instance holding records
          items:
            $ref: '#/components/schemas/holding'
          type: array
      required:
      - electronicAccess
      - holdings
      - items
      - notes
      type: object
    contributor:
      additionalProperties: false
      description: A contributor description
      example:
        name: name
        contributorTypeId: contributorTypeId
        contributorTypeText: contributorTypeText
        contributorNameTypeId: contributorNameTypeId
        authorityId: authorityId
        primary: true
      properties:
        name:
          description: Personal name, corporate name, meeting name
          type: string
        contributorTypeId:
          description: ID for the contributor type term defined as a reference table in settings
          type: string
        contributorTypeText:
          description: Free text element for adding contributor type terms other than those defined by the MARC code list for relators
          type: string
        contributorNameTypeId:
          description: Contributor type terms defined by the MARC code list for relators
          type: string
        authorityId:
          description: ID of authority record that controls the contributor
          type: string
        primary:
          description: Whether this is the primary contributor
          type: boolean
      type: object
    linkedDataHub:
      description: Linked Data Hub search dto, contains Hub and Identifiers
      example:
        id: id
        originalId: originalId
        tenantId: tenantId
        label: label
      properties:
        id:
          description: The Linked Data ID of an Hub
          type: string
        originalId:
          description: Original RDF ID of an Hub
          type: string
        tenantId:
          description: Tenant ID
          type: string
        label:
          description: Label of the Hub
          type: string
      required:
      - id
      type: object
    linkedDataContributor:
      description: Linked data Contributor DTO, contains name, type and isCreator flag
      example:
        name: name
        type: Family
        isCreator: true
      properties:
        name:
          description: Name of contributor
          type: string
        type:
          enum:
          - Family
          - Jurisdiction
          - Meeting
          - Organization
          - Person
          type: string
        isCreator:
          description: A flag indicating whether the contributor is the creator
          type: boolean
      required:
      - isCreator
      - name
      - type
      type: object
    publication:
      example:
        publisher: publisher
        dateOfPublication: dateOfPublication
        place: place
      properties:
        publisher:
          description: Name of publisher, distributor, etc.
          type: string
        dateOfPublication:
          description: Date (year YYYY) of publication, distribution, etc.
          type: string
        place:
          description: Place of publication, distribution, etc.
          type: string
      type: object
    item_status:
      description: The status of the item
      example:
        name: name
      properties:
        name:
          description: Name of the status e.g. Available, Checked out, In transit
          type: string
      type: object
    instanceSearchResult:
      description: Instance search result response
      example:
        totalRecords: 0
        instances:
        - id: id
          tenantId: tenantId
          shared: true
          hrid: hrid
          source: source
          statisticalCodeIds:
          - statisticalCodeIds
          - statisticalCodeIds
          statusId: statusId
          title: title
          indexTitle: indexTitle
          series:
          - value: value
            authorityId: authorityId
          - value: value
            authorityId: authorityId
          alternativeTitles:
          - alternativeTitleTypeId: alternativeTitleTypeId
            alternativeTitle: alternativeTitle
            authorityId: authorityId
          - alternativeTitleTypeId: alternativeTitleTypeId
            alternativeTitle: alternativeTitle
            authorityId: authorityId
          identifiers:
          - value: value
            identifierTypeId: identifierTypeId
          - value: value
            identifierTypeId: identifierTypeId
          contributors:
          - name: name
            contributorTypeId: contributorTypeId
            contributorTypeText: contributorTypeText
            contributorNameTypeId: contributorNameTypeId
            authorityId: authorityId
            primary: true
          - name: name
            contributorTypeId: contributorTypeId
            contributorTypeText: contributorTypeText
            contributorNameTypeId: contributorNameTypeId
            authorityId: authorityId
            primary: true
          subjects:
          - value: value
            authorityId: authorityId
            sourceId: sourceId
            typeId: typeId
          - value: value
            authorityId: authorityId
            sourceId: sourceId
            typeId: typeId
          dates: '{}'
          instanceTypeId: instanceTypeId
          instanceFormatIds:
          - instanceFormatIds
          - instanceFormatIds
          languages:
          - languages
          - languages
          metadata:
            createdDate: createdDate
            createdByUserId: createdByUserId
            updatedDate: updatedDate
            updatedByUserId: updatedByUserId
          administrativeNotes:
          - administrativeNotes
          - administrativeNotes
          modeOfIssuanceId: modeOfIssuanceId
          natureOfContentTermIds:
          - natureOfContentTermIds
          - natureOfContentTermIds
          publication:
          - publisher: publisher
            dateOfPublication: dateOfPublication
            place: place
          - publisher: publisher
            dateOfPublication: dateOfPublication
            place: place
          staffSuppress: true
          discoverySuppress: true
          isBoundWith: true
          tags:
            tagList:
            - tagList
            - tagList
          classifications:
          - classificationNumber: classificationNumber
            classificationTypeId: classificationTypeId
          - classificationNumber: classificationNumber
            classificationTypeId: classificationTypeId
          electronicAccess:
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          notes:
          - note: note
            staffOnly: false
          - note: note
            staffOnly: false
          items:
          - id: id
            tenantId: tenantId
            holdingsRecordId: holdingsRecordId
            hrid: hrid
            accessionNumber: accessionNumber
            formerIds:
            - formerIds
            - formerIds
            itemIdentifier: itemIdentifier
            barcode: barcode
            effectiveLocationId: effectiveLocationId
            status:
              name: name
            materialTypeId: materialTypeId
            discoverySuppress: true
            effectiveCallNumberComponents:
              callNumber: callNumber
              prefix: prefix
              suffix: suffix
              typeId: typeId
            volume: volume
            enumeration: enumeration
            chronology: chronology
            copyNumber: copyNumber
            itemLevelCallNumberTypeId: itemLevelCallNumberTypeId
            tags:
              tagList:
              - tagList
              - tagList
            electronicAccess:
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            administrativeNotes:
            - administrativeNotes
            - administrativeNotes
            notes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            statisticalCodeIds:
            - statisticalCodeIds
            - statisticalCodeIds
            circulationNotes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            metadata:
              createdDate: createdDate
              createdByUserId: createdByUserId
              updatedDate: updatedDate
              updatedByUserId: updatedByUserId
          - id: id
            tenantId: tenantId
            holdingsRecordId: holdingsRecordId
            hrid: hrid
            accessionNumber: accessionNumber
            formerIds:
            - formerIds
            - formerIds
            itemIdentifier: itemIdentifier
            barcode: barcode
            effectiveLocationId: effectiveLocationId
            status:
              name: name
            materialTypeId: materialTypeId
            discoverySuppress: true
            effectiveCallNumberComponents:
              callNumber: callNumber
              prefix: prefix
              suffix: suffix
              typeId: typeId
            volume: volume
            enumeration: enumeration
            chronology: chronology
            copyNumber: copyNumber
            itemLevelCallNumberTypeId: itemLevelCallNumberTypeId
            tags:
              tagList:
              - tagList
              - tagList
            electronicAccess:
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            administrativeNotes:
            - administrativeNotes
            - administrativeNotes
            notes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            statisticalCodeIds:
            - statisticalCodeIds
            - statisticalCodeIds
            circulationNotes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            metadata:
              createdDate: createdDate
              createdByUserId: createdByUserId
              updatedDate: updatedDate
              updatedByUserId: updatedByUserId
          holdings:
          - id: id
            tenantId: tenantId
            permanentLocationId: permanentLocationId
            discoverySuppress: true
            hrid: hrid
            sourceId: sourceId
            formerIds:
            - formerIds
            - formerIds
            statisticalCodeIds:
            - statisticalCodeIds
            - statisticalCodeIds
            tags:
              tagList:
              - tagList
              - tagList
            holdingsTypeId: holdingsTypeId
            callNumberPrefix: callNumberPrefix
            callNumber: callNumber
            callNumberSuffix: callNumberSuffix
            copyNumber: copyNumber
            electronicAccess:
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            administrativeNotes:
            - administrativeNotes
            - administrativeNotes
            notes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            metadata:
              createdDate: createdDate
              createdByUserId: createdByUserId
              updatedDate: updatedDate
              updatedByUserId: updatedByUserId
          - id: id
            tenantId: tenantId
            permanentLocationId: permanentLocationId
            discoverySuppress: true
            hrid: hrid
            sourceId: sourceId
            formerIds:
            - formerIds
            - formerIds
            statisticalCodeIds:
            - statisticalCodeIds
            - statisticalCodeIds
            tags:
              tagList:
              - tagList
              - tagList
            holdingsTypeId: holdingsTypeId
            callNumberPrefix: callNumberPrefix
            callNumber: callNumber
            callNumberSuffix: callNumberSuffix
            copyNumber: copyNumber
            electronicAccess:
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            administrativeNotes:
            - administrativeNotes
            - administrativeNotes
            notes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            metadata:
              createdDate: createdDate
              createdByUserId: createdByUserId
              updatedDate: updatedDate
              updatedByUserId: updatedByUserId
        - id: id
          tenantId: tenantId
          shared: true
          hrid: hrid
          source: source
          statisticalCodeIds:
          - statisticalCodeIds
          - statisticalCodeIds
          statusId: statusId
          title: title
          indexTitle: indexTitle
          series:
          - value: value
            authorityId: authorityId
          - value: value
            authorityId: authorityId
          alternativeTitles:
          - alternativeTitleTypeId: alternativeTitleTypeId
            alternativeTitle: alternativeTitle
            authorityId: authorityId
          - alternativeTitleTypeId: alternativeTitleTypeId
            alternativeTitle: alternativeTitle
            authorityId: authorityId
          identifiers:
          - value: value
            identifierTypeId: identifierTypeId
          - value: value
            identifierTypeId: identifierTypeId
          contributors:
          - name: name
            contributorTypeId: contributorTypeId
            contributorTypeText: contributorTypeText
            contributorNameTypeId: contributorNameTypeId
            authorityId: authorityId
            primary: true
          - name: name
            contributorTypeId: contributorTypeId
            contributorTypeText: contributorTypeText
            contributorNameTypeId: contributorNameTypeId
            authorityId: authorityId
            primary: true
          subjects:
          - value: value
            authorityId: authorityId
            sourceId: sourceId
            typeId: typeId
          - value: value
            authorityId: authorityId
            sourceId: sourceId
            typeId: typeId
          dates: '{}'
          instanceTypeId: instanceTypeId
          instanceFormatIds:
          - instanceFormatIds
          - instanceFormatIds
          languages:
          - languages
          - languages
          metadata:
            createdDate: createdDate
            createdByUserId: createdByUserId
            updatedDate: updatedDate
            updatedByUserId: updatedByUserId
          administrativeNotes:
          - administrativeNotes
          - administrativeNotes
          modeOfIssuanceId: modeOfIssuanceId
          natureOfContentTermIds:
          - natureOfContentTermIds
          - natureOfContentTermIds
          publication:
          - publisher: publisher
            dateOfPublication: dateOfPublication
            place: place
          - publisher: publisher
            dateOfPublication: dateOfPublication
            place: place
          staffSuppress: true
          discoverySuppress: true
          isBoundWith: true
          tags:
            tagList:
            - tagList
            - tagList
          classifications:
          - classificationNumber: classificationNumber
            classificationTypeId: classificationTypeId
          - classificationNumber: classificationNumber
            classificationTypeId: classificationTypeId
          electronicAccess:
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          - uri: uri
            linkText: linkText
            materialsSpecification: materialsSpecification
            publicNote: publicNote
            relationshipId: relationshipId
          notes:
          - note: note
            staffOnly: false
          - note: note
            staffOnly: false
          items:
          - id: id
            tenantId: tenantId
            holdingsRecordId: holdingsRecordId
            hrid: hrid
            accessionNumber: accessionNumber
            formerIds:
            - formerIds
            - formerIds
            itemIdentifier: itemIdentifier
            barcode: barcode
            effectiveLocationId: effectiveLocationId
            status:
              name: name
            materialTypeId: materialTypeId
            discoverySuppress: true
            effectiveCallNumberComponents:
              callNumber: callNumber
              prefix: prefix
              suffix: suffix
              typeId: typeId
            volume: volume
            enumeration: enumeration
            chronology: chronology
            copyNumber: copyNumber
            itemLevelCallNumberTypeId: itemLevelCallNumberTypeId
            tags:
              tagList:
              - tagList
              - tagList
            electronicAccess:
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            administrativeNotes:
            - administrativeNotes
            - administrativeNotes
            notes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            statisticalCodeIds:
            - statisticalCodeIds
            - statisticalCodeIds
            circulationNotes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            metadata:
              createdDate: createdDate
              createdByUserId: createdByUserId
              updatedDate: updatedDate
              updatedByUserId: updatedByUserId
          - id: id
            tenantId: tenantId
            holdingsRecordId: holdingsRecordId
            hrid: hrid
            accessionNumber: accessionNumber
            formerIds:
            - formerIds
            - formerIds
            itemIdentifier: itemIdentifier
            barcode: barcode
            effectiveLocationId: effectiveLocationId
            status:
              name: name
            materialTypeId: materialTypeId
            discoverySuppress: true
            effectiveCallNumberComponents:
              callNumber: callNumber
              prefix: prefix
              suffix: suffix
              typeId: typeId
            volume: volume
            enumeration: enumeration
            chronology: chronology
            copyNumber: copyNumber
            itemLevelCallNumberTypeId: itemLevelCallNumberTypeId
            tags:
              tagList:
              - tagList
              - tagList
            electronicAccess:
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            administrativeNotes:
            - administrativeNotes
            - administrativeNotes
            notes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            statisticalCodeIds:
            - statisticalCodeIds
            - statisticalCodeIds
            circulationNotes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            metadata:
              createdDate: createdDate
              createdByUserId: createdByUserId
              updatedDate: updatedDate
              updatedByUserId: updatedByUserId
          holdings:
          - id: id
            tenantId: tenantId
            permanentLocationId: permanentLocationId
            discoverySuppress: true
            hrid: hrid
            sourceId: sourceId
            formerIds:
            - formerIds
            - formerIds
            statisticalCodeIds:
            - statisticalCodeIds
            - statisticalCodeIds
            tags:
              tagList:
              - tagList
              - tagList
            holdingsTypeId: holdingsTypeId
            callNumberPrefix: callNumberPrefix
            callNumber: callNumber
            callNumberSuffix: callNumberSuffix
            copyNumber: copyNumber
            electronicAccess:
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            administrativeNotes:
            - administrativeNotes
            - administrativeNotes
            notes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            metadata:
              createdDate: createdDate
              createdByUserId: createdByUserId
              updatedDate: updatedDate
              updatedByUserId: updatedByUserId
          - id: id
            tenantId: tenantId
            permanentLocationId: permanentLocationId
            discoverySuppress: true
            hrid: hrid
            sourceId: sourceId
            formerIds:
            - formerIds
            - formerIds
            statisticalCodeIds:
            - statisticalCodeIds
            - statisticalCodeIds
            tags:
              tagList:
              - tagList
              - tagList
            holdingsTypeId: holdingsTypeId
            callNumberPrefix: callNumberPrefix
            callNumber: callNumber
            callNumberSuffix: callNumberSuffix
            copyNumber: copyNumber
            electronicAccess:
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            - uri: uri
              linkText: linkText
              materialsSpecification: materialsSpecification
              publicNote: publicNote
              relationshipId: relationshipId
            administrativeNotes:
            - administrativeNotes
            - administrativeNotes
            notes:
            - note: note
              staffOnly: false
            - note: note
              staffOnly: false
            metadata:
              createdDate: createdDate
              createdByUserId: createdByUserId
              updatedDate: updatedDate
              updatedByUserId: updatedByUserId
      properties:
        totalRecords:
          description: Amount of instances found
          type: integer
        instances:
          description: List of instances found
          items:
            $ref: '#/components/schemas/instance'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
      type: object
    error:
      description: An error
      properties:
        message:
          description: Error message text
          type: string
        type:
          description: Error message type
          type: string
        code:
          description: Error message code
          type: string
        parameters:
          items:
            $ref: '#/components/schemas/parameter'
          type: array
      type: object
    linkedDataWork:
      allOf:
      - $ref: '#/components/schemas/linkedDataWorkOnly'
      - description: Linked Data Work search dto, contains Work and linked Instances
        properties:
          instances:
            description: Instance array
            items:
              $ref: '#/components/schemas/linkedDataInstanceOnly'
            type: array
        type: object
        example: null
      example:
        id: id
        tenantId: tenantId
        classifications:
        - type: ddc
          number: number
          additionalNumber: additionalNumber
        - type: ddc
          number: number
          additionalNumber: additionalNumber
        contributors:
        - name: name
          type: Family
          isCreator: true
        - name: name
          type: Family
          isCreator: true
        hubLabels:
        - hubLabels
        - hubLabels
        languages:
        - languages
        - languages
        notes:
        - value: value
          type: type
        - value: value
          type: type
        subjects:
        - subjects
        - subjects
        titles:
        - value: value
          type: Main
        - value: value
          type: Main
        instances:
        - id: id
          tenantId: tenantId
          contributors:
          - name: name
            type: Family
            isCreator: true
          - name: name
            type: Family
            isCreator: true
          editionStatements:
          - editionStatements
          - editionStatements
          format: format
          identifiers:
          - value: value
            type: type
          - value: value
            type: type
          notes:
          - value: value
            type: type
          - value: value
            type: type
          publications:
          - name: name
            date: date
          - name: name
            date: date
          suppress:
            fromDiscovery: true
            staff: true
          titles:
          - value: value
            type: Main
          - value: value
            type: Main
        - id: id
          tenantId: tenantId
          contributors:
          - name: name
            type: Family
            isCreator: true
          - name: name
            type: Family
            isCreator: true
          editionStatements:
          - editionStatements
          - editionStatements
          format: format
          identifiers:
          - value: value
            type: type
          - value: value
            type: type
          notes:
          - value: value
            type: type
          - value: value
            type: type
          publications:
          - name: name
            date: date
          - name: name
            date: date
          suppress:
            fromDiscovery: true
            staff: true
          titles:
          - value: value
            type: Main
          - value: value
            type: Main
      type: object
  examples:
    unknownError:
      value:
        errors:
        - message: Illegal argument error
          type: IllegalArgumentException
          code: unknown_error
        total_records: 1
    authoritySearchResult:
      value:
        totalRecords: 10
        authorities:
        - id: f866ae27-ec31-4eb4-8ade-89fe3d9625eb
          tenantId: diku
          shared: false
          headingType: Personal Name
          authRefType: Authorized
          headingRef: Kerouac, Jack
          numberOfTitles: 0
          sourceFileId: 'NULL'
          naturalId: aat32
        - id: d16bc790-fa2a-4bae-9563-9796bc7bef3c
          tenantId: diku
          shared: false
          headingType: Personal Name
          authRefType: Authorized
          headingRef: Roberts, Julia, 1967-
          numberOfTitles: 1
          sourceFileId: af045f2f-e851-4613-984c-4bc13430454a
          naturalId: n910740801
    linkedDataHubSearchResult:
      value:
        searchQuery: query string
        content:
        - id: '1'
          originalId: d292aac1-6f82-4828-93ae-c1b5cde1318a
          label: hub AAP
        pageNumber: 0
        totalPages: 3
        totalRecords: 27
    validationErrorResponse:
      value:
        errors:
        - message: must not be null
          type: MethodArgumentNotValidException
          code: validation_error
          parameters:
          - key: parameter
            value: 'null'
        total_records: 1
    instanceSearchResult:
      value:
        instances:
        - id: d20569a7-9bba-44dd-9ad5-6f8f1d24ee1f
          tenantId: tenant
          shared: false
          title: 'Bilingualism: a bibliography of 1000 references with special reference to Wales.'
          contributors:
          - name: Eichhorst, Georg.
            contributorTypeId: a
            authorityId: a
            primary: true
          publication:
          - publisher: Duncker und Humblot
            dateOfPublication: '1976'
            place: Karlsruhe
          staffSuppress: false
          discoverySuppress: false
          isBoundWith: false
          electronicAccess: []
          notes: []
          items: []
          holdings: []
        totalRecords: 1
    linkedDataAuthoritySearchResult:
      value:
        searchQuery: query string
        content:
        - id: '1'
          label: Authority Label
          identifiers:
          - value: '1234567890'
            type: LCCN
          types:
          - http://bibfra.me/vocab/lite/Family
        pageNumber: 0
        totalPages: 10
        totalRecords: 100
    linkedDataWorkSearchResult:
      value:
        searchQuery: query string
        content:
        - id: '1'
          titles:
          - value: Title Value
            type: Main
          contributors:
          - name: John Doe
            type: Person
            isCreator: true
          languages:
          - eng
          classifications:
          - type: ddc
            number: '1234'
            additionalNumber: '5678'
          subjects:
          - Subject
          instances:
          - id: '2'
            titles:
            - value: Title Value
              type: Main
            identifiers:
            - value: '1234567890'
              type: ISBN
            contributors:
            - name: John Doe
              type: Person
              isCreator: true
            publications:
            - name: Publisher Name
              date: '2022'
            editionStatements:
            - Edition 1
        pageNumber: 0
        totalPages: 10
        totalRecords: 100
x-refined-from:
- folio-mod-search-openapi.json
- folio-mod-search-openapi.yml