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

Hong Kong Baptist University keywordGroupConfiguration API

The keywordGroupConfiguration API from Hong Kong Baptist University — 7 operation(s) for keywordgroupconfiguration.

Hong Kong Baptist University keywordGroupConfiguration API is one of 34 APIs that Hong Kong Baptist University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include keywordGroupConfiguration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 10 operations across 7 paths, and defines 12 schemas. It is described by OpenAPI 3.0.1, at version 5.35.0.

Requests are made against a single base URL, https://scholars.hkbu.edu.hk/ws/api.

10 operations 7 paths 12 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.0
Base URL
https://scholars.hkbu.edu.hk/ws/api/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hong Kong Baptist University 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_1 3 params → 200
PUT
/keyword-group-configurations
Create keyword group configuration
keywordGroupConfiguration_create_1 body → 201400
GET
/keyword-group-configurations/allowed-locales
A list of allowed locales in localized strings
keywordGroupConfiguration_getAllowedLocales_1 → 200
GET
/keyword-group-configurations/allowed-relation-types
A map of allowed relation types
keywordGroupConfiguration_getAllowedRelationTypes_1 → 200
GET
/keyword-group-configurations/allowed-target-system-names
A list of allowed target system names
keywordGroupConfiguration_getAllowedTargetSystemNames_1 → 200
GET
/keyword-group-configurations/{uuid}
Get keyword group configuration
keywordGroupConfiguration_get_1 1 param → 200301404
PUT
/keyword-group-configurations/{uuid}
Update keyword group configuration
keywordGroupConfiguration_update_1 1 param body → 200400404409
DELETE
/keyword-group-configurations/{uuid}
Delete keyword group configuration
keywordGroupConfiguration_delete_1 1 param → 204404409
POST
/keyword-group-configurations/{uuid}/actions/lock
Lock the content
keywordGroupConfiguration_lock_1 1 param → 204404409
POST
/keyword-group-configurations/{uuid}/actions/unlock
Unlock the content
keywordGroupConfiguration_unlock_1 1 param → 204404409

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are KeywordGroupConfiguration (27 properties), ConflictProblemDetails (7 properties), ProblemDetails (5 properties), KeywordGroupConfigurationList (3 properties). Each schema is shown below with its type and property counts.

APIStringListResult
object
2 properties
PageInformation
object
Information about pages
2 properties
ProblemDetails
object
RFC7807 Error details
5 properties
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
LocalesList
object
List of available locales
1 property
KeywordGroupConfigurationList
object
List of keyword group configurations
3 properties
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ContentRef
object
2 properties 2 required
KeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
27 properties 3 required
APIStringToStringListMapResult
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hong-kong-baptist-university-keywordgroupconfiguration-api-openapi.yml Raw ↑

Other APIs Hong Kong Baptist University publishes across the network.

HKBU Mobile App Backend (gated)
Hong Kong Baptist University activity API
Hong Kong Baptist University application API
Hong Kong Baptist University authorCollaboration API
Hong Kong Baptist University award API
Hong Kong Baptist University classificationScheme API
Hong Kong Baptist University concept API
Hong Kong Baptist University course API
Hong Kong Baptist University dataSet API
Hong Kong Baptist University education API
Hong Kong Baptist University equipment API
Hong Kong Baptist University ethicalReview API