Eindhoven University of Technology award API
The award API from Eindhoven University of Technology — 37 operation(s) for award.
Eindhoven University of Technology award 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 award. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 43 operations across 37 paths, and defines 76 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.
43 operations
37 paths
76 schemas
1 DELETE32 GET4 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Eindhoven University of Technology award 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 43
Across 37 paths, the API surfaces 43 operations — 1 DELETE, 32 GET, 4 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
award 43
GET
/awards
Lists all awards
PUT
/awards
Create award
GET
/awards/allowed-awardholder-roles
A list of allowed award holder roles
GET
/awards/allowed-budget-account-classifications
A list of allowed account classifications
GET
/awards/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/awards/allowed-collaborator-types
A list of allowed collaborator types
GET
/awards/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the award
GET
/awards/allowed-description-types
A list of allowed description types
GET
/awards/allowed-document-licenses
A list of allowed document licenses
GET
/awards/allowed-document-types
A list of allowed document types
GET
/awards/allowed-document-version-types
A list of allowed document version types
GET
/awards/allowed-funding-classifications
A list of allowed funding classifications
GET
/awards/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/awards/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/awards/allowed-link-types
A list of allowed link types
GET
/awards/allowed-locales
A list of allowed locales in localized strings
GET
/awards/allowed-nature-types
A list of allowed nature types
GET
/awards/allowed-templates
A list of allowed award templates
GET
/awards/allowed-types
A list of allowed award types
GET
/awards/allowed-workflow-steps
A list of allowed workflow steps
GET
/awards/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/awards/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/awards/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with awards
PUT
/awards/file-uploads
Upload file to a specific award
GET
/awards/orderings
Lists available orderings
POST
/awards/search
Query operation for awards
GET
/awards/{uuid}
Get award
PUT
/awards/{uuid}
Update award
DELETE
/awards/{uuid}
Delete award
POST
/awards/{uuid}/actions/lock
Lock the content
POST
/awards/{uuid}/actions/unlock
Unlock the content
GET
/awards/{uuid}/budgets
Get the budgets for the award
GET
/awards/{uuid}/budgets/{id}
Get a specific budget for the award
PUT
/awards/{uuid}/budgets/{id}
Update budget for an award
GET
/awards/{uuid}/cluster
Get the award cluster for the award
GET
/awards/{uuid}/dependents
Lists all dependents to an award
GET
/awards/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the award
PUT
/awards/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the award
GET
/awards/{uuid}/files/{fileId}
Get file from the award
GET
/awards/{uuid}/fingerprints
Get the fingerprints for the award
GET
/awards/{uuid}/milestones
List award milestones on an award
GET
/awards/{uuid}/notes
Lists notes
PUT
/awards/{uuid}/notes
Create note
Schemas 76
The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are Award (43 properties), Milestone (30 properties), AwardDocument (18 properties), MilestoneDocument (15 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
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
ResearcherCommitment
object
Planned and actual research commitment.
4 properties
1 required
DeprecatedDateRange
object
Deprecated version of DateRange
2 properties
AwardFundingBudgetAssociation
object
A budget for a financial funding of an award.
6 properties
1 required
UserRef
object
A reference to an user
1 required
MilestoneReminder
object
A milestone reminder.
3 properties
2 required
FingerprintListResult
object
List of fingerprints. Can contain a subset of all items along with the full count
3 properties
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
ConceptRef
object
A reference to a concept
1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
YearMonth
object
A date that can be defined by only year and month
2 properties
2 required
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
Fingerprint
object
A fingerprint
13 properties
1 required
DateRange
object
A date range
2 properties
OrganizationRef
object
A reference to an organization in the institution
1 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
AbstractAwardHolderAssociation
object
An association between an award and a person that was awarded it.
9 properties
2 required
RankedConcept
object
A ranked concept
4 properties
2 required
DeprecatedSystemCurrencyAmount
object
Deprecated version of SystemCurrencyAmount
2 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
AwardBudget
object
A budget for an award.
3 properties
1 required
ContractRef
object
A reference to a contract
1 required
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
MilestoneDocument
object
A milestone document
15 properties
4 required
Account
object
An account of a budget.
9 properties
Workflow
object
Information about workflow
2 properties
1 required
AwardCluster
object
An award cluster groups related awards from their individual relations.
14 properties
AllowedTemplateListResult
object
List of allowed templates.
1 property
Milestone
object
A milestone.
30 properties
2 required
LocalesList
object
List of available locales
1 property
UploadedFile
object
Information about the uploaded file
7 properties
1 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
ApplicationRef
object
A reference to an application
1 required
CollaboratorAssociation
object
A collaborator associated with the content.
4 properties
1 required
Identifier
object
1 property
1 required
AwardDocument
object
An award document.
18 properties
5 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
AwardBudgetResult
object
List of award budgets. Can contain a subset of all items along with the full count
3 properties
AllowedTemplate
object
An allowed template, such as 'ContributionToJournal' or 'BookAnthology' for research outputs.
2 properties
KeywordGroup
object
4 properties
2 required
WorkflowListResult
object
List of workflow steps.
1 property
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
AwardClusterRef
object
A reference to an award cluster
1 required
Award
object
Awards exists in two variations depending on the functionality enabled in the Pure installation.
43 properties
7 required
Name
object
A name describing a person, made up of given- and family name
2 properties
ProblemDetails
object
RFC7807 Error details
5 properties
ClassificationRef
object
A reference to a classification value
2 properties
1 required
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
EthicalReviewRef
object
A reference to an ethical review
1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
AwardRef
object
A reference to an award
1 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
AwardFundingAssociation
object
Funding associations exists in two variants, financial or non-financial.
8 properties
1 required
OrderingsList
object
List of available orderings
1 property
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
ClassificationRefList
object
List of classification references
1 property
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
AwardListResult
object
List of awards. Can contain a subset of all items along with the full count
3 properties
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
AwardsQuery
object
Create a query for awards
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Eindhoven University of Technology 12
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 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
#award