University of Basel API v2 API
The API v2 API from University of Basel — 56 operation(s) for api v2.
OpenAPI Specification
openapi: 3.1.0
info:
title: DSP Admin API API v2 API
version: v35.10.0
summary: DSP-API is part of the DaSCH Service Platform, a repository for the long-term preservation and reuse of data in the humanities.
contact:
name: DaSCH
url: https://www.dasch.swiss/
servers:
- url: https://api.dasch.swiss:443
description: The dsp-api server
tags:
- name: API v2
paths:
/v2/authentication:
get:
tags:
- API v2
operationId: getV2Authentication
responses:
'200':
description: ''
headers:
Set-Cookie:
required: false
schema:
type: array
items:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CheckResponse'
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- httpAuth: []
- httpAuth1: []
post:
tags:
- API v2
operationId: postV2Authentication
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoginPayload'
required: true
responses:
'200':
description: ''
headers:
Set-Cookie:
required: false
schema:
type: array
items:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TokenResponse'
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- API v2
operationId: deleteV2Authentication
parameters:
- name: KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9
in: cookie
required: false
schema:
type: string
responses:
'200':
description: ''
headers:
Set-Cookie:
required: false
schema:
type: array
items:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogoutResponse'
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- {}
- httpAuth: []
/v2/lists/{listIri}:
get:
tags:
- API v2
description: Returns a list (a graph with all list nodes).
operationId: getV2ListsListiri
parameters:
- name: listIri
in: path
description: The iri to a list.
required: true
schema:
type: string
example: http://rdfh.ch/lists/0001/FCIjX3J7R8SburI_yz7oeA
- name: x-knora-accept-schema
in: header
description: 'The ontology schema to be used for the request.
If not specified, the default schema ApiV2Complex will be used.'
required: false
schema:
type: string
- name: schema
in: query
description: 'The ontology schema to be used for the request.
If not specified, the default schema ApiV2Complex will be used.'
required: false
schema:
type: string
- name: x-knora-json-ld-rendering
in: header
description: 'The JSON-LD rendering to be used for the request (flat or hierarchical).
If not specified, hierarchical JSON-LD will be used.'
required: false
schema:
type: string
- name: markup
in: query
description: The markup rendering to be used for the request (XML or standoff).
required: false
schema:
type: string
- name: x-knora-accept-markup
in: header
description: The markup rendering to be used for the request (XML or standoff).
required: false
schema:
type: string
responses:
'200':
description: ''
headers:
Content-Type:
required: true
schema:
type: string
content:
application/ld+json:
schema:
type: string
text/turtle:
schema:
type: string
application/trig:
schema:
type: string
application/rdf+xml:
schema:
type: string
application/n-quads:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- httpAuth: []
- httpAuth1: []
/v2/node/{listIri}:
get:
tags:
- API v2
description: Returns a list node.
operationId: getV2NodeListiri
parameters:
- name: listIri
in: path
description: The iri to a list.
required: true
schema:
type: string
example: http://rdfh.ch/lists/0001/FCIjX3J7R8SburI_yz7oeA
- name: x-knora-accept-schema
in: header
description: 'The ontology schema to be used for the request.
If not specified, the default schema ApiV2Complex will be used.'
required: false
schema:
type: string
- name: schema
in: query
description: 'The ontology schema to be used for the request.
If not specified, the default schema ApiV2Complex will be used.'
required: false
schema:
type: string
- name: x-knora-json-ld-rendering
in: header
description: 'The JSON-LD rendering to be used for the request (flat or hierarchical).
If not specified, hierarchical JSON-LD will be used.'
required: false
schema:
type: string
- name: markup
in: query
description: The markup rendering to be used for the request (XML or standoff).
required: false
schema:
type: string
- name: x-knora-accept-markup
in: header
description: The markup rendering to be used for the request (XML or standoff).
required: false
schema:
type: string
responses:
'200':
description: ''
headers:
Content-Type:
required: true
schema:
type: string
content:
application/ld+json:
schema:
type: string
text/turtle:
schema:
type: string
application/trig:
schema:
type: string
application/rdf+xml:
schema:
type: string
application/n-quads:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- httpAuth: []
- httpAuth1: []
/v2/resources/info:
get:
tags:
- API v2
description: Get information about resources of a specific class in a project. Publicly accessible.
operationId: getV2ResourcesInfo
parameters:
- name: x-knora-accept-project
in: header
required: true
schema:
type: string
- name: resourceClass
in: query
required: true
schema:
type: string
- name: order
in: query
description: Sort the results in ascending (asc) or descending (desc) order.
required: false
schema:
default: Asc
type: string
- name: orderBy
in: query
description: Sort the results by the specified property.
required: false
schema:
default: LastModificationDate
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListResponseDto'
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/values/{resourceIri}/{valueUuid}:
get:
tags:
- API v2
description: Get a value of a resource. Publicly accessible. Requires appropriate object access permissions on the resource. Find detailed documentation on <a href="https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/editing-values/">docs.dasch.swiss</a>.
operationId: getV2ValuesResourceiriValueuuid
parameters:
- name: resourceIri
in: path
description: The IRI of a Resource.
required: true
schema:
type: string
- name: valueUuid
in: path
description: The UUID of a Value.
required: true
schema:
type: string
- name: version
in: query
required: false
schema:
type: string
- name: x-knora-accept-schema
in: header
description: 'The ontology schema to be used for the request.
If not specified, the default schema ApiV2Complex will be used.'
required: false
schema:
type: string
- name: schema
in: query
description: 'The ontology schema to be used for the request.
If not specified, the default schema ApiV2Complex will be used.'
required: false
schema:
type: string
- name: x-knora-json-ld-rendering
in: header
description: 'The JSON-LD rendering to be used for the request (flat or hierarchical).
If not specified, hierarchical JSON-LD will be used.'
required: false
schema:
type: string
- name: markup
in: query
description: The markup rendering to be used for the request (XML or standoff).
required: false
schema:
type: string
- name: x-knora-accept-markup
in: header
description: The markup rendering to be used for the request (XML or standoff).
required: false
schema:
type: string
responses:
'200':
description: ''
headers:
Content-Type:
required: true
schema:
type: string
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- httpAuth: []
- httpAuth1: []
/v2/values:
put:
tags:
- API v2
description: Update a value of a resource. Requires appropriate object access permissions on the resource. Find detailed documentation on <a href="https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/editing-values/">docs.dasch.swiss</a>.
operationId: putV2Values
requestBody:
content:
application/json:
schema:
type: string
example:
'@id': http://rdfh.ch/0001/a-thing
'@type': anything:Thing
anything:hasInteger:
'@id': http://rdfh.ch/0001/a-thing/values/vp96riPIRnmQcbMhgpv_Rg
'@type': knora-api:IntValue
knora-api:intValueAsInt: 5
'@context':
knora-api: http://api.knora.org/ontology/knora-api/v2#
anything: http://0.0.0.0:3333/ontology/0001/anything/v2#
required: true
responses:
'200':
description: ''
headers:
Content-Type:
required: true
schema:
type: string
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- httpAuth: []
- httpAuth1: []
post:
tags:
- API v2
description: Create a new value for a resource. Requires appropriate object access permissions on the resource. Find detailed documentation on <a href="https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/editing-values/">docs.dasch.swiss</a>.
operationId: postV2Values
requestBody:
content:
application/json:
schema:
type: string
example:
'@id': http://rdfh.ch/0001/a-thing
'@type': anything:Thing
anything:hasInteger:
'@type': knora-api:IntValue
knora-api:intValueAsInt: 4
'@context':
knora-api: http://api.knora.org/ontology/knora-api/v2#
anything: http://0.0.0.0:3333/ontology/0001/anything/v2#
required: true
responses:
'200':
description: ''
headers:
Content-Type:
required: true
schema:
type: string
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- httpAuth: []
- httpAuth1: []
/v2/values/order:
put:
tags:
- API v2
description: Reorder values of a property on a resource. Requires modify permission on the resource. Find detailed documentation on <a href="https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/editing-values/">docs.dasch.swiss</a>.
operationId: putV2ValuesOrder
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReorderValuesRequest'
example:
resourceIri: http://rdfh.ch/0001/resource-1
propertyIri: http://0.0.0.0:3333/ontology/0001/anything/v2#hasText
orderedValueIris:
- http://rdfh.ch/0001/value-3
- http://rdfh.ch/0001/value-1
- http://rdfh.ch/0001/value-2
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ReorderValuesResponse'
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- httpAuth: []
- httpAuth1: []
/v2/values/delete:
post:
tags:
- API v2
description: Mark a value as deleted. Requires appropriate object access permissions on the resource. Find detailed documentation on <a href="https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/editing-values/">docs.dasch.swiss</a>.
operationId: postV2ValuesDelete
requestBody:
content:
application/json:
schema:
type: string
example:
'@id': http://rdfh.ch/0001/a-thing
'@type': anything:Thing
anything:hasInteger:
'@id': http://rdfh.ch/0001/a-thing/values/vp96riPIRnmQcbMhgpv_Rg
'@type': knora-api:IntValue
'@context':
knora-api: http://api.knora.org/ontology/knora-api/v2#
anything: http://0.0.0.0:3333/ontology/0001/anything/v2#
required: true
responses:
'200':
description: ''
headers:
Content-Type:
required: true
schema:
type: string
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- httpAuth: []
- httpAuth1: []
/v2/values/erase:
post:
tags:
- API v2
description: Erase a Value and all of its old versions from the database completely. Requires SystemAdmin permissions. Find detailed documentation on <a href="https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/editing-values/">docs.dasch.swiss</a>.
operationId: postV2ValuesErase
requestBody:
content:
application/json:
schema:
type: string
example:
'@id': http://rdfh.ch/0001/a-thing
'@type': anything:Thing
anything:hasInteger:
'@id': http://rdfh.ch/0001/a-thing/values/vp96riPIRnmQcbMhgpv_Rg
'@type': knora-api:IntValue
'@context':
knora-api: http://api.knora.org/ontology/knora-api/v2#
anything: http://0.0.0.0:3333/ontology/0001/anything/v2#
required: true
responses:
'200':
description: ''
headers:
Content-Type:
required: true
schema:
type: string
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/ValidationException'
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/GravsearchException'
- $ref: '#/components/schemas/EditConflictException'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BadCredentialsException'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- httpAuth: []
- httpAuth1: []
/v2/values/erasehistory:
post:
tags:
- API v2
description: Erase all old versions of a Value from the database completely and keep only the latest version. Requires SystemAdmin permissions. Find detailed documentation on <a href="https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/editing-values/">docs.dasch.swiss</a>.
operationId: postV2ValuesErasehistory
requestBody:
content:
application/json:
schema:
type: string
example:
'@id': http://rdfh.ch/0001/a-thing
'@type': anything:Thing
anything:hasInteger:
'@id': http://rdfh.ch/0001/a-thing/values/vp96riPIRnmQcbMhgpv_Rg
'@type': knora-api:IntValue
'@context':
knora-api: http://api.knora.org/ontology/knora-api/v2#
anything: http://0.0.0.0:3333/ontology/0001/anything/v2#
required: true
responses:
'200':
description: ''
headers:
Content-Type:
required: true
schema:
type: string
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/OntologyConstraintException'
- $ref: '#/components/schemas/DuplicateValueException'
- $ref: '#/components/schemas/Va
# --- truncated at 32 KB (229 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/university-of-basel/refs/heads/main/openapi/university-of-basel-api-v2-api-openapi.yml