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

Eindhoven University of Technology milestone API

The milestone API from Eindhoven University of Technology — 24 operation(s) for milestone.

Eindhoven University of Technology milestone API is one of 38 APIs that Eindhoven University of Technology publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include milestone. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 27 operations across 24 paths, and defines 28 schemas. It is described by OpenAPI 3.0.1, at version 5.35.3-4.

Requests are made against a single base URL, /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.3-4
Base URL
https://pure.tue.nl/ws/oai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Eindhoven University of Technology 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 3 params → 200
PUT
/milestones
Create milestone
milestone_create body → 201400
GET
/milestones/allowed-categories
A list of allowed classifications for the category property
milestone_getAllowedCategories → 200
GET
/milestones/allowed-completion-states
A list of allowed completion states
milestone_getAllowedCompletionStates → 200
GET
/milestones/allowed-document-types
A list of allowed document types
milestone_getAllowedDocumentTypes → 200
GET
/milestones/allowed-locales
A list of allowed locales in localized strings
milestone_getAllowedLocales → 200
GET
/milestones/allowed-milestone-states
A list of allowed milestone states
milestone_getAllowedMilestoneStates → 200
GET
/milestones/application/allowed-academic-roles
A list of allowed academic roles for milestones which have a related application
milestone_getAllowedAcademicRolesRelatedToApplications → 200
GET
/milestones/application/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related application
milestone_getAllowedAdministrativeRolesRelatedToApplications → 200
GET
/milestones/award/allowed-academic-roles
A list of allowed academic roles for milestones which have a related award
milestone_getAllowedAcademicRolesRelatedToAwards → 200
GET
/milestones/award/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related award
milestone_getAllowedAdministrativeRolesRelatedToAwards → 200
GET
/milestones/contract/allowed-academic-roles
A list of allowed academic roles for milestones which have a related contract
milestone_getAllowedAcademicRolesRelatedToContract → 200
GET
/milestones/contract/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related contract
milestone_getAllowedAdministrativeRolesRelatedToContract → 200
GET
/milestones/ethical-review/allowed-academic-roles
A list of allowed academic roles for milestones which have a related ethical review
milestone_getAllowedAcademicRolesRelatedToEthicalReview → 200
GET
/milestones/ethical-review/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related ethical review
milestone_getAllowedAdministrativeRolesRelatedToEthicalReview → 200
PUT
/milestones/file-uploads
Upload file for a specific milestone
milestone_fileUploads 1 param body → default
GET
/milestones/orderings
Lists available orderings
milestone_getOrderings → 200
GET
/milestones/project/allowed-academic-roles
A list of allowed academic roles for milestones which have a related project
milestone_getAllowedAcademicRolesRelatedToProjects → 200
GET
/milestones/project/allowed-administrative-roles
A list of allowed administrative roles for milestones which have a related project
milestone_getAllowedAdministrativeRolesRelatedToProject → 200
POST
/milestones/search
Query operation for milestones
milestone_query body → 200400
GET
/milestones/{uuid}
Get milestone
milestone_get 1 param → 200301404
PUT
/milestones/{uuid}
Update milestone
milestone_update 1 param body → 200400404409
DELETE
/milestones/{uuid}
Delete milestone
milestone_delete 1 param → 204404409
POST
/milestones/{uuid}/actions/lock
Lock the content
milestone_lock 1 param → 204404409
POST
/milestones/{uuid}/actions/unlock
Unlock the content
milestone_unlock 1 param → 204404409
GET
/milestones/{uuid}/dependents
Lists all dependents to a milestone
milestone_dependents 2 params → 200
GET
/milestones/{uuid}/files/{fileId}
Get file from the milestone
milestone_getFile 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), ConflictProblemDetails (7 properties). Each schema is shown below with its type and property counts.

PageInformation
object
Information about pages
2 properties
ContentRef
object
2 properties 2 required
MilestoneReminder
object
A milestone reminder.
3 properties 2 required
UserRef
object
A reference to an user
1 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ProjectRef
object
A reference to project
1 required
MilestoneListResult
object
List of milestones. Can contain a subset of all items along with the full count
3 properties
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
ContentRefListResult
object
List of Content Refs
1 property
Visibility
object
Visibility of an object
2 properties 1 required
ContractRef
object
A reference to a contract
1 required
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties 4 required
MilestoneDocument
object
A milestone document
15 properties 4 required
Milestone
object
A milestone.
30 properties 2 required
APIStringListResult
object
2 properties
LocalesList
object
List of available locales
1 property
UploadedFile
object
Information about the uploaded file
7 properties 1 required
ApplicationRef
object
A reference to an application
1 required
MilestoneQuery
object
Create a query for milestone
8 properties
Identifier
object
1 property 1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
EthicalReviewRef
object
A reference to an ethical review
1 required
ProblemDetails
object
RFC7807 Error details
5 properties
ClassificationRef
object
A reference to a classification value
2 properties 1 required
AwardRef
object
A reference to an award
1 required
OrderingsList
object
List of available orderings
1 property
ClassificationRefList
object
List of classification references
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eindhoven-university-of-technology-milestone-api-openapi.yml Raw ↑

Other APIs Eindhoven University of Technology publishes across the network.

TU/e Research Portal OAI-PMH
Eindhoven University of Technology activity API
Eindhoven University of Technology application API
Eindhoven University of Technology authorCollaboration API
Eindhoven University of Technology award API
Eindhoven University of Technology classificationScheme API
Eindhoven University of Technology concept API
Eindhoven University of Technology conferenceSeries API
Eindhoven University of Technology contract API
Eindhoven University of Technology course API
Eindhoven University of Technology dataSet API
Eindhoven University of Technology education API