Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Hong Kong Baptist University

Hong Kong Baptist University milestone API

The milestone API from Hong Kong Baptist University — 24 operation(s) for milestone.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hong Kong Baptist University milestone 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 milestone. 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 24 paths, and defines 28 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 24 paths 28 schemas 1 DELETE20 GET3 POST3 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
1

Authentication & Security 1

Hong Kong Baptist University milestone 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 24 paths, the API surfaces 27 operations — 1 DELETE, 20 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

milestone 27
GET
/milestones
Lists all milestones
milestone_list_1 3 params → 200
PUT
/milestones
Create milestone
milestone_create_1 body → 201400
GET
/milestones/allowed-categories
A list of allowed classifications for the category property
milestone_getAllowedCategories_1 → 200
GET
/milestones/allowed-completion-states
A list of allowed completion states
milestone_getAllowedCompletionStates_1 → 200
GET
/milestones/allowed-document-types
A list of allowed document types
milestone_getAllowedDocumentTypes_1 → 200
GET
/milestones/allowed-locales
A list of allowed locales in localized strings
milestone_getAllowedLocales_1 → 200
GET
/milestones/allowed-milestone-states
A list of allowed milestone states
milestone_getAllowedMilestoneStates_1 → 200
GET
/milestones/application/allowed-academic-roles
A list of allowed academic roles for milestones which have a related application
milestone_getAllowedAcademicRolesRelatedToApplications_1 → 200
GET
/milestones/application/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related application
milestone_getAllowedAdministrativeRolesRelatedToApplications_1 → 200
GET
/milestones/award/allowed-academic-roles
A list of allowed academic roles for milestones which have a related award
milestone_getAllowedAcademicRolesRelatedToAwards_1 → 200
GET
/milestones/award/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related award
milestone_getAllowedAdministrativeRolesRelatedToAwards_1 → 200
GET
/milestones/contract/allowed-academic-roles
A list of allowed academic roles for milestones which have a related contract
milestone_getAllowedAcademicRolesRelatedToContract_1 → 200
GET
/milestones/contract/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related contract
milestone_getAllowedAdministrativeRolesRelatedToContract_1 → 200
GET
/milestones/ethical-review/allowed-academic-roles
A list of allowed academic roles for milestones which have a related ethical review
milestone_getAllowedAcademicRolesRelatedToEthicalReview_1 → 200
GET
/milestones/ethical-review/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related ethical review
milestone_getAllowedAdministrativeRolesRelatedToEthicalReview_1 → 200
PUT
/milestones/file-uploads
Upload file for a specific milestone
milestone_fileUploads_1 1 param body → default
GET
/milestones/orderings
Lists available orderings
milestone_getOrderings_1 → 200
GET
/milestones/project/allowed-academic-roles
A list of allowed academic roles for milestones which have a related project
milestone_getAllowedAcademicRolesRelatedToProjects_1 → 200
GET
/milestones/project/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related project
milestone_getAllowedAdministrativeRolesRelatedToProject_1 → 200
POST
/milestones/search
Query operation for milestones
milestone_query_1 body → 200400
GET
/milestones/{uuid}
Get milestone
milestone_get_1 1 param → 200301404
PUT
/milestones/{uuid}
Update milestone
milestone_update_1 1 param body → 200400404409
DELETE
/milestones/{uuid}
Delete milestone
milestone_delete_1 1 param → 204404409
POST
/milestones/{uuid}/actions/lock
Lock the content
milestone_lock_1 1 param → 204404409
POST
/milestones/{uuid}/actions/unlock
Unlock the content
milestone_unlock_1 1 param → 204404409
GET
/milestones/{uuid}/dependents
Lists all dependents to a milestone
milestone_dependents_1 2 params → 200
GET
/milestones/{uuid}/files/{fileId}
Get file from the milestone
milestone_getFile_1 2 params → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Milestone (30 properties), MilestoneDocument (15 properties), MilestoneQuery (8 properties), UploadedFile (7 properties). Each schema is shown below with its type and property counts.

ApplicationRef
object
A reference to an application
1 required
MilestoneReminder
object
A milestone reminder.
3 properties 2 required
MilestoneListResult
object
List of milestones. Can contain a subset of all items along with the full count
3 properties
MilestoneQuery
object
Create a query for milestone
8 properties
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
EthicalReviewRef
object
A reference to an ethical review
1 required
Milestone
object
A milestone.
30 properties 2 required
ClassificationRef
object
A reference to a classification value
2 properties 1 required
ProjectRef
object
A reference to project
1 required
ClassificationRefList
object
List of classification references
1 property
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
APIStringListResult
object
2 properties
PageInformation
object
Information about pages
2 properties
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
ProblemDetails
object
RFC7807 Error details
5 properties
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties 4 required
Identifier
object
1 property 1 required
ContractRef
object
A reference to a contract
1 required
MilestoneDocument
object
A milestone document
15 properties 4 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
UserRef
object
A reference to an user
1 required
AwardRef
object
A reference to an award
1 required
ContentRefListResult
object
List of Content Refs
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hong-kong-baptist-university-milestone-api-openapi.yml Raw ↑

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
#milestone
← Back to H APIs
API Details
ID
hong-kong-baptist-university:hong-kong-baptist-university-milestone-api
Base URL
https://scholars.hkbu.edu.hk/ws/api/
Docs
https://scholars.hkbu.edu.hk/ws/api/rapidoc.html
Provider
Hong Kong Baptist University
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network