Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Queen's University Belfast thesaurus API

The thesaurus API from Queen's University Belfast — 5 operation(s) for thesaurus.

Queen’s University Belfast thesaurus API is one of 38 APIs that Queen’s University Belfast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include thesaurus. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 5 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version 5.35.3-4.

Requests are made against a single base URL, https://pure.qub.ac.uk/ws/api.

5 operations 5 paths 9 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.35.3-4
Base URL
https://pureadmin.qub.ac.uk/ws/oai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Queen's University Belfast thesaurus API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

  • api-key — Security mechanism for the API

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

thesaurus 5
GET
/thesauri
Lists all thesauri
thesaurus_list 3 params → 200
GET
/thesauri/allowed-locales
A list of allowed locales in localized strings
thesaurus_getAllowedLocales → 200
GET
/thesauri/orderings
Lists available orderings
thesaurus_getOrderings → 200
POST
/thesauri/search
Query operation for thesauri
thesaurus_query body → 200400
GET
/thesauri/{uuid}
Get thesaurus
thesaurus_get 1 param → 200301404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Thesaurus (17 properties), ThesaurusQuery (6 properties), ProblemDetails (5 properties), ThesaurusListResult (3 properties). Each schema is shown below with its type and property counts.

Identifier
object
1 property 1 required
Thesaurus
object
A thesaurus
17 properties
LocalesList
object
List of available locales
1 property
PageInformation
object
Information about pages
2 properties
OrderingsList
object
List of available orderings
1 property
ThesaurusQuery
object
Create a query for thesauri
6 properties
ProblemDetails
object
RFC7807 Error details
5 properties
ThesaurusListResult
object
List of thesauri. Can contain a subset of all items along with the full count
3 properties
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

queens-university-belfast-thesaurus-api-openapi.yml Raw ↑

Other APIs Queen's University Belfast publishes across the network.

Queen's University Belfast Research Portal (Pure OAI-PMH)
Queen's University Belfast activity API
Queen's University Belfast application API
Queen's University Belfast authorCollaboration API
Queen's University Belfast award API
Queen's University Belfast classificationScheme API
Queen's University Belfast concept API
Queen's University Belfast conferenceSeries API
Queen's University Belfast contract API
Queen's University Belfast course API
Queen's University Belfast dataSet API
Queen's University Belfast education API