foliolib.folio.api.search.Search
- class foliolib.folio.api.search.Search(tenant: str)
Bases:
foliolib.folio.FolioApiSearch API
Search API
Base class of the Folio API
- Parameters
tenant (str) – Tenant id
Methods
browseauthorities(**kwargs)Provides list of authorities by headingRef
browseinstancesbycallnumber(**kwargs)Provides list of instances for browsing by call number
Provides list of instances for browsing by classification number
browseinstancesbycontributor(**kwargs)Provides list of instances for browsing by contributor
browseinstancesbysubject(**kwargs)Provides list of instances for browsing by subject
createindices(createIndexRequest)Creates indices for passed resource name and tenant id in request header.
getfacets(recordType, **kwargs)Provides list of facets for the record type
getholdingids(**kwargs)Get a list of holding ids linked to instances found by the CQL query
getidsjob(jobId)Get a job for the stream of resource ids.
getinstanceids(**kwargs)Get a list of instance ids for CQL query
getresourceids(jobId)Get a list of resource ids by job id
reindexinventoryrecords(reindexRequest)Initiates reindex for the inventory records
searchauthorities(**kwargs)Get a list of authorities for CQL query
searchinstances(**kwargs)Get a list of instances for CQL query
submitidsjob(resourceIdsJob)Creates a job for the stream of resource ids.
Update Index Dynamic Settings data.
updatemappings(updateMappingsRequest)Creates mappings for passed resource name and tenant id in request header.
- browseauthorities(**kwargs)
Provides list of authorities by headingRef
GET /browse/authorities- Keyword Arguments
query (str) – A CQL query string with search conditions.
limit (int) – Limit the number of elements returned in the response. (minimum: 0, maximum: 500, default: 100)
expandAll (bool) – Whether to return only basic properties or entire instance. (default: False)
highlightMatch (bool) – Whether to highlight matched resource by query input or not. (default: True)
precedingRecordsCount (int) – Number of preceding records for browsing around and around-including options (minimum: 1, maximum: 100)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Authority browse search response", "type": "object", "properties": { "totalRecords": { "type": "integer", "description": "Amount of items to display" }, "prev": { "type": "string", "description": "Previous value for browsing backward" }, "next": { "type": "string", "description": "Next value for browsing forward" }, "items": { "type": "array", "description": "List of authority browse items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Call-number browse search result item", "type": "object", "properties": { "authority": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "An authority description", "properties": { "id": { "type": "string", "description": "Authority UUID" }, "tenantId": { "description": "Tenant ID", "type": "string" }, "shared": { "description": "Indicate if it shared record", "type": "boolean" }, "source": { "type": "string", "description": "The metadata source and its format of the underlying record to the authority record" }, "personalName": { "type": "string", "description": "Heading personal name" }, "sftPersonalName": { "type": "array", "description": "See from tracing personal names", "items": { "type": "string", "description": "See from tracing personal name" } }, "saftPersonalName": { "type": "array", "description": "See also from tracing personal names", "items": { "type": "string", "description": "See also from tracing personal name" } }, "personalNameTitle": { "type": "string", "description": "Heading personal name title" }, "sftPersonalNameTitle": { "type": "array", "description": "See from tracing personal name title", "items": { "type": "string" } }, "saftPersonalNameTitle": { "type": "array", "description": "See also from tracing personal name title", "items": { "type": "string" } }, "corporateName": { "type": "string", "description": "Heading corporate name" }, "sftCorporateName": { "type": "array", "description": "See from tracing corporate names", "items": { "type": "string", "description": "See from tracing corporate name" } }, "saftCorporateName": { "type": "array", "description": "See also from tracing corporate names", "items": { "type": "string", "description": "See also from tracing corporate name" } }, "corporateNameTitle": { "type": "string", "description": "Heading corporate name title" }, "sftCorporateNameTitle": { "type": "array", "description": "See from tracing corporate name title", "items": { "type": "string" } }, "saftCorporateNameTitle": { "type": "array", "description": "See also from tracing corporate name title", "items": { "type": "string" } }, "meetingName": { "type": "string", "description": "Heading meeting name" }, "sftMeetingName": { "type": "array", "description": "See from tracing meeting names", "items": { "type": "string", "description": "See from tracing meeting name" } }, "saftMeetingName": { "type": "array", "description": "See also from tracing meeting names", "items": { "type": "string", "description": "See also from tracing meeting name" } }, "meetingNameTitle": { "type": "string", "description": "Heading meeting name title" }, "sftMeetingNameTitle": { "type": "array", "description": "See from tracing meeting name title", "items": { "type": "string" } }, "saftMeetingNameTitle": { "type": "array", "description": "See also from tracing meeting name title", "items": { "type": "string" } }, "uniformTitle": { "type": "string", "description": "Heading uniform title" }, "sftUniformTitle": { "type": "array", "description": "See from tracing uniform titles", "items": { "type": "string", "description": "See from tracing uniform title" } }, "saftUniformTitle": { "type": "array", "description": "See also from tracing uniform titles", "items": { "type": "string", "description": "See also from tracing uniform title" } }, "topicalTerm": { "type": "string", "description": "Heading topical term" }, "sftTopicalTerm": { "type": "array", "description": "See from tracing topical terms", "items": { "type": "string", "description": "See from tracing topical term" } }, "saftTopicalTerm": { "type": "array", "description": "See also from tracing topical terms", "items": { "type": "string", "description": "See also from tracing topical term" } }, "subjectHeadings": { "type": "string", "description": "Children's subject headings" }, "geographicName": { "type": "string", "description": "Heading geographic name" }, "sftGeographicName": { "type": "array", "description": "See from tracing geographic names", "items": { "type": "string", "description": "See from tracing geographic name" } }, "saftGeographicName": { "type": "array", "description": "See also from tracing geographic names", "items": { "type": "string", "description": "See also from tracing geographic name" } }, "genreTerm": { "type": "string", "description": "Heading genre/form term" }, "sftGenreTerm": { "type": "array", "description": "See from tracing genre/form terms", "items": { "type": "string", "description": "See from tracing genre/form term" } }, "saftGenreTerm": { "type": "array", "description": "See also from tracing genre/form terms", "items": { "type": "string", "description": "See also from tracing genre/form term" } }, "identifiers": { "type": "array", "description": "An extensible set of name-value pairs of identifiers associated with the resource", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Resource identifier", "properties": { "value": { "type": "string", "description": "Resource identifier value" }, "identifierTypeId": { "type": "string", "description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)" } } } }, "notes": { "type": "array", "description": "Notes (e.g. nonpublic general note)", "items": { "type": "object", "properties": { "noteTypeId": { "description": "ID of the type of note" }, "note": { "type": "string", "description": "Text content of the note" } } } }, "metadata": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Record metadata", "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" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } } }, "headingType": { "type": "string", "description": "Generated field by mod-search, used to easily identity the heading type of the record that provides authority information" }, "authRefType": { "type": "string", "description": "Generated field by mod-search, used to easily identity the authorized/reference type of the record that provides authority information" }, "headingRef": { "type": "string", "description": "Generated field by mod-search, used to easily identity the heading/reference of the record that provides authority information" }, "numberOfTitles": { "type": "integer", "description": "Generated field by mod-search, used to count the total number of bib records linked to this authority record" }, "sourceFileId": { "type": "string", "description": "Authority source file id; UUID" }, "naturalId": { "type": "string", "description": "Authority Natural ID" } } }, "headingRef": { "type": "string", "description": "The heading/reference of the record that provides authority information for authority browse item" }, "isAnchor": { "type": "boolean", "description": "Marks if current value is anchor or not" } } } } } }
- browseinstancesbycallnumber(**kwargs)
Provides list of instances for browsing by call number
GET /browse/call-numbers/instances- Keyword Arguments
query (str) – A CQL query string with search conditions.
limit (int) – Limit the number of elements returned in the browse response. (minimum: 0, maximum: 100, default: 100)
expandAll (bool) – Whether to return only basic properties or entire instance. (default: False)
highlightMatch (bool) – Whether to highlight matched resource by query input or not. (default: True)
precedingRecordsCount (int) – Number of preceding records for browsing around and around-including options (minimum: 1, maximum: 100)
callNumberType (str) – Type of call number (enum: [‘lc’, ‘dewey’, ‘nlm’, ‘sudoc’, ‘other’, ‘local’])
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Call number browse search response", "type": "object", "properties": { "totalRecords": { "type": "integer", "description": "Amount of items to display" }, "prev": { "type": "string", "description": "Previous value for browsing backward" }, "next": { "type": "string", "description": "Next value for browsing forward" }, "items": { "type": "array", "description": "List of call number browse items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Call-number browse search result item", "type": "object", "properties": { "fullCallNumber": { "type": "string", "description": "Full call number value to display" }, "shelfKey": { "type": "string", "description": "Shelf key value to be used for browsing" }, "isAnchor": { "type": "boolean", "description": "Marks if current value is anchor or not" }, "totalRecords": { "type": "integer", "description": "Amount of records for the call number value" }, "instance": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "instance description", "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": { "type": "string", "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID" }, "source": { "type": "string", "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)" }, "statisticalCodeIds": { "type": "array", "description": "List of statistical code IDs", "items": { "type": "string", "description": "UUID for a statistical code" } }, "statusId": { "type": "string", "description": "UUID for the Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)" }, "title": { "type": "string", "description": "The primary title (or label) associated with the resource" }, "indexTitle": { "type": "string", "description": "Title normalized for browsing and searching; based on the title with articles removed" }, "series": { "type": "array", "description": "List of series titles associated with the resource (e.g. Harry Potter)", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "A series item description", "properties": { "value": { "type": "string", "description": "Series title value" }, "authorityId": { "type": "string", "description": "UUID of authority record that controls an series title" } } } }, "alternativeTitles": { "type": "array", "description": "List of alternative titles for the resource (e.g. original language version title of a movie)", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "An alternative title description", "properties": { "alternativeTitleTypeId": { "type": "string", "description": "UUID for an alternative title qualifier" }, "alternativeTitle": { "type": "string", "description": "An alternative title for the resource" }, "authorityId": { "type": "string", "description": "UUID of authority record that controls an alternative title" } } } }, "identifiers": { "type": "array", "description": "Resource identifier value array", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Resource identifier", "properties": { "value": { "type": "string", "description": "Resource identifier value" }, "identifierTypeId": { "type": "string", "description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)" } } } }, "contributors": { "type": "array", "description": "List of contributors names", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "A contributor description", "properties": { "name": { "type": "string", "description": "Personal name, corporate name, meeting name" }, "contributorTypeId": { "type": "string", "description": "ID for the contributor type term defined as a reference table in settings" }, "contributorTypeText": { "type": "string", "description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators" }, "contributorNameTypeId": { "type": "string", "description": "Contributor type terms defined by the MARC code list for relators" }, "authorityId": { "type": "string", "description": "ID of authority record that controls the contributor" }, "primary": { "type": "boolean", "description": "Whether this is the primary contributor" } } } }, "subjects": { "type": "array", "description": "List of subject headings", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "A subject heading description", "properties": { "value": { "type": "string", "description": "Subject heading value" }, "authorityId": { "type": "string", "description": "UUID of authority record that controls a subject heading" } } } }, "instanceTypeId": { "type": "string", "description": "UUID of the unique term for the resource type whether it's from the RDA content term list of locally defined" }, "instanceFormatIds": { "type": "array", "description": "UUIDs for the unique terms for the format whether it's from the RDA carrier term list of locally defined", "items": { "type": "string" } }, "languages": { "type": "array", "description": "The set of languages used by the resource", "items": { "type": "string" } }, "metadata": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Record metadata", "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" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } } }, "administrativeNotes": { "type": "array", "description": "Administrative notes", "items": { "type": "string" } }, "modeOfIssuanceId": { "type": "string", "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)" }, "natureOfContentTermIds": { "type": "array", "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": { "type": "string", "description": "Single UUID for the Instance nature of content" } }, "publication": { "type": "array", "description": "List of publication items", "items": { "type": "object", "properties": { "publisher": { "type": "string", "description": "Name of publisher, distributor, etc." }, "dateOfPublication": { "type": "string", "description": "Date (year YYYY) of publication, distribution, etc." } } } }, "staffSuppress": { "type": "boolean", "description": "Records the fact that the record should not be displayed for others than catalogers" }, "discoverySuppress": { "type": "boolean", "description": "Records the fact that the record should not be displayed in a discovery system" }, "isBoundWith": { "description": "Indicates if this instance is included in a bound-with", "type": "boolean" }, "tags": { "$schema": "http://json-schema.org/draft-04/schema#", "id": "tags.schema", "title": "tags", "description": "List of simple tags that can be added to an object", "type": "object", "properties": { "tagList": { "description": "List of tags", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "classifications": { "type": "array", "description": "List of classifications", "items": { "type": "object", "properties": { "classificationNumber": { "type": "string", "description": "Classification (e.g. classification scheme, classification schedule)" }, "classificationTypeId": { "type": "string", "description": "Classification type ID" } } } }, "electronicAccess": { "type": "array", "description": "List of electronic access items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Electronic access object", "type": "object", "properties": { "uri": { "type": "string", "description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources" }, "linkText": { "type": "string", "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" }, "materialsSpecification": { "type": "string", "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)" }, "publicNote": { "type": "string", "description": "URL public note to be displayed in the discovery" } } } }, "notes": { "type": "array", "description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Bibliographic or administrative note for instance/item/holding", "type": "object", "properties": { "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean", "description": "If true, determines that the note should not be visible for others than staff", "default": false } } } }, "items": { "type": "array", "description": "List of instance items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Item description", "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the item record" }, "tenantId": { "description": "Tenant ID", "type": "string" }, "hrid": { "type": "string", "description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID" }, "accessionNumber": { "type": "string", "description": "Also called inventory number" }, "formerIds": { "type": "array", "description": "Previous identifiers assigned to the item", "items": { "type": "string" } }, "itemIdentifier": { "type": "string", "description": "Item identifier number, e.g. imported from the union catalogue (read only)." }, "barcode": { "type": "string", "description": "Unique inventory control number for physical resources, used largely for circulation purposes" }, "effectiveLocationId": { "type": "string", "description": "Read only current home location for the item." }, "status": { "description": "The status of the item", "type": "object", "properties": { "name": { "description": "Name of the status e.g. Available, Checked out, In transit", "type": "string" } } }, "materialTypeId": { "type": "string", "description": "Material type, term. Define what type of thing the item is." }, "discoverySuppress": { "type": "boolean", "description": "Records the fact that the record should not be displayed in a discovery system" }, "effectiveCallNumberComponents": { "type": "object", "description": "Elements of a full call number generated from the item or holding", "properties": { "callNumber": { "type": "string", "description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item." }, "prefix": { "type": "string", "description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item." }, "suffix": { "type": "string", "description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item." }, "typeId": { "type": "string", "description": "Effective Call Number Type Id is the call number type id of the item, if available, otherwise that of the holding." } } }, "effectiveShelvingOrder": { "type": "string", "description": "A system generated normalization of the call number that allows for call number sorting in reports and search results" }, "itemLevelCallNumberTypeId": { "type": "string", "description": "Call number type id" }, "tags": { "$schema": "http://json-schema.org/draft-04/schema#", "id": "tags.schema", "title": "tags", "description": "List of simple tags that can be added to an object", "type": "object", "properties": { "tagList": { "description": "List of tags", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "electronicAccess": { "type": "array", "description": "List of electronic access items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Electronic access object", "type": "object", "properties": { "uri": { "type": "string", "description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources" }, "linkText": { "type": "string", "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" }, "materialsSpecification": { "type": "string", "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)" }, "publicNote": { "type": "string", "description": "URL public note to be displayed in the discovery" } } } }, "administrativeNotes": { "type": "array", "description": "Administrative notes", "items": { "type": "string" } }, "notes": { "type": "array", "description": "Notes about action, copy, binding etc.", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Bibliographic or administrative note for instance/item/holding", "type": "object", "properties": { "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean", "description": "If true, determines that the note should not be visible for others than staff", "default": false } } } }, "statisticalCodeIds": { "type": "array", "description": "List of statistical code IDs", "items": { "type": "string", "description": "UUID for a statistical code" } }, "circulationNotes": { "type": "array", "description": "Notes to be displayed in circulation processes.", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Circulations note for item", "type": "object", "properties": { "note": { "type": "string", "description": "Text to display" }, "staffOnly": { "type": "boolean", "description": "Flag to restrict display of this note", "default": false } } } }, "metadata": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Record metadata", "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" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } } } }, "required": [ "notes" ] } }, "holdings": { "type": "array", "description": "List of instance holding records", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Holding description", "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the holding record" }, "tenantId": { "description": "Tenant ID", "type": "string" }, "permanentLocationId": { "type": "string", "description": "The permanent shelving location in which an item resides." }, "discoverySuppress": { "type": "boolean", "description": "Indicates that the record should not be displayed in a discovery system" }, "hrid": { "type": "string", "description": "the human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID" }, "sourceId": { "description": "(A reference to) the source of a holdings record", "type": "string" }, "formerIds": { "type": "array", "description": "Previous identifiers assigned to the holding", "items": { "type": "string" } }, "statisticalCodeIds": { "type": "array", "description": "List of statistical code IDs", "items": { "type": "string", "description": "UUID for a statistical code" } }, "tags": { "$schema": "http://json-schema.org/draft-04/schema#", "id": "tags.schema", "title": "tags", "description": "List of simple tags that can be added to an object", "type": "object", "properties": { "tagList": { "description": "List of tags", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "holdingsTypeId": { "type": "string", "description": "unique ID for the type of this holdings record, a UUID" }, "callNumberPrefix": { "type": "string", "description": "Prefix of the call number on the holding level." }, "callNumber": { "type": "string", "description": "Call Number is an identifier assigned to an item, usually printed on a label attached to the item." }, "callNumberSuffix": { "type": "string", "description": "Suffix of the call number on the holding level." }, "electronicAccess": { "type": "array", "description": "List of electronic access items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Electronic access object", "type": "object", "properties": { "uri": { "type": "string", "description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources" }, "linkText": { "type": "string", "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" }, "materialsSpecification": { "type": "string", "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)" }, "publicNote": { "type": "string", "description": "URL public note to be displayed in the discovery" } } } }, "administrativeNotes": { "type": "array", "description": "Administrative notes", "items": { "type": "string" } }, "notes": { "type": "array", "description": "Notes about action, copy, binding etc.", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Bibliographic or administrative note for instance/item/holding", "type": "object", "properties": { "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean", "description": "If true, determines that the note should not be visible for others than staff", "default": false } } } }, "metadata": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Record metadata", "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" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } } } }, "required": [ "electronicAccess", "notes" ] } } }, "required": [ "electronicAccess", "notes", "items", "holdings" ] } } } } } }
- browseinstancesbyclassificationnumber(browseOptionId, **kwargs)
Provides list of instances for browsing by classification number
GET /browse/classification-numbers/{browseOptionId}/instances- Parameters
browseOptionId (str) – Browse option type (enum: [‘all’, ‘lc’, ‘dewey’])
- Keyword Arguments
query (str) – A CQL query string with search conditions.
limit (int) – Limit the number of elements returned in the browse response. (minimum: 0, maximum: 100, default: 100)
expandAll (bool) – Whether to return only basic properties or entire instance. (default: False)
highlightMatch (bool) – Whether to highlight matched resource by query input or not. (default: True)
precedingRecordsCount (int) – Number of preceding records for browsing around and around-including options (minimum: 1, maximum: 100)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Classification number browse search response", "type": "object", "properties": { "totalRecords": { "type": "integer", "description": "Amount of items to display" }, "prev": { "type": "string", "description": "Previous value for browsing backward" }, "next": { "type": "string", "description": "Next value for browsing forward" }, "items": { "type": "array", "description": "List of classification number browse items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Classification number browse search result item", "type": "object", "properties": { "classificationNumber": { "type": "string", "description": "Classification number value to display" }, "classificationTypeId": { "type": "string", "description": "Classification type ID value" }, "isAnchor": { "type": "boolean", "description": "Marks if current value is anchor or not" }, "totalRecords": { "type": "integer", "description": "Amount of records for the classification number value" } } } } } }
- browseinstancesbycontributor(**kwargs)
Provides list of instances for browsing by contributor
GET /browse/contributors/instances- Keyword Arguments
query (str) – A CQL query string with search conditions.
limit (int) – Limit the number of elements returned in the response. (minimum: 0, maximum: 500, default: 100)
highlightMatch (bool) – Whether to highlight matched resource by query input or not. (default: True)
precedingRecordsCount (int) – Number of preceding records for browsing around and around-including options (minimum: 1, maximum: 100)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Instance contributor browse search response", "type": "object", "properties": { "totalRecords": { "type": "integer", "description": "Amount of items to display" }, "prev": { "type": "string", "description": "Previous value for browsing backward" }, "next": { "type": "string", "description": "Next value for browsing forward" }, "items": { "type": "array", "description": "List of instance contributor browse items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Instance contributor browse search result item", "type": "object", "properties": { "name": { "type": "string", "description": "Personal name, corporate name, meeting name" }, "contributorTypeId": { "type": "array", "description": "IDs for the contributor type term", "items": { "type": "string", "description": "ID for the contributor type term" } }, "contributorNameTypeId": { "type": "string", "description": "Contributor type terms defined by the MARC code list for relators" }, "authorityId": { "type": "string", "description": "ID of authority record that controls the contributor" }, "isAnchor": { "type": "boolean", "description": "Marks if current value is anchor or not" }, "totalRecords": { "type": "integer", "description": "Amount of records for the subject browse item" } } } } } }
- browseinstancesbysubject(**kwargs)
Provides list of instances for browsing by subject
GET /browse/subjects/instances- Keyword Arguments
query (str) – A CQL query string with search conditions.
limit (int) – Limit the number of elements returned in the response. (minimum: 0, maximum: 500, default: 100)
highlightMatch (bool) – Whether to highlight matched resource by query input or not. (default: True)
precedingRecordsCount (int) – Number of preceding records for browsing around and around-including options (minimum: 1, maximum: 100)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Subject browse search response", "type": "object", "properties": { "totalRecords": { "type": "integer", "description": "Amount of items to display" }, "prev": { "type": "string", "description": "Previous value for browsing backward" }, "next": { "type": "string", "description": "Next value for browsing forward" }, "items": { "type": "array", "description": "List of subject browse items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Subject browse search result item", "type": "object", "properties": { "value": { "type": "string", "description": "Subject value to be used for browsing" }, "isAnchor": { "type": "boolean", "description": "Marks if current value is anchor or not" }, "totalRecords": { "type": "integer", "description": "Amount of records for the subject browse item" }, "authorityId": { "type": "string", "description": "ID of authority record that controls the subject" } } } } } }
- createindices(createIndexRequest)
Creates indices for passed resource name and tenant id in request header.
POST /search/index/indices- Parameters
createIndexRequest (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Request body to create Elasticsearch index", "properties": { "resourceName": { "type": "string", "description": "Name of resource" } }, "additionalProperties": false, "required": [ "resourceName" ] }
{ "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Folio search create index response", "properties": { "errorMessage": { "type": "string", "description": "Error message with the reason why index was failed to create." }, "indices": { "type": "array", "description": "List of created elasticsearch indices.", "minItems": 0, "items": { "description": "Create index name", "type": "string" } }, "status": { "type": "string", "description": "Index creation status - success or error.", "enum": [ "success", "error" ] } }, "additionalProperties": false }
- getfacets(recordType, **kwargs)
Provides list of facets for the record type
GET /search/{recordType}/facets- Parameters
recordType (str) – (enum: [‘instances’, ‘authorities’, ‘contributors’, ‘subjects’])
- Keyword Arguments
query (str) – A CQL query string with search conditions.
facet (list) – List of facet names. (items: (type: string))
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Facet result response", "type": "object", "properties": { "facets": { "description": "Map with found facet items, key is the facet name, value - facet object with found values", "type": "object", "additionalProperties": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Result value for specific facet", "type": "object", "properties": { "values": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "JSON schema for facet items", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "description": "Facet item description", "properties": { "id": { "type": "string", "description": "Facet value" }, "totalRecords": { "type": "number", "description": "Amount of search results for that facet" } } } }, "totalRecords": { "type": "integer", "description": "Amount of facet items" } } } }, "totalRecords": { "type": "integer", "description": "Amount of facets found" } } }
- getholdingids(**kwargs)
Get a list of holding ids linked to instances found by the CQL query
GET /search/holdings/ids- Keyword Arguments
query (str) – A CQL query string with search conditions.
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
- getidsjob(jobId)
Get a job for the stream of resource ids.
GET /search/resources/jobs/{jobId}- Parameters
jobId (str) – UUID of the job to get
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Job for the stream of entity ids.", "properties": { "id": { "type": "string", "description": "Unique ID for the job record." }, "query": { "type": "string", "description": "CQL query for getting ids." }, "status": { "type": "string", "description": "Ids streaming status.", "enum": [ "IN_PROGRESS", "ERROR", "COMPLETED", "DEPRECATED" ] }, "entityType": { "type": "string", "description": "Type of entity for streaming ids.", "enum": [ "INSTANCE", "AUTHORITY", "HOLDINGS" ] }, "createdDate": { "description": "Date and time when the record was created.", "type": "string" } }, "additionalProperties": false, "required": [ "query", "entityType" ] }
- getinstanceids(**kwargs)
Get a list of instance ids for CQL query
GET /search/instances/ids- Keyword Arguments
query (str) – A CQL query string with search conditions.
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
- getresourceids(jobId)
Get a list of resource ids by job id
GET /search/resources/jobs/{jobId}/ids- Parameters
jobId (str) – UUID of the job to get
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
- reindexinventoryrecords(reindexRequest)
Initiates reindex for the inventory records
POST /search/index/inventory/reindex- Parameters
reindexRequest (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Reindex Request body", "type": "object", "properties": { "recreateIndex": { "type": "boolean", "default": false, "description": "Boolean parameter, if set to true - tenant index must be recreated before reindex operation" }, "resourceName": { "type": "string", "description": "Resource name to run reindex for", "default": "instance" }, "indexSettings": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Elasticsearch/Opensearch index settings", "type": "object", "properties": { "numberOfShards": { "type": "integer", "description": "The number of primary shards that an index should have.", "minimum": 1, "maximum": 100 }, "numberOfReplicas": { "type": "integer", "description": "The number of replicas each primary shard has.", "minimum": 1, "maximum": 100 }, "refreshInterval": { "type": "integer", "description": "How often to make new changes to the index visible to search (seconds). '-1' disables refresh.", "minimum": -1, "maximum": 3600 } } } } }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Get job by id response", "type": "object", "properties": { "id": { "description": "Job id", "type": "string" }, "jobStatus": { "description": "Overall job status", "type": "string" }, "submittedDate": { "description": "Timestamp when the job has been submitted", "type": "string" } } }
- searchauthorities(**kwargs)
Get a list of authorities for CQL query
GET /search/authorities- Keyword Arguments
query (str) – A CQL query string with search conditions.
limit (int) – Limit the number of elements returned in the response. (minimum: 0, maximum: 500, default: 100)
offset (int) – Skip over a number of elements by specifying an offset value for the query. (minimum: 0, maximum: 9999, default: 0)
expandAll (bool) – Whether to return only basic properties or entire instance. (default: False)
includeNumberOfTitles (bool) – Whether to perform a search for a number of linked instances. (default: True)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Authority search result response", "type": "object", "properties": { "totalRecords": { "type": "integer", "description": "Amount of authorities found" }, "authorities": { "type": "array", "description": "List of authorities found", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "An authority description", "properties": { "id": { "type": "string", "description": "Authority UUID" }, "tenantId": { "description": "Tenant ID", "type": "string" }, "shared": { "description": "Indicate if it shared record", "type": "boolean" }, "source": { "type": "string", "description": "The metadata source and its format of the underlying record to the authority record" }, "personalName": { "type": "string", "description": "Heading personal name" }, "sftPersonalName": { "type": "array", "description": "See from tracing personal names", "items": { "type": "string", "description": "See from tracing personal name" } }, "saftPersonalName": { "type": "array", "description": "See also from tracing personal names", "items": { "type": "string", "description": "See also from tracing personal name" } }, "personalNameTitle": { "type": "string", "description": "Heading personal name title" }, "sftPersonalNameTitle": { "type": "array", "description": "See from tracing personal name title", "items": { "type": "string" } }, "saftPersonalNameTitle": { "type": "array", "description": "See also from tracing personal name title", "items": { "type": "string" } }, "corporateName": { "type": "string", "description": "Heading corporate name" }, "sftCorporateName": { "type": "array", "description": "See from tracing corporate names", "items": { "type": "string", "description": "See from tracing corporate name" } }, "saftCorporateName": { "type": "array", "description": "See also from tracing corporate names", "items": { "type": "string", "description": "See also from tracing corporate name" } }, "corporateNameTitle": { "type": "string", "description": "Heading corporate name title" }, "sftCorporateNameTitle": { "type": "array", "description": "See from tracing corporate name title", "items": { "type": "string" } }, "saftCorporateNameTitle": { "type": "array", "description": "See also from tracing corporate name title", "items": { "type": "string" } }, "meetingName": { "type": "string", "description": "Heading meeting name" }, "sftMeetingName": { "type": "array", "description": "See from tracing meeting names", "items": { "type": "string", "description": "See from tracing meeting name" } }, "saftMeetingName": { "type": "array", "description": "See also from tracing meeting names", "items": { "type": "string", "description": "See also from tracing meeting name" } }, "meetingNameTitle": { "type": "string", "description": "Heading meeting name title" }, "sftMeetingNameTitle": { "type": "array", "description": "See from tracing meeting name title", "items": { "type": "string" } }, "saftMeetingNameTitle": { "type": "array", "description": "See also from tracing meeting name title", "items": { "type": "string" } }, "uniformTitle": { "type": "string", "description": "Heading uniform title" }, "sftUniformTitle": { "type": "array", "description": "See from tracing uniform titles", "items": { "type": "string", "description": "See from tracing uniform title" } }, "saftUniformTitle": { "type": "array", "description": "See also from tracing uniform titles", "items": { "type": "string", "description": "See also from tracing uniform title" } }, "topicalTerm": { "type": "string", "description": "Heading topical term" }, "sftTopicalTerm": { "type": "array", "description": "See from tracing topical terms", "items": { "type": "string", "description": "See from tracing topical term" } }, "saftTopicalTerm": { "type": "array", "description": "See also from tracing topical terms", "items": { "type": "string", "description": "See also from tracing topical term" } }, "subjectHeadings": { "type": "string", "description": "Children's subject headings" }, "geographicName": { "type": "string", "description": "Heading geographic name" }, "sftGeographicName": { "type": "array", "description": "See from tracing geographic names", "items": { "type": "string", "description": "See from tracing geographic name" } }, "saftGeographicName": { "type": "array", "description": "See also from tracing geographic names", "items": { "type": "string", "description": "See also from tracing geographic name" } }, "genreTerm": { "type": "string", "description": "Heading genre/form term" }, "sftGenreTerm": { "type": "array", "description": "See from tracing genre/form terms", "items": { "type": "string", "description": "See from tracing genre/form term" } }, "saftGenreTerm": { "type": "array", "description": "See also from tracing genre/form terms", "items": { "type": "string", "description": "See also from tracing genre/form term" } }, "identifiers": { "type": "array", "description": "An extensible set of name-value pairs of identifiers associated with the resource", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Resource identifier", "properties": { "value": { "type": "string", "description": "Resource identifier value" }, "identifierTypeId": { "type": "string", "description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)" } } } }, "notes": { "type": "array", "description": "Notes (e.g. nonpublic general note)", "items": { "type": "object", "properties": { "noteTypeId": { "description": "ID of the type of note" }, "note": { "type": "string", "description": "Text content of the note" } } } }, "metadata": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Record metadata", "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" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } } }, "headingType": { "type": "string", "description": "Generated field by mod-search, used to easily identity the heading type of the record that provides authority information" }, "authRefType": { "type": "string", "description": "Generated field by mod-search, used to easily identity the authorized/reference type of the record that provides authority information" }, "headingRef": { "type": "string", "description": "Generated field by mod-search, used to easily identity the heading/reference of the record that provides authority information" }, "numberOfTitles": { "type": "integer", "description": "Generated field by mod-search, used to count the total number of bib records linked to this authority record" }, "sourceFileId": { "type": "string", "description": "Authority source file id; UUID" }, "naturalId": { "type": "string", "description": "Authority Natural ID" } } } } } }
- searchinstances(**kwargs)
Get a list of instances for CQL query
GET /search/instances- Keyword Arguments
query (str) – A CQL query string with search conditions.
limit (int) – Limit the number of elements returned in the response. (minimum: 0, maximum: 500, default: 100)
offset (int) – Skip over a number of elements by specifying an offset value for the query. (minimum: 0, maximum: 9999, default: 0)
expandAll (bool) – Whether to return only basic properties or entire instance. (default: False)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Instance search result response", "type": "object", "properties": { "totalRecords": { "type": "integer", "description": "Amount of instances found" }, "instances": { "type": "array", "description": "List of instances found", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "instance description", "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": { "type": "string", "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID" }, "source": { "type": "string", "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)" }, "statisticalCodeIds": { "type": "array", "description": "List of statistical code IDs", "items": { "type": "string", "description": "UUID for a statistical code" } }, "statusId": { "type": "string", "description": "UUID for the Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)" }, "title": { "type": "string", "description": "The primary title (or label) associated with the resource" }, "indexTitle": { "type": "string", "description": "Title normalized for browsing and searching; based on the title with articles removed" }, "series": { "type": "array", "description": "List of series titles associated with the resource (e.g. Harry Potter)", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "A series item description", "properties": { "value": { "type": "string", "description": "Series title value" }, "authorityId": { "type": "string", "description": "UUID of authority record that controls an series title" } } } }, "alternativeTitles": { "type": "array", "description": "List of alternative titles for the resource (e.g. original language version title of a movie)", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "An alternative title description", "properties": { "alternativeTitleTypeId": { "type": "string", "description": "UUID for an alternative title qualifier" }, "alternativeTitle": { "type": "string", "description": "An alternative title for the resource" }, "authorityId": { "type": "string", "description": "UUID of authority record that controls an alternative title" } } } }, "identifiers": { "type": "array", "description": "Resource identifier value array", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Resource identifier", "properties": { "value": { "type": "string", "description": "Resource identifier value" }, "identifierTypeId": { "type": "string", "description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)" } } } }, "contributors": { "type": "array", "description": "List of contributors names", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "A contributor description", "properties": { "name": { "type": "string", "description": "Personal name, corporate name, meeting name" }, "contributorTypeId": { "type": "string", "description": "ID for the contributor type term defined as a reference table in settings" }, "contributorTypeText": { "type": "string", "description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators" }, "contributorNameTypeId": { "type": "string", "description": "Contributor type terms defined by the MARC code list for relators" }, "authorityId": { "type": "string", "description": "ID of authority record that controls the contributor" }, "primary": { "type": "boolean", "description": "Whether this is the primary contributor" } } } }, "subjects": { "type": "array", "description": "List of subject headings", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "A subject heading description", "properties": { "value": { "type": "string", "description": "Subject heading value" }, "authorityId": { "type": "string", "description": "UUID of authority record that controls a subject heading" } } } }, "instanceTypeId": { "type": "string", "description": "UUID of the unique term for the resource type whether it's from the RDA content term list of locally defined" }, "instanceFormatIds": { "type": "array", "description": "UUIDs for the unique terms for the format whether it's from the RDA carrier term list of locally defined", "items": { "type": "string" } }, "languages": { "type": "array", "description": "The set of languages used by the resource", "items": { "type": "string" } }, "metadata": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Record metadata", "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" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } } }, "administrativeNotes": { "type": "array", "description": "Administrative notes", "items": { "type": "string" } }, "modeOfIssuanceId": { "type": "string", "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)" }, "natureOfContentTermIds": { "type": "array", "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": { "type": "string", "description": "Single UUID for the Instance nature of content" } }, "publication": { "type": "array", "description": "List of publication items", "items": { "type": "object", "properties": { "publisher": { "type": "string", "description": "Name of publisher, distributor, etc." }, "dateOfPublication": { "type": "string", "description": "Date (year YYYY) of publication, distribution, etc." } } } }, "staffSuppress": { "type": "boolean", "description": "Records the fact that the record should not be displayed for others than catalogers" }, "discoverySuppress": { "type": "boolean", "description": "Records the fact that the record should not be displayed in a discovery system" }, "isBoundWith": { "description": "Indicates if this instance is included in a bound-with", "type": "boolean" }, "tags": { "$schema": "http://json-schema.org/draft-04/schema#", "id": "tags.schema", "title": "tags", "description": "List of simple tags that can be added to an object", "type": "object", "properties": { "tagList": { "description": "List of tags", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "classifications": { "type": "array", "description": "List of classifications", "items": { "type": "object", "properties": { "classificationNumber": { "type": "string", "description": "Classification (e.g. classification scheme, classification schedule)" }, "classificationTypeId": { "type": "string", "description": "Classification type ID" } } } }, "electronicAccess": { "type": "array", "description": "List of electronic access items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Electronic access object", "type": "object", "properties": { "uri": { "type": "string", "description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources" }, "linkText": { "type": "string", "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" }, "materialsSpecification": { "type": "string", "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)" }, "publicNote": { "type": "string", "description": "URL public note to be displayed in the discovery" } } } }, "notes": { "type": "array", "description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Bibliographic or administrative note for instance/item/holding", "type": "object", "properties": { "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean", "description": "If true, determines that the note should not be visible for others than staff", "default": false } } } }, "items": { "type": "array", "description": "List of instance items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Item description", "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the item record" }, "tenantId": { "description": "Tenant ID", "type": "string" }, "hrid": { "type": "string", "description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID" }, "accessionNumber": { "type": "string", "description": "Also called inventory number" }, "formerIds": { "type": "array", "description": "Previous identifiers assigned to the item", "items": { "type": "string" } }, "itemIdentifier": { "type": "string", "description": "Item identifier number, e.g. imported from the union catalogue (read only)." }, "barcode": { "type": "string", "description": "Unique inventory control number for physical resources, used largely for circulation purposes" }, "effectiveLocationId": { "type": "string", "description": "Read only current home location for the item." }, "status": { "description": "The status of the item", "type": "object", "properties": { "name": { "description": "Name of the status e.g. Available, Checked out, In transit", "type": "string" } } }, "materialTypeId": { "type": "string", "description": "Material type, term. Define what type of thing the item is." }, "discoverySuppress": { "type": "boolean", "description": "Records the fact that the record should not be displayed in a discovery system" }, "effectiveCallNumberComponents": { "type": "object", "description": "Elements of a full call number generated from the item or holding", "properties": { "callNumber": { "type": "string", "description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item." }, "prefix": { "type": "string", "description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item." }, "suffix": { "type": "string", "description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item." }, "typeId": { "type": "string", "description": "Effective Call Number Type Id is the call number type id of the item, if available, otherwise that of the holding." } } }, "effectiveShelvingOrder": { "type": "string", "description": "A system generated normalization of the call number that allows for call number sorting in reports and search results" }, "itemLevelCallNumberTypeId": { "type": "string", "description": "Call number type id" }, "tags": { "$schema": "http://json-schema.org/draft-04/schema#", "id": "tags.schema", "title": "tags", "description": "List of simple tags that can be added to an object", "type": "object", "properties": { "tagList": { "description": "List of tags", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "electronicAccess": { "type": "array", "description": "List of electronic access items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Electronic access object", "type": "object", "properties": { "uri": { "type": "string", "description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources" }, "linkText": { "type": "string", "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" }, "materialsSpecification": { "type": "string", "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)" }, "publicNote": { "type": "string", "description": "URL public note to be displayed in the discovery" } } } }, "administrativeNotes": { "type": "array", "description": "Administrative notes", "items": { "type": "string" } }, "notes": { "type": "array", "description": "Notes about action, copy, binding etc.", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Bibliographic or administrative note for instance/item/holding", "type": "object", "properties": { "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean", "description": "If true, determines that the note should not be visible for others than staff", "default": false } } } }, "statisticalCodeIds": { "type": "array", "description": "List of statistical code IDs", "items": { "type": "string", "description": "UUID for a statistical code" } }, "circulationNotes": { "type": "array", "description": "Notes to be displayed in circulation processes.", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Circulations note for item", "type": "object", "properties": { "note": { "type": "string", "description": "Text to display" }, "staffOnly": { "type": "boolean", "description": "Flag to restrict display of this note", "default": false } } } }, "metadata": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Record metadata", "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" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } } } }, "required": [ "notes" ] } }, "holdings": { "type": "array", "description": "List of instance holding records", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Holding description", "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the holding record" }, "tenantId": { "description": "Tenant ID", "type": "string" }, "permanentLocationId": { "type": "string", "description": "The permanent shelving location in which an item resides." }, "discoverySuppress": { "type": "boolean", "description": "Indicates that the record should not be displayed in a discovery system" }, "hrid": { "type": "string", "description": "the human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID" }, "sourceId": { "description": "(A reference to) the source of a holdings record", "type": "string" }, "formerIds": { "type": "array", "description": "Previous identifiers assigned to the holding", "items": { "type": "string" } }, "statisticalCodeIds": { "type": "array", "description": "List of statistical code IDs", "items": { "type": "string", "description": "UUID for a statistical code" } }, "tags": { "$schema": "http://json-schema.org/draft-04/schema#", "id": "tags.schema", "title": "tags", "description": "List of simple tags that can be added to an object", "type": "object", "properties": { "tagList": { "description": "List of tags", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "holdingsTypeId": { "type": "string", "description": "unique ID for the type of this holdings record, a UUID" }, "callNumberPrefix": { "type": "string", "description": "Prefix of the call number on the holding level." }, "callNumber": { "type": "string", "description": "Call Number is an identifier assigned to an item, usually printed on a label attached to the item." }, "callNumberSuffix": { "type": "string", "description": "Suffix of the call number on the holding level." }, "electronicAccess": { "type": "array", "description": "List of electronic access items", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Electronic access object", "type": "object", "properties": { "uri": { "type": "string", "description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources" }, "linkText": { "type": "string", "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" }, "materialsSpecification": { "type": "string", "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)" }, "publicNote": { "type": "string", "description": "URL public note to be displayed in the discovery" } } } }, "administrativeNotes": { "type": "array", "description": "Administrative notes", "items": { "type": "string" } }, "notes": { "type": "array", "description": "Notes about action, copy, binding etc.", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Bibliographic or administrative note for instance/item/holding", "type": "object", "properties": { "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean", "description": "If true, determines that the note should not be visible for others than staff", "default": false } } } }, "metadata": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Record metadata", "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" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } } } }, "required": [ "electronicAccess", "notes" ] } } }, "required": [ "electronicAccess", "notes", "items", "holdings" ] } } } }
- submitidsjob(resourceIdsJob)
Creates a job for the stream of resource ids.
POST /search/resources/jobs- Parameters
resourceIdsJob (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Job for the stream of entity ids.", "properties": { "id": { "type": "string", "description": "Unique ID for the job record." }, "query": { "type": "string", "description": "CQL query for getting ids." }, "status": { "type": "string", "description": "Ids streaming status.", "enum": [ "IN_PROGRESS", "ERROR", "COMPLETED", "DEPRECATED" ] }, "entityType": { "type": "string", "description": "Type of entity for streaming ids.", "enum": [ "INSTANCE", "AUTHORITY", "HOLDINGS" ] }, "createdDate": { "description": "Date and time when the record was created.", "type": "string" } }, "additionalProperties": false, "required": [ "query", "entityType" ] }
- updateindexdynamicsettings(updateIndexDynamicSettingsRequest)
Update Index Dynamic Settings data.
PUT /search/index/settings- Parameters
updateIndexDynamicSettingsRequest (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Update Index Settings request body", "type": "object", "properties": { "resourceName": { "type": "string", "description": "Resource name to set index Settings" }, "indexSettings": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Elasticsearch/Opensearch index dynamic settings", "type": "object", "properties": { "numberOfReplicas": { "type": "integer", "description": "The number of replicas each primary shard has.", "minimum": 1, "maximum": 100 }, "refreshInterval": { "type": "integer", "description": "How often to make new changes to the index visible to search (seconds). '-1' disables refresh.", "minimum": -1, "maximum": 3600 } } } }, "required": [ "resourceName" ] }
{ "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Folio search create index response", "properties": { "errorMessage": { "type": "string", "description": "Error message with the reason why index was failed to create." }, "status": { "type": "string", "description": "Index creation status - success or error.", "enum": [ "success", "error" ] } }, "additionalProperties": false }
- updatemappings(updateMappingsRequest)
Creates mappings for passed resource name and tenant id in request header.
POST /search/index/mappings- Parameters
updateMappingsRequest (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – When unhandled exception occurred during code execution, e.g. NullPointerException
Schema
{ "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Request to create resource mappings in Elasticsearch", "properties": { "resourceName": { "type": "string", "description": "Name of resource" } }, "additionalProperties": false, "required": [ "resourceName" ] }
{ "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Folio search create index response", "properties": { "errorMessage": { "type": "string", "description": "Error message with the reason why index was failed to create." }, "status": { "type": "string", "description": "Index creation status - success or error.", "enum": [ "success", "error" ] } }, "additionalProperties": false }