Hong Kong Baptist University pressMedia API
The pressMedia API from Hong Kong Baptist University — 24 operation(s) for pressmedia.
Hong Kong Baptist University pressMedia 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 pressMedia. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 28 operations across 24 paths, and defines 55 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.
28 operations
24 paths
55 schemas
1 DELETE20 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University pressMedia 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 28
Across 24 paths, the API surfaces 28 operations — 1 DELETE, 20 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
pressMedia 28
GET
/pressmedia
List all Press/Media content
PUT
/pressmedia
Create Press/Media content
GET
/pressmedia/allowed-categories
A list of allowed categories
GET
/pressmedia/allowed-custom-defined-field-values/{fieldIdentifer}/classifications
Get allowed classifications for the custom-defined field associated with the Press/Media
GET
/pressmedia/allowed-descriptions-types
A list of allowed description types
GET
/pressmedia/allowed-image-types
A list of allowed image types
GET
/pressmedia/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/pressmedia/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/pressmedia/allowed-locales
A list of allowed locales in localized strings
GET
/pressmedia/allowed-media-coverage-types
A list of allowed media coverage types
GET
/pressmedia/allowed-media-coverages-countries
A list of allowed countries
GET
/pressmedia/allowed-media-coverages-degree-of-recognitions
A list the degrees of recognition allowed on Press/Media
GET
/pressmedia/allowed-media-coverages-media-types
A list of allowed media types
GET
/pressmedia/allowed-media-coverages-persons-roles
A list of allowed person roles
GET
/pressmedia/allowed-media-coverages-subdivisions
A list of allowed subdivisions
GET
/pressmedia/allowed-types
A list of allowed Press/Media types
GET
/pressmedia/allowed-workflow-steps
A list of allowed workflow steps
PUT
/pressmedia/file-uploads
Upload file to a specific Press/Media
GET
/pressmedia/orderings
Lists available orderings
POST
/pressmedia/search
Query operation for Press/Media content
GET
/pressmedia/{uuid}
Get specific Press/Media
PUT
/pressmedia/{uuid}
Update Press/Media
DELETE
/pressmedia/{uuid}
Delete specific Press/Media
POST
/pressmedia/{uuid}/actions/lock
Lock the content
POST
/pressmedia/{uuid}/actions/unlock
Unlock the content
GET
/pressmedia/{uuid}/files/{fileId}
Get file related to Press/Media
GET
/pressmedia/{uuid}/notes
Lists notes
PUT
/pressmedia/{uuid}/notes
Create note
Schemas 55
The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are PressMedia (33 properties), MediaCoverage (16 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
PressMediaPrizeAssociation
object
An association to a prize.
1 property
1 required
PressMediaStudentThesisAssociation
object
An association to a student thesis.
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
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
PressMediaActivityAssociation
object
An association to an activity.
1 property
1 required
NoteListResult
object
List of notes
3 properties
OrganizationRef
object
A reference to an organization in the institution
1 required
DataSetRef
object
A reference to a data set
1 required
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
PressMediaQuery
object
Query for searching press media
6 properties
PressMediaDataSetAssociation
object
An association to a dataset.
1 property
1 required
PageInformation
object
Information about pages
2 properties
AbstractPressMediaPersonAssociation
object
An association between press media and a person
5 properties
1 required
APIStringListResult
object
2 properties
PressMediaResearchOutputAssociation
object
An association to a research output.
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
LocalesList
object
List of available locales
1 property
UploadedFile
object
Information about the uploaded file
7 properties
1 required
Visibility
object
Visibility of an object
2 properties
1 required
OrderingsList
object
List of available orderings
1 property
PrizeRef
object
A reference to a prize
1 required
PressMediaPressMediaAssociation
object
An association to a press media.
1 property
1 required
PressMediaProjectAssociation
object
An association to a project.
1 property
1 required
StudentThesisRef
object
A reference to student thesis
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
PressMediaListResult
object
List of Press Media. Can contain a subset of all items along with the full count
3 properties
ResearchOutputRef
object
A reference to a research output
1 required
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
Identifier
object
1 property
1 required
PressMediaRef
object
A reference to a press/media
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
MediaCoverage
object
A press media coverage
16 properties
2 required
Workflow
object
Information about workflow
2 properties
1 required
EventRef
object
A reference to an event
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
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
PressMediaEquipmentAssociation
object
An association to a piece of equipment.
1 property
1 required
PressMediaImpactAssociation
object
An association to an impact.
1 property
1 required
PressMedia
object
A piece of press, media, or other sort of news clipping.
33 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
#pressMedia