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

Endpoints for the pids.

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

This API exposes 4 operations across 3 paths, and defines 6 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.

4 operations 3 paths 6 schemas 2 GET1 OPTIONS1 POST

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 Pid 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 4

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

Pid 4

Endpoints for the pids.

GET
/api/v2/pids/{prefix}/{suffix}
Retrieves the Persistent Identifier (PID) for a given prefix and suffix.
GetPid 2 params → 200404410
POST
/api/v2/pids/{prefix}/{suffix}/requests
Sends an inquiry to the owner of the given PID.
SendRequestToOwner 2 params body → 204400404
GET
/api/v2/pids
Retrieves all PIDs.
GetPids 6 params → 200403
OPTIONS
/api/v2/pids
Responds with the HTTP methods allowed for the endpoint.
→ 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Pagination (6 properties), PidDtoPagedResponse (5 properties), PidDto (5 properties), PidDtoResponse (4 properties). Each schema is shown below with its type and property counts.

PidType
string
Specifies the type of PID.
PidDto
object
Represents a data transfer object (DTO) for a PID (Persistent Identifier).
5 properties 2 required
Pagination
object
Represents pagination information for a collection of items.
6 properties
PidRequestDto
object
Data transfer object (DTO) representing a PID request.
4 properties 3 required
PidDtoPagedResponse
object
5 properties
PidDtoResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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