RWTH Aachen University ProjectResource API
Endpoints for the project resources.
RWTH Aachen University ProjectResource 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 ProjectResource. 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 44 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
44 schemas
1 DELETE2 GET1 OPTIONS1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
RWTH Aachen University ProjectResource 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.
ProjectResource 6
Endpoints for the project resources.
POST
/api/v2/projects/{projectId}/resources
Creates a new resource for a specified project.
GET
/api/v2/projects/{projectId}/resources
Retrieves all resources for a specified project.
/api/v2/projects/{projectId}/resources
Responds with the HTTP methods allowed for the endpoint.
GET
/api/v2/projects/{projectId}/resources/{resourceId}
Retrieves a resource for a specified project.
PUT
/api/v2/projects/{projectId}/resources/{resourceId}
Updates a resource for a specified project.
DELETE
/api/v2/projects/{projectId}/resources/{resourceId}
Deletes a resource for a specified project.
Schemas 44
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are ResourceDto (20 properties), ResourceForUpdateDto (13 properties), ResourceForCreationDto (13 properties), ResourceTypeOptionsDto (9 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
DataStorageNrwS3ResourceTypeOptionsForManipulationDto
object
Represents the data transfer object (DTO) for manipulating DataStorage.nrw S3 resource type options.
3 properties
1 required
ResourceTypeDto
object
Represents a resource type.
4 properties
2 required
DataStorageNrwS3WormResourceTypeOptionsForManipulationDto
object
Represents the data transfer object (DTO) for manipulating DataStorage.nrw S3 WORM resource type options.
3 properties
1 required
DsNrwReplicationGroupDto
string
Possible replication groups for the DS NRW.
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
RdsS3WormResourceTypeOptionsForManipulationDto
object
Represents the data transfer object (DTO) for manipulating RDS S3 WORM resource type options.
1 property
1 required
LinkedDataOptionsDto
object
Represents the data transfer object (DTO) for Linked Data options.
LinkedDataResourceTypeOptionsForManipulationDto
object
Represents the data transfer object (DTO) for manipulating linked data resource type options.
ResourceForUpdateDto
object
Represents the data transfer object (DTO) used for updating a resource. Inherits properties from Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.R…
13 properties
5 required
Pagination
object
Represents pagination information for a collection of items.
6 properties
ResourceDtoResponse
object
4 properties
UserMinimalDto
object
Represents a minimal Data Transfer Object (DTO) for user information.
1 property
1 required
DisciplineForResourceManipulationDto
object
Data transfer object (DTO) representing a discipline for resource manipulation.
1 property
1 required
GitlabResourceTypeOptionsForCreationDto
object
Represents the data transfer object (DTO) for creating GitLab resource type options.
5 properties
5 required
ResourceTypeOptionsDto
object
Represents the options available for different resource types.
9 properties
ApplicationProfileForResourceCreationDto
object
Data transfer object (DTO) representing the creation of an application profile for a resource.
1 property
1 required
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
RdsResourceTypeOptionsForManipulationDto
object
Represents the data transfer object (DTO) for manipulating RDS Web resource type options.
1 property
1 required
ResourceTypeOptionsForCreationDto
object
Represents the data transfer object (DTO) for creating options related to any resource type.
8 properties
GitlabResourceTypeOptionsForUpdateDto
object
Represents the data transfer object (DTO) for updating GitLab resource type options.
2 properties
2 required
GitLabOptionsDto
object
Represents the data transfer object (DTO) for GitLab options.
4 properties
VisibilityForResourceManipulationDto
object
Represents the data transfer object (DTO) for manipulating the visibility of a resource.
1 property
1 required
DataStorageNrwS3OptionsDto
object
Represents the data transfer object (DTO) for DataStorage.nrw S3 options.
7 properties
6 required
ResourceTypeOptionsForUpdateDto
object
Represents the data transfer object (DTO) used for updating options related to any resource type.
8 properties
LicenseForResourceManipulationDto
object
Data transfer object (DTO) representing a license for resource manipulation.
1 property
1 required
RdsS3OptionsDto
object
Represents the data transfer object (DTO) for RDS S3 options.
7 properties
6 required
ResourceDtoPagedResponse
object
5 properties
FixedValueForResourceManipulationDto
object
Data transfer object (DTO) representing the manipulation of a fixed value associated with a resource.
4 properties
RdsS3ResourceTypeOptionsForManipulationDto
object
Represents the data transfer object (DTO) for manipulating RDS S3 resource type options.
1 property
1 required
ResourceForCreationDto
object
Represents the data transfer object (DTO) used for creating a resource. Inherits properties from Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.R…
13 properties
7 required
LifecycleOptionsForManipulationDto
object
Represents the data transfer object (DTO) for manipulating lifecycle options on an S3 bucket.
2 properties
DataStorageNrwWebResourceTypeOptionsForManipulationDto
object
Represents the data transfer object (DTO) for manipulating DataStorage.nrw Web resource type options.
3 properties
1 required
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
QuotaForManipulationDto
object
Represents a data transfer object (DTO) used for manipulating quota values.
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from RWTH Aachen University 12
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
#ProjectResource