Eindhoven University of Technology contract API
The contract API from Eindhoven University of Technology — 26 operation(s) for contract.
Eindhoven University of Technology contract 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 contract. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 30 operations across 26 paths, and defines 53 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.
30 operations
26 paths
53 schemas
1 DELETE22 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Eindhoven University of Technology contract 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 30
Across 26 paths, the API surfaces 30 operations — 1 DELETE, 22 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
contract 30
GET
/contracts
Lists all contracts
PUT
/contracts
Create contract
GET
/contracts/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/contracts/allowed-collaborator-types
A list of allowed contract collaborator types
GET
/contracts/allowed-description-types
A list of allowed description types
GET
/contracts/allowed-document-licenses
A list of allowed document licenses
GET
/contracts/allowed-document-types
A list of allowed document types
GET
/contracts/allowed-document-version-types
A list of allowed document version types
GET
/contracts/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/contracts/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/contracts/allowed-link-types
A list of allowed link types
GET
/contracts/allowed-locales
A list of allowed locales in localized strings
GET
/contracts/allowed-persons-roles
A list of allowed person roles
GET
/contracts/allowed-replies
A list of allowed reply values
GET
/contracts/allowed-requirements
A list of allowed requirement values
GET
/contracts/allowed-types
A list of allowed contract types
GET
/contracts/allowed-workflow-steps
A list of allowed workflow steps
PUT
/contracts/file-uploads
Upload file for a specific contract
GET
/contracts/orderings
Lists available orderings
POST
/contracts/search
Query operation for contracts
GET
/contracts/{uuid}
Get contract
PUT
/contracts/{uuid}
Update contract
DELETE
/contracts/{uuid}
Delete contract
POST
/contracts/{uuid}/actions/lock
Lock the content
POST
/contracts/{uuid}/actions/unlock
Unlock the content
GET
/contracts/{uuid}/dependents
Lists all dependents to a contract
GET
/contracts/{uuid}/files/{fileId}
Get file from the contract
GET
/contracts/{uuid}/milestones
List contract milestones on an contract
GET
/contracts/{uuid}/notes
Lists notes
PUT
/contracts/{uuid}/notes
Create note
Schemas 53
The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are Contract (35 properties), Milestone (30 properties), ContractDocument (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
MilestoneReminder
object
A milestone reminder.
3 properties
2 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 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.
ContractCurtailed
object
Information about the reason the contract is curtailed.
2 properties
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
MilestoneListResult
object
List of milestones. Can contain a subset of all items along with the full count
3 properties
ProjectRef
object
A reference to project
1 required
ContractQuery
object
Create a query for contract
6 properties
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
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
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
ExternalPersonRef
object
A reference to a person external to the institution
1 required
ContractRef
object
A reference to a contract
1 required
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
Workflow
object
Information about workflow
2 properties
1 required
Milestone
object
A milestone.
30 properties
2 required
AbstractClassifiedContractPersonAssociation
object
The persons associated with this contract
5 properties
2 required
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
Identifier
object
1 property
1 required
ContractContractAssociation
object
An association with a contract
2 properties
1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 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
EthicalReviewRef
object
A reference to an ethical review
1 required
ContractListResult
object
List of contracts. Can contain a subset of all items along with the full count
3 properties
ProblemDetails
object
RFC7807 Error details
5 properties
Name
object
A name describing a person, made up of given- and family name
2 properties
ContractAwardAssociation
object
An association with an award
3 properties
1 required
ClassificationRef
object
A reference to a classification value
2 properties
1 required
ContractDocument
object
A contract document.
18 properties
5 required
ContractCollaboratorAssociation
object
A association between a contract and a collaborator
5 properties
1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ContractExtended
object
Information about the contract extension.
1 property
AwardRef
object
A reference to an award
1 required
OrderingsList
object
List of available orderings
1 property
ClassificationSchemeRef
object
A reference to a classification scheme
1 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
Contract
object
A contract
35 properties
5 required
ContractApplicationAssociation
object
An association with an application
2 properties
1 required
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 award API
Eindhoven University of Technology classificationScheme API
Eindhoven University of Technology concept API
Eindhoven University of Technology conferenceSeries 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
#contract