Hong Kong Baptist University impact API
The impact API from Hong Kong Baptist University — 31 operation(s) for impact.
Hong Kong Baptist University impact 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 impact. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 36 operations across 31 paths, and defines 66 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.
36 operations
31 paths
66 schemas
1 DELETE26 GET4 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University impact 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 36
Across 31 paths, the API surfaces 36 operations — 1 DELETE, 26 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
impact 36
GET
/impacts
Lists all impacts
PUT
/impacts
Create impact
GET
/impacts/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/impacts/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the impact
GET
/impacts/allowed-description-types
A list of allowed classifications for the descriptions property
GET
/impacts/allowed-document-licenses
A list of allowed document licenses
GET
/impacts/allowed-document-types
A list of allowed document types
GET
/impacts/allowed-image-types
A list of allowed image types
GET
/impacts/allowed-impact-categories
A list of allowed impact categories
GET
/impacts/allowed-impact-evidence-indicators
A list of allowed impact evidence indicators
GET
/impacts/allowed-impact-levels
A list of allowed impact levels
GET
/impacts/allowed-impact-status
A list of allowed impact types
GET
/impacts/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/impacts/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/impacts/allowed-link-types
A list of allowed link types
GET
/impacts/allowed-locales
A list of allowed locales in localized strings
GET
/impacts/allowed-persons-countries
A list of allowed impact persons countries
GET
/impacts/allowed-persons-roles
A list of allowed persons roles
GET
/impacts/allowed-types
A list of allowed impact types
GET
/impacts/allowed-workflow-steps
A list of allowed workflow steps in localized strings
GET
/impacts/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/impacts/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/impacts/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with impacts
PUT
/impacts/file-uploads
Upload file to a specific impact
POST
/impacts/search
Query operation for impact
GET
/impacts/{uuid}
Get impact
PUT
/impacts/{uuid}
Update impact
DELETE
/impacts/{uuid}
Delete impact
POST
/impacts/{uuid}/actions/lock
Lock the content
POST
/impacts/{uuid}/actions/unlock
Unlock the content
GET
/impacts/{uuid}/dependents
Lists all dependents to an impact
GET
/impacts/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the impact
PUT
/impacts/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the impact
GET
/impacts/{uuid}/files/{fileId}
Get file from the impact
GET
/impacts/{uuid}/notes
Lists notes
PUT
/impacts/{uuid}/notes
Create note
Schemas 66
The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are Impact (41 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
EquipmentImpactAssociation
object
An association to a piece of equipment
1 property
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
KeywordGroup
object
4 properties
2 required
EquipmentRef
object
A reference to a piece of equipment
1 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
EvidenceContactInformation
object
EvidenceContactInformation
5 properties
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
ImageFile
object
An image file
15 properties
2 required
PageInformation
object
Information about pages
2 properties
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
ImpactStudentThesisAssociation
object
An association to a student thesis
1 property
1 required
ImpactActivityAssociation
object
An association to an activity
1 property
1 required
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
LocalesList
object
List of available locales
1 property
UploadedFile
object
Information about the uploaded file
7 properties
1 required
ImpactPrizeAssociation
object
An association to a prize
1 property
1 required
Visibility
object
Visibility of an object
2 properties
1 required
Document
object
Document
17 properties
4 required
ImpactQuery
object
Create a query for impact
6 properties
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
PrizeRef
object
A reference to a prize
1 required
ImpactEvidence
object
ImpactEvidence
9 properties
1 required
ImpactListResult
object
List of impact. Can contain a subset of all items along with the full count
3 properties
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
ImpactResearchOutputAssociation
object
An association to a research output
1 property
1 required
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
ImpactDataSetAssociation
object
An association to a data set
1 property
1 required
PressMediaRef
object
A reference to a press/media
1 required
ImpactProjectAssociation
object
An association to a project
1 property
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties
1 required
AbstractImpactClassifiedParticipantAssociation
object
An association between an impact and a person, which can either be internal or external
5 properties
2 required
Identifier
object
1 property
1 required
ImpactImpactAssociation
object
An association to an impact
1 property
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.
CompoundDateRange
object
A date range of that can be defined by only year, year and month or a full date
2 properties
ContentRefListResult
object
List of Content Refs
1 property
WorkflowListResult
object
List of workflow steps.
1 property
ImpactPressMediaAssociation
object
An association to a press media
1 property
1 required
DataSetRef
object
A reference to a data set
1 required
Impact
object
Impact
41 properties
6 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
#impact