Hong Kong Baptist University researchOutput API
The researchOutput API from Hong Kong Baptist University — 66 operation(s) for researchoutput.
Hong Kong Baptist University researchOutput 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 researchOutput. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 71 operations across 66 paths, and defines 83 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.
71 operations
66 paths
83 schemas
1 DELETE61 GET4 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University researchOutput 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 71
Across 66 paths, the API surfaces 71 operations — 1 DELETE, 61 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
researchOutput 71
GET
/research-outputs
Lists all research outputs
PUT
/research-outputs
Create research output
GET
/research-outputs/allowed-additional-file-access-types
A list of allowed access types
GET
/research-outputs/allowed-additional-file-license-types
A list of allowed license types
GET
/research-outputs/allowed-article-processing-charge-currencies
A list of allowed article processing charge currencies
GET
/research-outputs/allowed-book-anthology-contributor-roles
A list of allowed contributor roles for the book anthology subtype
GET
/research-outputs/allowed-book-anthology-description-types
A list of allowed description types for the book anthology subtype
GET
/research-outputs/allowed-case-note-sources
A list of allowed case note sources
GET
/research-outputs/allowed-categories
A list of allowed categories
GET
/research-outputs/allowed-contribution-to-book-anthology-contributor-roles
A list of allowed contributor roles for the contribution to book anthology subtype
GET
/research-outputs/allowed-contribution-to-book-anthology-description-types
A list of allowed description types for the contribution to book anthology subtype
GET
/research-outputs/allowed-contribution-to-conference-contributor-roles
A list of allowed contributor roles for the contribution to conference subtype
GET
/research-outputs/allowed-contribution-to-conference-description-types
A list of allowed description types for the contribution to conference subtype
GET
/research-outputs/allowed-contribution-to-journal-contributor-roles
A list of allowed contributor roles for the contribution to journal subtype
GET
/research-outputs/allowed-contribution-to-journal-description-types
A list of allowed description types for the contribution to journal subtype
GET
/research-outputs/allowed-contribution-to-memorandum-contributor-roles
A list of allowed contributor roles for the contribution to memorandum subtype
GET
/research-outputs/allowed-contribution-to-memorandum-description-types
A list of allowed description types for the contribution to memorandum subtype
GET
/research-outputs/allowed-contribution-to-periodical-contributor-roles
A list of allowed contributor roles for the contribution to periodical subtype
GET
/research-outputs/allowed-contribution-to-periodical-description-types
A list of allowed description types for the contribution to periodical subtype
GET
/research-outputs/allowed-contributor-countries
A list of allowed contributor countries
GET
/research-outputs/allowed-countries
A list of allowed countries
GET
/research-outputs/allowed-custom-defined-field-values/{fieldIdentifer}/classifications
Get allowed classifications for the custom-defined field associated with the research output
GET
/research-outputs/allowed-electronic-version-access-types
A list of allowed access types
GET
/research-outputs/allowed-electronic-version-license-types
A list of allowed license types
GET
/research-outputs/allowed-electronic-version-version-types
A list of allowed version types
GET
/research-outputs/allowed-image-types
A list of allowed image types
GET
/research-outputs/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/research-outputs/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/research-outputs/allowed-languages
A list of allowed languages
GET
/research-outputs/allowed-link-types
A list of allowed link types
GET
/research-outputs/allowed-locales
A list of allowed locales in localized strings
GET
/research-outputs/allowed-main-research-areas
A list of allowed main research areas
GET
/research-outputs/allowed-memorandum-contributor-roles
A list of allowed contributor roles for the memorandum subtype
GET
/research-outputs/allowed-memorandum-description-types
A list of allowed description types for the memorandum subtype
GET
/research-outputs/allowed-metric-collections
A list of allowed metric collections
GET
/research-outputs/allowed-non-textual-contributor-roles
A list of allowed contributor roles for the non-textual subtype
GET
/research-outputs/allowed-non-textual-description-types
A list of allowed description types for the non-textual subtype
GET
/research-outputs/allowed-other-contribution-contributor-roles
A list of allowed contributor roles for the other contribution subtype
GET
/research-outputs/allowed-other-contribution-description-types
A list of allowed description types for the other contribution subtype
GET
/research-outputs/allowed-output-medias
A list of allowed output medias
GET
/research-outputs/allowed-patent-contributor-roles
A list of allowed contributor roles for the patent subtype
GET
/research-outputs/allowed-patent-description-types
A list of allowed description types for the patent subtype
GET
/research-outputs/allowed-peer-review-configurations
A list of peer review configurations
GET
/research-outputs/allowed-publication-statuses
A list of allowed publication statuses
GET
/research-outputs/allowed-qualifications
A list of allowed qualifications
GET
/research-outputs/allowed-supervisor-roles
A list of allowed supervisor roles
GET
/research-outputs/allowed-templates
A list of allowed research output templates
GET
/research-outputs/allowed-thesis-contributor-roles
A list of allowed contributor roles for the thesis subtype
GET
/research-outputs/allowed-thesis-description-types
A list of allowed description types for the thesis subtype
GET
/research-outputs/allowed-types
A list of allowed research output types
GET
/research-outputs/allowed-workflow-steps
A list of allowed workflow steps
GET
/research-outputs/allowed-working-paper-contributor-roles
A list of allowed contributor roles for the working paper subtype
GET
/research-outputs/allowed-working-paper-description-types
A list of allowed description types for the working paper subtype
GET
/research-outputs/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/research-outputs/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/research-outputs/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with research outputs
PUT
/research-outputs/file-uploads
Upload file to a specific research output
GET
/research-outputs/orderings
Lists available orderings
POST
/research-outputs/search
Query operation for research outputs
GET
/research-outputs/{uuid}
Get research output
PUT
/research-outputs/{uuid}
Update research output
DELETE
/research-outputs/{uuid}
Delete research output
POST
/research-outputs/{uuid}/actions/lock
Lock the content
POST
/research-outputs/{uuid}/actions/unlock
Unlock the content
GET
/research-outputs/{uuid}/dependents
Lists all dependents to a research output
GET
/research-outputs/{uuid}/disciplines/{discipline-scheme}
Get disciplinesfrom the discipline scheme associated with the research output
PUT
/research-outputs/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the research output
GET
/research-outputs/{uuid}/files/{fileId}
Get file from the research output
GET
/research-outputs/{uuid}/metrics/{collection-id}
Lists metrics with collection id
GET
/research-outputs/{uuid}/notes
Lists notes
PUT
/research-outputs/{uuid}/notes
Create note
Schemas 83
The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are ResearchOutput (53 properties), ImageFile (15 properties), AdditionalFileElectronicVersion (10 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.
ResearchOutput
object
Research output exists in many variations, from written to non-textual form. Templates are available for a range of these variations.
53 properties
8 required
ClassificationRef
object
A reference to a classification value
2 properties
1 required
ProjectRef
object
A reference to project
1 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
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
MetricCollectionItem
object
A metric collection. Contents a list of metric values.
4 properties
1 required
FormattedString
object
A string containing HTML formatted text
1 property
1 required
OrderingsList
object
List of available orderings
1 property
ResearchOutputPrizeAssociation
object
An association to a prize.
1 property
1 required
AbstractContributorAssociation
object
An association between research output and a person that has contributed to it
3 properties
1 required
ProblemDetails
object
RFC7807 Error details
5 properties
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
MetricCollectionDefinition
object
Information about a set of related metrics, usually from a single provider
3 properties
2 required
MetricCollection
object
List of metrics
3 properties
1 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
ResearchOutputPressMediaAssociation
object
An association to a press media.
1 property
1 required
ResearchOutputPeerReviewConfiguration
object
A specification for a research output type and the allowed combinations of it's interrelated fields: category, peerReview, and internationPeerReview
2 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
ProjectAwardableAssociation
object
A relation to a project, optionally in the context of the Award that made it possible.
2 properties
1 required
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
ArticleProcessingCharge
object
Holds information on the article processing charge
3 properties
PublicationStatus
object
A representation of a point in time when the status of a publication changed, e.g. the submission date or publication date of the publication.
4 properties
Visibility
object
Visibility of an object
2 properties
1 required
ResearchOutputPeerReviewConfigurationListResult
object
List of research output peer review configurations
1 property
MetricDefinition
object
Information about how a specific metric is defined; how data of the metric is structured
3 properties
2 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
MetricCollectionDefinitionList
object
List of metric collection definitions
1 property
ResearchOutputAssociation
object
An association to a research output.
1 property
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
ResearchOutputDataSetAssociation
object
An association to a dataset.
1 property
1 required
ElectronicVersionFile
object
Information about an electronic version file
10 properties
2 required
ResearchOutputStudentThesisAssociation
object
An association to a student thesis.
1 property
1 required
ResearchOutputImpactAssociation
object
An association to an impact.
1 property
1 required
ResearchOutputsQuery
object
Create a query for researchOutputs
6 properties
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
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
CurrencyAmount
object
A monetary value in the specified currency as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/paymentcurrencyamount-dictio…
2 properties
2 required
MetricValue
object
A metric value, that contains one piece of data. Only one type of value can be set at a time, and it must match the specification of the metric definition.
6 properties
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
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
Identifier
object
1 property
1 required
PressMediaRef
object
A reference to a press/media
1 required
DateRange
object
A date range
2 properties
Workflow
object
Information about workflow
2 properties
1 required
ResearchOutputListResult
object
List of researchoutputs. Can contain a subset of all items along with the full count
3 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.
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.
AdditionalFileElectronicVersion
object
An additional file related to a research output.
10 properties
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
ElectronicVersion
object
Electronic version related to a research output.
9 properties
1 required
PrizeRef
object
A reference to a prize
1 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
ResearchOutputPeerReviewConfigurationCombination
object
A specification for a publication category and it's interrelated fields: peerReview and internationalPeerReview
2 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
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
WorkflowListResult
object
List of workflow steps.
1 property
ContentRefListResult
object
List of Content Refs
1 property
FundingDetails
object
Details about funding.
4 properties
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
#researchOutput