Hong Kong Baptist University studentThesis API
The studentThesis API from Hong Kong Baptist University — 26 operation(s) for studentthesis.
Hong Kong Baptist University studentThesis 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 studentThesis. 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 50 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
50 schemas
1 DELETE22 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University studentThesis 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.
studentThesis 30
GET
/student-theses
Lists all student theses
PUT
/student-theses
Create student thesis
GET
/student-theses/allowed-contributor-countries
A list of allowed contributor countries for student theses
GET
/student-theses/allowed-contributor-roles
A list of allowed contributor roles for student theses
GET
/student-theses/allowed-custom-defined-field-values/{fieldIdentifer}/classifications
Get allowed classifications for the custom-defined field associated with the student thesis
GET
/student-theses/allowed-document-embargo-reasons
A list of allowed document embargo reasons
GET
/student-theses/allowed-document-license-types
A list of allowed document license types
GET
/student-theses/allowed-document-types
A list of allowed document types
GET
/student-theses/allowed-document-version-types
A list of allowed document version types
GET
/student-theses/allowed-image-types
A list of allowed image types
GET
/student-theses/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/student-theses/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/student-theses/allowed-languages
A list of allowed languages
GET
/student-theses/allowed-link-types
A list of allowed link types
GET
/student-theses/allowed-locales
A list of allowed locales in localized strings
GET
/student-theses/allowed-supervisor-roles
A list of allowed supervisor roles
GET
/student-theses/allowed-types
A list of allowed student thesis types
GET
/student-theses/allowed-workflow-steps
A list of allowed workflow steps
PUT
/student-theses/file-uploads
Upload file to a specific student thesis
GET
/student-theses/orderings
Lists available orderings
POST
/student-theses/search
Query operation for student theses
GET
/student-theses/{uuid}
Get student thesis
PUT
/student-theses/{uuid}
Update student thesis
DELETE
/student-theses/{uuid}
Delete student thesis
POST
/student-theses/{uuid}/actions/lock
Lock the content
POST
/student-theses/{uuid}/actions/unlock
Unlock the content
GET
/student-theses/{uuid}/dependents
Lists all dependents to a student thesis
GET
/student-theses/{uuid}/files/{fileId}
Get file from the student thesis
GET
/student-theses/{uuid}/notes
Lists notes
PUT
/student-theses/{uuid}/notes
Create note
Schemas 50
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are StudentThesis (45 properties), StudentThesisDocument (21 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.
ExternalPersonRef
object
A reference to a person external to the institution
1 required
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
KeywordGroup
object
4 properties
2 required
EquipmentRef
object
A reference to a piece of equipment
1 required
ProjectRef
object
A reference to project
1 required
ClassificationRefList
object
List of classification references
1 property
NoteListResult
object
List of notes
3 properties
StudentThesis
object
A student thesis
45 properties
7 required
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
StudentThesisListResult
object
List of student theses. Can contain a subset of all items along with the full count
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
AbstractStudentThesisContributorAssociation
object
An association between student thesis and a person that has contributed to it
3 properties
1 required
PageInformation
object
Information about pages
2 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
ActivityRef
object
A reference to an activity
1 required
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
UploadedFile
object
Information about the uploaded file
7 properties
1 required
Visibility
object
Visibility of an object
2 properties
1 required
FormattedString
object
A string containing HTML formatted text
1 property
1 required
OrderingsList
object
List of available orderings
1 property
PrizeRef
object
A reference to a prize
1 required
StudentThesesQuery
object
Create a query for student theses
6 properties
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
ResearchOutputRef
object
A reference to a research output
1 required
PressMediaRef
object
A reference to a press/media
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
Identifier
object
1 property
1 required
ContentRefListResult
object
List of Content Refs
1 property
SupervisorAssociation
object
A supervisor on a research output.
7 properties
1 required
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.
WorkflowListResult
object
List of workflow steps.
1 property
StudentThesisDocument
object
A student thesis document.
21 properties
5 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 equipment API
Hong Kong Baptist University ethicalReview API
#studentThesis