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 application API

The application API from Eindhoven University of Technology — 36 operation(s) for application.

Eindhoven University of Technology application 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 application. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 42 operations across 36 paths, and defines 62 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.

42 operations 36 paths 62 schemas 1 DELETE31 GET4 POST6 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 application 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 42

Across 36 paths, the API surfaces 42 operations — 1 DELETE, 31 GET, 4 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

application 42
GET
/applications
Lists all applications
application_list 3 params → 200
PUT
/applications
Create application
application_create body → 201400
GET
/applications/allowed-applicant-roles
A list of allowed applicant roles
application_getAllowedApplicantRoles → 200
GET
/applications/allowed-application-statuses
A list of allowed application statuses
application_getAllowedApplicationStatuses → 200
GET
/applications/allowed-budget-account-classifications
A list of allowed account classifications
application_getAllowedBudgetAccountClassifications → 200
GET
/applications/allowed-classified-identifier-types
A list of allowed classified identifier types
application_getAllowedClassifiedIdentifierTypes → 200
GET
/applications/allowed-collaborator-types
A list of allowed collaborators types
application_getAllowedCollaboratorTypes → 200
GET
/applications/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the application
application_getAllowedCustomDefinedFieldClassifications 1 param → 200400404
GET
/applications/allowed-description-types
A list of allowed description types
application_getAllowedDescriptionTypes → 200
GET
/applications/allowed-document-licenses
A list of allowed document licenses
application_getAllowedDocumentLicenses → 200
GET
/applications/allowed-document-types
A list of allowed document types
application_getAllowedDocumentTypes → 200
GET
/applications/allowed-document-version-types
A list of allowed document version types
application_getAllowedDocumentVersionTypes → 200
GET
/applications/allowed-funding-classifications
A list of allowed fundings classifications
application_getAllowedFundingClassifications → 200
GET
/applications/allowed-keyword-group-configurations
A list of keyword group configurations
application_getAllowedKeywordGroupConfigurations → 200
GET
/applications/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
application_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/applications/allowed-link-types
A list of allowed link types
application_getAllowedLinkTypes → 200
GET
/applications/allowed-locales
A list of allowed locales in localized strings
application_getAllowedLocales → 200
GET
/applications/allowed-nature-types
A list of allowed nature types
application_getAllowedNatureTypes → 200
GET
/applications/allowed-templates
A list of allowed application templates
application_getAllowedTemplates → 200
GET
/applications/allowed-types
A list of allowed application types
application_getAllowedTypes → 200
GET
/applications/allowed-workflow-steps
A list of allowed workflow steps
application_getAllowedWorkflowSteps → 200
GET
/applications/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
application_getAllowedDisciplineSchemes → 200
GET
/applications/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
application_getAllowedDisciplines 3 params → 200
POST
/applications/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with applications
application_listDisciplineAssociations 1 param body → 200400
PUT
/applications/file-uploads
Upload file to a specific application
application_fileUploads 1 param body → default
GET
/applications/orderings
Lists available orderings
application_getOrderings → 200
POST
/applications/search
Query operation for applications
application_query body → 200400
GET
/applications/{uuid}
Get application
application_get 1 param → 200301404
PUT
/applications/{uuid}
Update application
application_update 1 param body → 200400404409
DELETE
/applications/{uuid}
Delete application
application_delete 1 param → 204404409
POST
/applications/{uuid}/actions/lock
Lock the content
application_lock 1 param → 204404409
POST
/applications/{uuid}/actions/unlock
Unlock the content
application_unlock 1 param → 204404409
GET
/applications/{uuid}/budgets
Get the budgets for the application
application_getBudgets 1 param → 200404
GET
/applications/{uuid}/budgets/{id}
Get a specific budget for the application
application_getBudget 2 params → 200404
PUT
/applications/{uuid}/budgets/{id}
Update budget for an application
application_updateBudget 2 params body → 200400404409
GET
/applications/{uuid}/cluster
Get the application cluster for the application
application_getCluster 1 param → 200404
GET
/applications/{uuid}/dependents
Lists all dependents to an application
application_dependents 2 params → 200
GET
/applications/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the application
application_getDisciplineAssociation 2 params → 200404
PUT
/applications/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the application
application_putDisciplineAssociation 2 params body → 200400404
GET
/applications/{uuid}/files/{fileId}
Get file from the application
application_getFile 2 params → 200
GET
/applications/{uuid}/notes
Lists notes
application_listNotes 3 params → 200404
PUT
/applications/{uuid}/notes
Create note
application_createNote 1 param body → 200400

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are Application (40 properties), ApplicationCluster (16 properties), AllowedKeywordGroupConfiguration (10 properties), Account (9 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
ResearcherCommitment
object
Planned and actual research commitment.
4 properties 1 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties 1 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ProjectRef
object
A reference to project
1 required
YearMonth
object
A date that can be defined by only year and month
2 properties 2 required
ApplicationBudget
object
A budget for an application.
3 properties 1 required
ApplicationFundingAssociation
object
Funding associations exists in two variants, financial or non-financial.
8 properties 1 required
FundingOpportunityRef
object
A reference to a funding opportunity
1 required
DateRange
object
A date range
2 properties
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
OrganizationRef
object
A reference to an organization in the institution
1 required
ApplicationFundingBudgetAssociation
object
A budget for a financial funding of an application.
6 properties 1 required
YearlyBudget
object
A yearly budget of an account.
3 properties
ContentRefListResult
object
List of Content Refs
1 property
Note
object
A note
3 properties 1 required
NoteListResult
object
List of notes
3 properties
Visibility
object
Visibility of an object
2 properties 1 required
ApplicationBudgetResult
object
List of application budgets. Can contain a subset of all items along with the full count
3 properties
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
ClassificationRefList
object
List of classification references
1 property
ApplicationListResult
object
List of applications. Can contain a subset of all items along with the full count
3 properties
Application
object
Applications exists in two variations depending on the functionality enabled in the Pure installation.
40 properties 6 required
Link
object
A hyperlink describing a location on the web.
5 properties 1 required
Account
object
An account of a budget.
9 properties
Workflow
object
Information about workflow
2 properties 1 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
UploadedFile
object
Information about the uploaded file
7 properties 1 required
LocalesList
object
List of available locales
1 property
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property 1 required
ApplicationRef
object
A reference to an application
1 required
CollaboratorAssociation
object
A collaborator associated with the content.
4 properties 1 required
ClassifiedLocalizedValue
object
A classified localized value
3 properties 1 required
Identifier
object
1 property 1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
AllowedTemplate
object
An allowed template, such as 'ContributionToJournal' or 'BookAnthology' for research outputs.
2 properties
WorkflowListResult
object
List of workflow steps.
1 property
KeywordGroup
object
4 properties 2 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
AccountEntry
object
An account entry of an account.
4 properties
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties 2 required
ProblemDetails
object
RFC7807 Error details
5 properties
Name
object
A name describing a person, made up of given- and family name
2 properties
ClassificationRef
object
A reference to a classification value
2 properties 1 required
ApplicationClusterRef
object
A reference to an application cluster
1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
AbstractApplicantAssociation
object
An association between an application and a person that has applied for it.
8 properties 2 required
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
AwardRef
object
A reference to an award
1 required
OrderingsList
object
List of available orderings
1 property
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties 2 required
ApplicationCluster
object
An application cluster groups related applications from their individual relations.
16 properties
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
SystemCurrencyAmount
object
A monetary value in the Pure installation's system currency as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/paymentcurr…
2 properties 1 required
ApplicationsQuery
object
Create a query for applications
6 properties
AllowedTemplateListResult
object
List of allowed templates.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eindhoven-university-of-technology-application-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 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
Eindhoven University of Technology equipment API