Hong Kong Baptist University journal API
The journal API from Hong Kong Baptist University — 22 operation(s) for journal.
Hong Kong Baptist University journal 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 journal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 27 operations across 22 paths, and defines 47 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.
27 operations
22 paths
47 schemas
1 DELETE18 GET4 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University journal 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 27
Across 22 paths, the API surfaces 27 operations — 1 DELETE, 18 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
journal 27
GET
/journals
Lists all journals
PUT
/journals
Create journal
GET
/journals/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/journals/allowed-countries
A list of allowed countries
GET
/journals/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/journals/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/journals/allowed-link-types
A list of allowed link types
GET
/journals/allowed-locales
A list of allowed locales in localized strings
GET
/journals/allowed-metric-collections
A list of allowed metric collections
GET
/journals/allowed-types
A list of allowed journal types
GET
/journals/allowed-workflow-steps
A list of allowed workflow steps
GET
/journals/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/journals/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/journals/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with journals
GET
/journals/orderings
Lists available orderings
POST
/journals/search
Query operation for journals
GET
/journals/{uuid}
Get journal
PUT
/journals/{uuid}
Update journal
DELETE
/journals/{uuid}
Delete journal
POST
/journals/{uuid}/actions/lock
Lock the content
POST
/journals/{uuid}/actions/unlock
Unlock the content
GET
/journals/{uuid}/dependents
Lists all dependents to a journal
GET
/journals/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the journal
PUT
/journals/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the journal
GET
/journals/{uuid}/metrics/{collection-id}
Lists metrics with collection id
GET
/journals/{uuid}/notes
Lists notes
PUT
/journals/{uuid}/notes
Create note
Schemas 47
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are Journal (25 properties), SherpaRomeoOpenAccessPermission (11 properties), AllowedKeywordGroupConfiguration (10 properties), ConflictProblemDetails (7 properties). Each schema is shown below with its type and property counts.
ArticleVersion
object
Version of an article
2 properties
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.
AdditionalISSN
object
2 properties
2 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
KeywordGroup
object
4 properties
2 required
ClassificationRef
object
A reference to a classification value
2 properties
1 required
ClassificationRefList
object
List of classification references
1 property
PublisherRef
object
A reference to a publisher
1 required
NoteListResult
object
List of notes
3 properties
ISSN
object
An ISSN of a journal, can be populated with a start and end date if the ISSN is only used in a specific period.
4 properties
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
JournalsQuery
object
Create a query for journals
6 properties
SherpaRomeoOpenAccessPermission
object
Describes a SHERPA RoMEO access permissions object used in a policy.
11 properties
1 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
PageInformation
object
Information about pages
2 properties
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 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
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
MetricCollectionItem
object
A metric collection. Contents a list of metric values.
4 properties
1 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
OrderingsList
object
List of available orderings
1 property
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
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
SherpaRomeoPolicy
object
Describes a SHERPA RoMEO open access policy.
6 properties
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
MetricCollectionDefinition
object
Information about a set of related metrics, usually from a single provider
3 properties
2 required
Journal
object
A periodical presenting articles on a particular subject.
25 properties
3 required
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
MetricCollectionDefinitionList
object
List of metric collection definitions
1 property
Identifier
object
1 property
1 required
MetricCollection
object
List of metrics
3 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
JournalListResult
object
A list of journals
3 properties
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties
1 required
ContentRefListResult
object
List of Content Refs
1 property
JournalTitle
object
A title of a journal, can be populated with a start and end date if the title is only used in a specific period.
4 properties
1 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
#journal