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

Endpoints for the resources.

RWTH Aachen University Resource 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 Resource. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 22 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.

2 operations 2 paths 22 schemas 1 GET1 OPTIONS

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 Resource 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 2

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

Resource 2

Endpoints for the resources.

GET
/api/v2/resources/{resourceId}
Retrieves a resource by its ID.
GetResource 1 param → 200403404
OPTIONS
/api/v2/resources
Responds with the HTTP methods allowed for the endpoint.
→ 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ResourceDto (20 properties), ResourceTypeOptionsDto (9 properties), DataStorageNrwS3WormOptionsDto (7 properties), RdsS3OptionsDto (7 properties). Each schema is shown below with its type and property counts.

VisibilityDto
object
Represents a Data Transfer Object (DTO) for visibility settings.
2 properties
LicenseDto
object
Represents a Data Transfer Object (DTO) for license details.
3 properties
QuotaUnit
string
Specifies the unit of quota.
ResourceDto
object
Represents a Data Transfer Object (DTO) for resource details.
20 properties 9 required
ResourceTypeDto
object
Represents a resource type.
4 properties 2 required
RdsOptionsDto
object
Represents the data transfer object (DTO) for RDS options.
2 properties 1 required
FileSystemStorageOptionsDto
object
Represents the data transfer object (DTO) for FileSystemStorage options.
1 property 1 required
DataStorageNrwS3WormOptionsDto
object
Represents the data transfer object (DTO) for DataStorage.nrw S3 WORM options.
7 properties 6 required
RdsS3WormOptionsDto
object
Represents the data transfer object (DTO) for RDS S3 WORM options.
7 properties 6 required
ApplicationProfileMinimalDto
object
Represents a minimalistic application profile data transfer object.
1 property 1 required
LinkedDataOptionsDto
object
Represents the data transfer object (DTO) for Linked Data options.
ResourceDtoResponse
object
4 properties
UserMinimalDto
object
Represents a minimal Data Transfer Object (DTO) for user information.
1 property 1 required
ResourceTypeOptionsDto
object
Represents the options available for different resource types.
9 properties
DataStorageNrwWebOptionsDto
object
Represents the data transfer object (DTO) for DataStorage.nrw Web options.
2 properties 1 required
QuotaDto
object
Represents a Data Transfer Object (DTO) for quota values.
2 properties 2 required
GitLabOptionsDto
object
Represents the data transfer object (DTO) for GitLab options.
4 properties
DataStorageNrwS3OptionsDto
object
Represents the data transfer object (DTO) for DataStorage.nrw S3 options.
7 properties 6 required
RdsS3OptionsDto
object
Represents the data transfer object (DTO) for RDS S3 options.
7 properties 6 required
FixedValueForResourceManipulationDto
object
Data transfer object (DTO) representing the manipulation of a fixed value associated with a resource.
4 properties
DisciplineDto
object
Represents the data transfer object for a discipline.
4 properties
ProjectMinimalDto
object
Represents a minimal data transfer object (DTO) for a project.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rwth-aachen-university-resource-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