University of Basel Admin API API
The Admin API API from University of Basel — 66 operation(s) for admin api.
The Admin API API from University of Basel — 66 operation(s) for admin api.
openapi: 3.1.0
info:
title: DSP Admin API 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: Admin API
paths:
/admin/files/{projectShortcode}/{filename}:
get:
tags:
- Admin API
description: Returns the permission code and the project's restricted view settings for a given shortcode and filename. Publicly accessible.
operationId: getAdminFilesProjectshortcodeFilename
parameters:
- name: projectShortcode
in: path
description: The shortcode of a project. Must be a 4 digit hexadecimal String.
required: true
schema:
type: string
example: '0001'
- name: filename
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionCodeAndProjectRestrictedViewSettings'
'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: []
/admin/groups:
get:
tags:
- Admin API
description: Return all groups. Publicly accessible.
operationId: getAdminGroups
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GroupsGetResponseADM'
example:
groups:
- id: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
name: NewGroup
descriptions:
- value: NewGroup description in English
language: en
- value: NewGroup Beschreibung auf Deutsch
language: de
project:
id: http://rdfh.ch/projects/0042
shortname: example
shortcode: '0001'
longname: Example Project
description:
- value: An example project
language: en
keywords:
- example
- project
ontologies: []
status: true
selfjoin: false
allowedCopyrightHolders: []
enabledLicenses:
- http://rdfh.ch/licenses/boris
- http://rdfh.ch/licenses/open-licence-2.0
- http://rdfh.ch/licenses/cc-by-nc-sa-4.0
- http://rdfh.ch/licenses/public-domain
- http://rdfh.ch/licenses/unknown
- http://rdfh.ch/licenses/ai-generated
- urn:dasch:placeholder
- http://rdfh.ch/licenses/cc-by-4.0
- http://rdfh.ch/licenses/cc-by-nc-nd-4.0
- http://rdfh.ch/licenses/noc-nc-1.0
- http://rdfh.ch/licenses/cc-by-nd-4.0
- http://rdfh.ch/licenses/cc-pdm-1.0
- http://rdfh.ch/licenses/cc-0-1.0
- http://rdfh.ch/licenses/cc-by-nc-4.0
- http://rdfh.ch/licenses/cc-by-sa-4.0
status: true
selfjoin: false
'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'
post:
tags:
- Admin API
description: Create new group. Requires SystemAdmin or ProjectAdmin permissions for the project.
operationId: Create new group
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GroupCreateRequest'
example:
name: NewGroup
descriptions:
- value: NewGroup description in English
language: en
- value: NewGroup Beschreibung auf Deutsch
language: de
project: http://rdfh.ch/projects/0042
status: true
selfjoin: false
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GroupGetResponseADM'
example:
group:
id: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
name: NewGroup
descriptions:
- value: NewGroup description in English
language: en
- value: NewGroup Beschreibung auf Deutsch
language: de
project:
id: http://rdfh.ch/projects/0042
shortname: example
shortcode: '0001'
longname: Example Project
description:
- value: An example project
language: en
keywords:
- example
- project
ontologies: []
status: true
selfjoin: false
allowedCopyrightHolders: []
enabledLicenses:
- http://rdfh.ch/licenses/boris
- http://rdfh.ch/licenses/open-licence-2.0
- http://rdfh.ch/licenses/cc-by-nc-sa-4.0
- http://rdfh.ch/licenses/public-domain
- http://rdfh.ch/licenses/unknown
- http://rdfh.ch/licenses/ai-generated
- urn:dasch:placeholder
- http://rdfh.ch/licenses/cc-by-4.0
- http://rdfh.ch/licenses/cc-by-nc-nd-4.0
- http://rdfh.ch/licenses/noc-nc-1.0
- http://rdfh.ch/licenses/cc-by-nd-4.0
- http://rdfh.ch/licenses/cc-pdm-1.0
- http://rdfh.ch/licenses/cc-0-1.0
- http://rdfh.ch/licenses/cc-by-nc-4.0
- http://rdfh.ch/licenses/cc-by-sa-4.0
status: true
selfjoin: false
'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: []
/admin/groups/{groupIri}:
get:
tags:
- Admin API
description: Return a single group identified by its IRI. Publicly accessible.
operationId: getAdminGroupsGroupiri
parameters:
- name: groupIri
in: path
description: The IRI of a group. Must be URL-encoded.
required: true
schema:
type: string
example: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GroupGetResponseADM'
example:
group:
id: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
name: NewGroup
descriptions:
- value: NewGroup description in English
language: en
- value: NewGroup Beschreibung auf Deutsch
language: de
project:
id: http://rdfh.ch/projects/0042
shortname: example
shortcode: '0001'
longname: Example Project
description:
- value: An example project
language: en
keywords:
- example
- project
ontologies: []
status: true
selfjoin: false
allowedCopyrightHolders: []
enabledLicenses:
- http://rdfh.ch/licenses/boris
- http://rdfh.ch/licenses/open-licence-2.0
- http://rdfh.ch/licenses/cc-by-nc-sa-4.0
- http://rdfh.ch/licenses/public-domain
- http://rdfh.ch/licenses/unknown
- http://rdfh.ch/licenses/ai-generated
- urn:dasch:placeholder
- http://rdfh.ch/licenses/cc-by-4.0
- http://rdfh.ch/licenses/cc-by-nc-nd-4.0
- http://rdfh.ch/licenses/noc-nc-1.0
- http://rdfh.ch/licenses/cc-by-nd-4.0
- http://rdfh.ch/licenses/cc-pdm-1.0
- http://rdfh.ch/licenses/cc-0-1.0
- http://rdfh.ch/licenses/cc-by-nc-4.0
- http://rdfh.ch/licenses/cc-by-sa-4.0
status: true
selfjoin: false
'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'
put:
tags:
- Admin API
description: Update a group's basic information. Requires SystemAdmin or ProjectAdmin permissions for the group's project.
operationId: putAdminGroupsGroupiri
parameters:
- name: groupIri
in: path
description: The IRI of a group. Must be URL-encoded.
required: true
schema:
type: string
example: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GroupUpdateRequest'
example:
name: NewGroupNewName
descriptions:
- value: NewGroupNewName description in English
language: en
- value: NewGroupNewName Beschreibung auf Deutsch
language: de
status: false
selfjoin: true
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GroupGetResponseADM'
example:
group:
id: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
name: NewGroup
descriptions:
- value: NewGroup description in English
language: en
- value: NewGroup Beschreibung auf Deutsch
language: de
project:
id: http://rdfh.ch/projects/0042
shortname: example
shortcode: '0001'
longname: Example Project
description:
- value: An example project
language: en
keywords:
- example
- project
ontologies: []
status: true
selfjoin: false
allowedCopyrightHolders: []
enabledLicenses:
- http://rdfh.ch/licenses/boris
- http://rdfh.ch/licenses/open-licence-2.0
- http://rdfh.ch/licenses/cc-by-nc-sa-4.0
- http://rdfh.ch/licenses/public-domain
- http://rdfh.ch/licenses/unknown
- http://rdfh.ch/licenses/ai-generated
- urn:dasch:placeholder
- http://rdfh.ch/licenses/cc-by-4.0
- http://rdfh.ch/licenses/cc-by-nc-nd-4.0
- http://rdfh.ch/licenses/noc-nc-1.0
- http://rdfh.ch/licenses/cc-by-nd-4.0
- http://rdfh.ch/licenses/cc-pdm-1.0
- http://rdfh.ch/licenses/cc-0-1.0
- http://rdfh.ch/licenses/cc-by-nc-4.0
- http://rdfh.ch/licenses/cc-by-sa-4.0
status: true
selfjoin: false
'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: []
delete:
tags:
- Admin API
description: Deletes a group by changing its status to 'false'. Requires SystemAdmin or ProjectAdmin permissions for the group's project.
operationId: deleteAdminGroupsGroupiri
parameters:
- name: groupIri
in: path
description: The IRI of a group. Must be URL-encoded.
required: true
schema:
type: string
example: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GroupGetResponseADM'
example:
group:
id: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
name: NewGroup
descriptions:
- value: NewGroup description in English
language: en
- value: NewGroup Beschreibung auf Deutsch
language: de
project:
id: http://rdfh.ch/projects/0042
shortname: example
shortcode: '0001'
longname: Example Project
description:
- value: An example project
language: en
keywords:
- example
- project
ontologies: []
status: true
selfjoin: false
allowedCopyrightHolders: []
enabledLicenses:
- http://rdfh.ch/licenses/boris
- http://rdfh.ch/licenses/open-licence-2.0
- http://rdfh.ch/licenses/cc-by-nc-sa-4.0
- http://rdfh.ch/licenses/public-domain
- http://rdfh.ch/licenses/unknown
- http://rdfh.ch/licenses/ai-generated
- urn:dasch:placeholder
- http://rdfh.ch/licenses/cc-by-4.0
- http://rdfh.ch/licenses/cc-by-nc-nd-4.0
- http://rdfh.ch/licenses/noc-nc-1.0
- http://rdfh.ch/licenses/cc-by-nd-4.0
- http://rdfh.ch/licenses/cc-pdm-1.0
- http://rdfh.ch/licenses/cc-0-1.0
- http://rdfh.ch/licenses/cc-by-nc-4.0
- http://rdfh.ch/licenses/cc-by-sa-4.0
status: true
selfjoin: false
'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: []
/admin/groups/{groupIri}/members:
get:
tags:
- Admin API
description: Return all members of a single group. Requires SystemAdmin or ProjectAdmin permissions for the group's project.
operationId: getAdminGroupsGroupiriMembers
parameters:
- name: groupIri
in: path
description: The IRI of a group. Must be URL-encoded.
required: true
schema:
type: string
example: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GroupMembersGetResponseADM'
example:
members:
- id: http://rdfh.ch/users/0001
username: username
email: user@exampl.com
givenName: Jane
familyName: Doe
status: true
lang: rm
groups:
- id: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
name: NewGroup
descriptions:
- value: NewGroup description in English
language: en
- value: NewGroup Beschreibung auf Deutsch
language: de
project:
id: http://rdfh.ch/projects/0042
shortname: example
shortcode: '0001'
longname: Example Project
description:
- value: An example project
language: en
keywords:
- example
- project
ontologies: []
status: true
selfjoin: false
allowedCopyrightHolders: []
enabledLicenses:
- http://rdfh.ch/licenses/boris
- http://rdfh.ch/licenses/open-licence-2.0
- http://rdfh.ch/licenses/cc-by-nc-sa-4.0
- http://rdfh.ch/licenses/public-domain
- http://rdfh.ch/licenses/unknown
- http://rdfh.ch/licenses/ai-generated
- urn:dasch:placeholder
- http://rdfh.ch/licenses/cc-by-4.0
- http://rdfh.ch/licenses/cc-by-nc-nd-4.0
- http://rdfh.ch/licenses/noc-nc-1.0
- http://rdfh.ch/licenses/cc-by-nd-4.0
- http://rdfh.ch/licenses/cc-pdm-1.0
- http://rdfh.ch/licenses/cc-0-1.0
- http://rdfh.ch/licenses/cc-by-nc-4.0
- http://rdfh.ch/licenses/cc-by-sa-4.0
status: true
selfjoin: false
projects:
- id: http://rdfh.ch/projects/0042
shortname: example
shortcode: '0001'
longname: Example Project
description:
- value: An example project
language: en
keywords:
- example
- project
ontologies: []
status: true
selfjoin: false
allowedCopyrightHolders: []
enabledLicenses:
- http://rdfh.ch/licenses/boris
- http://rdfh.ch/licenses/open-licence-2.0
- http://rdfh.ch/licenses/cc-by-nc-sa-4.0
- http://rdfh.ch/licenses/public-domain
- http://rdfh.ch/licenses/unknown
- http://rdfh.ch/licenses/ai-generated
- urn:dasch:placeholder
- http://rdfh.ch/licenses/cc-by-4.0
- http://rdfh.ch/licenses/cc-by-nc-nd-4.0
- http://rdfh.ch/licenses/noc-nc-1.0
- http://rdfh.ch/licenses/cc-by-nd-4.0
- http://rdfh.ch/licenses/cc-pdm-1.0
- http://rdfh.ch/licenses/cc-0-1.0
- http://rdfh.ch/licenses/cc-by-nc-4.0
- http://rdfh.ch/licenses/cc-by-sa-4.0
permissions:
groupsPerProject: {}
administrativePermissionsPerProject: {}
'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: []
/admin/groups/{groupIri}/status:
put:
tags:
- Admin API
description: Updates a group's status. Requires SystemAdmin or ProjectAdmin permissions for the group's project.
operationId: putAdminGroupsGroupiriStatus
parameters:
- name: groupIri
in: path
description: The IRI of a group. Must be URL-encoded.
required: true
schema:
type: string
example: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GroupStatusUpdateRequest'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GroupGetResponseADM'
example:
group:
id: http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w
name: NewGroup
descriptions:
- value: NewGroup description in English
language: en
- value: NewGroup Beschreibung auf Deutsch
language: de
project:
id: http://rdfh.ch/projects/0042
shortname: example
shortcode: '0001'
longname: Example Project
description:
- value: An example project
language: en
keywords:
- example
- project
ontologies: []
status: true
selfjoin: false
allowedCopyrightHolders: []
enabledLicenses:
- http://rdfh.ch/licenses/boris
- http://rdfh.ch/licenses/open-licence-2.0
- http://rdfh.ch/licenses/cc-by-nc-sa-4.0
- http://rdfh.ch/licenses/public-domain
- http://rdfh.ch/licenses/unknown
- http://rdfh.ch/licenses/ai-generated
- urn:dasch:placeholder
- http://rdfh.ch/licenses/cc-by-4.0
- http://rdfh.ch/licenses/cc-by-nc-nd-4.0
- http://rdfh.ch/licenses/noc-nc-1.0
- http://rdfh.ch/licenses/cc-by-nd-4.0
- http://rdfh.ch/licenses/cc-pdm-1.0
- http://rdfh.ch/licenses/cc-0-1.0
- http://rdfh.ch/licenses/cc-by-nc-4.0
- http://rdfh.ch/licenses/cc-by-sa-4.0
status: true
selfjoin: false
'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: []
/admin/lists:
get:
tags:
- Admin API
description: Get all lists or all lists belonging to a project. Note that you can provide either a project IRI or a project shortcode. Publicly accessible.
operationId: getAdminLists
parameters:
- name: projectIri
in: query
description: The (optional) IRI of the project.
required: false
schema:
type: string
example: http://rdfh.ch/projects/0042
- name: projectShortcode
in: query
description: The (optional) shortcode of the project.
required: false
schema:
type: string
example: '0042'
responses:
'200':
# --- truncated at 32 KB (231 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/university-of-basel/refs/heads/main/openapi/university-of-basel-admin-api-api-openapi.yml