Hong Kong Baptist University publisher API

The publisher API from Hong Kong Baptist University — 18 operation(s) for publisher.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hong Kong Baptist University publisher 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 publisher. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 23 operations across 18 paths, and defines 32 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.

23 operations 18 paths 32 schemas 1 DELETE14 GET4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.1

API Version

5.35.0

Base URL

https://scholars.hkbu.edu.hk/ws/api/

Authentication

API Key

Contact

pure-support@elsevier.com

Resource Areas

Authentication & Security 1

Hong Kong Baptist University publisher 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 23

Across 18 paths, the API surfaces 23 operations — 1 DELETE, 14 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

publisher 23

GET

/publishers

Lists all publishers

publisher_list_1 3 params → 200

PUT

/publishers

Create publisher

publisher_create_1 body → 201400

GET

/publishers/allowed-countries

A list of allowed countries

publishers_getAllowedCountries_1 → 200

GET

/publishers/allowed-keyword-group-configurations

A list of keyword group configurations

publisher_getAllowedKeywordGroupConfigurations_1 → 200

GET

/publishers/allowed-keyword-group-configurations/{id}/classifications

A list of allowed classifications for the specified keyword group

publisher_getAllowedKeywordGroupConfigurationClassifications_1 1 param → 200

GET

/publishers/allowed-locales

A list of allowed locales in localized strings

publisher_getAllowedLocales_1 → 200

GET

/publishers/allowed-types

A list of allowed publisher types

publisher_getAllowedTypes_1 → 200

GET

/publishers/allowed-workflow-steps

A list of allowed workflow steps

publisher_getAllowedWorkflowSteps_1 → 200

GET

/publishers/disciplines/allowed-discipline-schemes

A list of allowed discipline schemes

publisher_getAllowedDisciplineSchemes_1 → 200

GET

/publishers/disciplines/{discipline-scheme}/allowed-disciplines

A list of allowed disciplines for a specific discipline scheme

publisher_getAllowedDisciplines_1 3 params → 200

POST

/publishers/disciplines/{discipline-scheme}/search

Query operation for disciplines associated with publishers

publisher_listDisciplineAssociations_1 1 param body → 200400

GET

/publishers/orderings

Lists available orderings

publisher_getOrderings_1 → 200

POST

/publishers/search

Query operation for publishers

publisher_query_1 body → 200400

GET

/publishers/{uuid}

Get publisher

publisher_get_1 1 param → 200301404

PUT

/publishers/{uuid}

Update publishers

publisher_update_1 1 param body → 200400404409

DELETE

/publishers/{uuid}

Delete publisher

publisher_delete_1 1 param → 204404409

POST

/publishers/{uuid}/actions/lock

Lock the content

publisher_lock_1 1 param → 204404409

POST

/publishers/{uuid}/actions/unlock

Unlock the content

publisher_unlock_1 1 param → 204404409

GET

/publishers/{uuid}/dependents

Lists all dependents to a publisher

publisher_dependents_1 2 params → 200

GET

/publishers/{uuid}/disciplines/{discipline-scheme}

Get disciplines from the discipline scheme associated with the publisher

publisher_getDisciplineAssociation_1 2 params → 200404

PUT

/publishers/{uuid}/disciplines/{discipline-scheme}

Update disciplines from the discipline scheme associated with the publisher

publisher_putDisciplineAssociation_1 2 params body → 200400404

GET

/publishers/{uuid}/notes

Lists notes

publisher_listNotes_1 3 params → 200404

PUT

/publishers/{uuid}/notes

Create note

publisher_createNote_1 1 param body → 200400

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Publisher (18 properties), AllowedKeywordGroupConfiguration (10 properties), ConflictProblemDetails (7 properties), PublishersQuery (6 properties). Each schema is shown below with its type and property counts.

Note

object

A note

3 properties 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

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

NoteListResult

object

List of notes

3 properties

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

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

DisciplinesDisciplineListResult

object

List of disciplines for a specific discipline scheme

3 properties

OrderingsList

object

List of available orderings

1 property

Publisher

object

A publisher known to institution

18 properties 2 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

PublishersQuery

object

Create a query for publishers

6 properties

DisciplinesAssociationListResult

object

List of discipline associations. Can contain a subset of all items along with the full count

3 properties

DisciplinesDisciplineScheme

object

A discipline scheme

2 properties 2 required

Identifier

object

1 property 1 required

ContentRefListResult

object

List of Content Refs

1 property

LocalizedString

object

A set of string values, one for each submission locale. Note: invalid locale values will be ignored.

Workflow

object

Information about workflow

2 properties 1 required

WorkflowListResult

object

List of workflow steps.

1 property

DisciplinesAssociation

object

An association between a content and a number of discipline assignments

3 properties 1 required

PublisherListResult

object

List of publishers. Can contain a subset of all items along with the full count

3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Hong Kong Baptist University publishes across the network.

HKBU Mobile App Backend (gated)

AE Profile APIs.io

Hong Kong Baptist University activity API

AE Profile APIs.io

Hong Kong Baptist University application API

AE Profile APIs.io

Hong Kong Baptist University authorCollaboration API

AE Profile APIs.io

Hong Kong Baptist University award API

AE Profile APIs.io

Hong Kong Baptist University classificationScheme API

AE Profile APIs.io

Hong Kong Baptist University concept API

AE Profile APIs.io

Hong Kong Baptist University course API

AE Profile APIs.io

Hong Kong Baptist University dataSet API

AE Profile APIs.io

Hong Kong Baptist University education API

AE Profile APIs.io

Hong Kong Baptist University equipment API

AE Profile APIs.io

Hong Kong Baptist University ethicalReview API

AE Profile APIs.io

#publisher

← Back to H APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Hong Kong Baptist University publisher API

Metadata

Authentication & Security 1

Paths & Operations 23

Schemas 32

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Hong Kong Baptist University publisher API

Metadata

Authentication & Security 1

Paths & Operations 23

Schemas 32

Specification

Source

More from Hong Kong Baptist University 12

API Details

Provider

Explore more