Hong Kong Baptist University equipment API
The equipment API from Hong Kong Baptist University — 26 operation(s) for equipment.
Hong Kong Baptist University equipment 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 equipment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 30 operations across 26 paths, and defines 54 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.
30 operations
26 paths
54 schemas
1 DELETE22 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University equipment 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 30
Across 26 paths, the API surfaces 30 operations — 1 DELETE, 22 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
equipment 30
GET
/equipment
Lists all equipment
PUT
/equipment
Create equipment
GET
/equipment/allowed-address-countries
A list of allowed address countries
GET
/equipment/allowed-address-subdivision
A list of allowed address subdivisions
GET
/equipment/allowed-address-types
A list of allowed address types
GET
/equipment/allowed-categories
A list of allowed categories
GET
/equipment/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/equipment/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the equipment
GET
/equipment/allowed-description-types
A list of allowed classifications for the descriptions property
GET
/equipment/allowed-email-types
A list of allowed e-mail types
GET
/equipment/allowed-image-types
A list of allowed image types
GET
/equipment/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/equipment/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/equipment/allowed-loan-types
A list of allowed loan types
GET
/equipment/allowed-locales
A list of allowed locales in localized strings
GET
/equipment/allowed-persons-roles
A list of allowed persons roles
GET
/equipment/allowed-phone-number-types
A list of allowed phone number types
GET
/equipment/allowed-types
A list of allowed equipment types
GET
/equipment/allowed-web-address-types
A list of allowed web address types
GET
/equipment/allowed-workflow-steps
A list of allowed workflow steps in localized strings
PUT
/equipment/file-uploads
Upload file to a specific equipment
POST
/equipment/search
Query operation for equipment
GET
/equipment/{uuid}
Get equipment
PUT
/equipment/{uuid}
Update equipment
DELETE
/equipment/{uuid}
Delete equipment
POST
/equipment/{uuid}/actions/lock
Lock the content
POST
/equipment/{uuid}/actions/unlock
Unlock the content
GET
/equipment/{uuid}/files/{fileId}
Get file from the equipment
GET
/equipment/{uuid}/notes
Lists notes
PUT
/equipment/{uuid}/notes
Create note
Schemas 54
The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are Equipment (42 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties), ClassifiedAddress (10 properties). Each schema is shown below with its type and property counts.
Note
object
A note
3 properties
1 required
EquipmentDataSetAssociation
object
An association to a dataset.
1 property
1 required
EquipmentDetails
object
Details about a piece of equipment
7 properties
1 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
ClassifiedValue
object
A classified value
3 properties
2 required
EquipmentListResult
object
List of equipment. Can contain a subset of all items along with the full count
3 properties
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ProjectRef
object
A reference to project
1 required
ClassificationRef
object
A reference to a classification value
2 properties
1 required
ClassificationRefList
object
List of classification references
1 property
EquipmentRef
object
A reference to a piece of equipment
1 required
KeywordGroup
object
4 properties
2 required
NoteListResult
object
List of notes
3 properties
OrganizationRef
object
A reference to an organization in the institution
1 required
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
2 properties
DataSetRef
object
A reference to a data set
1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ContentRef
object
2 properties
2 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
ImageFile
object
An image file
15 properties
2 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
ImpactRef
object
A reference to impact
1 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
PageInformation
object
Information about pages
2 properties
EquipmentQuery
object
Create a query for equipment
6 properties
EquipmentPrizeAssociation
object
An association to a prize.
1 property
1 required
EquipmentPressMediaAssociation
object
An association to a press media.
1 property
1 required
LocalesList
object
List of available locales
1 property
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
ActivityRef
object
A reference to an activity
1 required
ClassifiedAddress
object
A physical address
10 properties
1 required
UploadedFile
object
Information about the uploaded file
7 properties
1 required
Visibility
object
Visibility of an object
2 properties
1 required
PrizeRef
object
A reference to a prize
1 required
ClassifiedLocalizedValue
object
A classified localized value
3 properties
1 required
GeoLocation
object
Geographical location
3 properties
StudentThesisRef
object
A reference to student thesis
1 required
ProblemDetails
object
RFC7807 Error details
5 properties
Equipment
object
An equipment known to an institution
42 properties
7 required
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
AbstractEquipmentPersonAssociation
object
An association between equipment and a person
5 properties
1 required
SystemCurrencyAmount
object
A monetary value in the Pure installation's system currency as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/paymentcurr…
2 properties
1 required
ResearchOutputRef
object
A reference to a research output
1 required
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
Identifier
object
1 property
1 required
PersonRef
object
A reference to a person internal to the institution
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
PressMediaRef
object
A reference to a press/media
1 required
WorkflowListResult
object
List of workflow steps.
1 property
Workflow
object
Information about workflow
2 properties
1 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
EquipmentProjectAssociation
object
An association to a project.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hong Kong Baptist University 12
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 ethicalReview API
Hong Kong Baptist University event API
#equipment