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

Endpoints for admin functionality.

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

This API exposes 12 operations across 9 paths, and defines 60 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.

12 operations 9 paths 60 schemas 1 DELETE6 GET1 OPTIONS1 PATCH1 POST2 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 Admin 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 12

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

Admin 12

Endpoints for admin functionality.

GET
/api/v2/admin/activity-logs
Retrieves all activity logs.
GetAllActivityLogs 9 params → 200
GET
/api/v2/admin/projects
Retrieves all projects.
GetAllProjects 7 params → 200403
GET
/api/v2/admin/resources
Retrieves all resources.
GetAllResources 5 params → 200403
GET
/api/v2/admin/users
Retrieves all users.
GetAllUsers 5 params → 200403
GET
/api/v2/admin/metadata/{graph}
Gets a metadata graph.
GetMetadataGraph 2 params → 200403
PUT
/api/v2/admin/metadata/{graph}
Updates a metadata graph.
UpdateMetadataGraph 1 param body → 204403
PATCH
/api/v2/admin/metadata/{graph}
Patches a metadata graph.
PatchMetadata 1 param body → 204403
GET
/api/v2/admin/graphs
Gets all deployed graphs.
GetDeployedGraphs 3 params → 200403
POST
/api/v2/admin/resource/{resourceId}/type/{typeId}
Creates a new datasource for a specified resource and type.
CreateDatasource 4 params → 200403
PUT
/api/v2/admin/resource/{resourceId}/type/{typeId}
Updates the type and option ID of a specified resource.
UpdateResourceType 3 params → 204403
DELETE
/api/v2/admin/users/{userId}
Deletes the given user.
1 param → 204
OPTIONS
/api/v2/admin
Responds with the HTTP methods allowed for the endpoint.
→ 200

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are ResourceAdminDto (23 properties), ProjectAdminDto (23 properties), ProjectDto (18 properties), UserDto (14 properties). Each schema is shown below with its type and property counts.

ProjectResourceMinimalDto
object
Represents a minimal data transfer object (DTO) for a project resource.
2 properties
ResourceAdminDto
object
Represents a Data Transfer Object (DTO) for administrative purposes with additional resource details.
23 properties 11 required
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
ResourceTypeMinimalDto
object
Represents a minimal Data Transfer Object (DTO) for a resource type.
2 properties 2 required
QuotaUnit
string
Specifies the unit of quota.
ProjectDto
object
Represents a data transfer object (DTO) for project information.
18 properties 10 required
ResourceAdminDtoPagedResponse
object
5 properties
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
RdfDefinitionDtoResponse
object
4 properties
IdentityProviderDto
object
Represents a Data Transfer Object (DTO) for an identity provider.
2 properties 2 required
ResourceQuotaDto
object
Represents a Data Transfer Object (DTO) containing quota information for a resource.
5 properties 1 required
DataStorageNrwS3WormOptionsDto
object
Represents the data transfer object (DTO) for DataStorage.nrw S3 WORM options.
7 properties 6 required
FileSystemStorageOptionsDto
object
Represents the data transfer object (DTO) for FileSystemStorage options.
1 property 1 required
RdsS3WormOptionsDto
object
Represents the data transfer object (DTO) for RDS S3 WORM options.
7 properties 6 required
ProjectRoleMinimalDto
object
Represents a minimal data transfer object (DTO) for a project role.
3 properties
ProjectPublicationRequestDto
object
Represents a data transfer object (DTO) for a project publication request.
7 properties
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.
Pagination
object
Represents pagination information for a collection of items.
6 properties
UserMinimalDto
object
Represents a minimal Data Transfer Object (DTO) for user information.
1 property 1 required
MetadataUpdateAdminParameters
object
Represents parameters for updating metadata in an administrative context.
1 property 1 required
RdfDefinitionForManipulationDto
object
Represents the data transfer object (DTO) used for manipulating RDF definitions.
2 properties 2 required
RdfDefinitionDto
object
Represents a Data Transfer Object (DTO) for RDF (Resource Description Framework) definition details.
2 properties
ResourceMinimalDto
object
Represents a minimal Data Transfer Object (DTO) for a resource, containing essential identifiers.
1 property 1 required
ActivityLogDto
object
Represents a data transfer object (DTO) for an activity log.
7 properties
RdfPatchDocumentDto
object
Represents an RDF Patch document containing a series of operations.
1 property
RdfPatchOperationType
string
Represents the types of operations that can be performed in an RDF Patch document.
PublicationAdvisoryServiceDto
object
Data transfer object (DTO) representing the publication advisory service of an organization.
4 properties 2 required
ResourceTypeOptionsDto
object
Represents the options available for different resource types.
9 properties
DefaultOrganizationQuotaDto
object
Represents the default quota of an organization.
3 properties
ProjectQuotaDto
object
Represents a data transfer object (DTO) containing quota information for a project.
7 properties
DataStorageNrwWebOptionsDto
object
Represents the data transfer object (DTO) for DataStorage.nrw Web options.
2 properties 1 required
ActivityLogDtoPagedResponse
object
5 properties
QuotaDto
object
Represents a Data Transfer Object (DTO) for quota values.
2 properties 2 required
CoscineHttpMethod
string
An enumeration representing the supported HTTP verbs.
UserEmailDto
object
Represents a Data Transfer Object (DTO) for user email information.
3 properties
TitleDto
object
Represents the Data Transfer Object (DTO) for title information.
2 properties 2 required
ProjectAdminDtoPagedResponse
object
5 properties
GitLabOptionsDto
object
Represents the data transfer object (DTO) for GitLab options.
4 properties
DeployedGraphDtoPagedResponse
object
5 properties
DataStorageNrwS3OptionsDto
object
Represents the data transfer object (DTO) for DataStorage.nrw S3 options.
7 properties 6 required
CoscineRoleDto
object
Data Transfer Object (DTO) that represents a user role within Coscine.///
1 property 1 required
ProjectAdminDto
object
Represents a data transfer object (DTO) for an administrative view of a project. Extends the base information in Coscine.Api.Core.Shared.DataTransferObjects.Re…
23 properties 10 required
UserDtoPagedResponse
object
5 properties
CreateDatasourceDtoResponse
object
4 properties
CreateDatasourceDto
object
Represents the data transfer object for creating a datasource.
1 property
UserDto
object
Represents a Data Transfer Object (DTO) for user-related information.
14 properties 7 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
DeployedGraphDto
object
Represents a Data Transfer Object (DTO) for deployed graph details.
2 properties
UserOrganizationDto
object
Represents a Data Transfer Object (DTO) for user-related organization information, inheriting from OrganizationDto.
5 properties 2 required
DsNrwReplicationGroup
string
DisciplineDto
object
Represents the data transfer object for a discipline.
4 properties
RdfFormat
string
Specifies the RDF (Resource Description Framework) format.
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
RdfPatchOperationDto
object
Represents a single operation in an RDF Patch document.
2 properties
LanguageDto
object
Represents a Data Transfer Object (DTO) for language details.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rwth-aachen-university-admin-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 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
RWTH Aachen University License API