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

RWTH Aachen University Project API

Endpoints for the projects.

RWTH Aachen University Project API is one of 49 APIs that RWTH Aachen University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 6 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://coscine.rwth-aachen.de/coscine.

6 operations 2 paths 15 schemas 1 DELETE2 GET1 OPTIONS1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://coscine.rwth-aachen.de/coscine/api/
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

RWTH Aachen University Project API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — JWT Authorization header using the Bearer scheme.

Paths & Operations 6

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

Project 6

Endpoints for the projects.

POST
/api/v2/projects
Creates a new project.
CreateProject body → 201403400404
GET
/api/v2/projects
Retrieves all projects.
GetProjects 5 params → 200403
OPTIONS
/api/v2/projects
Responds with the HTTP methods allowed for the endpoint.
→ 200
GET
/api/v2/projects/{projectId}
Retrieves a project.
GetProject 2 params → 200403400404
PUT
/api/v2/projects/{projectId}
Updates a project.
UpdateProject 1 param body → 204403400404
DELETE
/api/v2/projects/{projectId}
Deletes a project.
DeleteProject 1 param → 204403400404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ProjectDto (18 properties), ProjectForCreationDto (13 properties), ProjectForUpdateDto (12 properties), Pagination (6 properties). Each schema is shown below with its type and property counts.

PublicationAdvisoryServiceDto
object
Data transfer object (DTO) representing the publication advisory service of an organization.
4 properties 2 required
VisibilityDto
object
Represents a Data Transfer Object (DTO) for visibility settings.
2 properties
DisciplineForProjectManipulationDto
object
Data transfer object (DTO) representing a discipline for project manipulation.
1 property 1 required
OrganizationForProjectManipulationDto
object
Data transfer object (DTO) representing an organization for project manipulation.
2 properties 2 required
ProjectDto
object
Represents a data transfer object (DTO) for project information.
18 properties 10 required
ProjectForUpdateDto
object
Data transfer object (DTO) representing the update of a project. Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.Proj…
12 properties 6 required
Pagination
object
Represents pagination information for a collection of items.
6 properties
DisciplineDto
object
Represents the data transfer object for a discipline.
4 properties
ProjectDtoResponse
object
4 properties
ProjectMinimalDto
object
Represents a minimal data transfer object (DTO) for a project.
1 property 1 required
ProjectOrganizationDto
object
Represents a data transfer object (DTO) for an organization in the context of a project.
5 properties 3 required
UserMinimalDto
object
Represents a minimal Data Transfer Object (DTO) for user information.
1 property 1 required
VisibilityForProjectManipulationDto
object
Represents the data transfer object (DTO) for manipulating the visibility of a project.
1 property 1 required
ProjectForCreationDto
object
Data transfer object (DTO) representing the creation of a project. Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.Pr…
13 properties 5 required
ProjectDtoPagedResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rwth-aachen-university-project-api-openapi.yml Raw ↑

Other APIs RWTH Aachen University publishes across the network.

RWTH Publications OAI-PMH
RWTH Single Sign-On (OAuth2 / OpenID Connect / Shibboleth)
RWTH Aachen University Admin API
RWTH Aachen University ApplicationProfile API
RWTH Aachen University Blob API
RWTH Aachen University DataHamsterReport API
RWTH Aachen University Discipline API
RWTH Aachen University Graph API
RWTH Aachen University GraphMetadata API
RWTH Aachen University GraphMetadataContent API
RWTH Aachen University Handle API
RWTH Aachen University Language API