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

The keywordGroupConfiguration API from Queen's University Belfast — 7 operation(s) for keywordgroupconfiguration.

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

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

keywordGroupConfiguration 10
GET
/keyword-group-configurations
Lists all keyword group configurations
keywordGroupConfiguration_list 3 params → 200
PUT
/keyword-group-configurations
Create keyword group configuration
keywordGroupConfiguration_create body → 201400
GET
/keyword-group-configurations/allowed-locales
A list of allowed locales in localized strings
keywordGroupConfiguration_getAllowedLocales → 200
GET
/keyword-group-configurations/allowed-relation-types
A map of allowed relation types
keywordGroupConfiguration_getAllowedRelationTypes → 200
GET
/keyword-group-configurations/allowed-target-system-names
A list of allowed target system names
keywordGroupConfiguration_getAllowedTargetSystemNames → 200
GET
/keyword-group-configurations/{uuid}
Get keyword group configuration
keywordGroupConfiguration_get 1 param → 200301404
PUT
/keyword-group-configurations/{uuid}
Update keyword group configuration
keywordGroupConfiguration_update 1 param body → 200400404409
DELETE
/keyword-group-configurations/{uuid}
Delete keyword group configuration
keywordGroupConfiguration_delete 1 param → 204404409
POST
/keyword-group-configurations/{uuid}/actions/lock
Lock the content
keywordGroupConfiguration_lock 1 param → 204404409
POST
/keyword-group-configurations/{uuid}/actions/unlock
Unlock the content
keywordGroupConfiguration_unlock 1 param → 204404409

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are KeywordGroupConfiguration (28 properties), ConflictProblemDetails (7 properties), ProblemDetails (5 properties), KeywordGroupConfigurationList (3 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
KeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
28 properties 3 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
PageInformation
object
Information about pages
2 properties
APIStringToStringListMapResult
object
2 properties
ContentRef
object
2 properties 2 required
ProblemDetails
object
RFC7807 Error details
5 properties
KeywordGroupConfigurationList
object
List of keyword group configurations
3 properties
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
APIStringListResult
object
2 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-keywordgroupconfiguration-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