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 classificationScheme API

The classificationScheme API from Queen's University Belfast — 7 operation(s) for classificationscheme.

Queen’s University Belfast classificationScheme 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 classificationScheme. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 7 paths, and defines 17 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.

10 operations 7 paths 17 schemas 1 DELETE5 GET2 POST2 PUT

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 classificationScheme 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 10

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

classificationScheme 10
GET
/classification-schemes
Lists all classification schemes
classificationScheme_list 3 params → 200
PUT
/classification-schemes
Create classification scheme
classificationScheme_create body → 201400
GET
/classification-schemes/allowed-associated-schemes
A list of allowed associated schemes classifications
classificationScheme_getAllowedAssociatedSchemesClassifications → 200
GET
/classification-schemes/allowed-locales
A list of allowed locales in localized strings
classificationScheme_getAllowedLocales → 200
GET
/classification-schemes/allowed-type-classifications
A list of allowed types of classification schemes
classificationScheme_getAllowedTypeClassifications → 200
GET
/classification-schemes/{uuid}
Get classification scheme
classificationScheme_get 1 param → 200301404
PUT
/classification-schemes/{uuid}
Update classification scheme
classificationScheme_update 1 param body → 200400404409
DELETE
/classification-schemes/{uuid}
Delete classification scheme
classificationScheme_delete 1 param → 204404409
POST
/classification-schemes/{uuid}/actions/lock
Lock the content
classificationScheme_lock 1 param → 204404409
POST
/classification-schemes/{uuid}/actions/unlock
Unlock the content
classificationScheme_unlock 1 param → 204404409

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ClassificationScheme (17 properties), ConflictProblemDetails (7 properties), Classification (6 properties), ProblemDetails (5 properties). Each schema is shown below with its type and property counts.

Identifier
object
1 property 1 required
LocalesList
object
List of available locales
1 property
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
ClassificationRelation
object
Relation between classifications
3 properties
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
PageInformation
object
Information about pages
2 properties
ClassificationSchemeRelation
object
Association between classification schemes
4 properties
ClassificationScheme
object
A classification scheme.
17 properties
ClassificationRefList
object
List of classification references
1 property
ClassificationRef
object
A reference to a classification value
2 properties 1 required
ProblemDetails
object
RFC7807 Error details
5 properties
ContentRef
object
2 properties 2 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
ClassificationSchemeList
object
List of classification schemes
3 properties
Classification
object
A way to annotate another object with a type/role/etc.
6 properties 1 required
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-classificationscheme-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 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
Queen's University Belfast equipment API