Eindhoven University of Technology studentProject API
The studentProject API from Eindhoven University of Technology — 26 operation(s) for studentproject.
Eindhoven University of Technology studentProject 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 studentProject. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 30 operations across 26 paths, and defines 44 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
44 schemas
1 DELETE22 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Eindhoven University of Technology studentProject 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.
studentProject 30
GET
/student-projects
Lists all student projects
PUT
/student-projects
Create student project
GET
/student-projects/allowed-appendix-document-licenses
A list of allowed document licenses
GET
/student-projects/allowed-appendix-document-types
A list of allowed document types
GET
/student-projects/allowed-campuses
A list of allowed campuses
GET
/student-projects/allowed-document-licenses
A list of allowed document licenses
GET
/student-projects/allowed-document-types
A list of allowed document types
GET
/student-projects/allowed-external-collaborator-roles
A list of allowed external collaborator rules
GET
/student-projects/allowed-groups
A list of allowed groups
GET
/student-projects/allowed-image-types
A list of allowed image types
GET
/student-projects/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/student-projects/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/student-projects/allowed-languages
A list of allowed languages
GET
/student-projects/allowed-link-types
A list of allowed link types
GET
/student-projects/allowed-locales
A list of allowed locales in localized strings
GET
/student-projects/allowed-supervisor-types
A list of allowed supervisor types
GET
/student-projects/allowed-types
A list of allowed student project types
GET
/student-projects/allowed-workflow-steps
A list of allowed workflow steps in localized strings
PUT
/student-projects/file-uploads
Upload file to a specific student project
GET
/student-projects/orderings
Lists available orderings
POST
/student-projects/search
Query operation for student project
GET
/student-projects/{uuid}
Get student project
PUT
/student-projects/{uuid}
Update student project
DELETE
/student-projects/{uuid}
Delete student project
POST
/student-projects/{uuid}/actions/lock
Lock the content
POST
/student-projects/{uuid}/actions/unlock
Unlock the content
GET
/student-projects/{uuid}/dependents
Lists all dependents to the student project
GET
/student-projects/{uuid}/files/{fileId}
Get file from the student project
GET
/student-projects/{uuid}/notes
Lists notes
PUT
/student-projects/{uuid}/notes
Create note
Schemas 44
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are StudentProject (44 properties), StudentProjectDocument (18 properties), StudentProjectAppendixDocument (17 properties), ImageFile (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
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
PersonRef
object
A reference to a person internal to the institution
1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
StudentProjectAuthor
object
The collection of authors of the student project
4 properties
2 required
StudentProjectNotificationRecipient
object
A number of email addresses that will be notified once this student project enters the validated workflow step
2 properties
1 required
StudentProjectDocument
object
A student project document
18 properties
4 required
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
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
EducationAssociation
object
An association to an education
4 properties
2 required
ExternalPersonRef
object
A reference to a person external to the institution
1 required
ImageFile
object
An image file
15 properties
2 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
SemesterRef
object
A reference to semester
1 required
Workflow
object
Information about workflow
2 properties
1 required
LocalesList
object
List of available locales
1 property
UploadedFile
object
Information about the uploaded file
7 properties
1 required
StudentProjectListResult
object
List of student projects. Can contain a subset of all items along with the full count
3 properties
StudentProjectAppendixDocument
object
A student project appendix document
17 properties
4 required
StudentProjectSupervisor
object
A supervisor for a student project
5 properties
2 required
EducationRef
object
A reference to Education
1 required
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 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
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
StudentProjectQuery
object
Create a query for studentProject
6 properties
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
StudentProjectExternalCollaborator
object
An external collaborator of a student project
6 properties
4 required
OrderingsList
object
List of available orderings
1 property
SpecializationRef
object
A reference to a specialization
1 required
ClassificationRefList
object
List of classification references
1 property
StudentProject
object
A student project
44 properties
10 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 contract API
Eindhoven University of Technology course API
Eindhoven University of Technology dataSet API
Eindhoven University of Technology education API
#studentProject