Hong Kong Baptist University project API
The project API from Hong Kong Baptist University — 33 operation(s) for project.
Hong Kong Baptist University project 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 project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 38 operations across 33 paths, and defines 79 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.
38 operations
33 paths
79 schemas
1 DELETE28 GET4 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University project 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 38
Across 33 paths, the API surfaces 38 operations — 1 DELETE, 28 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
project 38
GET
/projects
Lists all projects
PUT
/projects
Create project
GET
/projects/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/projects/allowed-collaborator-types
A list of allowed collaborator types
GET
/projects/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the project
GET
/projects/allowed-description-types
A list of allowed description types
GET
/projects/allowed-document-licenses
A list of allowed document licenses
GET
/projects/allowed-document-types
A list of allowed document types
GET
/projects/allowed-image-types
A list of allowed image types
GET
/projects/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/projects/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/projects/allowed-link-types
A list of allowed link types
GET
/projects/allowed-locales
A list of allowed locales in localized strings
GET
/projects/allowed-nature-types
A list of allowed nature types
GET
/projects/allowed-participant-roles
A list of allowed participant roles
GET
/projects/allowed-project-relation-types
A list of allowed project relation types
GET
/projects/allowed-templates
A list of allowed project templates
GET
/projects/allowed-types
A list of allowed project types
GET
/projects/allowed-workflow-steps
A list of allowed workflow steps
GET
/projects/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/projects/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/projects/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with projects
PUT
/projects/file-uploads
Upload file to a specific project
GET
/projects/orderings
Lists available orderings
POST
/projects/search
Query operation for projects
GET
/projects/{uuid}
Get project
PUT
/projects/{uuid}
Update project
DELETE
/projects/{uuid}
Delete project
POST
/projects/{uuid}/actions/lock
Lock the content
POST
/projects/{uuid}/actions/unlock
Unlock the content
GET
/projects/{uuid}/application-clusters
Get the application clusters for the project
GET
/projects/{uuid}/award-clusters
Get the award clusters for the project
GET
/projects/{uuid}/dependents
Lists all dependents to an project
GET
/projects/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the project
PUT
/projects/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the project
GET
/projects/{uuid}/files/{fileId}
Get file from the project
GET
/projects/{uuid}/notes
Lists notes
PUT
/projects/{uuid}/notes
Create note
Schemas 79
The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are Project (47 properties), Document (17 properties), ApplicationCluster (16 properties), ImageFile (15 properties). Each schema is shown below with its type and property counts.
ApplicationRef
object
A reference to an application
1 required
DataSetAwardableAssociation
object
A relation to a dataset, optionally in the context of the Award that made it possible.
2 properties
1 required
ProjectRef
object
A reference to project
1 required
ClassificationRef
object
A reference to a classification value
2 properties
1 required
PrizeAwardableAssociation
object
A relation to a prize, optionally in the context of the Award that made it possible.
2 properties
1 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
EquipmentAwardableAssociation
object
A relation to an equipment, optionally in the context of the Award that made it possible.
2 properties
1 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
OrderingsList
object
List of available orderings
1 property
AwardClusterRef
object
A reference to an award cluster
1 required
AbstractParticipantAssociation
object
An association for a person that participated in the project.
9 properties
2 required
ProblemDetails
object
RFC7807 Error details
5 properties
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
ProjectCurtailed
object
Information about project curtail.
2 properties
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
ResearcherCommitment
object
Planned and actual research commitment.
4 properties
1 required
ProjectListResult
object
List of projects. Can contain a subset of all items along with the full count
3 properties
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
AwardClusterListResult
object
List of award clusters. Can contain a subset of all items along with the full count
3 properties
PageInformation
object
Information about pages
2 properties
AllowedTemplate
object
An allowed template, such as 'ContributionToJournal' or 'BookAnthology' for research outputs.
2 properties
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
ResearchOutputAwardableAssociation
object
A relation to a research output, optionally in the context of the Award that made it possible.
2 properties
1 required
Visibility
object
Visibility of an object
2 properties
1 required
PressMediaAwardableAssociation
object
A relation to a press/media, optionally in the context of the Award that made it possible.
2 properties
1 required
AwardCluster
object
An award cluster groups related awards from their individual relations.
14 properties
ProjectAssociation
object
An association to a project.
2 properties
1 required
YearMonth
object
A date that can be defined by only year and month
2 properties
2 required
CollaboratorAssociation
object
A collaborator associated with the content.
4 properties
1 required
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties
1 required
AwardRef
object
A reference to an award
1 required
Note
object
A note
3 properties
1 required
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
ActivityAwardableAssociation
object
A relation to an activity, optionally in the context of the Award that made it possible.
2 properties
1 required
ApplicationClusterRef
object
A reference to an application cluster
1 required
DeprecatedDateRange
object
Deprecated version of DateRange
2 properties
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
ImpactRef
object
A reference to impact
1 required
LocalesList
object
List of available locales
1 property
UploadedFile
object
Information about the uploaded file
7 properties
1 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
AllowedTemplateListResult
object
List of allowed templates.
1 property
Identifier
object
1 property
1 required
PressMediaRef
object
A reference to a press/media
1 required
Workflow
object
Information about workflow
2 properties
1 required
DateRange
object
A date range
2 properties
DataSetRef
object
A reference to a data set
1 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
ImpactAwardableAssociation
object
A relation to an impact, optionally in the context of the Award that made it possible.
2 properties
1 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ClassificationRefList
object
List of classification references
1 property
EquipmentRef
object
A reference to a piece of equipment
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.
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
Project
object
Projects exists in two variations depending on the functionality enabled in the Pure installation.
47 properties
5 required
Document
object
Document
17 properties
4 required
PrizeRef
object
A reference to a prize
1 required
StudentThesisRef
object
A reference to student thesis
1 required
ApplicationCluster
object
An application cluster groups related applications from their individual relations.
16 properties
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
StudentThesisAwardableAssociation
object
A relation to a student thesis, optionally in the context of the Award that made it possible.
2 properties
1 required
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
ApplicationClusterListResult
object
List of application clusters. 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
Name
object
A name describing a person, made up of given- and family name
2 properties
WorkflowListResult
object
List of workflow steps.
1 property
ProjectsQuery
object
Create a query for projects
6 properties
ContentRefListResult
object
List of Content Refs
1 property
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
#project