Hong Kong Baptist University activity API
The activity API from Hong Kong Baptist University — 38 operation(s) for activity.
Hong Kong Baptist University activity 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 activity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 43 operations across 38 paths, and defines 58 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.
43 operations
38 paths
58 schemas
1 DELETE33 GET4 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University activity 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 43
Across 38 paths, the API surfaces 43 operations — 1 DELETE, 33 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
activity 43
GET
/activities
Lists all activities
PUT
/activities
Create activity
GET
/activities/allowed-attendance-person-roles
A list of allowed attendance activity person roles
GET
/activities/allowed-categories
A list of allowed categories
GET
/activities/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/activities/allowed-consultancy-person-roles
A list of allowed consultancy activity person roles
GET
/activities/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the activity
GET
/activities/allowed-degree-of-recognitions
A list of allowed degree of recognitions
GET
/activities/allowed-description-types
A list of allowed description types
GET
/activities/allowed-document-licenses
A list of allowed document licenses
GET
/activities/allowed-document-types
A list of allowed document types
GET
/activities/allowed-editorial-work-person-roles
A list of allowed editorial-work activity person roles
GET
/activities/allowed-examination-person-roles
A list of allowed examination activity person roles
GET
/activities/allowed-host-visitor-countries
A list of allowed host visitor countries
GET
/activities/allowed-host-visitor-person-roles
A list of allowed host-visitor activity person roles
GET
/activities/allowed-image-types
A list of allowed image types
GET
/activities/allowed-indicators
A list of allowed activity indicators
GET
/activities/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/activities/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/activities/allowed-link-types
A list of allowed link types
GET
/activities/allowed-locales
A list of allowed locales in localized strings
GET
/activities/allowed-membership-person-roles
A list of allowed membership activity person roles
GET
/activities/allowed-other-activity-person-roles
A list of allowed other activity person roles
GET
/activities/allowed-talk-person-roles
A list of allowed talk activity person roles
GET
/activities/allowed-types
A list of allowed activity types
GET
/activities/allowed-visit-other-person-roles
A list of allowed visit-other activity person roles
GET
/activities/allowed-workflow-steps
A list of allowed workflow steps in localized strings
GET
/activities/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/activities/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/activities/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with activities
PUT
/activities/file-uploads
Upload file to a specific activity
GET
/activities/orderings
Lists available orderings
POST
/activities/search
Query operation for activities
GET
/activities/{uuid}
Get activity
PUT
/activities/{uuid}
Update an activity
DELETE
/activities/{uuid}
Delete activity
POST
/activities/{uuid}/actions/lock
Lock the content
POST
/activities/{uuid}/actions/unlock
Unlock the content
GET
/activities/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the activity
PUT
/activities/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the activity
GET
/activities/{uuid}/files/{fileId}
Get file from the activity
GET
/activities/{uuid}/notes
Lists notes
PUT
/activities/{uuid}/notes
Create note
Schemas 58
The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are Activity (39 properties), Document (17 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.
Note
object
A note
3 properties
1 required
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ClassificationRef
object
A reference to a classification value
2 properties
1 required
ProjectRef
object
A reference to project
1 required
EquipmentRef
object
A reference to a piece of equipment
1 required
KeywordGroup
object
4 properties
2 required
ClassificationRefList
object
List of classification references
1 property
NoteListResult
object
List of notes
3 properties
OrganizationRef
object
A reference to an organization in the institution
1 required
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
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
ActivityListResult
object
List of activities. Can contain a subset of all items along with the full count
3 properties
PageInformation
object
Information about pages
2 properties
ActivityPrizeAssociation
object
An association with a prize.
1 property
1 required
ActivitiesQuery
object
Create a query for activities
6 properties
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
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
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
UploadedFile
object
Information about the uploaded file
7 properties
1 required
Activity
object
Activities exist in many variations.
39 properties
6 required
Visibility
object
Visibility of an object
2 properties
1 required
Document
object
Document
17 properties
4 required
OrderingsList
object
List of available orderings
1 property
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
ActivityProjectAssociation
object
An association with a project.
1 property
1 required
ActivityDatasetAssociation
object
An association with an dataset.
1 property
1 required
PrizeRef
object
A reference to a prize
1 required
AbstractActivityPersonAssociation
object
An association between an activity and a person, which can either be internal or external
5 properties
2 required
StudentThesisRef
object
A reference to student thesis
1 required
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 properties
1 required
ProblemDetails
object
RFC7807 Error details
5 properties
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
ResearchOutputRef
object
A reference to a research output
1 required
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
PressMediaRef
object
A reference to a press/media
1 required
Identifier
object
1 property
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
Workflow
object
Information about workflow
2 properties
1 required
CompoundDateRange
object
A date range of that can be defined by only year, year and month or a full date
2 properties
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
WorkflowListResult
object
List of workflow steps.
1 property
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties
1 required
DataSetRef
object
A reference to a data set
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 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
Hong Kong Baptist University event API
#activity