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

Endpoints for the file and metadata trees.

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

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

9 operations 5 paths 23 schemas 1 DELETE3 GET1 OPTIONS2 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 Tree 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 9

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

Tree 9

Endpoints for the file and metadata trees.

GET
/api/v2/projects/{projectId}/resources/{resourceId}/trees/filesdeprecated
Retrieves the file tree associated with a resource.
GetFileTree 6 params → 200403400404
GET
/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadatadeprecated
Retrieves the metadata tree associated with a resource.
GetMetadataTree 9 params → 200403400404
POST
/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadatadeprecated
Creates a new metadata tree for a resource.
CreateMetadataTree 2 params body → 201403400404
PUT
/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadatadeprecated
Updates an existing metadata tree of a resource.
UpdateMetadataTree 2 params body → 204403400404
DELETE
/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadatadeprecated
Deletes (invalidates) a metadata tree associated with a resource.
DeleteMetadataTree 2 params body → 204403400404
GET
/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata/specificdeprecated
Retrieves the specific metadata tree associated with a resource.
GetSpecificMetadataTree 7 params → 200403400404
POST
/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata/extracteddeprecated
Creates a new extracted metadata tree for a resource.
CreateExtractedMetadataTree 2 params body → 201403400404
PUT
/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata/extracteddeprecated
Updates an existing metadata tree of a resource.
UpdateExtractedMetadataTree 2 params body → 204403400404
OPTIONS
/api/v2/projects/{projectId}/resources/{resourceId}/trees
Responds with the HTTP methods allowed for the endpoint.
2 params → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are FileTreeDto (10 properties), MetadataTreeDto (8 properties), ProvenanceDto (7 properties), Pagination (6 properties). Each schema is shown below with its type and property counts.

MetadataTreeForCreationDto
object
Data transfer object (DTO) representing the creation of a metadata tree. Extends the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.Me…
2 properties 2 required
MetadataTreeForUpdateDto
object
Data transfer object (DTO) representing the update of a metadata tree. Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObject…
2 properties 2 required
ProvenanceParametersDto
object
Data transfer object (DTO) representing Provenance Parameters in a request.
6 properties
VariantDto
object
Represents the variants of this specific metadata tree.
2 properties
FileTreeDtoPagedResponse
object
5 properties
TreeDataType
string
Represents the types of nodes within a hierarchical tree structure.
Pagination
object
Represents pagination information for a collection of items.
6 properties
ExtractedMetadataTreeForCreationDto
object
Data transfer object (DTO) representing the creation of a metadata tree. Extends the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.Me…
4 properties 4 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
MetadataTreeExtractedDto
object
Represents a data transfer object (DTO) for extracted metadata within a tree structure, extending the base TreeDto.
5 properties
FileTreeDto
object
Represents a Data Transfer Object (DTO) for a file within a tree structure, extending the base TreeDto.
10 properties
MetadataTreeDtoPagedResponse
object
5 properties
MetadataTreeDtoResponse
object
4 properties
FileActionHttpMethod
string
Represents the possible HTTP methods associated with file actions.
FileActionsDto
object
Represents a Data Transfer Object (DTO) for a collection of file actions, including download action details.
1 property
MetadataTreeForDeletionDto
object
Data transfer object (DTO) for deleting a specific version of metadata.
3 properties 3 required
ProvenanceDto
object
Represents a data transfer object (DTO) for provenance information.
7 properties 3 required
ExtractedMetadataTreeForUpdateDto
object
Data transfer object (DTO) representing the update of a metadata tree. Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObject…
5 properties 4 required
RdfFormat
string
Specifies the RDF (Resource Description Framework) format.
FileActionDto
object
Represents a Data Transfer Object (DTO) for file actions, including the URL and HTTP method.
2 properties
MetadataTreeDto
object
Represents a data transfer object (DTO) for metadata within a tree structure, extending the base TreeDto.
8 properties
HashParametersDto
object
Data transfer object (DTO) representing Hash Parameters in a request.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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