Opensearch API

Component Types

The GOKB Opensearch API queries separate indices for several types of components. Specific types can be selected via the parameter componentType:

ComponentType	Index	Description
Package	packages	Package level metadata like provider, platform and descriptions of content
Org	orgs	Provider and publisher references
Platform	platforms	Platform information like provider, base URL and access info
TIPP	tipps	Package-specific title information like access URL, coverage and KBART identifiers
Title	titles	Package-agnostic title instance build from package info and externally referenced data
Book	titles	Subset of monographic reference titles
Journal	titles	Subset of serial reference titles
Database	titles	Subset of database reference titles

For more information concerning specific record fields, see Opensearch Record Mapping.

Endpoint for specific search: https://gokb.org/gokb/api/find?

General search parameters

Parameter	Value Range/Pattern	DB Equivalent
q	-	name+altname+suggest+ids (see 'qfields')
qfields	Specify fields to be searched via parameter q, e.g. primaryUrl for Platforms. Repeat parameter to provide a list of values.
name	-	name
altname	-	variantNames
label	-	name+variantNames
suggest	-	name (ngram search)
componentType	Package, Title, Journal, Book, Database, Platform, Org, TIPP	niceName
uuid	-	uuid
status	Current, Retired, Expected, Deleted (Repeatable)	status.value
identifier	{identifier value} or {namespace},{identifier value}	ids
id	{OID*}	logEntityId
changedSince	yyyy-MM-dd HH:mm:ss or yyyy-MM-dd	lastUpdated
changedBefore	yyyy-MM-dd HH:mm:ss or yyyy-MM-dd	lastUpdated

• OID: The Object ID consist of the class name of the object and its database ID, i.e.: org.gokb.cred.Org:12345

Component-specific parameters

Parameter	Value Range/Pattern	Component Type(s)	DB Equivalent
provider	{OID*}/{uuid}/{name}	Package	provider
publisher	{OID*}/{uuid}/{name}	TitleInstance/JournalInstance/BookInstance/DatabaseInstance	currentPublisher
listStatus	Checked, In Progress	Package	listStatus
contentType	Journal, Book, Database, Mixed	Package	contentType
primaryUrl	-	Platform	primaryUrl
linkedPackage/pkg	{OID*}/{uuid}/{name}	TIPP	pkg
linkedTitle/title	{OID*}/{uuid}/{name}	TIPP	title
importId	-	TIPP	importId
role	Content Provider, Platform Provider, Imprint, Publisher	Org	roles (name)
curatoryGroup	-	Package/Platform	curatoryGroups (name)
platform	{OID*}/{uuid}/{name}	TIPP/Package	hostPlatform/nominalPlatform

• OID: The Object ID consist of the class name of the object and its database ID, i.e.: org.gokb.cred.Org:12345

Result manipulation

Parameter	Value Range/Pattern
sort	name, lastUpdated
order	asc, desc

Endpoint for data dumps: https://gokb.org/gokb/api/scroll?

Search parameters

Parameter	Value Range/Pattern	DB Equivalent
componentType	Package, Title, Journal, Book, Database, Platform, Org, TIPP	niceName
status	Current, Retired, Expected, Deleted (Repeatable)	status.value
changedSince	yyyy-MM-dd HH:mm:ss or yyyy-MM-dd	lastUpdated
changedBefore	yyyy-MM-dd HH:mm:ss or yyyy-MM-dd	lastUpdated

As well as these general fields, all component-specific parameters may be used as well.

Result manipulation

Parameter	Value Range/Pattern
sort	name, lastUpdated
order	asc, desc