Search API (v2.1.0)

API for searching, browsing, and managing facets for various record types, including instances, holdings, and authorities. It also provides endpoints for configuring search and browse features, as well as managing the search index.

browse

Provides endpoints to browse records (e.g., instances, authorities) in alphabetical order by a specific field, such as call number, classification number, subject, or contributor.

Browse Call Numbers Deprecated

Provides list of instances for browsing by call number

query Parameters

query required	string A CQL query string with search conditions.
limit	integer [ 0 .. 100 ] Default: 100 Limit the number of elements returned in the browse response.
expandAll	boolean Default: false Whether to return only basic properties or entire instance.
highlightMatch	boolean Default: true Whether to highlight matched resource by query input or not.
precedingRecordsCount	integer [ 1 .. 100 ] Number of preceding records for browsing around and around-including queries
callNumberType	string (callNumberType) Enum: "lc" "dewey" "nlm" "sudoc" "other" "local" Type of call number

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"items": [{"fullCallNumber": "Bilingualism: a bibliography of 1000 references with special reference to Wales.",
"shelfKey": "Bilingualism: a bibliography of 1000 references with special reference to Wales.",
"isAnchor": true,
"totalRecords": 1,
"instance": {"id": "d20569a7-9bba-44dd-9ad5-6f8f1d24ee1f",
"title": "Bilingualism: a bibliography of 1000 references with special reference to Wales.",
"contributors": [{"name": "Eichhorst, Georg."
}
],
"publication": [{"publisher": "Duncker und Humblot",
"dateOfPublication": "1976"
}
],
"electronicAccess": [{"uri": "http://www.example.com"
}
],
"notes": [{"note": "Staff note"
}
],
"items": [{"barcode": "12345",
"notes": [{"note": "Staff note"
}
],
"electronicAccess": [{"uri": "http://www.example.com"
}
]
}
],
"holdings": [{"callNumber": "FS 124.44",
"notes": [{"note": "Staff note"
}
],
"electronicAccess": [{"uri": "http://www.example.com"
}
]
}
]
}
}
],
"prev": "string",
"next": "string",
"totalRecords": 1
}

Browse Instance Classifications

Provides list of classifications by classification number

path Parameters

browseOptionId

required

string (browseOptionType)

Enum: "all" "lc" "dewey"

Browse option type

query Parameters

query

required

string

Examples:

query=number >= "DT571.F84" or number < "DT571.F84" - Search for all classification numbers before and after "DT571.F84"
query=number >= "DT571.F84" - Search for all classification numbers after "DT571.F84"
query=number >= "DT571.F84" - Search for all classification numbers before "DT571.F84"
query=(number >= "DT571.F84" or number < "DT571.F84") and instances.shared==false - Search for local classification numbers before and after "DT571.F84"

A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is number. Filters support logic operators AND and OR. All filters should be combined in parentheses. Anchor will be included only if <= or >= are used in the query. Otherwise, the empty row will be added if highlightMatch is equal to true.

Supported filter options
Option	Data type	Supported operators	Description
instances.tenantId	string	==	Filter by tenant ID in consortium
instances.shared	boolean	==	Filter by shared/non-shared in consortium

limit

integer [ 0 .. 100 ]

Default: 100

Limit the number of elements returned in the browse response.

highlightMatch

boolean

Default: true

Whether to highlight matched resource by query input or not.

precedingRecordsCount

integer [ 1 .. 100 ]

Number of preceding records for browsing around and around-including queries

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"totalRecords": 2,
"prev": "QA76.73.C15",
"items": [{"classificationNumber": "QA76.73.C15",
"classificationTypeId": "5af5cb9d-063f-48ea-8148-7da3ecaafd7d",
"isAnchor": true,
"totalRecords": 10
},
{"classificationNumber": "TK5105.88815",
"classificationTypeId": "7e5684a9-c8c1-4c1e-85b9-d047f53eeb6d",
"isAnchor": false,
"totalRecords": 5
}
]
}

Browse Instance Subjects

Provides list of instances for browsing by subject

query Parameters

query

required

string

Examples:

query=value >= "Fantasy" or value < "Fantasy" - Search for all subject values before and after "Fantasy"
query=value >= "Fantasy" - Search for all subject values after "Fantasy"
query=value >= "Fantasy" - Search for all subject values before "Fantasy"
query=(value >= "Fantasy" or value < "Fantasy") and instances.shared==false - Search for local subject values before and after "Fantasy"

A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is value. Filters support logic operators AND and OR. All filters should be combined in parentheses. Anchor will be included only if <= or >= are used in the query. Otherwise, the empty row will be added if highlightMatch is equal to true.

Supported filter options
Option	Data type	Supported operators	Description
typeId	uuid	==	Filter by subject type
sourceId	uuid	==	Filter by subject source
instances.tenantId	string	==	Filter by tenant ID in consortium
instances.shared	boolean	==	Filter by shared/non-shared in consortium

limit

integer [ 0 .. 500 ]

Default: 100

Limit the number of elements returned in the response.

highlightMatch

boolean

Default: true

Whether to highlight matched resource by query input or not.

precedingRecordsCount

integer [ 1 .. 100 ]

Number of preceding records for browsing around and around-including queries

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"totalRecords": 10,
"prev": "Biology",
"next": "Physics",
"items": [{"value": "Biology",
"isAnchor": true,
"totalRecords": 5,
"authorityId": "d20569a7-9bba-44dd-9ad5-6f8f1d24ee1f"
},
{"value": "Chemistry",
"isAnchor": false,
"totalRecords": 5,
"authorityId": "11110000-fcf6-45cc-b6da-4420a61ef72c"
},
{"value": "Physics",
"isAnchor": false,
"totalRecords": 5,
"authorityId": "5fab345a-30a4-4aee-8667-1e33d4627ce9"
}
]
}

Browse Instance Contributors

Provides list of instances for browsing by contributor

query Parameters

query

required

string

Examples:

query=name >= "Abedi, Ali" or name < "Abedi, Ali" - Search for all contributor values before and after "Abedi, Ali"
query=name >= "Abedi, Ali" - Search for all contributor values after "Abedi, Ali"
query=name >= "Abedi, Ali" - Search for all contributor values before "Abedi, Ali"
query=(name >= "Abedi, Ali" or name < "Abedi, Ali") and instances.shared==false and contributorNameTypeId="b6993450-25c1-4c23-a1d1-98abb67fb506" - Search for local contributor values with name type id = "b6993450-25c1-4c23-a1d1-98abb67fb506" before and after "Abedi, Ali"

A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is name. Filters support logic operators AND and OR. All filters should be combined in parentheses. Anchor will be included only if <= or >= are used in the query. Otherwise, the empty row will be added if highlightMatch is equal to true.

Supported filter options
Option	Data type	Supported operators	Description
contributorNameTypeId	uuid	==	Filter by contributor name type
instances.tenantId	string	==	Filter by tenant ID in consortium
instances.shared	boolean	==	Filter by shared/non-shared in consortium

limit

integer [ 0 .. 500 ]

Default: 100

Limit the number of elements returned in the response.

highlightMatch

boolean

Default: true

Whether to highlight matched resource by query input or not.

precedingRecordsCount

integer [ 1 .. 100 ]

Number of preceding records for browsing around and around-including queries

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"totalRecords": 5,
"next": "Paul McCartney",
"items": [{"name": "Anthony Kiedis",
"contributorTypeId": ["2a165833-1673-493f-934b-f3d3c8fcb299"
],
"contributorNameTypeId": "e2ef4075-310a-4447-a231-712bf10cc985",
"authorityId": "7ff32633-cc49-4332-870a-b05e329d2a2d",
"isAnchor": false,
"totalRecords": 1
},
{"name": "Bon Jovi",
"contributorTypeId": ["2a165833-1673-493f-934b-f3d3c8fcb299",
"3ae36e29-e38f-457c-8fcf-1974a6cb63d3",
"653ffe66-aa3f-4f1c-a090-c42c4011ef40"
],
"contributorNameTypeId": "e2ef4075-310a-4447-a231-712bf10cc985",
"authorityId": "0a4c6d10-2161-4f64-aace-9e919489b6c9",
"isAnchor": false,
"totalRecords": 2
},
{"name": "John Lennon",
"isAnchor": true,
"totalRecords": 0
},
{"name": "Klaus Meine",
"contributorTypeId": ["2a165833-1673-493f-934b-f3d3c8fcb299",
"3ae36e29-e38f-457c-8fcf-1974a6cb63d3"
],
"contributorNameTypeId": "e2ef4075-310a-4447-a231-712bf10cc985",
"authorityId": "7ff32633-cc49-4332-870a-b05e329d2a2d",
"isAnchor": false,
"totalRecords": 2
},
{"name": "Paul McCartney",
"contributorTypeId": ["2a165833-1673-493f-934b-f3d3c8fcb299",
"3ae36e29-e38f-457c-8fcf-1974a6cb63d3"
],
"contributorNameTypeId": "e2ef4075-310a-4447-a231-712bf10cc985",
"authorityId": "0a4c6d10-2161-4f64-aace-9e919489b6c9",
"isAnchor": false,
"totalRecords": 2
}
]
}

Browse Authorities

Provides list of authorities by headingRef

query Parameters

query

required

string

Examples:

query=headingRef >= "Comic-Con" or headingRef < "Comic-Con" - Search for all authority headings before and after "Comic-Con"
query=headingRef >= "Comic-Con" - Search for all authority headings after "Comic-Con"
query=headingRef >= "Comic-Con" - Search for all authority headings before "Comic-Con"
query=(headingRef >= "Comic-Con" or headingRef < "Comic-Con") and authRefType==("Authorized" or "Auth/Ref") and headingType=="Personal Name" - Search for "Authorized" or "Auth/Ref" personal name authority headings before and after "Comic-Con"

A CQL query string with filter conditions must include anchor query with range conditions. Anchor field is headingRef. Filters support logic operators AND and OR. All filters should be combined in parentheses. Anchor will be included only if <= or >= are used in the query. Otherwise, the empty row will be added if highlightMatch is equal to true.

Supported filter options
Option	Data type	Supported operators	Description
tenantId	string	==	Filter by tenant ID in consortium
shared	boolean	==	Filter by shared/non-shared in consortium
sourceFileId	uuid	==	Filter by authority source file ID. `NULL` value to filter by non-specified.
headingType	string	==	Filter by heading type: `Personal Name`, `Corporate Name`, `Conference Name`, `Geographic Name`, `Uniform Title`, `Topical`, `Genre`
isTitleHeadingRef	boolean	==	Filter title/non-title heading
authRefType	boolean	==	Filter by reference type: `Authorized`, `Reference`, `Auth/Ref`
subjectHeadings	char	==	Filter by subject heading code
metadata.createdDate	date	==, >, <, <=, >=	Filter by authority create date
metadata.updatedDate	date	==, >, <, <=, >=	Filter by authority update date

expandAll

boolean

Default: false

Whether to return only basic properties or entire authority record.
Basic fields are:

id
tenantId
shared
headingType
authRefType
headingRef
sourceFileId
naturalId
numberOfTitles

highlightMatch

boolean

Default: true

Whether to highlight matched resource by query input or not.

precedingRecordsCount

integer [ 1 .. 100 ]

Number of preceding records for browsing around and around-including queries

limit

integer [ 0 .. 500 ]

Default: 100

Limit the number of elements returned in the response.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

Example

Browse response

{"totalRecords": 3,
"prev": "Adair, Thomas Montgomery, 1913-1988",
"next": "Leven, Mel",
"items": [{"headingRef": "Allen, Barbara",
"isAnchor": true
},
{"authority": {"id": "7c1fff0d-6c83-4ee9-b64b-2beb0d3b9bfd",
"tenantId": "diku",
"shared": false,
"headingType": "Personal Name",
"authRefType": "Reference",
"headingRef": "Allen, Barbara, 1906-1974",
"sourceFileId": "af045f2f-e851-4613-984c-4bc13430454a",
"naturalId": "n94088693",
"numberOfTitles": 2
},
"headingRef": "Allen, Barbara, 1906-1974"
}
]
}

config

Provides endpoints to configure search and browse features, such as enabling/disabling specific features or managing language settings.

Get Language Configurations

Get all supported languages

Responses

Response samples

200

Content type

application/json

{"languageConfigs": [{"code": "eng",
"languageAnalyzer": "eng-analyzer"
},
{"code": "ukr",
"languageAnalyzer": "ukr-analyzer"
}
],
"totalRecords": 2
}

Create Language Configuration

Save languages that will be used for analyzers

Request Body schema: application/json

code required	string[a-zA-Z]{3} An ISO-639-2/B compatible language code.
languageAnalyzer	string Custom elasticsearch analyzer for language.

Responses

Request samples

Payload

Content type

application/json

{"code": "eng",
"languageAnalyzer": "eng-analyzer"
}

Response samples

200
422

Content type

application/json

{"code": "eng",
"languageAnalyzer": "eng-analyzer"
}

Delete Language Configuration

Delete all supported languages

path Parameters

code

required

string[a-zA-Z]{3}

Language code

Responses

Update Language Configuration

Update language config settings

path Parameters

code

required

string[a-zA-Z]{3}

Language code

Request Body schema: application/json

code required	string[a-zA-Z]{3} An ISO-639-2/B compatible language code.
languageAnalyzer	string Custom elasticsearch analyzer for language.

Responses

Request samples

Payload

Content type

application/json

{"code": "eng",
"languageAnalyzer": "eng-analyzer"
}

Response samples

200
422

Content type

application/json

{"code": "eng",
"languageAnalyzer": "eng-analyzer"
}

Get Feature Configurations

Get all feature configurations per tenant

Responses

Response samples

200

Content type

application/json

{"features": [{"feature": "search.all.fields",
"enabled": false
}
],
"totalRecords": 1
}

Save Feature Configuration

Save feature configuration (enables or disables pre-defined optional search options)

Request Body schema: application/json

feature required	string (tenantConfiguredFeature) Enum: "search.all.fields" "browse.cn.intermediate.values" "browse.cn.intermediate.remove.duplicates" "browse.classifications" The feature name.
enabled required	boolean Action - enable or disable option

Responses

Request samples

Payload

Content type

application/json

{"feature": "search.all.fields",
"enabled": false
}

Response samples

200
400
422

Content type

application/json

{"feature": "search.all.fields",
"enabled": false
}

Delete Feature Configuration

Delete feature configuration by id

path Parameters

featureId

required

string

Enum: "search.all.fields" "browse.cn.intermediate.values" "browse.cn.intermediate.remove.duplicates" "browse.classifications"

Feature id (name)

Responses

Update Feature Configuration

Update feature configuration settings

path Parameters

featureId

required

string

Enum: "search.all.fields" "browse.cn.intermediate.values" "browse.cn.intermediate.remove.duplicates" "browse.classifications"

Feature id (name)

Request Body schema: application/json

feature required	string (tenantConfiguredFeature) Enum: "search.all.fields" "browse.cn.intermediate.values" "browse.cn.intermediate.remove.duplicates" "browse.classifications" The feature name.
enabled required	boolean Action - enable or disable option

Responses

Request samples

Payload

Content type

application/json

{"feature": "search.all.fields",
"enabled": false
}

Response samples

200
400
422

Content type

application/json

{"feature": "search.all.fields",
"enabled": false
}

Get Browse Configurations

Get all configurations for browse type

path Parameters

browseType

required

string (browseType)

Value: "instance-classification"

Browse feature type

Responses

Response samples

200

Content type

application/json

{"configs": [{"id": "all",
"shelvingAlgorithm": "default",
"typeIds": [ ]
},
{"id": "dewey",
"shelvingAlgorithm": "dewey",
"typeIds": [ ]
},
{"id": "lc",
"shelvingAlgorithm": "lc",
"typeIds": [ ]
}
],
"totalRecords": 3
}

Update Browse Configurations

Update configuration for browse type

path Parameters

browseType required	string (browseType) Value: "instance-classification" Browse feature type
browseOptionId required	string (browseOptionType) Enum: "all" "lc" "dewey" Browse option type

Request Body schema: application/json
required

id required	string (browseOptionType) Enum: "all" "lc" "dewey" Browse option type
shelvingAlgorithm required	string (shelvingOrderAlgorithmType) Enum: "lc" "dewey" "default" Shelving order algorithm
typeIds	Array of strings <uuid> [ items <uuid > ] Type IDs that should be used by the option

Responses

Request samples

Payload

Content type

application/json

{"id": "all",
"shelvingAlgorithm": "default",
"typeIds": ["7e5684a9-c8c1-4c1e-85b9-d047f53eeb6d",
"1faf5a71-01cc-4f14-82e8-38e26b6e3071"
]
}

Response samples

400
422

Content type

application/json

{"errors": [{"message": "must not be null",
"type": "MethodArgumentNotValidException",
"code": "validation_error",
"parameters": [{"key": "parameter",
"value": "null"
}
]
}
],
"total_records": 1
}

facets

Provides endpoints to retrieve aggregated information (facets) about records, such as counts of records by specific fields or ranges of values. This can be used for faceted search or browsing.

Get Facets

Provides list of facets for the record type

path Parameters

recordType

required

string (recordType)

Enum: "instances" "authorities" "contributors" "subjects" "classifications"

Type of record to get facets for.

query Parameters

query required	string A CQL query string with search conditions.
facet required	Array of strings List of facet names.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"facets": {"source": {"values": [{"id": "MARC",
"totalRecords": 20
},
{"id": "FOLIO",
"totalRecords": 10
}
],
"totalRecords": 2
}
},
"totalRecords": 1
}

index-management

Provides endpoints to manage the search index, including creating or updating mappings, settings, and manually populating the index with records from external sources (e.g., inventory).

Create Index

Creates indices for passed resource name and tenant id in request header.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Request Body schema: application/json

resourceName

required

string

Name of resource

Responses

Request samples

Payload

Content type

application/json

{"resourceName": "instance"
}

Response samples

200
400
500

Content type

application/json

{"errorMessage": "Failed to update index settings",
"status": "error"
}

Create Index Mappings

Creates mappings for passed resource name and tenant id in request header.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Request Body schema: application/json

resourceName

required

string

Name of resource

Responses

Request samples

Payload

Content type

application/json

{"resourceName": "authority"
}

Response samples

200
500

Content type

application/json

{"errorMessage": "Failed to update index settings",
"status": "error"
}

Index Records

Indexes the records into elasticsearch.

Request Body schema: application/json

Array

id	string Resource id
type	string (resourceEventType) Enum: "UPDATE" "CREATE" "DELETE" "REINDEX" "DELETE_ALL" Resource event operation type - one of [update, create, delete, delete_all, reindex]
deleteEventSubType	string (resourceDeleteEventSubType) Enum: "SOFT_DELETE" "HARD_DELETE" Resource event delete operation type - one of [soft-delete, hard-delete]
tenant	string Tenant id
resourceName	string Name of resource
new	object Instance record new fields
old	object Instance record old fields

Responses

Request samples

Payload

Content type

application/json

[{"resourceName": "instance",
"type": "CREATE",
"tenant": "diku",
"new": {"id": "83249565-16a8-4687-9061-fd1de43d7f34",
"hrid": "in869",
"title": "Kunstschätze aus badischen Schlössern :Meersburg, Rastatt, Favorite, Bruchsal, Heidelberg, Schwetzingen : 9. Juli bis 12. Oktober 1968, Ausstellung im Gartensaal des Karlsruher Schlosses /Badisches Landesmuseum Karlsruhe ; [Gesamtgestaltung und Redaktion, Ernst Petrasch].",
"source": "MARC",
"editions": ["2. Aufl."
],
"metadata": {"createdDate": "1974-12-03T00:00:00",
"updatedDate": "2018-10-15T13:25:11Z"
},
"statusId": "7cc3837e-c4f1-4584-a3ae-b0c0bfce4bb2",
"subjects": ["Art--Germany--Exhibitions.",
"Castles--Germany--Exhibitions.",
"Art, Modern.",
"Exhibition catalogs."
],
"languages": ["ger"
],
"indexTitle": "Kunstschätze aus badischen Schlössern :Meersburg, Rastatt, Favorite, Bruchsal, Heidelberg, Schwetzingen : 9. Juli bis 12. Oktober 1968, Ausstellung im Gartensaal des Karlsruher Schlosses /Badisches Landesmuseum Karlsruhe ; [Gesamtgestaltung und Redaktion, Ernst Petrasch].",
"identifiers": [{"value": "(ICU)BID10243",
"identifierTypeId": "2baf4cec-6abf-438b-abd0-a6c512c3c173"
},
{"value": "(OCoLC)26620653",
"identifierTypeId": "01ca9cda-7027-4d64-abed-9e3c4943daf2"
}
],
"publication": [{"place": {"Karlsruhe": null
},
"publisher": "The Museum",
"dateOfPublication": "1968"
}
],
"contributors": [{"name": "Badisches Landesmuseum Karlsruhe",
"primary": true,
"contributorNameTypeId": "2b4007a7-2d96-4262-a360-c9f760e355c3"
},
{"name": "Petrasch, Ernst",
"primary": false,
"contributorNameTypeId": "35b01201-597f-4938-a0d1-110245ba9d67"
}
],
"instanceTypeId": "1c43b4c1-b138-4386-a91d-0d305e4ddf23",
"modeOfIssuanceId": "7b143a6c-84e8-4168-94b1-24220a3d14cc",
"discoverySuppress": false,
"statusUpdatedDate": "2019-12-18T20:46:50Z",
"physicalDescriptions": [{"46 p.": "ill. ; 21 cm."
}
]
}
}
]

Response samples

200
500

Content type

application/json

Example

successResponse

{"status": "success"
}

Update Index Settings

Update Index Dynamic Settings data.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Request Body schema: application/json

resourceName

required

string

Resource name to set index Settings

object (indexDynamicSettings)

Elasticsearch/Opensearch index dynamic settings

numberOfReplicas	integer [ 1 .. 100 ] The number of replicas each primary shard has.
refreshInterval	integer [ -1 .. 3600 ] How often to make new changes to the index visible to search (seconds). '-1' disables refresh.

Responses

Request samples

Payload

Content type

application/json

{"resourceName": "instance",
"indexSettings": {"numberOfReplicas": 4,
"refreshInterval": -1
}
}

Response samples

200
500

Content type

application/json

{"errorMessage": "Failed to update index settings",
"status": "error"
}

Re-Index

Initiates reindex for the inventory records

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Request Body schema: application/json
required

recreateIndex

boolean

Default: false

Boolean parameter, if set to true - tenant index must be recreated before reindex operation

resourceName

required

string

Enum: "authority" "location" "linked-data-instance" "linked-data-work" "linked-data-hub"

Resource name to run reindex for

object (indexSettings)

Elasticsearch/Opensearch index settings

numberOfShards	integer [ 1 .. 100 ] The number of primary shards that an index should have.
numberOfReplicas	integer [ 1 .. 100 ] The number of replicas each primary shard has.
refreshInterval	integer [ -1 .. 3600 ] How often to make new changes to the index visible to search (seconds). '-1' disables refresh.

Responses

Request samples

Payload

Content type

application/json

{"recreateIndex": true,
"resourceName": "authority"
}

Response samples

200
500

Content type

application/json

{"id": "68ec4438-8b93-46df-8c36-232db4f7862e",
"jobStatus": "In progress",
"submittedDate": "2024-12-05T10:22:22"
}

Get Reindex Status

Get a list of statuses for each resource reindexing

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

[{"entityType": "instance",
"status": "Upload Completed",
"totalMergeRanges": 3,
"processedMergeRanges": 3,
"totalUploadRanges": 2,
"processedUploadRanges": 2,
"startTimeMerge": "2024-04-01T01:37:34.15755006Z",
"endTimeMerge": "2024-04-01T01:37:35.15755006Z",
"startTimeUpload": "2024-04-01T01:37:36.15755006Z",
"endTimeUpload": "2024-04-01T01:37:37.15755006Z"
},
{"entityType": "item",
"status": "Merge In Progress",
"totalMergeRanges": 3,
"processedMergeRanges": 2,
"startTimeMerge": "2024-04-01T01:37:34.15755006Z"
},
{"entityType": "contributor",
"status": "Upload Completed",
"totalUploadRanges": 3,
"processedUploadRanges": 3,
"startTimeUpload": "2024-04-01T01:37:34.15755006Z",
"endTimeUpload": "2024-04-01T01:37:35.15755006Z"
},
{"entityType": "classification",
"status": "Upload Failed",
"totalUploadRanges": 2,
"processedUploadRanges": 1,
"startTimeUpload": "2024-04-01T01:37:36.15755006Z",
"endTimeUpload": "2024-04-01T01:37:37.15755006Z"
}
]

Re-Index

Initiates the full reindex for the inventory instance records

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Request Body schema: application/json

numberOfShards	integer [ 1 .. 100 ] The number of primary shards that an index should have.
numberOfReplicas	integer [ 1 .. 100 ] The number of replicas each primary shard has.
refreshInterval	integer [ -1 .. 3600 ] How often to make new changes to the index visible to search (seconds). '-1' disables refresh.

Responses

Request samples

Payload

Content type

application/json

{"numberOfShards": 1,
"numberOfReplicas": 1,
"refreshInterval": 1
}

Response samples

400
500

Content type

application/json

{"errors": [{"message": "must not be null",
"type": "MethodArgumentNotValidException",
"code": "validation_error",
"parameters": [{"key": "parameter",
"value": "null"
}
]
}
],
"total_records": 1
}

Upload Re-Index

Initiates reindex upload for inventory instance records

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Request Body schema: application/json

entityTypes

required

Array of objects non-empty

Items Enum: "instance" "subject" "contributor" "classification"

Entity name to run reindex upload

object (indexSettings)

Elasticsearch/Opensearch index settings

numberOfShards	integer [ 1 .. 100 ] The number of primary shards that an index should have.
numberOfReplicas	integer [ 1 .. 100 ] The number of replicas each primary shard has.
refreshInterval	integer [ -1 .. 3600 ] How often to make new changes to the index visible to search (seconds). '-1' disables refresh.

Responses

Request samples

Payload

Content type

application/json

{"entityTypes": ["instance",
"subject",
"contributor",
"classification"
]
}

Response samples

400
500

Content type

application/json

{"errors": [{"message": "must not be null",
"type": "MethodArgumentNotValidException",
"code": "validation_error",
"parameters": [{"key": "parameter",
"value": "null"
}
]
}
],
"total_records": 1
}

Failed Merge Ranges Re-Index

Initiates reindexing of failed merge ranges for inventory instance records

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

400
500

Content type

application/json

{"errors": [{"message": "must not be null",
"type": "MethodArgumentNotValidException",
"code": "validation_error",
"parameters": [{"key": "parameter",
"value": "null"
}
]
}
],
"total_records": 1
}

search

Provides endpoints to search for records (e.g., instances, authorities) using CQL (Contextual Query Language) queries. Supports various search options and retrieval of search results.

Search Instances

Get a list of instances for CQL query

query Parameters

query

required

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 all electronicAccess fields - uri, linkText, materialsSpecification, 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
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)

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 all electronicAccess fields - uri, linkText, materialsSpecification, 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.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 all electronicAccess fields - uri, linkText, materialsSpecification, publicNote
item.effectiveShelvingOrder	term	item.effectiveShelvingOrder="A 12"	Matches instances that have item with given effectiveShelvingOrder value
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.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

integer [ 0 .. 500 ]

Default: 100

Limit the number of elements returned in the response.

offset

integer [ 0 .. 9999 ]

Default: 0

Skip over a number of elements by specifying an offset value for the query.

expandAll

boolean

Default: false

Whether to return only basic properties or entire instance.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"instances": [{"id": "d20569a7-9bba-44dd-9ad5-6f8f1d24ee1f",
"tenantId": "tenant",
"shared": false,
"title": "Bilingualism: a bibliography of 1000 references with special reference to Wales.",
"contributors": [{"name": "Eichhorst, Georg.",
"contributorTypeId": "a",
"authorityId": "a",
"primary": true
}
],
"publication": [{"publisher": "Duncker und Humblot",
"dateOfPublication": "1976",
"place": "Karlsruhe"
}
],
"staffSuppress": false,
"discoverySuppress": false,
"isBoundWith": false,
"electronicAccess": [ ],
"notes": [ ],
"items": [ ],
"holdings": [ ]
}
],
"totalRecords": 1
}

Search Authorities

Get a list of authorities for CQL query

query Parameters

query required	string A CQL query string with search conditions.
limit	integer [ 0 .. 500 ] Default: 100 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.
expandAll	boolean Default: false Whether to return only basic properties or entire instance.
includeNumberOfTitles	boolean Default: true Whether to perform a search for a number of linked instances.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"totalRecords": 10,
"authorities": [{"id": "f866ae27-ec31-4eb4-8ade-89fe3d9625eb",
"tenantId": "diku",
"shared": false,
"headingType": "Personal Name",
"authRefType": "Authorized",
"headingRef": "Kerouac, Jack",
"numberOfTitles": 0,
"sourceFileId": "NULL",
"naturalId": "aat32"
},
{"id": "d16bc790-fa2a-4bae-9563-9796bc7bef3c",
"tenantId": "diku",
"shared": false,
"headingType": "Personal Name",
"authRefType": "Authorized",
"headingRef": "Roberts, Julia, 1967-",
"numberOfTitles": 1,
"sourceFileId": "af045f2f-e851-4613-984c-4bc13430454a",
"naturalId": "n910740801"
}
]
}

Search Linked Data Works

Get a list of linked data records for CQL query

query Parameters

query required	string A CQL query string with search conditions.
limit	integer [ 0 .. 100 ] Default: 10 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.
omitInstances	boolean Default: false Whether to omit instances from a Work search result set

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"searchQuery": "query string",
"content": [{"id": "1",
"titles": [{"value": "Title Value",
"type": "Main"
}
],
"contributors": [{"name": "John Doe",
"type": "Person",
"isCreator": true
}
],
"languages": ["eng"
],
"classifications": [{"number": "1234",
"source": "ddc"
}
],
"subjects": ["Subject"
],
"instances": [{"id": "2",
"titles": [{"value": "Title Value",
"type": "Main"
}
],
"identifiers": [{"value": "1234567890",
"type": "ISBN"
}
],
"contributors": [{"name": "John Doe",
"type": "Person",
"isCreator": true
}
],
"publications": [{"name": "Publisher Name",
"date": "2022"
}
],
"editionStatements": ["Edition 1"
]
}
]
}
],
"pageNumber": 0,
"totalPages": 10,
"totalRecords": 100
}

Search Linked Data Hubs

Get a list of linked data Hubs records for CQL query

query Parameters

query required	string A CQL query string with search conditions.
limit	integer [ 0 .. 100 ] Default: 10 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"searchQuery": "query string",
"content": [{"id": "1",
"originalId": "d292aac1-6f82-4828-93ae-c1b5cde1318a",
"hubAAP": "hub AAP",
"title": "hub title"
}
],
"pageNumber": 0,
"totalPages": 3,
"totalRecords": 27
}

Search Linked Data Instances

Get a list of linked data records for CQL query

query Parameters

query required	string A CQL query string with search conditions.
limit	integer [ 0 .. 100 ] Default: 10 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"searchQuery": "query string",
"content": [{"id": "1",
"titles": [{"value": "Title Value",
"type": "Main"
}
],
"contributors": [{"name": "John Doe",
"type": "Person",
"isCreator": true
}
],
"languages": ["eng"
],
"classifications": [{"number": "1234",
"source": "ddc"
}
],
"subjects": ["Subject"
],
"identifiers": [{"value": "1234567890",
"type": "ISBN"
}
],
"publications": [{"name": "Publisher Name",
"date": "2022"
}
],
"editionStatements": ["Edition 1"
]
}
],
"pageNumber": 0,
"totalPages": 10,
"totalRecords": 100
}

search-consortium

Provides endpoints to search for consolidated records (e.g., holdings, items) across multiple institutions or libraries within a consortium.

Get Consolidated Holdings

Get a list of holdings (only for consortium environment)

query Parameters

instanceId	string UUID of the instance
tenantId	string Tenant ID to filter by
limit	integer [ 0 .. 1000 ] Default: 100 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.
sortBy	string Defines a field to sort by. Possible values: id hrid tenantId instanceId callNumberPrefix callNumber copyNumber permanentLocationId
sortOrder	string (sortOrder) Enum: "asc" "desc" Defines sorting order

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"holdings": [{"id": "68ec4438-8b93-46df-8c36-232db4f7862e",
"hrid": "ho00231",
"tenantId": "college",
"instanceId": "1af42087-458d-4777-a797-a7717020ab18",
"discoverySuppress": false,
"callNumberPrefix": "int",
"callNumber": "MS 33.123",
"callNumberSuffix": "pro",
"copyNumber": "c10",
"permanentLocationId": "e18610eb-0842-4dac-bd6a-23e6ef962230"
},
{"id": "b6993450-25c1-4c23-a1d1-98abb67fb506",
"hrid": "ho00333",
"tenantId": "university",
"instanceId": "1af42087-458d-4777-a797-a7717020ab18",
"discoverySuppress": true,
"permanentLocationId": "e18610eb-0842-4dac-bd6a-23e6ef962230"
}
],
"totalRecords": 1203
}

Get Consolidated Items

Get a list of items (only for consortium environment)

query Parameters

instanceId	string UUID of the instance
holdingsRecordId	string UUID of the holdings record
tenantId	string Tenant ID to filter by
limit	integer [ 0 .. 1000 ] Default: 100 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.
sortBy	string Defines a field to sort by. Possible values: id hrid tenantId instanceId holdingsRecordId barcode
sortOrder	string (sortOrder) Enum: "asc" "desc" Defines sorting order

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"items": [{"id": "68ec4438-8b93-46df-8c36-232db4f7862e",
"hrid": "it00231",
"tenantId": "college",
"instanceId": "1af42087-458d-4777-a797-a7717020ab18",
"holdingsRecordId": "2ec87381-cfc6-4cd7-8368-9398410a64c4",
"barcode": "1233322"
},
{"id": "dab66210-5038-424a-a31e-cda18b4d4061",
"hrid": "it00033321",
"tenantId": "university",
"instanceId": "1af42087-458d-4777-a797-a7717020ab18",
"holdingsRecordId": "2ec87381-cfc6-4cd7-8368-9398410a64c4",
"barcode": "7873426"
}
],
"totalRecords": 1203
}

Get Consortium Locations

Get a list of locations (only for consortium environment)

query Parameters

tenantId	string Tenant ID to filter by
id	string ID to filter by
limit	integer [ 0 .. 10000 ] Default: 10000 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.
sortBy	string Default: "name" Defines a field to sort by. Possible values: id tenantId name
sortOrder	string (sortOrder) Enum: "asc" "desc" Defines sorting order

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"totalRecords": 0,
"locations": [{"metadata": {"createdByUserId": "createdByUserId",
"createdDate": "createdDate",
"updatedDate": "updatedDate",
"updatedByUserId": "updatedByUserId"
},
"code": "code",
"institutionId": "institutionId",
"discoveryDisplayName": "discoveryDisplayName",
"libraryId": "libraryId",
"campusId": "campusId",
"description": "description",
"isActive": "isActive",
"primaryServicePoint": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name": "name",
"tenantId": "tenantId",
"id": "id",
"servicePointIds": ["046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"046b6c7f-0b8a-43b9-b35d-6489e6daee91"
]
},
{"metadata": {"createdByUserId": "createdByUserId",
"createdDate": "createdDate",
"updatedDate": "updatedDate",
"updatedByUserId": "updatedByUserId"
},
"code": "code",
"institutionId": "institutionId",
"discoveryDisplayName": "discoveryDisplayName",
"libraryId": "libraryId",
"campusId": "campusId",
"description": "description",
"isActive": "isActive",
"primaryServicePoint": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name": "name",
"tenantId": "tenantId",
"id": "id",
"servicePointIds": ["046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"046b6c7f-0b8a-43b9-b35d-6489e6daee91"
]
}
]
}

Get Consortium Campuses

Get a list of campuses (only for consortium environment)

query Parameters

tenantId	string Tenant ID to filter by
id	string ID to filter by
limit	integer [ 0 .. 1000 ] Default: 1000 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.
sortBy	string Default: "name" Defines a field to sort by. Possible values: id tenantId institutionId name
sortOrder	string (sortOrder) Enum: "asc" "desc" Defines sorting order

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"totalRecords": 0,
"campuses": [{"metadata": {"createdByUserId": "createdByUserId",
"createdDate": "createdDate",
"updatedDate": "updatedDate",
"updatedByUserId": "updatedByUserId"
},
"code": "code",
"institutionId": "institutionId",
"tenantId": "tenantId",
"name": "name",
"id": "id"
},
{"metadata": {"createdByUserId": "createdByUserId",
"createdDate": "createdDate",
"updatedDate": "updatedDate",
"updatedByUserId": "updatedByUserId"
},
"code": "code",
"institutionId": "institutionId",
"tenantId": "tenantId",
"name": "name",
"id": "id"
}
]
}

Get Consortium Libraries

Get a list of libraries (only for consortium environment)

query Parameters

tenantId	string Tenant ID to filter by
id	string ID to filter by
limit	integer [ 0 .. 1000 ] Default: 1000 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.
sortBy	string Default: "name" Defines a field to sort by. Possible values: id tenantId campusId name
sortOrder	string (sortOrder) Enum: "asc" "desc" Defines sorting order

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"totalRecords": 0,
"libraries": [{"metadata": {"createdByUserId": "createdByUserId",
"createdDate": "createdDate",
"updatedDate": "updatedDate",
"updatedByUserId": "updatedByUserId"
},
"code": "code",
"tenantId": "tenantId",
"name": "name",
"campusId": "campusId",
"id": "id"
},
{"metadata": {"createdByUserId": "createdByUserId",
"createdDate": "createdDate",
"updatedDate": "updatedDate",
"updatedByUserId": "updatedByUserId"
},
"code": "code",
"tenantId": "tenantId",
"name": "name",
"campusId": "campusId",
"id": "id"
}
]
}

Get Consortium Institutions

Get a list of institutions (only for consortium environment)

query Parameters

tenantId	string Tenant ID to filter by
id	string ID to filter by
limit	integer [ 0 .. 1000 ] Default: 1000 Limit the number of elements returned in the response.
offset	integer [ 0 .. 9999 ] Default: 0 Skip over a number of elements by specifying an offset value for the query.
sortBy	string Default: "name" Defines a field to sort by. Possible values: id tenantId name
sortOrder	string (sortOrder) Enum: "asc" "desc" Defines sorting order

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"institutions": [{"metadata": {"createdByUserId": "createdByUserId",
"createdDate": "createdDate",
"updatedDate": "updatedDate",
"updatedByUserId": "updatedByUserId"
},
"code": "code",
"tenantId": "tenantId",
"name": "name",
"id": "id"
},
{"metadata": {"createdByUserId": "createdByUserId",
"createdDate": "createdDate",
"updatedDate": "updatedDate",
"updatedByUserId": "updatedByUserId"
},
"code": "code",
"tenantId": "tenantId",
"name": "name",
"id": "id"
}
],
"totalRecords": 0
}

Fetch Consolidated Items

Fetch a list of items (only for consortium environment)

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Request Body schema: application/json

identifierType required	string Enum: "id" "hrid" "accessionNumber" "formerIds" "barcode" "holdingsRecordId" "instanceId" "instanceHrid" "itemBarcode" Type of entity identifier
identifierValues required	Array of strings Entity identifier values

Responses

Request samples

Payload

Content type

application/json

{"identifierType": "id",
"identifierValues": ["string"
]
}

Response samples

200
400
500

Content type

application/json

{"items": [{"id": "68ec4438-8b93-46df-8c36-232db4f7862e",
"hrid": "it00231",
"tenantId": "college",
"instanceId": "1af42087-458d-4777-a797-a7717020ab18",
"holdingsRecordId": "2ec87381-cfc6-4cd7-8368-9398410a64c4",
"barcode": "1233322"
},
{"id": "dab66210-5038-424a-a31e-cda18b4d4061",
"hrid": "it00033321",
"tenantId": "university",
"instanceId": "1af42087-458d-4777-a797-a7717020ab18",
"holdingsRecordId": "2ec87381-cfc6-4cd7-8368-9398410a64c4",
"barcode": "7873426"
}
],
"totalRecords": 1203
}

Fetch Consolidated Holdings

Fetch a list of holdings (only for consortium environment)

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Request Body schema: application/json

identifierType required	string Enum: "id" "hrid" "accessionNumber" "formerIds" "barcode" "holdingsRecordId" "instanceId" "instanceHrid" "itemBarcode" Type of entity identifier
identifierValues required	Array of strings Entity identifier values

Responses

Request samples

Payload

Content type

application/json

{"identifierType": "id",
"identifierValues": ["string"
]
}

Response samples

200
400
500

Content type

application/json

{"holdings": [{"id": "68ec4438-8b93-46df-8c36-232db4f7862e",
"hrid": "ho00231",
"tenantId": "college",
"instanceId": "1af42087-458d-4777-a797-a7717020ab18",
"discoverySuppress": false,
"callNumberPrefix": "int",
"callNumber": "MS 33.123",
"callNumberSuffix": "pro",
"copyNumber": "c10",
"permanentLocationId": "e18610eb-0842-4dac-bd6a-23e6ef962230"
},
{"id": "b6993450-25c1-4c23-a1d1-98abb67fb506",
"hrid": "ho00333",
"tenantId": "university",
"instanceId": "1af42087-458d-4777-a797-a7717020ab18",
"discoverySuppress": true,
"permanentLocationId": "e18610eb-0842-4dac-bd6a-23e6ef962230"
}
],
"totalRecords": 1203
}

Fetch consolidated holding by id

Get holding by id (only for consortium environment)

path Parameters

id

required

string <uuid>

The UUID of a record

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"callNumberPrefix": "callNumberPrefix",
"instanceId": "instanceId",
"discoverySuppress": true,
"hrid": "hrid",
"callNumber": "callNumber",
"permanentLocationId": "permanentLocationId",
"tenantId": "tenantId",
"copyNumber": "copyNumber",
"callNumberSuffix": "callNumberSuffix",
"id": "id"
}

Fetch consolidated item by id

Get an item (only for consortium environment)

path Parameters

id

required

string <uuid>

The UUID of a record

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"instanceId": "instanceId",
"hrid": "hrid",
"tenantId": "tenantId",
"id": "id",
"holdingsRecordId": "holdingsRecordId",
"barcode": "barcode"
}

search-resources-ids

Provides endpoints to retrieve record IDs by CQL queries, without returning the full record data.

Get Instance IDs Deprecated

Get a list of instance ids for CQL query

query Parameters

query

required

string

A CQL query string with search conditions.

header Parameters

x-okapi-tenant required	string X-Okapi-Tenant header value
Content-Type	string Content-Type header value

Responses

Response samples

200
400
500

Content type

application/json

{"ids": [{"id": "e7e7f4a4-ff8e-48f4-ae8e-25770b7ab4b9"
},
{"id": "e60063f6-db50-4a2a-93f6-6b27ab0420f2"
},
{"id": "5fab345a-30a4-4aee-8667-1e33d4627ce9"
}
],
"totalRecords": 3
}

Get Holdings IDs Deprecated

Get a list of holding ids linked to instances found by the CQL query

query Parameters

query

required

string

A CQL query string with search conditions.

header Parameters

x-okapi-tenant required	string X-Okapi-Tenant header value
Content-Type	string Content-Type header value

Responses

Response samples

200
400
500

Content type

application/json

{"ids": [{"id": "dfb3afad-15c8-4243-9df1-81b12ebd6413"
},
{"id": "c95c7b5d-1fc2-4615-9c73-7034113d30fd"
},
{"id": "2d8abe4b-be87-441c-a163-c3876aa9717b"
}
],
"totalRecords": 3
}

Get Job

Get a job for the stream of resource ids.

path Parameters

jobId

required

string

UUID of the job to get

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"id": "eea1432c-beb8-4f4f-b96a-f8de977f1106",
"query": "title=*",
"status": "COMPLETED",
"entityType": "INSTANCE",
"createdDate": "1974-12-03T00:00:00"
}

Trigger new Job

Creates a job for the stream of resource ids.

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Request Body schema: application/json

id	string Unique ID for the job record.
query required	string CQL query for getting ids.
status	string Enum: "IN_PROGRESS" "ERROR" "COMPLETED" "DEPRECATED" Ids streaming status.
entityType required	string Enum: "INSTANCE" "AUTHORITY" "HOLDINGS" Type of entity for streaming ids.
createdDate	string Date and time when the record was created.

Responses

Request samples

Payload

Content type

application/json

{"query": "title=*",
"entityType": "INSTANCE"
}

Response samples

200
400
500

Content type

application/json

{"id": "eea1432c-beb8-4f4f-b96a-f8de977f1106",
"query": "title=*",
"status": "COMPLETED",
"entityType": "INSTANCE",
"createdDate": "1974-12-03T00:00:00"
}

Get Resource IDs

Get a list of resource ids by job id

path Parameters

jobId

required

string

UUID of the job to get

header Parameters

x-okapi-tenant

required

string

X-Okapi-Tenant header value

Responses

Response samples

200
400
500

Content type

application/json

{"ids": [{"id": "e7e7f4a4-ff8e-48f4-ae8e-25770b7ab4b9"
},
{"id": "e60063f6-db50-4a2a-93f6-6b27ab0420f2"
},
{"id": "5fab345a-30a4-4aee-8667-1e33d4627ce9"
}
],
"totalRecords": 3
}

Search API (v2.1.0)

browse

Browse Call Numbers Deprecated

query Parameters

header Parameters

Responses

Response samples

Browse Instance Classifications

path Parameters

query Parameters

header Parameters

Responses

Response samples

Browse Instance Subjects

query Parameters

header Parameters

Responses

Response samples

Browse Instance Contributors

query Parameters

header Parameters

Responses

Response samples

Browse Authorities

query Parameters

header Parameters

Responses

Response samples

config

Get Language Configurations

Responses

Response samples

Create Language Configuration

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Language Configuration

path Parameters

Responses

Update Language Configuration

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Feature Configurations

Responses

Response samples

Save Feature Configuration

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Feature Configuration

path Parameters

Responses

Update Feature Configuration

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Browse Configurations

path Parameters

Responses

Response samples

Update Browse Configurations

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

facets

Get Facets

path Parameters

query Parameters

header Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required