curl -X GET \
-H "Accept: application/json" \
"https://folio-dev-spitfire-okapi.ci.folio.org/search/instances?query=query_example&limit=56&offset=56&expandAll=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchApi;
import java.io.File;
import java.util.*;
public class SearchApiExample {
public static void main(String[] args) {
// Create an instance of the API class
SearchApi apiInstance = new SearchApi();
String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
String query = query_example; // String | A CQL query string
Instance search options
Option |
Type |
Example |
Description |
keyword |
full-text |
keyword all "web semantic" |
An alias for: title, alternativeTitles, indexTitle, series, identifiers.value, contributors.name |
id |
term |
id=="1234567" |
Matches instance with the id |
hrid |
term |
hrid=="hr1*0" |
Matches instances with given HRID |
source |
term |
source=="MARC" |
Matches instances with given source (FOLIO/MARC) |
title |
full-text |
title all "semantic web" |
Matches instances with the given title, searches against title, alternativeTitles,
indexTitle, series fields
|
alternativeTitles.alternativeTitle |
full-text |
alternativeTitles.alternativeTitle all "semantic web" |
Matches instances with the given alternative title |
uniformTitle |
full-text |
uniformTitle all "semantic web" |
Matches instances with the given uniform title |
indexTitle |
full-text |
indexTitle all "semantic web" |
Matches instances with the given index title |
series |
full-text |
series all "series" |
Matches instance with given series value |
identifiers.value |
term |
identifiers.value = "1023*" |
Matches instances with the given identifier value |
identifiers.identifierTypeId |
term |
identifiers.identifierTypeId=="123" identifiers.value = "1023*"
|
Matches instances that have an identifier of type 123 and ANY
identifier with value 1023*
|
contributors |
full-text |
contributors all "John" |
Matches instances that have a John contributor |
contributors.name |
term |
contributors.name all "John" |
Matches instances that have a primary John contributor |
contributors.contributorTypeId |
term |
contributors.contributorTypeId all "1234567" |
Matches instances that have a contributor type Id 1234567 |
contributors.contributorNameTypeId |
term |
contributors.contributorNameTypeId all "1234567" |
Matches instances that have a contributor name type Id 1234567 |
contributors.primary |
term |
contributors all "John" and contributors.primary==true |
Matches instances that have a primary John contributor |
contributors.authorityId |
term |
contributors.authorityId ==
"81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
authorityId |
term |
authorityId == "81ae0f60-f2bc-450c-84c8-5a21096daed9" |
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
subjects |
full-text |
subjects all "Chemistry" |
Matches instances that have a Chemistry subject |
instanceTypeId |
term |
instanceTypeId == "123" |
Matches instances with the 123 type |
statusId |
term |
statusId == "123" |
Matches instances with the 123 status |
instanceFormatIds |
term |
instanceFormatIds == "123" |
Matches instances with the 123 format id |
languages |
term |
languages == "eng" |
Matches instances that have eng language |
metadata.createdDate |
term |
metadata.createdDate > "2021-03-01T00:00:00.000+00:00"
|
Matches instances that were created after 2020-12-12 |
metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances that were updated after 2020-12-12 |
modeOfIssuanceId |
term |
modeOfIssuanceId=="123" |
Matches instances that have 123 mode of issuance |
natureOfContentTermIds |
term |
natureOfContentTermIds=="123" |
Matches instances that have 123 nature of content |
publisher |
full-text |
publisher all "Publisher of Ukraine" |
Matches instances that have Publisher of Ukraine publisher |
publication.place |
full-text |
publication.place all "Ukraine" |
Matches instances that have `Ukraine` in publication place |
instanceTags |
term |
instanceTags=="important" |
Matches instances that have important tag |
classifications.classificationNumber |
term |
classifications.classificationNumber=="cl1" |
Matches instances that have cl1 classification number |
classifications.classificationTypeId |
term |
classifications.classificationTypeId == "123" |
Matches instances that have classification type id 123 |
electronicAccess |
full-text |
electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
electronicAccess.uri |
term |
electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
electronicAccess.linkText |
full-text |
electronicAccess.linkText="Folio website" |
Search by electronic access link text |
electronicAccess.publicNote |
full-text |
electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
electronicAccess.relationshipId |
term |
electronicAccess.relationshipId="47d563ed-1ae2-41dc-97f8-8ebefce904f0" |
Search by electronic access relationship type ID |
staffSuppress |
term |
staffSuppress==true |
Matches instances that are staff suppressed |
discoverySuppress |
term |
discoverySuppress==true |
Matches instances that are suppressed from discovery |
publicNotes |
full-text |
publicNotes all "public note" |
Matches instances that have a public note (i.e. note.staffOnly is
false)
|
administrativeNotes |
full-text |
administrativeNotes all "librarian note" |
Search by administrative notes |
notes.note |
full-text |
notes.note all "librarian note" |
Search by instance notes (include staffOnly) |
isbn |
term |
isbn="1234*" |
Matches instances that have an ISBN identifier with the given value |
issn |
term |
issn="1234*" |
Matches instances that have an ISSN identifier with the given value |
oclc |
term |
oclc="1234*" |
Matches instances that have an OCLC identifier with the given value |
lccn |
term |
lccn = "LCCN" |
Matches instances with the given lccn |
normalizedClassificationNumber |
term |
normalizedClassificationNumber == "LCCN" |
Matches instances with the given classification number (normalizes case,
whitespaces, special characters, supports leading and trailing wildcard)
|
normalizedDate1 |
term |
normalizedDate1>=1990 |
Matches instances with the given Date1 (normalizes alpha u characters) |
classificationId |
term |
classificationId = "c4f60d7413158e9466856f4c0250d91d312f86cf" |
Matches instances with the given classificationId |
Holdings search options
Option |
Type |
Example |
Description |
holdings.id |
term |
holdings.id=="1234567" |
Matches instances that have a holding with the id |
holdings.sourceId |
term |
holdings.sourceId=="FOLIO" |
Matches instances that have a holding with the source FOLIO |
holdings.holdingsTypeId |
term |
holdings.holdingsTypeId=="1234567" |
Matches instances that have a holding with the holdings type id 1234567
|
holdings.permanentLocationId |
term |
holdings.permanentLocationId=="123765" |
Matches instances that have holdings with given statisticalCodeId |
holdings.statisticalCodeIds |
term |
holdings.statisticalCodeIds=="123765" |
Matches instances that have holdings with given permanentLocationId |
holdings.discoverySuppress |
term |
holdings.discoverySuppress==true |
Matches instances that have holdings suppressed/not suppressed from discovery |
holdings.hrid |
term |
holdings.hrid=="hr10*3" |
Matches instances that have a holding with given HRID |
holdingsTags |
term |
holdingsTags=="important" |
Matches instances that have holdings with given tags |
holdingsFullCallNumbers |
term |
holdingsFullCallNumbers="cn*434" |
Matches instances that have holdings with given call number string (prefix + call
number + suffix)
|
holdingsNormalizedCallNumbers |
term |
holdingsNormalizedCallNumbers="cn434" |
Matches instances that have holdings with given call number and might not be
formatted correctly
|
holdings.electronicAccess |
full-text |
holdings.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
holdings.electronicAccess.uri |
term |
holdings.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
holdings.electronicAccess.linkText |
full-text |
holdings.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
holdings.electronicAccess.publicNote |
full-text |
holdings.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
holdings.electronicAccess.relationshipId |
term |
holdings.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by holdings electronic access relationship type ID |
holdings.administrativeNotes |
full-text |
holdings.administrativeNotes all "librarian note" |
Search by holdings administrative notes |
holdings.notes.note |
full-text |
holdings.notes.note all "librarian note" |
Search by holdings notes |
holdingsTypeId |
term |
holdingsTypeId=="123" |
Search by holdings type id |
holdingsPublicNotes |
full-text |
holdingsPublicNotes all "public note" |
Search by holdings public notes |
holdingsIdentifiers |
term |
holdingsIdentifiers == "ho00000000006" |
Search by holdings Identifiers: holdings.id, holdings.hrid,
holdings.formerIds
|
holdings.metadata.createdDate |
term |
metadata.createdDate > "2020-12-12" |
Matches instances with holdings that were created after 2020-12-12 |
holdings.metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances with holdings that were updated after 2020-12-12 |
Item search options
Option |
Type |
Example |
Description |
item.id |
term |
item.id=="1234567" |
Matches instances that have an item with the id |
item.hrid |
term |
item.hrid=="it001" |
Matches instances that have an item with the HRID |
item.barcode |
term |
item.barcode=="10011" |
Matches instances that have an item with the barcode |
item.effectiveLocationId |
term |
item.effectiveLocationId=="1212" |
Matches instances that have item with the effective location |
item.statisticalCodeIds |
term |
item.statisticalCodeIds=="1212" |
Matches instances that have item with the statistical code Id |
item.status.name |
term |
item.status.name=="Available" |
Matches instances that have item with given status |
item.materialTypeId |
term |
item.materialTypeId="23434" |
Matches instances that have item with given material type |
item.discoverySuppress |
term |
item.discoverySuppress=true |
Matches instances that have item suppressed/not suppressed from discovery |
itemFullCallNumbers |
term |
itemFullCallNumbers="cn*434" |
Matches instances that have item with given call number string (prefix + call number
+ suffix)
|
itemNormalizedCallNumbers |
term |
itemNormalizedCallNumbers="cn434" |
Matches instances that have item with given call number and might not be formatted
correctly
|
itemLevelCallNumberTypeId |
term |
itemLevelCallNumberTypeId="81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have item with given call number type id |
itemTags |
term |
itemTags="important" |
Matches instances that have item with given tag |
item.electronicAccess |
full-text |
item.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
item.electronicAccess.uri |
term |
item.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
item.electronicAccess.linkText |
full-text |
item.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
item.electronicAccess.publicNote |
full-text |
item.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
item.electronicAccess.relationshipId |
term |
item.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by item electronic access relationship type ID |
item.administrativeNotes |
full-text |
item.administrativeNotes all "librarian note" |
Search by item administrative notes |
item.notes.note |
full-text |
item.notes.note all "librarian note" |
Search by item notes and circulation notes |
item.circulationNotes.note |
full-text |
item.circulationNotes.note all "circulation note" |
Search by item circulation notes |
itemPublicNotes |
full-text |
itemPublicNotes all "public note" |
Search by item public notes and circulation notes |
itemIdentifiers |
term |
itemIdentifiers all "81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Search by item Identifiers: item.id, item.hrid, item.formerIds,
item.accessionNumber, item.itemIdentifier
|
item.metadata.createdDate |
term |
item.metadata.createdDate > "2020-12-12" |
Matches instances with item that were created after 2020-12-12 |
item.metadata.updatedDate |
term |
item.metadata.updatedDate > "2020-12-12" |
Matches instances with item that were updated after 2020-12-12 |
callNumberType |
term |
callNumberType = "lc" |
Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local. |
Integer limit = 56; // Integer | Limit the number of elements returned in the response.
Integer offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query.
Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
try {
instanceSearchResult result = apiInstance.searchInstances(xOkapiTenant, query, limit, offset, expandAll);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SearchApi#searchInstances");
e.printStackTrace();
}
}
}
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String xOkapiTenant = new String(); // String | X-Okapi-Tenant header value
final String query = new String(); // String | A CQL query string
Instance search options
Option |
Type |
Example |
Description |
keyword |
full-text |
keyword all "web semantic" |
An alias for: title, alternativeTitles, indexTitle, series, identifiers.value, contributors.name |
id |
term |
id=="1234567" |
Matches instance with the id |
hrid |
term |
hrid=="hr1*0" |
Matches instances with given HRID |
source |
term |
source=="MARC" |
Matches instances with given source (FOLIO/MARC) |
title |
full-text |
title all "semantic web" |
Matches instances with the given title, searches against title, alternativeTitles,
indexTitle, series fields
|
alternativeTitles.alternativeTitle |
full-text |
alternativeTitles.alternativeTitle all "semantic web" |
Matches instances with the given alternative title |
uniformTitle |
full-text |
uniformTitle all "semantic web" |
Matches instances with the given uniform title |
indexTitle |
full-text |
indexTitle all "semantic web" |
Matches instances with the given index title |
series |
full-text |
series all "series" |
Matches instance with given series value |
identifiers.value |
term |
identifiers.value = "1023*" |
Matches instances with the given identifier value |
identifiers.identifierTypeId |
term |
identifiers.identifierTypeId=="123" identifiers.value = "1023*"
|
Matches instances that have an identifier of type 123 and ANY
identifier with value 1023*
|
contributors |
full-text |
contributors all "John" |
Matches instances that have a John contributor |
contributors.name |
term |
contributors.name all "John" |
Matches instances that have a primary John contributor |
contributors.contributorTypeId |
term |
contributors.contributorTypeId all "1234567" |
Matches instances that have a contributor type Id 1234567 |
contributors.contributorNameTypeId |
term |
contributors.contributorNameTypeId all "1234567" |
Matches instances that have a contributor name type Id 1234567 |
contributors.primary |
term |
contributors all "John" and contributors.primary==true |
Matches instances that have a primary John contributor |
contributors.authorityId |
term |
contributors.authorityId ==
"81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
authorityId |
term |
authorityId == "81ae0f60-f2bc-450c-84c8-5a21096daed9" |
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
subjects |
full-text |
subjects all "Chemistry" |
Matches instances that have a Chemistry subject |
instanceTypeId |
term |
instanceTypeId == "123" |
Matches instances with the 123 type |
statusId |
term |
statusId == "123" |
Matches instances with the 123 status |
instanceFormatIds |
term |
instanceFormatIds == "123" |
Matches instances with the 123 format id |
languages |
term |
languages == "eng" |
Matches instances that have eng language |
metadata.createdDate |
term |
metadata.createdDate > "2021-03-01T00:00:00.000+00:00"
|
Matches instances that were created after 2020-12-12 |
metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances that were updated after 2020-12-12 |
modeOfIssuanceId |
term |
modeOfIssuanceId=="123" |
Matches instances that have 123 mode of issuance |
natureOfContentTermIds |
term |
natureOfContentTermIds=="123" |
Matches instances that have 123 nature of content |
publisher |
full-text |
publisher all "Publisher of Ukraine" |
Matches instances that have Publisher of Ukraine publisher |
publication.place |
full-text |
publication.place all "Ukraine" |
Matches instances that have `Ukraine` in publication place |
instanceTags |
term |
instanceTags=="important" |
Matches instances that have important tag |
classifications.classificationNumber |
term |
classifications.classificationNumber=="cl1" |
Matches instances that have cl1 classification number |
classifications.classificationTypeId |
term |
classifications.classificationTypeId == "123" |
Matches instances that have classification type id 123 |
electronicAccess |
full-text |
electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
electronicAccess.uri |
term |
electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
electronicAccess.linkText |
full-text |
electronicAccess.linkText="Folio website" |
Search by electronic access link text |
electronicAccess.publicNote |
full-text |
electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
electronicAccess.relationshipId |
term |
electronicAccess.relationshipId="47d563ed-1ae2-41dc-97f8-8ebefce904f0" |
Search by electronic access relationship type ID |
staffSuppress |
term |
staffSuppress==true |
Matches instances that are staff suppressed |
discoverySuppress |
term |
discoverySuppress==true |
Matches instances that are suppressed from discovery |
publicNotes |
full-text |
publicNotes all "public note" |
Matches instances that have a public note (i.e. note.staffOnly is
false)
|
administrativeNotes |
full-text |
administrativeNotes all "librarian note" |
Search by administrative notes |
notes.note |
full-text |
notes.note all "librarian note" |
Search by instance notes (include staffOnly) |
isbn |
term |
isbn="1234*" |
Matches instances that have an ISBN identifier with the given value |
issn |
term |
issn="1234*" |
Matches instances that have an ISSN identifier with the given value |
oclc |
term |
oclc="1234*" |
Matches instances that have an OCLC identifier with the given value |
lccn |
term |
lccn = "LCCN" |
Matches instances with the given lccn |
normalizedClassificationNumber |
term |
normalizedClassificationNumber == "LCCN" |
Matches instances with the given classification number (normalizes case,
whitespaces, special characters, supports leading and trailing wildcard)
|
normalizedDate1 |
term |
normalizedDate1>=1990 |
Matches instances with the given Date1 (normalizes alpha u characters) |
classificationId |
term |
classificationId = "c4f60d7413158e9466856f4c0250d91d312f86cf" |
Matches instances with the given classificationId |
Holdings search options
Option |
Type |
Example |
Description |
holdings.id |
term |
holdings.id=="1234567" |
Matches instances that have a holding with the id |
holdings.sourceId |
term |
holdings.sourceId=="FOLIO" |
Matches instances that have a holding with the source FOLIO |
holdings.holdingsTypeId |
term |
holdings.holdingsTypeId=="1234567" |
Matches instances that have a holding with the holdings type id 1234567
|
holdings.permanentLocationId |
term |
holdings.permanentLocationId=="123765" |
Matches instances that have holdings with given statisticalCodeId |
holdings.statisticalCodeIds |
term |
holdings.statisticalCodeIds=="123765" |
Matches instances that have holdings with given permanentLocationId |
holdings.discoverySuppress |
term |
holdings.discoverySuppress==true |
Matches instances that have holdings suppressed/not suppressed from discovery |
holdings.hrid |
term |
holdings.hrid=="hr10*3" |
Matches instances that have a holding with given HRID |
holdingsTags |
term |
holdingsTags=="important" |
Matches instances that have holdings with given tags |
holdingsFullCallNumbers |
term |
holdingsFullCallNumbers="cn*434" |
Matches instances that have holdings with given call number string (prefix + call
number + suffix)
|
holdingsNormalizedCallNumbers |
term |
holdingsNormalizedCallNumbers="cn434" |
Matches instances that have holdings with given call number and might not be
formatted correctly
|
holdings.electronicAccess |
full-text |
holdings.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
holdings.electronicAccess.uri |
term |
holdings.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
holdings.electronicAccess.linkText |
full-text |
holdings.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
holdings.electronicAccess.publicNote |
full-text |
holdings.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
holdings.electronicAccess.relationshipId |
term |
holdings.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by holdings electronic access relationship type ID |
holdings.administrativeNotes |
full-text |
holdings.administrativeNotes all "librarian note" |
Search by holdings administrative notes |
holdings.notes.note |
full-text |
holdings.notes.note all "librarian note" |
Search by holdings notes |
holdingsTypeId |
term |
holdingsTypeId=="123" |
Search by holdings type id |
holdingsPublicNotes |
full-text |
holdingsPublicNotes all "public note" |
Search by holdings public notes |
holdingsIdentifiers |
term |
holdingsIdentifiers == "ho00000000006" |
Search by holdings Identifiers: holdings.id, holdings.hrid,
holdings.formerIds
|
holdings.metadata.createdDate |
term |
metadata.createdDate > "2020-12-12" |
Matches instances with holdings that were created after 2020-12-12 |
holdings.metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances with holdings that were updated after 2020-12-12 |
Item search options
Option |
Type |
Example |
Description |
item.id |
term |
item.id=="1234567" |
Matches instances that have an item with the id |
item.hrid |
term |
item.hrid=="it001" |
Matches instances that have an item with the HRID |
item.barcode |
term |
item.barcode=="10011" |
Matches instances that have an item with the barcode |
item.effectiveLocationId |
term |
item.effectiveLocationId=="1212" |
Matches instances that have item with the effective location |
item.statisticalCodeIds |
term |
item.statisticalCodeIds=="1212" |
Matches instances that have item with the statistical code Id |
item.status.name |
term |
item.status.name=="Available" |
Matches instances that have item with given status |
item.materialTypeId |
term |
item.materialTypeId="23434" |
Matches instances that have item with given material type |
item.discoverySuppress |
term |
item.discoverySuppress=true |
Matches instances that have item suppressed/not suppressed from discovery |
itemFullCallNumbers |
term |
itemFullCallNumbers="cn*434" |
Matches instances that have item with given call number string (prefix + call number
+ suffix)
|
itemNormalizedCallNumbers |
term |
itemNormalizedCallNumbers="cn434" |
Matches instances that have item with given call number and might not be formatted
correctly
|
itemLevelCallNumberTypeId |
term |
itemLevelCallNumberTypeId="81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have item with given call number type id |
itemTags |
term |
itemTags="important" |
Matches instances that have item with given tag |
item.electronicAccess |
full-text |
item.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
item.electronicAccess.uri |
term |
item.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
item.electronicAccess.linkText |
full-text |
item.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
item.electronicAccess.publicNote |
full-text |
item.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
item.electronicAccess.relationshipId |
term |
item.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by item electronic access relationship type ID |
item.administrativeNotes |
full-text |
item.administrativeNotes all "librarian note" |
Search by item administrative notes |
item.notes.note |
full-text |
item.notes.note all "librarian note" |
Search by item notes and circulation notes |
item.circulationNotes.note |
full-text |
item.circulationNotes.note all "circulation note" |
Search by item circulation notes |
itemPublicNotes |
full-text |
itemPublicNotes all "public note" |
Search by item public notes and circulation notes |
itemIdentifiers |
term |
itemIdentifiers all "81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Search by item Identifiers: item.id, item.hrid, item.formerIds,
item.accessionNumber, item.itemIdentifier
|
item.metadata.createdDate |
term |
item.metadata.createdDate > "2020-12-12" |
Matches instances with item that were created after 2020-12-12 |
item.metadata.updatedDate |
term |
item.metadata.updatedDate > "2020-12-12" |
Matches instances with item that were updated after 2020-12-12 |
callNumberType |
term |
callNumberType = "lc" |
Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local. |
final Integer limit = new Integer(); // Integer | Limit the number of elements returned in the response.
final Integer offset = new Integer(); // Integer | Skip over a number of elements by specifying an offset value for the query.
final Boolean expandAll = new Boolean(); // Boolean | Whether to return only basic properties or entire instance.
try {
final result = await api_instance.searchInstances(xOkapiTenant, query, limit, offset, expandAll);
print(result);
} catch (e) {
print('Exception when calling DefaultApi->searchInstances: $e\n');
}
import org.openapitools.client.api.SearchApi;
public class SearchApiExample {
public static void main(String[] args) {
SearchApi apiInstance = new SearchApi();
String xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
String query = query_example; // String | A CQL query string
Instance search options
Option |
Type |
Example |
Description |
keyword |
full-text |
keyword all "web semantic" |
An alias for: title, alternativeTitles, indexTitle, series, identifiers.value, contributors.name |
id |
term |
id=="1234567" |
Matches instance with the id |
hrid |
term |
hrid=="hr1*0" |
Matches instances with given HRID |
source |
term |
source=="MARC" |
Matches instances with given source (FOLIO/MARC) |
title |
full-text |
title all "semantic web" |
Matches instances with the given title, searches against title, alternativeTitles,
indexTitle, series fields
|
alternativeTitles.alternativeTitle |
full-text |
alternativeTitles.alternativeTitle all "semantic web" |
Matches instances with the given alternative title |
uniformTitle |
full-text |
uniformTitle all "semantic web" |
Matches instances with the given uniform title |
indexTitle |
full-text |
indexTitle all "semantic web" |
Matches instances with the given index title |
series |
full-text |
series all "series" |
Matches instance with given series value |
identifiers.value |
term |
identifiers.value = "1023*" |
Matches instances with the given identifier value |
identifiers.identifierTypeId |
term |
identifiers.identifierTypeId=="123" identifiers.value = "1023*"
|
Matches instances that have an identifier of type 123 and ANY
identifier with value 1023*
|
contributors |
full-text |
contributors all "John" |
Matches instances that have a John contributor |
contributors.name |
term |
contributors.name all "John" |
Matches instances that have a primary John contributor |
contributors.contributorTypeId |
term |
contributors.contributorTypeId all "1234567" |
Matches instances that have a contributor type Id 1234567 |
contributors.contributorNameTypeId |
term |
contributors.contributorNameTypeId all "1234567" |
Matches instances that have a contributor name type Id 1234567 |
contributors.primary |
term |
contributors all "John" and contributors.primary==true |
Matches instances that have a primary John contributor |
contributors.authorityId |
term |
contributors.authorityId ==
"81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
authorityId |
term |
authorityId == "81ae0f60-f2bc-450c-84c8-5a21096daed9" |
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
subjects |
full-text |
subjects all "Chemistry" |
Matches instances that have a Chemistry subject |
instanceTypeId |
term |
instanceTypeId == "123" |
Matches instances with the 123 type |
statusId |
term |
statusId == "123" |
Matches instances with the 123 status |
instanceFormatIds |
term |
instanceFormatIds == "123" |
Matches instances with the 123 format id |
languages |
term |
languages == "eng" |
Matches instances that have eng language |
metadata.createdDate |
term |
metadata.createdDate > "2021-03-01T00:00:00.000+00:00"
|
Matches instances that were created after 2020-12-12 |
metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances that were updated after 2020-12-12 |
modeOfIssuanceId |
term |
modeOfIssuanceId=="123" |
Matches instances that have 123 mode of issuance |
natureOfContentTermIds |
term |
natureOfContentTermIds=="123" |
Matches instances that have 123 nature of content |
publisher |
full-text |
publisher all "Publisher of Ukraine" |
Matches instances that have Publisher of Ukraine publisher |
publication.place |
full-text |
publication.place all "Ukraine" |
Matches instances that have `Ukraine` in publication place |
instanceTags |
term |
instanceTags=="important" |
Matches instances that have important tag |
classifications.classificationNumber |
term |
classifications.classificationNumber=="cl1" |
Matches instances that have cl1 classification number |
classifications.classificationTypeId |
term |
classifications.classificationTypeId == "123" |
Matches instances that have classification type id 123 |
electronicAccess |
full-text |
electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
electronicAccess.uri |
term |
electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
electronicAccess.linkText |
full-text |
electronicAccess.linkText="Folio website" |
Search by electronic access link text |
electronicAccess.publicNote |
full-text |
electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
electronicAccess.relationshipId |
term |
electronicAccess.relationshipId="47d563ed-1ae2-41dc-97f8-8ebefce904f0" |
Search by electronic access relationship type ID |
staffSuppress |
term |
staffSuppress==true |
Matches instances that are staff suppressed |
discoverySuppress |
term |
discoverySuppress==true |
Matches instances that are suppressed from discovery |
publicNotes |
full-text |
publicNotes all "public note" |
Matches instances that have a public note (i.e. note.staffOnly is
false)
|
administrativeNotes |
full-text |
administrativeNotes all "librarian note" |
Search by administrative notes |
notes.note |
full-text |
notes.note all "librarian note" |
Search by instance notes (include staffOnly) |
isbn |
term |
isbn="1234*" |
Matches instances that have an ISBN identifier with the given value |
issn |
term |
issn="1234*" |
Matches instances that have an ISSN identifier with the given value |
oclc |
term |
oclc="1234*" |
Matches instances that have an OCLC identifier with the given value |
lccn |
term |
lccn = "LCCN" |
Matches instances with the given lccn |
normalizedClassificationNumber |
term |
normalizedClassificationNumber == "LCCN" |
Matches instances with the given classification number (normalizes case,
whitespaces, special characters, supports leading and trailing wildcard)
|
normalizedDate1 |
term |
normalizedDate1>=1990 |
Matches instances with the given Date1 (normalizes alpha u characters) |
classificationId |
term |
classificationId = "c4f60d7413158e9466856f4c0250d91d312f86cf" |
Matches instances with the given classificationId |
Holdings search options
Option |
Type |
Example |
Description |
holdings.id |
term |
holdings.id=="1234567" |
Matches instances that have a holding with the id |
holdings.sourceId |
term |
holdings.sourceId=="FOLIO" |
Matches instances that have a holding with the source FOLIO |
holdings.holdingsTypeId |
term |
holdings.holdingsTypeId=="1234567" |
Matches instances that have a holding with the holdings type id 1234567
|
holdings.permanentLocationId |
term |
holdings.permanentLocationId=="123765" |
Matches instances that have holdings with given statisticalCodeId |
holdings.statisticalCodeIds |
term |
holdings.statisticalCodeIds=="123765" |
Matches instances that have holdings with given permanentLocationId |
holdings.discoverySuppress |
term |
holdings.discoverySuppress==true |
Matches instances that have holdings suppressed/not suppressed from discovery |
holdings.hrid |
term |
holdings.hrid=="hr10*3" |
Matches instances that have a holding with given HRID |
holdingsTags |
term |
holdingsTags=="important" |
Matches instances that have holdings with given tags |
holdingsFullCallNumbers |
term |
holdingsFullCallNumbers="cn*434" |
Matches instances that have holdings with given call number string (prefix + call
number + suffix)
|
holdingsNormalizedCallNumbers |
term |
holdingsNormalizedCallNumbers="cn434" |
Matches instances that have holdings with given call number and might not be
formatted correctly
|
holdings.electronicAccess |
full-text |
holdings.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
holdings.electronicAccess.uri |
term |
holdings.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
holdings.electronicAccess.linkText |
full-text |
holdings.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
holdings.electronicAccess.publicNote |
full-text |
holdings.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
holdings.electronicAccess.relationshipId |
term |
holdings.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by holdings electronic access relationship type ID |
holdings.administrativeNotes |
full-text |
holdings.administrativeNotes all "librarian note" |
Search by holdings administrative notes |
holdings.notes.note |
full-text |
holdings.notes.note all "librarian note" |
Search by holdings notes |
holdingsTypeId |
term |
holdingsTypeId=="123" |
Search by holdings type id |
holdingsPublicNotes |
full-text |
holdingsPublicNotes all "public note" |
Search by holdings public notes |
holdingsIdentifiers |
term |
holdingsIdentifiers == "ho00000000006" |
Search by holdings Identifiers: holdings.id, holdings.hrid,
holdings.formerIds
|
holdings.metadata.createdDate |
term |
metadata.createdDate > "2020-12-12" |
Matches instances with holdings that were created after 2020-12-12 |
holdings.metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances with holdings that were updated after 2020-12-12 |
Item search options
Option |
Type |
Example |
Description |
item.id |
term |
item.id=="1234567" |
Matches instances that have an item with the id |
item.hrid |
term |
item.hrid=="it001" |
Matches instances that have an item with the HRID |
item.barcode |
term |
item.barcode=="10011" |
Matches instances that have an item with the barcode |
item.effectiveLocationId |
term |
item.effectiveLocationId=="1212" |
Matches instances that have item with the effective location |
item.statisticalCodeIds |
term |
item.statisticalCodeIds=="1212" |
Matches instances that have item with the statistical code Id |
item.status.name |
term |
item.status.name=="Available" |
Matches instances that have item with given status |
item.materialTypeId |
term |
item.materialTypeId="23434" |
Matches instances that have item with given material type |
item.discoverySuppress |
term |
item.discoverySuppress=true |
Matches instances that have item suppressed/not suppressed from discovery |
itemFullCallNumbers |
term |
itemFullCallNumbers="cn*434" |
Matches instances that have item with given call number string (prefix + call number
+ suffix)
|
itemNormalizedCallNumbers |
term |
itemNormalizedCallNumbers="cn434" |
Matches instances that have item with given call number and might not be formatted
correctly
|
itemLevelCallNumberTypeId |
term |
itemLevelCallNumberTypeId="81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have item with given call number type id |
itemTags |
term |
itemTags="important" |
Matches instances that have item with given tag |
item.electronicAccess |
full-text |
item.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
item.electronicAccess.uri |
term |
item.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
item.electronicAccess.linkText |
full-text |
item.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
item.electronicAccess.publicNote |
full-text |
item.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
item.electronicAccess.relationshipId |
term |
item.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by item electronic access relationship type ID |
item.administrativeNotes |
full-text |
item.administrativeNotes all "librarian note" |
Search by item administrative notes |
item.notes.note |
full-text |
item.notes.note all "librarian note" |
Search by item notes and circulation notes |
item.circulationNotes.note |
full-text |
item.circulationNotes.note all "circulation note" |
Search by item circulation notes |
itemPublicNotes |
full-text |
itemPublicNotes all "public note" |
Search by item public notes and circulation notes |
itemIdentifiers |
term |
itemIdentifiers all "81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Search by item Identifiers: item.id, item.hrid, item.formerIds,
item.accessionNumber, item.itemIdentifier
|
item.metadata.createdDate |
term |
item.metadata.createdDate > "2020-12-12" |
Matches instances with item that were created after 2020-12-12 |
item.metadata.updatedDate |
term |
item.metadata.updatedDate > "2020-12-12" |
Matches instances with item that were updated after 2020-12-12 |
callNumberType |
term |
callNumberType = "lc" |
Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local. |
Integer limit = 56; // Integer | Limit the number of elements returned in the response.
Integer offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query.
Boolean expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
try {
instanceSearchResult result = apiInstance.searchInstances(xOkapiTenant, query, limit, offset, expandAll);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SearchApi#searchInstances");
e.printStackTrace();
}
}
}
// Create an instance of the API class
SearchApi *apiInstance = [[SearchApi alloc] init];
String *xOkapiTenant = xOkapiTenant_example; // X-Okapi-Tenant header value (default to null)
String *query = query_example; // A CQL query string
Instance search options
Option |
Type |
Example |
Description |
keyword |
full-text |
keyword all "web semantic" |
An alias for: title, alternativeTitles, indexTitle, series, identifiers.value, contributors.name |
id |
term |
id=="1234567" |
Matches instance with the id |
hrid |
term |
hrid=="hr1*0" |
Matches instances with given HRID |
source |
term |
source=="MARC" |
Matches instances with given source (FOLIO/MARC) |
title |
full-text |
title all "semantic web" |
Matches instances with the given title, searches against title, alternativeTitles,
indexTitle, series fields
|
alternativeTitles.alternativeTitle |
full-text |
alternativeTitles.alternativeTitle all "semantic web" |
Matches instances with the given alternative title |
uniformTitle |
full-text |
uniformTitle all "semantic web" |
Matches instances with the given uniform title |
indexTitle |
full-text |
indexTitle all "semantic web" |
Matches instances with the given index title |
series |
full-text |
series all "series" |
Matches instance with given series value |
identifiers.value |
term |
identifiers.value = "1023*" |
Matches instances with the given identifier value |
identifiers.identifierTypeId |
term |
identifiers.identifierTypeId=="123" identifiers.value = "1023*"
|
Matches instances that have an identifier of type 123 and ANY
identifier with value 1023*
|
contributors |
full-text |
contributors all "John" |
Matches instances that have a John contributor |
contributors.name |
term |
contributors.name all "John" |
Matches instances that have a primary John contributor |
contributors.contributorTypeId |
term |
contributors.contributorTypeId all "1234567" |
Matches instances that have a contributor type Id 1234567 |
contributors.contributorNameTypeId |
term |
contributors.contributorNameTypeId all "1234567" |
Matches instances that have a contributor name type Id 1234567 |
contributors.primary |
term |
contributors all "John" and contributors.primary==true |
Matches instances that have a primary John contributor |
contributors.authorityId |
term |
contributors.authorityId ==
"81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
authorityId |
term |
authorityId == "81ae0f60-f2bc-450c-84c8-5a21096daed9" |
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
subjects |
full-text |
subjects all "Chemistry" |
Matches instances that have a Chemistry subject |
instanceTypeId |
term |
instanceTypeId == "123" |
Matches instances with the 123 type |
statusId |
term |
statusId == "123" |
Matches instances with the 123 status |
instanceFormatIds |
term |
instanceFormatIds == "123" |
Matches instances with the 123 format id |
languages |
term |
languages == "eng" |
Matches instances that have eng language |
metadata.createdDate |
term |
metadata.createdDate > "2021-03-01T00:00:00.000+00:00"
|
Matches instances that were created after 2020-12-12 |
metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances that were updated after 2020-12-12 |
modeOfIssuanceId |
term |
modeOfIssuanceId=="123" |
Matches instances that have 123 mode of issuance |
natureOfContentTermIds |
term |
natureOfContentTermIds=="123" |
Matches instances that have 123 nature of content |
publisher |
full-text |
publisher all "Publisher of Ukraine" |
Matches instances that have Publisher of Ukraine publisher |
publication.place |
full-text |
publication.place all "Ukraine" |
Matches instances that have `Ukraine` in publication place |
instanceTags |
term |
instanceTags=="important" |
Matches instances that have important tag |
classifications.classificationNumber |
term |
classifications.classificationNumber=="cl1" |
Matches instances that have cl1 classification number |
classifications.classificationTypeId |
term |
classifications.classificationTypeId == "123" |
Matches instances that have classification type id 123 |
electronicAccess |
full-text |
electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
electronicAccess.uri |
term |
electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
electronicAccess.linkText |
full-text |
electronicAccess.linkText="Folio website" |
Search by electronic access link text |
electronicAccess.publicNote |
full-text |
electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
electronicAccess.relationshipId |
term |
electronicAccess.relationshipId="47d563ed-1ae2-41dc-97f8-8ebefce904f0" |
Search by electronic access relationship type ID |
staffSuppress |
term |
staffSuppress==true |
Matches instances that are staff suppressed |
discoverySuppress |
term |
discoverySuppress==true |
Matches instances that are suppressed from discovery |
publicNotes |
full-text |
publicNotes all "public note" |
Matches instances that have a public note (i.e. note.staffOnly is
false)
|
administrativeNotes |
full-text |
administrativeNotes all "librarian note" |
Search by administrative notes |
notes.note |
full-text |
notes.note all "librarian note" |
Search by instance notes (include staffOnly) |
isbn |
term |
isbn="1234*" |
Matches instances that have an ISBN identifier with the given value |
issn |
term |
issn="1234*" |
Matches instances that have an ISSN identifier with the given value |
oclc |
term |
oclc="1234*" |
Matches instances that have an OCLC identifier with the given value |
lccn |
term |
lccn = "LCCN" |
Matches instances with the given lccn |
normalizedClassificationNumber |
term |
normalizedClassificationNumber == "LCCN" |
Matches instances with the given classification number (normalizes case,
whitespaces, special characters, supports leading and trailing wildcard)
|
normalizedDate1 |
term |
normalizedDate1>=1990 |
Matches instances with the given Date1 (normalizes alpha u characters) |
classificationId |
term |
classificationId = "c4f60d7413158e9466856f4c0250d91d312f86cf" |
Matches instances with the given classificationId |
Holdings search options
Option |
Type |
Example |
Description |
holdings.id |
term |
holdings.id=="1234567" |
Matches instances that have a holding with the id |
holdings.sourceId |
term |
holdings.sourceId=="FOLIO" |
Matches instances that have a holding with the source FOLIO |
holdings.holdingsTypeId |
term |
holdings.holdingsTypeId=="1234567" |
Matches instances that have a holding with the holdings type id 1234567
|
holdings.permanentLocationId |
term |
holdings.permanentLocationId=="123765" |
Matches instances that have holdings with given statisticalCodeId |
holdings.statisticalCodeIds |
term |
holdings.statisticalCodeIds=="123765" |
Matches instances that have holdings with given permanentLocationId |
holdings.discoverySuppress |
term |
holdings.discoverySuppress==true |
Matches instances that have holdings suppressed/not suppressed from discovery |
holdings.hrid |
term |
holdings.hrid=="hr10*3" |
Matches instances that have a holding with given HRID |
holdingsTags |
term |
holdingsTags=="important" |
Matches instances that have holdings with given tags |
holdingsFullCallNumbers |
term |
holdingsFullCallNumbers="cn*434" |
Matches instances that have holdings with given call number string (prefix + call
number + suffix)
|
holdingsNormalizedCallNumbers |
term |
holdingsNormalizedCallNumbers="cn434" |
Matches instances that have holdings with given call number and might not be
formatted correctly
|
holdings.electronicAccess |
full-text |
holdings.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
holdings.electronicAccess.uri |
term |
holdings.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
holdings.electronicAccess.linkText |
full-text |
holdings.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
holdings.electronicAccess.publicNote |
full-text |
holdings.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
holdings.electronicAccess.relationshipId |
term |
holdings.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by holdings electronic access relationship type ID |
holdings.administrativeNotes |
full-text |
holdings.administrativeNotes all "librarian note" |
Search by holdings administrative notes |
holdings.notes.note |
full-text |
holdings.notes.note all "librarian note" |
Search by holdings notes |
holdingsTypeId |
term |
holdingsTypeId=="123" |
Search by holdings type id |
holdingsPublicNotes |
full-text |
holdingsPublicNotes all "public note" |
Search by holdings public notes |
holdingsIdentifiers |
term |
holdingsIdentifiers == "ho00000000006" |
Search by holdings Identifiers: holdings.id, holdings.hrid,
holdings.formerIds
|
holdings.metadata.createdDate |
term |
metadata.createdDate > "2020-12-12" |
Matches instances with holdings that were created after 2020-12-12 |
holdings.metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances with holdings that were updated after 2020-12-12 |
Item search options
Option |
Type |
Example |
Description |
item.id |
term |
item.id=="1234567" |
Matches instances that have an item with the id |
item.hrid |
term |
item.hrid=="it001" |
Matches instances that have an item with the HRID |
item.barcode |
term |
item.barcode=="10011" |
Matches instances that have an item with the barcode |
item.effectiveLocationId |
term |
item.effectiveLocationId=="1212" |
Matches instances that have item with the effective location |
item.statisticalCodeIds |
term |
item.statisticalCodeIds=="1212" |
Matches instances that have item with the statistical code Id |
item.status.name |
term |
item.status.name=="Available" |
Matches instances that have item with given status |
item.materialTypeId |
term |
item.materialTypeId="23434" |
Matches instances that have item with given material type |
item.discoverySuppress |
term |
item.discoverySuppress=true |
Matches instances that have item suppressed/not suppressed from discovery |
itemFullCallNumbers |
term |
itemFullCallNumbers="cn*434" |
Matches instances that have item with given call number string (prefix + call number
+ suffix)
|
itemNormalizedCallNumbers |
term |
itemNormalizedCallNumbers="cn434" |
Matches instances that have item with given call number and might not be formatted
correctly
|
itemLevelCallNumberTypeId |
term |
itemLevelCallNumberTypeId="81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have item with given call number type id |
itemTags |
term |
itemTags="important" |
Matches instances that have item with given tag |
item.electronicAccess |
full-text |
item.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
item.electronicAccess.uri |
term |
item.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
item.electronicAccess.linkText |
full-text |
item.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
item.electronicAccess.publicNote |
full-text |
item.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
item.electronicAccess.relationshipId |
term |
item.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by item electronic access relationship type ID |
item.administrativeNotes |
full-text |
item.administrativeNotes all "librarian note" |
Search by item administrative notes |
item.notes.note |
full-text |
item.notes.note all "librarian note" |
Search by item notes and circulation notes |
item.circulationNotes.note |
full-text |
item.circulationNotes.note all "circulation note" |
Search by item circulation notes |
itemPublicNotes |
full-text |
itemPublicNotes all "public note" |
Search by item public notes and circulation notes |
itemIdentifiers |
term |
itemIdentifiers all "81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Search by item Identifiers: item.id, item.hrid, item.formerIds,
item.accessionNumber, item.itemIdentifier
|
item.metadata.createdDate |
term |
item.metadata.createdDate > "2020-12-12" |
Matches instances with item that were created after 2020-12-12 |
item.metadata.updatedDate |
term |
item.metadata.updatedDate > "2020-12-12" |
Matches instances with item that were updated after 2020-12-12 |
callNumberType |
term |
callNumberType = "lc" |
Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local. |
(default to null)
Integer *limit = 56; // Limit the number of elements returned in the response. (optional) (default to 100)
Integer *offset = 56; // Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)
Boolean *expandAll = true; // Whether to return only basic properties or entire instance. (optional) (default to false)
// Search Instances
[apiInstance searchInstancesWith:xOkapiTenant
query:query
limit:limit
offset:offset
expandAll:expandAll
completionHandler: ^(instanceSearchResult output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var SearchApi = require('search_api');
// Create an instance of the API class
var api = new SearchApi.SearchApi()
var xOkapiTenant = xOkapiTenant_example; // {String} X-Okapi-Tenant header value
var query = query_example; // {String} A CQL query string
Instance search options
Option |
Type |
Example |
Description |
keyword |
full-text |
keyword all "web semantic" |
An alias for: title, alternativeTitles, indexTitle, series, identifiers.value, contributors.name |
id |
term |
id=="1234567" |
Matches instance with the id |
hrid |
term |
hrid=="hr1*0" |
Matches instances with given HRID |
source |
term |
source=="MARC" |
Matches instances with given source (FOLIO/MARC) |
title |
full-text |
title all "semantic web" |
Matches instances with the given title, searches against title, alternativeTitles,
indexTitle, series fields
|
alternativeTitles.alternativeTitle |
full-text |
alternativeTitles.alternativeTitle all "semantic web" |
Matches instances with the given alternative title |
uniformTitle |
full-text |
uniformTitle all "semantic web" |
Matches instances with the given uniform title |
indexTitle |
full-text |
indexTitle all "semantic web" |
Matches instances with the given index title |
series |
full-text |
series all "series" |
Matches instance with given series value |
identifiers.value |
term |
identifiers.value = "1023*" |
Matches instances with the given identifier value |
identifiers.identifierTypeId |
term |
identifiers.identifierTypeId=="123" identifiers.value = "1023*"
|
Matches instances that have an identifier of type 123 and ANY
identifier with value 1023*
|
contributors |
full-text |
contributors all "John" |
Matches instances that have a John contributor |
contributors.name |
term |
contributors.name all "John" |
Matches instances that have a primary John contributor |
contributors.contributorTypeId |
term |
contributors.contributorTypeId all "1234567" |
Matches instances that have a contributor type Id 1234567 |
contributors.contributorNameTypeId |
term |
contributors.contributorNameTypeId all "1234567" |
Matches instances that have a contributor name type Id 1234567 |
contributors.primary |
term |
contributors all "John" and contributors.primary==true |
Matches instances that have a primary John contributor |
contributors.authorityId |
term |
contributors.authorityId ==
"81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
authorityId |
term |
authorityId == "81ae0f60-f2bc-450c-84c8-5a21096daed9" |
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
subjects |
full-text |
subjects all "Chemistry" |
Matches instances that have a Chemistry subject |
instanceTypeId |
term |
instanceTypeId == "123" |
Matches instances with the 123 type |
statusId |
term |
statusId == "123" |
Matches instances with the 123 status |
instanceFormatIds |
term |
instanceFormatIds == "123" |
Matches instances with the 123 format id |
languages |
term |
languages == "eng" |
Matches instances that have eng language |
metadata.createdDate |
term |
metadata.createdDate > "2021-03-01T00:00:00.000+00:00"
|
Matches instances that were created after 2020-12-12 |
metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances that were updated after 2020-12-12 |
modeOfIssuanceId |
term |
modeOfIssuanceId=="123" |
Matches instances that have 123 mode of issuance |
natureOfContentTermIds |
term |
natureOfContentTermIds=="123" |
Matches instances that have 123 nature of content |
publisher |
full-text |
publisher all "Publisher of Ukraine" |
Matches instances that have Publisher of Ukraine publisher |
publication.place |
full-text |
publication.place all "Ukraine" |
Matches instances that have `Ukraine` in publication place |
instanceTags |
term |
instanceTags=="important" |
Matches instances that have important tag |
classifications.classificationNumber |
term |
classifications.classificationNumber=="cl1" |
Matches instances that have cl1 classification number |
classifications.classificationTypeId |
term |
classifications.classificationTypeId == "123" |
Matches instances that have classification type id 123 |
electronicAccess |
full-text |
electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
electronicAccess.uri |
term |
electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
electronicAccess.linkText |
full-text |
electronicAccess.linkText="Folio website" |
Search by electronic access link text |
electronicAccess.publicNote |
full-text |
electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
electronicAccess.relationshipId |
term |
electronicAccess.relationshipId="47d563ed-1ae2-41dc-97f8-8ebefce904f0" |
Search by electronic access relationship type ID |
staffSuppress |
term |
staffSuppress==true |
Matches instances that are staff suppressed |
discoverySuppress |
term |
discoverySuppress==true |
Matches instances that are suppressed from discovery |
publicNotes |
full-text |
publicNotes all "public note" |
Matches instances that have a public note (i.e. note.staffOnly is
false)
|
administrativeNotes |
full-text |
administrativeNotes all "librarian note" |
Search by administrative notes |
notes.note |
full-text |
notes.note all "librarian note" |
Search by instance notes (include staffOnly) |
isbn |
term |
isbn="1234*" |
Matches instances that have an ISBN identifier with the given value |
issn |
term |
issn="1234*" |
Matches instances that have an ISSN identifier with the given value |
oclc |
term |
oclc="1234*" |
Matches instances that have an OCLC identifier with the given value |
lccn |
term |
lccn = "LCCN" |
Matches instances with the given lccn |
normalizedClassificationNumber |
term |
normalizedClassificationNumber == "LCCN" |
Matches instances with the given classification number (normalizes case,
whitespaces, special characters, supports leading and trailing wildcard)
|
normalizedDate1 |
term |
normalizedDate1>=1990 |
Matches instances with the given Date1 (normalizes alpha u characters) |
classificationId |
term |
classificationId = "c4f60d7413158e9466856f4c0250d91d312f86cf" |
Matches instances with the given classificationId |
Holdings search options
Option |
Type |
Example |
Description |
holdings.id |
term |
holdings.id=="1234567" |
Matches instances that have a holding with the id |
holdings.sourceId |
term |
holdings.sourceId=="FOLIO" |
Matches instances that have a holding with the source FOLIO |
holdings.holdingsTypeId |
term |
holdings.holdingsTypeId=="1234567" |
Matches instances that have a holding with the holdings type id 1234567
|
holdings.permanentLocationId |
term |
holdings.permanentLocationId=="123765" |
Matches instances that have holdings with given statisticalCodeId |
holdings.statisticalCodeIds |
term |
holdings.statisticalCodeIds=="123765" |
Matches instances that have holdings with given permanentLocationId |
holdings.discoverySuppress |
term |
holdings.discoverySuppress==true |
Matches instances that have holdings suppressed/not suppressed from discovery |
holdings.hrid |
term |
holdings.hrid=="hr10*3" |
Matches instances that have a holding with given HRID |
holdingsTags |
term |
holdingsTags=="important" |
Matches instances that have holdings with given tags |
holdingsFullCallNumbers |
term |
holdingsFullCallNumbers="cn*434" |
Matches instances that have holdings with given call number string (prefix + call
number + suffix)
|
holdingsNormalizedCallNumbers |
term |
holdingsNormalizedCallNumbers="cn434" |
Matches instances that have holdings with given call number and might not be
formatted correctly
|
holdings.electronicAccess |
full-text |
holdings.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
holdings.electronicAccess.uri |
term |
holdings.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
holdings.electronicAccess.linkText |
full-text |
holdings.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
holdings.electronicAccess.publicNote |
full-text |
holdings.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
holdings.electronicAccess.relationshipId |
term |
holdings.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by holdings electronic access relationship type ID |
holdings.administrativeNotes |
full-text |
holdings.administrativeNotes all "librarian note" |
Search by holdings administrative notes |
holdings.notes.note |
full-text |
holdings.notes.note all "librarian note" |
Search by holdings notes |
holdingsTypeId |
term |
holdingsTypeId=="123" |
Search by holdings type id |
holdingsPublicNotes |
full-text |
holdingsPublicNotes all "public note" |
Search by holdings public notes |
holdingsIdentifiers |
term |
holdingsIdentifiers == "ho00000000006" |
Search by holdings Identifiers: holdings.id, holdings.hrid,
holdings.formerIds
|
holdings.metadata.createdDate |
term |
metadata.createdDate > "2020-12-12" |
Matches instances with holdings that were created after 2020-12-12 |
holdings.metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances with holdings that were updated after 2020-12-12 |
Item search options
Option |
Type |
Example |
Description |
item.id |
term |
item.id=="1234567" |
Matches instances that have an item with the id |
item.hrid |
term |
item.hrid=="it001" |
Matches instances that have an item with the HRID |
item.barcode |
term |
item.barcode=="10011" |
Matches instances that have an item with the barcode |
item.effectiveLocationId |
term |
item.effectiveLocationId=="1212" |
Matches instances that have item with the effective location |
item.statisticalCodeIds |
term |
item.statisticalCodeIds=="1212" |
Matches instances that have item with the statistical code Id |
item.status.name |
term |
item.status.name=="Available" |
Matches instances that have item with given status |
item.materialTypeId |
term |
item.materialTypeId="23434" |
Matches instances that have item with given material type |
item.discoverySuppress |
term |
item.discoverySuppress=true |
Matches instances that have item suppressed/not suppressed from discovery |
itemFullCallNumbers |
term |
itemFullCallNumbers="cn*434" |
Matches instances that have item with given call number string (prefix + call number
+ suffix)
|
itemNormalizedCallNumbers |
term |
itemNormalizedCallNumbers="cn434" |
Matches instances that have item with given call number and might not be formatted
correctly
|
itemLevelCallNumberTypeId |
term |
itemLevelCallNumberTypeId="81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have item with given call number type id |
itemTags |
term |
itemTags="important" |
Matches instances that have item with given tag |
item.electronicAccess |
full-text |
item.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
item.electronicAccess.uri |
term |
item.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
item.electronicAccess.linkText |
full-text |
item.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
item.electronicAccess.publicNote |
full-text |
item.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
item.electronicAccess.relationshipId |
term |
item.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by item electronic access relationship type ID |
item.administrativeNotes |
full-text |
item.administrativeNotes all "librarian note" |
Search by item administrative notes |
item.notes.note |
full-text |
item.notes.note all "librarian note" |
Search by item notes and circulation notes |
item.circulationNotes.note |
full-text |
item.circulationNotes.note all "circulation note" |
Search by item circulation notes |
itemPublicNotes |
full-text |
itemPublicNotes all "public note" |
Search by item public notes and circulation notes |
itemIdentifiers |
term |
itemIdentifiers all "81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Search by item Identifiers: item.id, item.hrid, item.formerIds,
item.accessionNumber, item.itemIdentifier
|
item.metadata.createdDate |
term |
item.metadata.createdDate > "2020-12-12" |
Matches instances with item that were created after 2020-12-12 |
item.metadata.updatedDate |
term |
item.metadata.updatedDate > "2020-12-12" |
Matches instances with item that were updated after 2020-12-12 |
callNumberType |
term |
callNumberType = "lc" |
Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local. |
var opts = {
'limit': 56, // {Integer} Limit the number of elements returned in the response.
'offset': 56, // {Integer} Skip over a number of elements by specifying an offset value for the query.
'expandAll': true // {Boolean} Whether to return only basic properties or entire instance.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.searchInstances(xOkapiTenant, query, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class searchInstancesExample
{
public void main()
{
// Create an instance of the API class
var apiInstance = new SearchApi();
var xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value (default to null)
var query = query_example; // String | A CQL query string
Instance search options
Option |
Type |
Example |
Description |
keyword |
full-text |
keyword all "web semantic" |
An alias for: title, alternativeTitles, indexTitle, series, identifiers.value, contributors.name |
id |
term |
id=="1234567" |
Matches instance with the id |
hrid |
term |
hrid=="hr1*0" |
Matches instances with given HRID |
source |
term |
source=="MARC" |
Matches instances with given source (FOLIO/MARC) |
title |
full-text |
title all "semantic web" |
Matches instances with the given title, searches against title, alternativeTitles,
indexTitle, series fields
|
alternativeTitles.alternativeTitle |
full-text |
alternativeTitles.alternativeTitle all "semantic web" |
Matches instances with the given alternative title |
uniformTitle |
full-text |
uniformTitle all "semantic web" |
Matches instances with the given uniform title |
indexTitle |
full-text |
indexTitle all "semantic web" |
Matches instances with the given index title |
series |
full-text |
series all "series" |
Matches instance with given series value |
identifiers.value |
term |
identifiers.value = "1023*" |
Matches instances with the given identifier value |
identifiers.identifierTypeId |
term |
identifiers.identifierTypeId=="123" identifiers.value = "1023*"
|
Matches instances that have an identifier of type 123 and ANY
identifier with value 1023*
|
contributors |
full-text |
contributors all "John" |
Matches instances that have a John contributor |
contributors.name |
term |
contributors.name all "John" |
Matches instances that have a primary John contributor |
contributors.contributorTypeId |
term |
contributors.contributorTypeId all "1234567" |
Matches instances that have a contributor type Id 1234567 |
contributors.contributorNameTypeId |
term |
contributors.contributorNameTypeId all "1234567" |
Matches instances that have a contributor name type Id 1234567 |
contributors.primary |
term |
contributors all "John" and contributors.primary==true |
Matches instances that have a primary John contributor |
contributors.authorityId |
term |
contributors.authorityId ==
"81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
authorityId |
term |
authorityId == "81ae0f60-f2bc-450c-84c8-5a21096daed9" |
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
subjects |
full-text |
subjects all "Chemistry" |
Matches instances that have a Chemistry subject |
instanceTypeId |
term |
instanceTypeId == "123" |
Matches instances with the 123 type |
statusId |
term |
statusId == "123" |
Matches instances with the 123 status |
instanceFormatIds |
term |
instanceFormatIds == "123" |
Matches instances with the 123 format id |
languages |
term |
languages == "eng" |
Matches instances that have eng language |
metadata.createdDate |
term |
metadata.createdDate > "2021-03-01T00:00:00.000+00:00"
|
Matches instances that were created after 2020-12-12 |
metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances that were updated after 2020-12-12 |
modeOfIssuanceId |
term |
modeOfIssuanceId=="123" |
Matches instances that have 123 mode of issuance |
natureOfContentTermIds |
term |
natureOfContentTermIds=="123" |
Matches instances that have 123 nature of content |
publisher |
full-text |
publisher all "Publisher of Ukraine" |
Matches instances that have Publisher of Ukraine publisher |
publication.place |
full-text |
publication.place all "Ukraine" |
Matches instances that have `Ukraine` in publication place |
instanceTags |
term |
instanceTags=="important" |
Matches instances that have important tag |
classifications.classificationNumber |
term |
classifications.classificationNumber=="cl1" |
Matches instances that have cl1 classification number |
classifications.classificationTypeId |
term |
classifications.classificationTypeId == "123" |
Matches instances that have classification type id 123 |
electronicAccess |
full-text |
electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
electronicAccess.uri |
term |
electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
electronicAccess.linkText |
full-text |
electronicAccess.linkText="Folio website" |
Search by electronic access link text |
electronicAccess.publicNote |
full-text |
electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
electronicAccess.relationshipId |
term |
electronicAccess.relationshipId="47d563ed-1ae2-41dc-97f8-8ebefce904f0" |
Search by electronic access relationship type ID |
staffSuppress |
term |
staffSuppress==true |
Matches instances that are staff suppressed |
discoverySuppress |
term |
discoverySuppress==true |
Matches instances that are suppressed from discovery |
publicNotes |
full-text |
publicNotes all "public note" |
Matches instances that have a public note (i.e. note.staffOnly is
false)
|
administrativeNotes |
full-text |
administrativeNotes all "librarian note" |
Search by administrative notes |
notes.note |
full-text |
notes.note all "librarian note" |
Search by instance notes (include staffOnly) |
isbn |
term |
isbn="1234*" |
Matches instances that have an ISBN identifier with the given value |
issn |
term |
issn="1234*" |
Matches instances that have an ISSN identifier with the given value |
oclc |
term |
oclc="1234*" |
Matches instances that have an OCLC identifier with the given value |
lccn |
term |
lccn = "LCCN" |
Matches instances with the given lccn |
normalizedClassificationNumber |
term |
normalizedClassificationNumber == "LCCN" |
Matches instances with the given classification number (normalizes case,
whitespaces, special characters, supports leading and trailing wildcard)
|
normalizedDate1 |
term |
normalizedDate1>=1990 |
Matches instances with the given Date1 (normalizes alpha u characters) |
classificationId |
term |
classificationId = "c4f60d7413158e9466856f4c0250d91d312f86cf" |
Matches instances with the given classificationId |
Holdings search options
Option |
Type |
Example |
Description |
holdings.id |
term |
holdings.id=="1234567" |
Matches instances that have a holding with the id |
holdings.sourceId |
term |
holdings.sourceId=="FOLIO" |
Matches instances that have a holding with the source FOLIO |
holdings.holdingsTypeId |
term |
holdings.holdingsTypeId=="1234567" |
Matches instances that have a holding with the holdings type id 1234567
|
holdings.permanentLocationId |
term |
holdings.permanentLocationId=="123765" |
Matches instances that have holdings with given statisticalCodeId |
holdings.statisticalCodeIds |
term |
holdings.statisticalCodeIds=="123765" |
Matches instances that have holdings with given permanentLocationId |
holdings.discoverySuppress |
term |
holdings.discoverySuppress==true |
Matches instances that have holdings suppressed/not suppressed from discovery |
holdings.hrid |
term |
holdings.hrid=="hr10*3" |
Matches instances that have a holding with given HRID |
holdingsTags |
term |
holdingsTags=="important" |
Matches instances that have holdings with given tags |
holdingsFullCallNumbers |
term |
holdingsFullCallNumbers="cn*434" |
Matches instances that have holdings with given call number string (prefix + call
number + suffix)
|
holdingsNormalizedCallNumbers |
term |
holdingsNormalizedCallNumbers="cn434" |
Matches instances that have holdings with given call number and might not be
formatted correctly
|
holdings.electronicAccess |
full-text |
holdings.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
holdings.electronicAccess.uri |
term |
holdings.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
holdings.electronicAccess.linkText |
full-text |
holdings.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
holdings.electronicAccess.publicNote |
full-text |
holdings.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
holdings.electronicAccess.relationshipId |
term |
holdings.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by holdings electronic access relationship type ID |
holdings.administrativeNotes |
full-text |
holdings.administrativeNotes all "librarian note" |
Search by holdings administrative notes |
holdings.notes.note |
full-text |
holdings.notes.note all "librarian note" |
Search by holdings notes |
holdingsTypeId |
term |
holdingsTypeId=="123" |
Search by holdings type id |
holdingsPublicNotes |
full-text |
holdingsPublicNotes all "public note" |
Search by holdings public notes |
holdingsIdentifiers |
term |
holdingsIdentifiers == "ho00000000006" |
Search by holdings Identifiers: holdings.id, holdings.hrid,
holdings.formerIds
|
holdings.metadata.createdDate |
term |
metadata.createdDate > "2020-12-12" |
Matches instances with holdings that were created after 2020-12-12 |
holdings.metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances with holdings that were updated after 2020-12-12 |
Item search options
Option |
Type |
Example |
Description |
item.id |
term |
item.id=="1234567" |
Matches instances that have an item with the id |
item.hrid |
term |
item.hrid=="it001" |
Matches instances that have an item with the HRID |
item.barcode |
term |
item.barcode=="10011" |
Matches instances that have an item with the barcode |
item.effectiveLocationId |
term |
item.effectiveLocationId=="1212" |
Matches instances that have item with the effective location |
item.statisticalCodeIds |
term |
item.statisticalCodeIds=="1212" |
Matches instances that have item with the statistical code Id |
item.status.name |
term |
item.status.name=="Available" |
Matches instances that have item with given status |
item.materialTypeId |
term |
item.materialTypeId="23434" |
Matches instances that have item with given material type |
item.discoverySuppress |
term |
item.discoverySuppress=true |
Matches instances that have item suppressed/not suppressed from discovery |
itemFullCallNumbers |
term |
itemFullCallNumbers="cn*434" |
Matches instances that have item with given call number string (prefix + call number
+ suffix)
|
itemNormalizedCallNumbers |
term |
itemNormalizedCallNumbers="cn434" |
Matches instances that have item with given call number and might not be formatted
correctly
|
itemLevelCallNumberTypeId |
term |
itemLevelCallNumberTypeId="81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have item with given call number type id |
itemTags |
term |
itemTags="important" |
Matches instances that have item with given tag |
item.electronicAccess |
full-text |
item.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
item.electronicAccess.uri |
term |
item.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
item.electronicAccess.linkText |
full-text |
item.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
item.electronicAccess.publicNote |
full-text |
item.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
item.electronicAccess.relationshipId |
term |
item.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by item electronic access relationship type ID |
item.administrativeNotes |
full-text |
item.administrativeNotes all "librarian note" |
Search by item administrative notes |
item.notes.note |
full-text |
item.notes.note all "librarian note" |
Search by item notes and circulation notes |
item.circulationNotes.note |
full-text |
item.circulationNotes.note all "circulation note" |
Search by item circulation notes |
itemPublicNotes |
full-text |
itemPublicNotes all "public note" |
Search by item public notes and circulation notes |
itemIdentifiers |
term |
itemIdentifiers all "81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Search by item Identifiers: item.id, item.hrid, item.formerIds,
item.accessionNumber, item.itemIdentifier
|
item.metadata.createdDate |
term |
item.metadata.createdDate > "2020-12-12" |
Matches instances with item that were created after 2020-12-12 |
item.metadata.updatedDate |
term |
item.metadata.updatedDate > "2020-12-12" |
Matches instances with item that were updated after 2020-12-12 |
callNumberType |
term |
callNumberType = "lc" |
Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local. |
(default to null)
var limit = 56; // Integer | Limit the number of elements returned in the response. (optional) (default to 100)
var offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)
var expandAll = true; // Boolean | Whether to return only basic properties or entire instance. (optional) (default to false)
try {
// Search Instances
instanceSearchResult result = apiInstance.searchInstances(xOkapiTenant, query, limit, offset, expandAll);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling SearchApi.searchInstances: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SearchApi();
$xOkapiTenant = xOkapiTenant_example; // String | X-Okapi-Tenant header value
$query = query_example; // String | A CQL query string
Instance search options
Option |
Type |
Example |
Description |
keyword |
full-text |
keyword all "web semantic" |
An alias for: title, alternativeTitles, indexTitle, series, identifiers.value, contributors.name |
id |
term |
id=="1234567" |
Matches instance with the id |
hrid |
term |
hrid=="hr1*0" |
Matches instances with given HRID |
source |
term |
source=="MARC" |
Matches instances with given source (FOLIO/MARC) |
title |
full-text |
title all "semantic web" |
Matches instances with the given title, searches against title, alternativeTitles,
indexTitle, series fields
|
alternativeTitles.alternativeTitle |
full-text |
alternativeTitles.alternativeTitle all "semantic web" |
Matches instances with the given alternative title |
uniformTitle |
full-text |
uniformTitle all "semantic web" |
Matches instances with the given uniform title |
indexTitle |
full-text |
indexTitle all "semantic web" |
Matches instances with the given index title |
series |
full-text |
series all "series" |
Matches instance with given series value |
identifiers.value |
term |
identifiers.value = "1023*" |
Matches instances with the given identifier value |
identifiers.identifierTypeId |
term |
identifiers.identifierTypeId=="123" identifiers.value = "1023*"
|
Matches instances that have an identifier of type 123 and ANY
identifier with value 1023*
|
contributors |
full-text |
contributors all "John" |
Matches instances that have a John contributor |
contributors.name |
term |
contributors.name all "John" |
Matches instances that have a primary John contributor |
contributors.contributorTypeId |
term |
contributors.contributorTypeId all "1234567" |
Matches instances that have a contributor type Id 1234567 |
contributors.contributorNameTypeId |
term |
contributors.contributorNameTypeId all "1234567" |
Matches instances that have a contributor name type Id 1234567 |
contributors.primary |
term |
contributors all "John" and contributors.primary==true |
Matches instances that have a primary John contributor |
contributors.authorityId |
term |
contributors.authorityId ==
"81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
authorityId |
term |
authorityId == "81ae0f60-f2bc-450c-84c8-5a21096daed9" |
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
subjects |
full-text |
subjects all "Chemistry" |
Matches instances that have a Chemistry subject |
instanceTypeId |
term |
instanceTypeId == "123" |
Matches instances with the 123 type |
statusId |
term |
statusId == "123" |
Matches instances with the 123 status |
instanceFormatIds |
term |
instanceFormatIds == "123" |
Matches instances with the 123 format id |
languages |
term |
languages == "eng" |
Matches instances that have eng language |
metadata.createdDate |
term |
metadata.createdDate > "2021-03-01T00:00:00.000+00:00"
|
Matches instances that were created after 2020-12-12 |
metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances that were updated after 2020-12-12 |
modeOfIssuanceId |
term |
modeOfIssuanceId=="123" |
Matches instances that have 123 mode of issuance |
natureOfContentTermIds |
term |
natureOfContentTermIds=="123" |
Matches instances that have 123 nature of content |
publisher |
full-text |
publisher all "Publisher of Ukraine" |
Matches instances that have Publisher of Ukraine publisher |
publication.place |
full-text |
publication.place all "Ukraine" |
Matches instances that have `Ukraine` in publication place |
instanceTags |
term |
instanceTags=="important" |
Matches instances that have important tag |
classifications.classificationNumber |
term |
classifications.classificationNumber=="cl1" |
Matches instances that have cl1 classification number |
classifications.classificationTypeId |
term |
classifications.classificationTypeId == "123" |
Matches instances that have classification type id 123 |
electronicAccess |
full-text |
electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
electronicAccess.uri |
term |
electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
electronicAccess.linkText |
full-text |
electronicAccess.linkText="Folio website" |
Search by electronic access link text |
electronicAccess.publicNote |
full-text |
electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
electronicAccess.relationshipId |
term |
electronicAccess.relationshipId="47d563ed-1ae2-41dc-97f8-8ebefce904f0" |
Search by electronic access relationship type ID |
staffSuppress |
term |
staffSuppress==true |
Matches instances that are staff suppressed |
discoverySuppress |
term |
discoverySuppress==true |
Matches instances that are suppressed from discovery |
publicNotes |
full-text |
publicNotes all "public note" |
Matches instances that have a public note (i.e. note.staffOnly is
false)
|
administrativeNotes |
full-text |
administrativeNotes all "librarian note" |
Search by administrative notes |
notes.note |
full-text |
notes.note all "librarian note" |
Search by instance notes (include staffOnly) |
isbn |
term |
isbn="1234*" |
Matches instances that have an ISBN identifier with the given value |
issn |
term |
issn="1234*" |
Matches instances that have an ISSN identifier with the given value |
oclc |
term |
oclc="1234*" |
Matches instances that have an OCLC identifier with the given value |
lccn |
term |
lccn = "LCCN" |
Matches instances with the given lccn |
normalizedClassificationNumber |
term |
normalizedClassificationNumber == "LCCN" |
Matches instances with the given classification number (normalizes case,
whitespaces, special characters, supports leading and trailing wildcard)
|
normalizedDate1 |
term |
normalizedDate1>=1990 |
Matches instances with the given Date1 (normalizes alpha u characters) |
classificationId |
term |
classificationId = "c4f60d7413158e9466856f4c0250d91d312f86cf" |
Matches instances with the given classificationId |
Holdings search options
Option |
Type |
Example |
Description |
holdings.id |
term |
holdings.id=="1234567" |
Matches instances that have a holding with the id |
holdings.sourceId |
term |
holdings.sourceId=="FOLIO" |
Matches instances that have a holding with the source FOLIO |
holdings.holdingsTypeId |
term |
holdings.holdingsTypeId=="1234567" |
Matches instances that have a holding with the holdings type id 1234567
|
holdings.permanentLocationId |
term |
holdings.permanentLocationId=="123765" |
Matches instances that have holdings with given statisticalCodeId |
holdings.statisticalCodeIds |
term |
holdings.statisticalCodeIds=="123765" |
Matches instances that have holdings with given permanentLocationId |
holdings.discoverySuppress |
term |
holdings.discoverySuppress==true |
Matches instances that have holdings suppressed/not suppressed from discovery |
holdings.hrid |
term |
holdings.hrid=="hr10*3" |
Matches instances that have a holding with given HRID |
holdingsTags |
term |
holdingsTags=="important" |
Matches instances that have holdings with given tags |
holdingsFullCallNumbers |
term |
holdingsFullCallNumbers="cn*434" |
Matches instances that have holdings with given call number string (prefix + call
number + suffix)
|
holdingsNormalizedCallNumbers |
term |
holdingsNormalizedCallNumbers="cn434" |
Matches instances that have holdings with given call number and might not be
formatted correctly
|
holdings.electronicAccess |
full-text |
holdings.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
holdings.electronicAccess.uri |
term |
holdings.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
holdings.electronicAccess.linkText |
full-text |
holdings.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
holdings.electronicAccess.publicNote |
full-text |
holdings.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
holdings.electronicAccess.relationshipId |
term |
holdings.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by holdings electronic access relationship type ID |
holdings.administrativeNotes |
full-text |
holdings.administrativeNotes all "librarian note" |
Search by holdings administrative notes |
holdings.notes.note |
full-text |
holdings.notes.note all "librarian note" |
Search by holdings notes |
holdingsTypeId |
term |
holdingsTypeId=="123" |
Search by holdings type id |
holdingsPublicNotes |
full-text |
holdingsPublicNotes all "public note" |
Search by holdings public notes |
holdingsIdentifiers |
term |
holdingsIdentifiers == "ho00000000006" |
Search by holdings Identifiers: holdings.id, holdings.hrid,
holdings.formerIds
|
holdings.metadata.createdDate |
term |
metadata.createdDate > "2020-12-12" |
Matches instances with holdings that were created after 2020-12-12 |
holdings.metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances with holdings that were updated after 2020-12-12 |
Item search options
Option |
Type |
Example |
Description |
item.id |
term |
item.id=="1234567" |
Matches instances that have an item with the id |
item.hrid |
term |
item.hrid=="it001" |
Matches instances that have an item with the HRID |
item.barcode |
term |
item.barcode=="10011" |
Matches instances that have an item with the barcode |
item.effectiveLocationId |
term |
item.effectiveLocationId=="1212" |
Matches instances that have item with the effective location |
item.statisticalCodeIds |
term |
item.statisticalCodeIds=="1212" |
Matches instances that have item with the statistical code Id |
item.status.name |
term |
item.status.name=="Available" |
Matches instances that have item with given status |
item.materialTypeId |
term |
item.materialTypeId="23434" |
Matches instances that have item with given material type |
item.discoverySuppress |
term |
item.discoverySuppress=true |
Matches instances that have item suppressed/not suppressed from discovery |
itemFullCallNumbers |
term |
itemFullCallNumbers="cn*434" |
Matches instances that have item with given call number string (prefix + call number
+ suffix)
|
itemNormalizedCallNumbers |
term |
itemNormalizedCallNumbers="cn434" |
Matches instances that have item with given call number and might not be formatted
correctly
|
itemLevelCallNumberTypeId |
term |
itemLevelCallNumberTypeId="81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have item with given call number type id |
itemTags |
term |
itemTags="important" |
Matches instances that have item with given tag |
item.electronicAccess |
full-text |
item.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
item.electronicAccess.uri |
term |
item.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
item.electronicAccess.linkText |
full-text |
item.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
item.electronicAccess.publicNote |
full-text |
item.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
item.electronicAccess.relationshipId |
term |
item.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by item electronic access relationship type ID |
item.administrativeNotes |
full-text |
item.administrativeNotes all "librarian note" |
Search by item administrative notes |
item.notes.note |
full-text |
item.notes.note all "librarian note" |
Search by item notes and circulation notes |
item.circulationNotes.note |
full-text |
item.circulationNotes.note all "circulation note" |
Search by item circulation notes |
itemPublicNotes |
full-text |
itemPublicNotes all "public note" |
Search by item public notes and circulation notes |
itemIdentifiers |
term |
itemIdentifiers all "81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Search by item Identifiers: item.id, item.hrid, item.formerIds,
item.accessionNumber, item.itemIdentifier
|
item.metadata.createdDate |
term |
item.metadata.createdDate > "2020-12-12" |
Matches instances with item that were created after 2020-12-12 |
item.metadata.updatedDate |
term |
item.metadata.updatedDate > "2020-12-12" |
Matches instances with item that were updated after 2020-12-12 |
callNumberType |
term |
callNumberType = "lc" |
Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local. |
$limit = 56; // Integer | Limit the number of elements returned in the response.
$offset = 56; // Integer | Skip over a number of elements by specifying an offset value for the query.
$expandAll = true; // Boolean | Whether to return only basic properties or entire instance.
try {
$result = $api_instance->searchInstances($xOkapiTenant, $query, $limit, $offset, $expandAll);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SearchApi->searchInstances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SearchApi;
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SearchApi->new();
my $xOkapiTenant = xOkapiTenant_example; # String | X-Okapi-Tenant header value
my $query = query_example; # String | A CQL query string
Instance search options
Option |
Type |
Example |
Description |
keyword |
full-text |
keyword all "web semantic" |
An alias for: title, alternativeTitles, indexTitle, series, identifiers.value, contributors.name |
id |
term |
id=="1234567" |
Matches instance with the id |
hrid |
term |
hrid=="hr1*0" |
Matches instances with given HRID |
source |
term |
source=="MARC" |
Matches instances with given source (FOLIO/MARC) |
title |
full-text |
title all "semantic web" |
Matches instances with the given title, searches against title, alternativeTitles,
indexTitle, series fields
|
alternativeTitles.alternativeTitle |
full-text |
alternativeTitles.alternativeTitle all "semantic web" |
Matches instances with the given alternative title |
uniformTitle |
full-text |
uniformTitle all "semantic web" |
Matches instances with the given uniform title |
indexTitle |
full-text |
indexTitle all "semantic web" |
Matches instances with the given index title |
series |
full-text |
series all "series" |
Matches instance with given series value |
identifiers.value |
term |
identifiers.value = "1023*" |
Matches instances with the given identifier value |
identifiers.identifierTypeId |
term |
identifiers.identifierTypeId=="123" identifiers.value = "1023*"
|
Matches instances that have an identifier of type 123 and ANY
identifier with value 1023*
|
contributors |
full-text |
contributors all "John" |
Matches instances that have a John contributor |
contributors.name |
term |
contributors.name all "John" |
Matches instances that have a primary John contributor |
contributors.contributorTypeId |
term |
contributors.contributorTypeId all "1234567" |
Matches instances that have a contributor type Id 1234567 |
contributors.contributorNameTypeId |
term |
contributors.contributorNameTypeId all "1234567" |
Matches instances that have a contributor name type Id 1234567 |
contributors.primary |
term |
contributors all "John" and contributors.primary==true |
Matches instances that have a primary John contributor |
contributors.authorityId |
term |
contributors.authorityId ==
"81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
authorityId |
term |
authorityId == "81ae0f60-f2bc-450c-84c8-5a21096daed9" |
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
subjects |
full-text |
subjects all "Chemistry" |
Matches instances that have a Chemistry subject |
instanceTypeId |
term |
instanceTypeId == "123" |
Matches instances with the 123 type |
statusId |
term |
statusId == "123" |
Matches instances with the 123 status |
instanceFormatIds |
term |
instanceFormatIds == "123" |
Matches instances with the 123 format id |
languages |
term |
languages == "eng" |
Matches instances that have eng language |
metadata.createdDate |
term |
metadata.createdDate > "2021-03-01T00:00:00.000+00:00"
|
Matches instances that were created after 2020-12-12 |
metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances that were updated after 2020-12-12 |
modeOfIssuanceId |
term |
modeOfIssuanceId=="123" |
Matches instances that have 123 mode of issuance |
natureOfContentTermIds |
term |
natureOfContentTermIds=="123" |
Matches instances that have 123 nature of content |
publisher |
full-text |
publisher all "Publisher of Ukraine" |
Matches instances that have Publisher of Ukraine publisher |
publication.place |
full-text |
publication.place all "Ukraine" |
Matches instances that have `Ukraine` in publication place |
instanceTags |
term |
instanceTags=="important" |
Matches instances that have important tag |
classifications.classificationNumber |
term |
classifications.classificationNumber=="cl1" |
Matches instances that have cl1 classification number |
classifications.classificationTypeId |
term |
classifications.classificationTypeId == "123" |
Matches instances that have classification type id 123 |
electronicAccess |
full-text |
electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
electronicAccess.uri |
term |
electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
electronicAccess.linkText |
full-text |
electronicAccess.linkText="Folio website" |
Search by electronic access link text |
electronicAccess.publicNote |
full-text |
electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
electronicAccess.relationshipId |
term |
electronicAccess.relationshipId="47d563ed-1ae2-41dc-97f8-8ebefce904f0" |
Search by electronic access relationship type ID |
staffSuppress |
term |
staffSuppress==true |
Matches instances that are staff suppressed |
discoverySuppress |
term |
discoverySuppress==true |
Matches instances that are suppressed from discovery |
publicNotes |
full-text |
publicNotes all "public note" |
Matches instances that have a public note (i.e. note.staffOnly is
false)
|
administrativeNotes |
full-text |
administrativeNotes all "librarian note" |
Search by administrative notes |
notes.note |
full-text |
notes.note all "librarian note" |
Search by instance notes (include staffOnly) |
isbn |
term |
isbn="1234*" |
Matches instances that have an ISBN identifier with the given value |
issn |
term |
issn="1234*" |
Matches instances that have an ISSN identifier with the given value |
oclc |
term |
oclc="1234*" |
Matches instances that have an OCLC identifier with the given value |
lccn |
term |
lccn = "LCCN" |
Matches instances with the given lccn |
normalizedClassificationNumber |
term |
normalizedClassificationNumber == "LCCN" |
Matches instances with the given classification number (normalizes case,
whitespaces, special characters, supports leading and trailing wildcard)
|
normalizedDate1 |
term |
normalizedDate1>=1990 |
Matches instances with the given Date1 (normalizes alpha u characters) |
classificationId |
term |
classificationId = "c4f60d7413158e9466856f4c0250d91d312f86cf" |
Matches instances with the given classificationId |
Holdings search options
Option |
Type |
Example |
Description |
holdings.id |
term |
holdings.id=="1234567" |
Matches instances that have a holding with the id |
holdings.sourceId |
term |
holdings.sourceId=="FOLIO" |
Matches instances that have a holding with the source FOLIO |
holdings.holdingsTypeId |
term |
holdings.holdingsTypeId=="1234567" |
Matches instances that have a holding with the holdings type id 1234567
|
holdings.permanentLocationId |
term |
holdings.permanentLocationId=="123765" |
Matches instances that have holdings with given statisticalCodeId |
holdings.statisticalCodeIds |
term |
holdings.statisticalCodeIds=="123765" |
Matches instances that have holdings with given permanentLocationId |
holdings.discoverySuppress |
term |
holdings.discoverySuppress==true |
Matches instances that have holdings suppressed/not suppressed from discovery |
holdings.hrid |
term |
holdings.hrid=="hr10*3" |
Matches instances that have a holding with given HRID |
holdingsTags |
term |
holdingsTags=="important" |
Matches instances that have holdings with given tags |
holdingsFullCallNumbers |
term |
holdingsFullCallNumbers="cn*434" |
Matches instances that have holdings with given call number string (prefix + call
number + suffix)
|
holdingsNormalizedCallNumbers |
term |
holdingsNormalizedCallNumbers="cn434" |
Matches instances that have holdings with given call number and might not be
formatted correctly
|
holdings.electronicAccess |
full-text |
holdings.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
holdings.electronicAccess.uri |
term |
holdings.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
holdings.electronicAccess.linkText |
full-text |
holdings.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
holdings.electronicAccess.publicNote |
full-text |
holdings.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
holdings.electronicAccess.relationshipId |
term |
holdings.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by holdings electronic access relationship type ID |
holdings.administrativeNotes |
full-text |
holdings.administrativeNotes all "librarian note" |
Search by holdings administrative notes |
holdings.notes.note |
full-text |
holdings.notes.note all "librarian note" |
Search by holdings notes |
holdingsTypeId |
term |
holdingsTypeId=="123" |
Search by holdings type id |
holdingsPublicNotes |
full-text |
holdingsPublicNotes all "public note" |
Search by holdings public notes |
holdingsIdentifiers |
term |
holdingsIdentifiers == "ho00000000006" |
Search by holdings Identifiers: holdings.id, holdings.hrid,
holdings.formerIds
|
holdings.metadata.createdDate |
term |
metadata.createdDate > "2020-12-12" |
Matches instances with holdings that were created after 2020-12-12 |
holdings.metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances with holdings that were updated after 2020-12-12 |
Item search options
Option |
Type |
Example |
Description |
item.id |
term |
item.id=="1234567" |
Matches instances that have an item with the id |
item.hrid |
term |
item.hrid=="it001" |
Matches instances that have an item with the HRID |
item.barcode |
term |
item.barcode=="10011" |
Matches instances that have an item with the barcode |
item.effectiveLocationId |
term |
item.effectiveLocationId=="1212" |
Matches instances that have item with the effective location |
item.statisticalCodeIds |
term |
item.statisticalCodeIds=="1212" |
Matches instances that have item with the statistical code Id |
item.status.name |
term |
item.status.name=="Available" |
Matches instances that have item with given status |
item.materialTypeId |
term |
item.materialTypeId="23434" |
Matches instances that have item with given material type |
item.discoverySuppress |
term |
item.discoverySuppress=true |
Matches instances that have item suppressed/not suppressed from discovery |
itemFullCallNumbers |
term |
itemFullCallNumbers="cn*434" |
Matches instances that have item with given call number string (prefix + call number
+ suffix)
|
itemNormalizedCallNumbers |
term |
itemNormalizedCallNumbers="cn434" |
Matches instances that have item with given call number and might not be formatted
correctly
|
itemLevelCallNumberTypeId |
term |
itemLevelCallNumberTypeId="81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have item with given call number type id |
itemTags |
term |
itemTags="important" |
Matches instances that have item with given tag |
item.electronicAccess |
full-text |
item.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
item.electronicAccess.uri |
term |
item.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
item.electronicAccess.linkText |
full-text |
item.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
item.electronicAccess.publicNote |
full-text |
item.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
item.electronicAccess.relationshipId |
term |
item.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by item electronic access relationship type ID |
item.administrativeNotes |
full-text |
item.administrativeNotes all "librarian note" |
Search by item administrative notes |
item.notes.note |
full-text |
item.notes.note all "librarian note" |
Search by item notes and circulation notes |
item.circulationNotes.note |
full-text |
item.circulationNotes.note all "circulation note" |
Search by item circulation notes |
itemPublicNotes |
full-text |
itemPublicNotes all "public note" |
Search by item public notes and circulation notes |
itemIdentifiers |
term |
itemIdentifiers all "81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Search by item Identifiers: item.id, item.hrid, item.formerIds,
item.accessionNumber, item.itemIdentifier
|
item.metadata.createdDate |
term |
item.metadata.createdDate > "2020-12-12" |
Matches instances with item that were created after 2020-12-12 |
item.metadata.updatedDate |
term |
item.metadata.updatedDate > "2020-12-12" |
Matches instances with item that were updated after 2020-12-12 |
callNumberType |
term |
callNumberType = "lc" |
Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local. |
my $limit = 56; # Integer | Limit the number of elements returned in the response.
my $offset = 56; # Integer | Skip over a number of elements by specifying an offset value for the query.
my $expandAll = true; # Boolean | Whether to return only basic properties or entire instance.
eval {
my $result = $api_instance->searchInstances(xOkapiTenant => $xOkapiTenant, query => $query, limit => $limit, offset => $offset, expandAll => $expandAll);
print Dumper($result);
};
if ($@) {
warn "Exception when calling SearchApi->searchInstances: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = openapi_client.SearchApi()
xOkapiTenant = xOkapiTenant_example # String | X-Okapi-Tenant header value (default to null)
query = query_example # String | A CQL query string
Instance search options
Option |
Type |
Example |
Description |
keyword |
full-text |
keyword all "web semantic" |
An alias for: title, alternativeTitles, indexTitle, series, identifiers.value, contributors.name |
id |
term |
id=="1234567" |
Matches instance with the id |
hrid |
term |
hrid=="hr1*0" |
Matches instances with given HRID |
source |
term |
source=="MARC" |
Matches instances with given source (FOLIO/MARC) |
title |
full-text |
title all "semantic web" |
Matches instances with the given title, searches against title, alternativeTitles,
indexTitle, series fields
|
alternativeTitles.alternativeTitle |
full-text |
alternativeTitles.alternativeTitle all "semantic web" |
Matches instances with the given alternative title |
uniformTitle |
full-text |
uniformTitle all "semantic web" |
Matches instances with the given uniform title |
indexTitle |
full-text |
indexTitle all "semantic web" |
Matches instances with the given index title |
series |
full-text |
series all "series" |
Matches instance with given series value |
identifiers.value |
term |
identifiers.value = "1023*" |
Matches instances with the given identifier value |
identifiers.identifierTypeId |
term |
identifiers.identifierTypeId=="123" identifiers.value = "1023*"
|
Matches instances that have an identifier of type 123 and ANY
identifier with value 1023*
|
contributors |
full-text |
contributors all "John" |
Matches instances that have a John contributor |
contributors.name |
term |
contributors.name all "John" |
Matches instances that have a primary John contributor |
contributors.contributorTypeId |
term |
contributors.contributorTypeId all "1234567" |
Matches instances that have a contributor type Id 1234567 |
contributors.contributorNameTypeId |
term |
contributors.contributorNameTypeId all "1234567" |
Matches instances that have a contributor name type Id 1234567 |
contributors.primary |
term |
contributors all "John" and contributors.primary==true |
Matches instances that have a primary John contributor |
contributors.authorityId |
term |
contributors.authorityId ==
"81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
authorityId |
term |
authorityId == "81ae0f60-f2bc-450c-84c8-5a21096daed9" |
Matches instances that have a contributor authorityId 81ae0f60-f2bc-450c-84c8-5a21096daed9
|
subjects |
full-text |
subjects all "Chemistry" |
Matches instances that have a Chemistry subject |
instanceTypeId |
term |
instanceTypeId == "123" |
Matches instances with the 123 type |
statusId |
term |
statusId == "123" |
Matches instances with the 123 status |
instanceFormatIds |
term |
instanceFormatIds == "123" |
Matches instances with the 123 format id |
languages |
term |
languages == "eng" |
Matches instances that have eng language |
metadata.createdDate |
term |
metadata.createdDate > "2021-03-01T00:00:00.000+00:00"
|
Matches instances that were created after 2020-12-12 |
metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances that were updated after 2020-12-12 |
modeOfIssuanceId |
term |
modeOfIssuanceId=="123" |
Matches instances that have 123 mode of issuance |
natureOfContentTermIds |
term |
natureOfContentTermIds=="123" |
Matches instances that have 123 nature of content |
publisher |
full-text |
publisher all "Publisher of Ukraine" |
Matches instances that have Publisher of Ukraine publisher |
publication.place |
full-text |
publication.place all "Ukraine" |
Matches instances that have `Ukraine` in publication place |
instanceTags |
term |
instanceTags=="important" |
Matches instances that have important tag |
classifications.classificationNumber |
term |
classifications.classificationNumber=="cl1" |
Matches instances that have cl1 classification number |
classifications.classificationTypeId |
term |
classifications.classificationTypeId == "123" |
Matches instances that have classification type id 123 |
electronicAccess |
full-text |
electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
electronicAccess.uri |
term |
electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
electronicAccess.linkText |
full-text |
electronicAccess.linkText="Folio website" |
Search by electronic access link text |
electronicAccess.publicNote |
full-text |
electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
electronicAccess.relationshipId |
term |
electronicAccess.relationshipId="47d563ed-1ae2-41dc-97f8-8ebefce904f0" |
Search by electronic access relationship type ID |
staffSuppress |
term |
staffSuppress==true |
Matches instances that are staff suppressed |
discoverySuppress |
term |
discoverySuppress==true |
Matches instances that are suppressed from discovery |
publicNotes |
full-text |
publicNotes all "public note" |
Matches instances that have a public note (i.e. note.staffOnly is
false)
|
administrativeNotes |
full-text |
administrativeNotes all "librarian note" |
Search by administrative notes |
notes.note |
full-text |
notes.note all "librarian note" |
Search by instance notes (include staffOnly) |
isbn |
term |
isbn="1234*" |
Matches instances that have an ISBN identifier with the given value |
issn |
term |
issn="1234*" |
Matches instances that have an ISSN identifier with the given value |
oclc |
term |
oclc="1234*" |
Matches instances that have an OCLC identifier with the given value |
lccn |
term |
lccn = "LCCN" |
Matches instances with the given lccn |
normalizedClassificationNumber |
term |
normalizedClassificationNumber == "LCCN" |
Matches instances with the given classification number (normalizes case,
whitespaces, special characters, supports leading and trailing wildcard)
|
normalizedDate1 |
term |
normalizedDate1>=1990 |
Matches instances with the given Date1 (normalizes alpha u characters) |
classificationId |
term |
classificationId = "c4f60d7413158e9466856f4c0250d91d312f86cf" |
Matches instances with the given classificationId |
Holdings search options
Option |
Type |
Example |
Description |
holdings.id |
term |
holdings.id=="1234567" |
Matches instances that have a holding with the id |
holdings.sourceId |
term |
holdings.sourceId=="FOLIO" |
Matches instances that have a holding with the source FOLIO |
holdings.holdingsTypeId |
term |
holdings.holdingsTypeId=="1234567" |
Matches instances that have a holding with the holdings type id 1234567
|
holdings.permanentLocationId |
term |
holdings.permanentLocationId=="123765" |
Matches instances that have holdings with given statisticalCodeId |
holdings.statisticalCodeIds |
term |
holdings.statisticalCodeIds=="123765" |
Matches instances that have holdings with given permanentLocationId |
holdings.discoverySuppress |
term |
holdings.discoverySuppress==true |
Matches instances that have holdings suppressed/not suppressed from discovery |
holdings.hrid |
term |
holdings.hrid=="hr10*3" |
Matches instances that have a holding with given HRID |
holdingsTags |
term |
holdingsTags=="important" |
Matches instances that have holdings with given tags |
holdingsFullCallNumbers |
term |
holdingsFullCallNumbers="cn*434" |
Matches instances that have holdings with given call number string (prefix + call
number + suffix)
|
holdingsNormalizedCallNumbers |
term |
holdingsNormalizedCallNumbers="cn434" |
Matches instances that have holdings with given call number and might not be
formatted correctly
|
holdings.electronicAccess |
full-text |
holdings.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
holdings.electronicAccess.uri |
term |
holdings.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
holdings.electronicAccess.linkText |
full-text |
holdings.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
holdings.electronicAccess.publicNote |
full-text |
holdings.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
holdings.electronicAccess.relationshipId |
term |
holdings.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by holdings electronic access relationship type ID |
holdings.administrativeNotes |
full-text |
holdings.administrativeNotes all "librarian note" |
Search by holdings administrative notes |
holdings.notes.note |
full-text |
holdings.notes.note all "librarian note" |
Search by holdings notes |
holdingsTypeId |
term |
holdingsTypeId=="123" |
Search by holdings type id |
holdingsPublicNotes |
full-text |
holdingsPublicNotes all "public note" |
Search by holdings public notes |
holdingsIdentifiers |
term |
holdingsIdentifiers == "ho00000000006" |
Search by holdings Identifiers: holdings.id, holdings.hrid,
holdings.formerIds
|
holdings.metadata.createdDate |
term |
metadata.createdDate > "2020-12-12" |
Matches instances with holdings that were created after 2020-12-12 |
holdings.metadata.updatedDate |
term |
metadata.updatedDate > "2020-12-12" |
Matches instances with holdings that were updated after 2020-12-12 |
Item search options
Option |
Type |
Example |
Description |
item.id |
term |
item.id=="1234567" |
Matches instances that have an item with the id |
item.hrid |
term |
item.hrid=="it001" |
Matches instances that have an item with the HRID |
item.barcode |
term |
item.barcode=="10011" |
Matches instances that have an item with the barcode |
item.effectiveLocationId |
term |
item.effectiveLocationId=="1212" |
Matches instances that have item with the effective location |
item.statisticalCodeIds |
term |
item.statisticalCodeIds=="1212" |
Matches instances that have item with the statistical code Id |
item.status.name |
term |
item.status.name=="Available" |
Matches instances that have item with given status |
item.materialTypeId |
term |
item.materialTypeId="23434" |
Matches instances that have item with given material type |
item.discoverySuppress |
term |
item.discoverySuppress=true |
Matches instances that have item suppressed/not suppressed from discovery |
itemFullCallNumbers |
term |
itemFullCallNumbers="cn*434" |
Matches instances that have item with given call number string (prefix + call number
+ suffix)
|
itemNormalizedCallNumbers |
term |
itemNormalizedCallNumbers="cn434" |
Matches instances that have item with given call number and might not be formatted
correctly
|
itemLevelCallNumberTypeId |
term |
itemLevelCallNumberTypeId="81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Matches instances that have item with given call number type id |
itemTags |
term |
itemTags="important" |
Matches instances that have item with given tag |
item.electronicAccess |
full-text |
item.electronicAccess any "resource" |
An alias for electronicAccess fields - uri, linkText, publicNote
|
item.electronicAccess.uri |
term |
item.electronicAccess.uri="http://folio.org*" |
Search by electronic access URI |
item.electronicAccess.linkText |
full-text |
item.electronicAccess.linkText="Folio website" |
Search by electronic access link text |
item.electronicAccess.publicNote |
full-text |
item.electronicAccess.publicNote="a rare book" |
Search by electronic access public note |
item.electronicAccess.relationshipId |
term |
item.electronicAccess.relationshipId="0b460e53-aee9-41a8-a447-0755cdac22ca" |
Search by item electronic access relationship type ID |
item.administrativeNotes |
full-text |
item.administrativeNotes all "librarian note" |
Search by item administrative notes |
item.notes.note |
full-text |
item.notes.note all "librarian note" |
Search by item notes and circulation notes |
item.circulationNotes.note |
full-text |
item.circulationNotes.note all "circulation note" |
Search by item circulation notes |
itemPublicNotes |
full-text |
itemPublicNotes all "public note" |
Search by item public notes and circulation notes |
itemIdentifiers |
term |
itemIdentifiers all "81ae0f60-f2bc-450c-84c8-5a21096daed9"
|
Search by item Identifiers: item.id, item.hrid, item.formerIds,
item.accessionNumber, item.itemIdentifier
|
item.metadata.createdDate |
term |
item.metadata.createdDate > "2020-12-12" |
Matches instances with item that were created after 2020-12-12 |
item.metadata.updatedDate |
term |
item.metadata.updatedDate > "2020-12-12" |
Matches instances with item that were updated after 2020-12-12 |
callNumberType |
term |
callNumberType = "lc" |
Matches instances with item that has call number with type Library of Congress classification. Supported values: lc, dewey, nlm, sudoc, other, local. |
(default to null)
limit = 56 # Integer | Limit the number of elements returned in the response. (optional) (default to 100)
offset = 56 # Integer | Skip over a number of elements by specifying an offset value for the query. (optional) (default to 0)
expandAll = true # Boolean | Whether to return only basic properties or entire instance. (optional) (default to false)
try:
# Search Instances
api_response = api_instance.search_instances(xOkapiTenant, query, limit=limit, offset=offset, expandAll=expandAll)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->searchInstances: %s\n" % e)
extern crate SearchApi;
pub fn main() {
let xOkapiTenant = xOkapiTenant_example; // String
let query = query_example; // String
let limit = 56; // Integer
let offset = 56; // Integer
let expandAll = true; // Boolean
let mut context = SearchApi::Context::default();
let result = client.searchInstances(xOkapiTenant, query, limit, offset, expandAll, &context).wait();
println!("{:?}", result);
}