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': description: Contains the list of all root nodes of each found list. content: application/json: schema: $ref: '#/components/schemas/ListsGetResponseADM' '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: Creates a new list by creating the root node of the list. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: postAdminLists requestBody: content: application/json: schema: $ref: '#/components/schemas/ListCreateRootNodeRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ListGetResponseADM' '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/{p1}: get: tags: - Admin API description: Returns a list node, root or child, with children (if exist). Publicly accessible. operationId: getAdminListsP1 parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ListItemGetResponseADM' '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 list node's properties. Requires SystemAdmin or ProjectAdmin permissions for the list's project. operationId: putAdminListsP1 parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ListChangeRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/NodeInfoGetResponseADM' '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: - Admin API description: Creates a new list node as a child of the specified list node. Requires SystemAdmin or ProjectAdmin permissions for the list's project. operationId: postAdminListsP1 parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ListCreateChildNodeRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ChildNodeInfoGetResponseADM' '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: Delete a list node. Requires SystemAdmin or ProjectAdmin permissions for the list's project. operationId: deleteAdminListsP1 parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ListItemDeleteResponseADM' '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/{p1}/info: get: tags: - Admin API description: Returns basic information about a list node, root or child, w/o children (if exist). Publicly accessible. operationId: getAdminListsP1Info parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/NodeInfoGetResponseADM' '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' /admin/lists/infos/{p1}: get: tags: - Admin API description: '*Deprecated*. Use GET admin/lists//info instead. Returns basic information about a list node, root or child, w/o children (if exist). Publicly accessible.' operationId: getAdminListsInfosP1 parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/NodeInfoGetResponseADM' '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' deprecated: true /admin/lists/nodes/{p1}: get: tags: - Admin API description: '*Deprecated*. Use GET admin/lists//info instead. Returns basic information about a list node, root or child, w/o children (if exist). Publicly accessible.' operationId: getAdminListsNodesP1 parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/NodeInfoGetResponseADM' '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' deprecated: true /admin/lists/candelete/{p1}: get: tags: - Admin API description: Checks if a list can be deleted (none of its nodes is used in data). operationId: getAdminListsCandeleteP1 parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CanDeleteListResponseADM' '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' /admin/lists/{p1}/name: put: tags: - Admin API description: Update a list node's name. Requires SystemAdmin or ProjectAdmin permissions for the list's project. operationId: putAdminListsP1Name parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ListChangeNameRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/NodeInfoGetResponseADM' '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/{p1}/labels: put: tags: - Admin API description: Update a list node's labels. Requires SystemAdmin or ProjectAdmin permissions for the list's project. operationId: putAdminListsP1Labels parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ListChangeLabelsRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/NodeInfoGetResponseADM' '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/{p1}/comments: put: tags: - Admin API description: Update a list node's comments. Requires SystemAdmin or ProjectAdmin permissions for the list's project. operationId: putAdminListsP1Comments parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ListChangeCommentsRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/NodeInfoGetResponseADM' '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/{p1}/position: put: tags: - Admin API description: Update a list node's position. Requires SystemAdmin or ProjectAdmin permissions for the list's project. operationId: putAdminListsP1Position parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ListChangePositionRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/NodePositionChangeResponseADM' '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/comments/{p1}: delete: tags: - Admin API description: Delete a list node's comments. Requires authentication. operationId: deleteAdminListsCommentsP1 parameters: - name: p1 in: path description: The IRI of the list. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ListNodeCommentsDeleteResponseADM' '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/maintenance/{action-name}: post: tags: - Admin API description: Execute a maintenance action. Requires SystemAdmin permissions. operationId: postAdminMaintenanceAction-name parameters: - name: action-name in: path description: 'The name of the maintenance action to be executed. Maintenance actions are executed asynchronously in the background. ' required: true schema: type: string example: fix-top-left requestBody: description: 'The optional parameters as json for the maintenance action. May be required by certain actions. ' content: application/json: schema: type: string required: false responses: '202': description: '' '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/permissions/ap: post: tags: - Admin API description: Create a new administrative permission. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: postAdminPermissionsAp requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAdministrativePermissionAPIRequestADM' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AdministrativePermissionCreateResponseADM' '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/permissions/ap/{projectIri}: get: tags: - Admin API description: Get all administrative permissions for a project. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminPermissionsApProjectiri parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AdministrativePermissionsForProjectGetResponseADM' '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/permissions/ap/{projectIri}/{groupIri}: get: tags: - Admin API description: Get all administrative permissions for a project and a group. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminPermissionsApProjectiriGroupiri parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 - 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/AdministrativePermissionGetResponseADM' '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/permissions/doap/{projectIri}: get: tags: - Admin API description: Get all default object access permissions for a project. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminPermissionsDoapProjectiri parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DefaultObjectAccessPermissionsForProjectGetResponseADM' '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/permissions/{projectIri}: get: tags: - Admin API description: Get all permissions for a project. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminPermissionsProjectiri parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PermissionsForProjectGetResponseADM' '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/permissions/doap/{permissionIri}: put: tags: - Admin API description: Update an existing default object access permission. The request may update the hasPermission and/or any allowed combination of group, resource class and property for the permission. Requires SystemAdmin permissions. operationId: putAdminPermissionsDoapPermissioniri parameters: - name: permissionIri in: path description: The IRI of a permission. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/permissions/00FF/Mck2xJDjQ_Oimi_9z4aFaA requestBody: description: Default object access permissions can be only for group, resource class, property or both resource class and property.If an invalid combination is provided, the request will fail with a Bad Request response.The iris for resource class and property must be valid Api V2 complex iris. content: application/json: schema: $ref: '#/components/schemas/ChangeDoapRequest' examples: For a group: value: forGroup: http://www.knora.org/ontology/knora-admin#ProjectMember For a resource class and a property: value: forResourceClass: http://api.dasch.swiss/ontology/0803/incunabula/v2#bild forProperty: http://api.dasch.swiss/ontology/0803/incunabula/v2#pagenum required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DefaultObjectAccessPermissionGetResponseADM' '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/permissions/{permissionIri}/group: put: tags: - Admin API description: Update a permission's group. Requires SystemAdmin permissions. operationId: putAdminPermissionsPermissioniriGroup parameters: - name: permissionIri in: path description: The IRI of a permission. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/permissions/00FF/Mck2xJDjQ_Oimi_9z4aFaA requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePermissionGroupApiRequestADM' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PermissionGetResponseADM' '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/permissions/{permissionIri}/hasPermissions: put: tags: - Admin API description: Update a permission's set of hasPermissions. Requires SystemAdmin permissions. operationId: putAdminPermissionsPermissioniriHaspermissions parameters: - name: permissionIri in: path description: The IRI of a permission. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/permissions/00FF/Mck2xJDjQ_Oimi_9z4aFaA requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePermissionHasPermissionsApiRequestADM' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PermissionGetResponseADM' '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/permissions/{permissionIri}/property: put: tags: - Admin API description: Update a DAOP's property. Use `PUT /admin/permissions/doap/{permissionIri}` instead. Requires SystemAdmin permissions. operationId: putAdminPermissionsPermissioniriProperty parameters: - name: permissionIri in: path description: The IRI of a permission. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/permissions/00FF/Mck2xJDjQ_Oimi_9z4aFaA requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePermissionPropertyApiRequestADM' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DefaultObjectAccessPermissionGetResponseADM' '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' deprecated: true security: - httpAuth: [] - httpAuth1: [] /admin/permissions/{permissionIri}/resourceClass: put: tags: - Admin API description: Update a DOAP's resource class. Use `PUT /admin/permissions/doap/{permissionIri}` instead. Requires SystemAdmin permissions. operationId: putAdminPermissionsPermissioniriResourceclass parameters: - name: permissionIri in: path description: The IRI of a permission. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/permissions/00FF/Mck2xJDjQ_Oimi_9z4aFaA requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePermissionResourceClassApiRequestADM' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DefaultObjectAccessPermissionGetResponseADM' '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' deprecated: true security: - httpAuth: [] - httpAuth1: [] /admin/permissions/{permissionIri}: delete: tags: - Admin API description: Delete an permission. Requires SystemAdmin permissions. operationId: deleteAdminPermissionsPermissioniri parameters: - name: permissionIri in: path description: The IRI of a permission. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/permissions/00FF/Mck2xJDjQ_Oimi_9z4aFaA responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PermissionDeleteResponseADM' '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/permissions/doap: post: tags: - Admin API description: Create a new default object access permission. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: postAdminPermissionsDoap requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDefaultObjectAccessPermissionAPIRequestADM' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DefaultObjectAccessPermissionCreateResponseADM' '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/projects/shortcode/{projectShortcode}/legal-info/licenses: get: tags: - Admin API description: Get the available licenses for use within this project. Publicly accessible. operationId: getAdminProjectsShortcodeProjectshortcodeLegal-infoLicenses 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: page in: query description: The number of the desired page to be returned. required: false schema: default: 1 type: integer format: int32 minimum: 1 - name: page-size in: query description: The number of items per page to be returned. required: false schema: default: 25 type: integer format: int32 minimum: 1 maximum: 100 - name: filter in: query description: Filter the results. required: false 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: showOnlyEnabled in: query description: Show only enabled licenses if true. required: false schema: default: false type: boolean responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PagedResponse_ProjectLicenseDto' example: data: - id: http://rdfh.ch/licenses/cc-by-4.0 uri: https://creativecommons.org/licenses/by/4.0/ labelEn: CC BY 4.0 isRecommended: true isEnabled: true - id: http://rdfh.ch/licenses/cc-by-sa-4.0 uri: https://creativecommons.org/licenses/by-sa/4.0/ labelEn: CC BY-SA 4.0 isRecommended: true isEnabled: true - id: http://rdfh.ch/licenses/cc-by-nc-4.0 uri: https://creativecommons.org/licenses/by-nc/4.0/ labelEn: CC BY-NC 4.0 isRecommended: true isEnabled: true - id: http://rdfh.ch/licenses/cc-by-nc-sa-4.0 uri: https://creativecommons.org/licenses/by-nc-sa/4.0/ labelEn: CC BY-NC-SA 4.0 isRecommended: true isEnabled: true - id: http://rdfh.ch/licenses/cc-by-nd-4.0 uri: https://creativecommons.org/licenses/by-nd/4.0/ labelEn: CC BY-ND 4.0 isRecommended: true isEnabled: true - id: http://rdfh.ch/licenses/cc-by-nc-nd-4.0 uri: https://creativecommons.org/licenses/by-nc-nd/4.0/ labelEn: CC BY-NC-ND 4.0 isRecommended: true isEnabled: true - id: http://rdfh.ch/licenses/ai-generated uri: http://rdfh.ch/licenses/ai-generated labelEn: AI-Generated Content - Not Protected by Copyright isRecommended: true isEnabled: true - id: http://rdfh.ch/licenses/unknown uri: http://rdfh.ch/licenses/unknown labelEn: Unknown License - Ask Copyright Holder for Permission isRecommended: true isEnabled: true - id: http://rdfh.ch/licenses/public-domain uri: http://rdfh.ch/licenses/public-domain labelEn: Public Domain - Not Protected by Copyright isRecommended: true isEnabled: true - id: http://rdfh.ch/licenses/cc-0-1.0 uri: https://creativecommons.org/publicdomain/zero/1.0/ labelEn: CC0 1.0 isRecommended: false isEnabled: true - id: http://rdfh.ch/licenses/cc-pdm-1.0 uri: https://creativecommons.org/publicdomain/mark/1.0/ labelEn: CC PDM 1.0 isRecommended: false isEnabled: true - id: http://rdfh.ch/licenses/boris uri: https://www.ub.unibe.ch/services/open_science/boris_publications/index_eng.html#collapse_pane631832 labelEn: BORIS Standard License isRecommended: false isEnabled: true - id: http://rdfh.ch/licenses/open-licence-2.0 uri: https://www.etalab.gouv.fr/wp-content/uploads/2018/11/open-licence.pdf labelEn: LICENCE OUVERTE 2.0 isRecommended: false isEnabled: true - id: http://rdfh.ch/licenses/noc-nc-1.0 uri: http://rightsstatements.org/vocab/NoC-NC/1.0/ labelEn: No Copyright - Non-Commercial Use Only isRecommended: false isEnabled: true - id: urn:dasch:placeholder uri: urn:dasch:placeholder labelEn: Placeholder License - Not a Real License only to be used when the real license is not known yet. isRecommended: false isEnabled: true pagination: pageSize: 15 totalItems: 15 totalPages: 1 currentPage: 1 '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' /admin/projects/shortcode/{projectShortcode}/legal-info/licenses/{licenseIri}: get: tags: - Admin API description: Get a specific license by its IRI for use within this project. Publicly accessible. operationId: getAdminProjectsShortcodeProjectshortcodeLegal-infoLicensesLicenseiri 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: licenseIri in: path description: The IRI of the license. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/licenses/cc-by-nc-4.0 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectLicenseDto' '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' /admin/projects/shortcode/{projectShortcode}/legal-info/authorships: get: tags: - Admin API description: Get the allowed authorships for use within this project. The user must be project member, project admin or system admin. operationId: getAdminProjectsShortcodeProjectshortcodeLegal-infoAuthorships 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: page in: query description: The number of the desired page to be returned. required: false schema: default: 1 type: integer format: int32 minimum: 1 - name: page-size in: query description: The number of items per page to be returned. required: false schema: default: 25 type: integer format: int32 minimum: 1 maximum: 100 - name: filter in: query description: Filter the results. required: false 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 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PagedResponse_Authorship' example: data: - Lotte Reiniger - Margaret J. Winkler - Hilma af Klint pagination: pageSize: 3 totalItems: 15 totalPages: 5 currentPage: 1 '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/projects/shortcode/{projectShortcode}/legal-info/licenses/{licenseIri}/enable: put: tags: - Admin API description: Enable a license for use within this project. The user must be project admin or system admin. operationId: putAdminProjectsShortcodeProjectshortcodeLegal-infoLicensesLicenseiriEnable 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: licenseIri in: path description: The IRI of the license. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/licenses/cc-by-nc-4.0 responses: '200': description: '' '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/projects/shortcode/{projectShortcode}/legal-info/licenses/{licenseIri}/disable: put: tags: - Admin API description: Disable a license for use within this project. The user must be project admin or system admin. operationId: putAdminProjectsShortcodeProjectshortcodeLegal-infoLicensesLicenseiriDisable 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: licenseIri in: path description: The IRI of the license. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/licenses/cc-by-nc-4.0 responses: '200': description: '' '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/projects/shortcode/{projectShortcode}/legal-info/copyright-holders: get: tags: - Admin API description: Get the allowed copyright holders for use within this project. The user must be project member, project admin or system admin. operationId: getAdminProjectsShortcodeProjectshortcodeLegal-infoCopyright-holders 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: page in: query description: The number of the desired page to be returned. required: false schema: default: 1 type: integer format: int32 minimum: 1 - name: page-size in: query description: The number of items per page to be returned. required: false schema: default: 25 type: integer format: int32 minimum: 1 maximum: 100 - name: filter in: query description: Filter the results. required: false 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 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PagedResponse_CopyrightHolder' example: data: - DaSCH - University of Zurich pagination: pageSize: 2 totalItems: 10 totalPages: 5 currentPage: 1 '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: [] put: tags: - Admin API description: Update a particular allowed copyright holder for use within this project, does not update existing values on assets. The user must be a system admin. operationId: putAdminProjectsShortcodeProjectshortcodeLegal-infoCopyright-holders 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyrightHolderReplaceRequest' example: old-value: DaSch new-value: DaSCH required: true responses: '200': description: '' '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: - Admin API description: Add new allowed copyright holders for use within this project. The user must be a system or project admin. operationId: postAdminProjectsShortcodeProjectshortcodeLegal-infoCopyright-holders 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyrightHolderAddRequest' example: data: - DaSCH - University of Zurich required: true responses: '200': description: '' '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/projects: get: tags: - Admin API description: Returns all projects. Publicly accessible. operationId: getAdminProjects responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectsGetResponse' '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: Creates a new project. Requires SystemAdmin permissions. operationId: postAdminProjects requestBody: description: The property `enabledLicenses` is optional. If not provided, the DaSCH recommended licenses will be used. The property `allowedCopyrightHolders` is optional. The copyright holder for AI generated values and unknown authorship will be added in any case. content: application/json: schema: $ref: '#/components/schemas/ProjectCreateRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectOperationResponseADM' '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/projects/Keywords: get: tags: - Admin API description: Returns all unique keywords for all projects as a list. Publicly accessible. operationId: getAdminProjectsKeywords responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectsKeywordsGetResponse' '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' /admin/projects/iri/{projectIri}: get: tags: - Admin API description: Returns a single project identified by the IRI. Publicly accessible. operationId: getAdminProjectsIriProjectiri parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectGetResponse' '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: Updates a project identified by the IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: putAdminProjectsIriProjectiri parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectUpdateRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectOperationResponseADM' '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 project identified by the IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: deleteAdminProjectsIriProjectiri parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectOperationResponseADM' '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/projects/shortcode/{projectShortcode}: get: tags: - Admin API description: Returns a single project identified by the shortcode. Publicly accessible. operationId: getAdminProjectsShortcodeProjectshortcode 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' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectGetResponse' '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' /admin/projects/shortname/{projectShortname}: get: tags: - Admin API description: Returns a single project identified by the shortname. Publicly accessible. operationId: getAdminProjectsShortnameProjectshortname parameters: - name: projectShortname in: path description: The shortname of a project. required: true schema: type: string example: someShortname responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectGetResponse' '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' /admin/projects/iri/{projectIri}/Keywords: get: tags: - Admin API description: Returns all keywords for a single project. Publicly accessible. operationId: getAdminProjectsIriProjectiriKeywords parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectKeywordsGetResponse' '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' /admin/projects/iri/{projectIri}/RestrictedViewSettings: get: tags: - Admin API description: Returns the project's restricted view settings identified by the IRI. Publicly accessible. operationId: getAdminProjectsIriProjectiriRestrictedviewsettings parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectRestrictedViewSettingsGetResponseADM' '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: Sets the project's restricted view settings identified by the IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: postAdminProjectsIriProjectiriRestrictedviewsettings parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 requestBody: description: 'Set how all still image resources of a projects should be displayed when viewed as restricted. This can be either a size restriction or a watermark. For that, we support two of the (IIIF size)[https://iiif.io/api/image/3.0/#42-size] forms: * `!d,d` The returned image is scaled so that the width and height of the returned image are not greater than d, while maintaining the aspect ratio. * `pct:n` The width and height of the returned image is scaled to n percent of the width and height of the original image. 1<= n <= 100. If the watermark is set to `true`, the returned image will be watermarked, otherwise the default size !128,128 is set. It is only possible to set either the size or the watermark, not both at the same time.' content: application/json: schema: $ref: '#/components/schemas/SetRestrictedViewRequest' example: size: '!128,128' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/RestrictedViewResponse' '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/projects/shortcode/{projectShortcode}/RestrictedViewSettings: get: tags: - Admin API description: Returns the project's restricted view settings identified by the shortcode. Publicly accessible. operationId: getAdminProjectsShortcodeProjectshortcodeRestrictedviewsettings 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' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectRestrictedViewSettingsGetResponseADM' '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: Sets the project's restricted view settings identified by the shortcode. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: postAdminProjectsShortcodeProjectshortcodeRestrictedviewsettings 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' requestBody: description: 'Set how all still image resources of a projects should be displayed when viewed as restricted. This can be either a size restriction or a watermark. For that, we support two of the (IIIF size)[https://iiif.io/api/image/3.0/#42-size] forms: * `!d,d` The returned image is scaled so that the width and height of the returned image are not greater than d, while maintaining the aspect ratio. * `pct:n` The width and height of the returned image is scaled to n percent of the width and height of the original image. 1<= n <= 100. If the watermark is set to `true`, the returned image will be watermarked, otherwise the default size !128,128 is set. It is only possible to set either the size or the watermark, not both at the same time.' content: application/json: schema: $ref: '#/components/schemas/SetRestrictedViewRequest' example: size: '!128,128' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/RestrictedViewResponse' '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/projects/shortname/{projectShortname}/RestrictedViewSettings: get: tags: - Admin API description: Returns the project's restricted view settings identified by the shortname. Publicly accessible. operationId: getAdminProjectsShortnameProjectshortnameRestrictedviewsettings parameters: - name: projectShortname in: path description: The shortname of a project. required: true schema: type: string example: someShortname responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectRestrictedViewSettingsGetResponseADM' '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' /admin/projects/iri/{projectIri}/AllData: get: tags: - Admin API description: Returns all ontologies, data, and configuration belonging to a project identified by the IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminProjectsIriProjectiriAlldata parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' headers: Content-Disposition: required: true schema: type: string Content-Type: required: true schema: type: string content: application/octet-stream: schema: type: string format: binary '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/projects/iri/{projectIri}/members: get: tags: - Admin API description: Returns all project members of a project identified by the IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminProjectsIriProjectiriMembers parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectMembersGetResponseADM' '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/projects/shortcode/{projectShortcode}/members: get: tags: - Admin API description: Returns all project members of a project identified by the shortcode. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminProjectsShortcodeProjectshortcodeMembers 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' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectMembersGetResponseADM' '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/projects/shortname/{projectShortname}/members: get: tags: - Admin API description: Returns all project members of a project identified by the shortname. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminProjectsShortnameProjectshortnameMembers parameters: - name: projectShortname in: path description: The shortname of a project. required: true schema: type: string example: someShortname responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectMembersGetResponseADM' '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/projects/iri/{projectIri}/admin-members: get: tags: - Admin API description: Returns all admin members of a project identified by the IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminProjectsIriProjectiriAdmin-members parameters: - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectAdminMembersGetResponseADM' '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/projects/shortcode/{projectShortcode}/admin-members: get: tags: - Admin API description: Returns all admin members of a project identified by the shortcode. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminProjectsShortcodeProjectshortcodeAdmin-members 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' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectAdminMembersGetResponseADM' '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/projects/shortname/{projectShortname}/admin-members: get: tags: - Admin API description: Returns all admin members of a project identified by the shortname. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: getAdminProjectsShortnameProjectshortnameAdmin-members parameters: - name: projectShortname in: path description: The shortname of a project. required: true schema: type: string example: someShortname responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectAdminMembersGetResponseADM' '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/projects/shortcode/{projectShortcode}/erase: delete: tags: - Admin API description: '!ATTENTION! Erase a project with the given shortcode. This will permanently and irrecoverably remove the project and all of its assets. Requires SystemAdmin permissions. Only available if the feature has been configured on the server side.' operationId: deleteAdminProjectsShortcodeProjectshortcodeErase 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: keepAssets in: query description: If set to true the assets in ingest will not be removed. required: false schema: default: false type: boolean responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ProjectOperationResponseADM' '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/users/iri/{userIri}/project-memberships: get: tags: - Admin API description: Returns the user's project memberships for a user identified by their IRI. Publicly accessible. operationId: getAdminUsersIriUseririProject-memberships parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserProjectMembershipsGetResponseADM' '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' /admin/users/iri/{userIri}/project-admin-memberships: get: tags: - Admin API description: Returns the user's project admin memberships for a user identified by their IRI. Publicly accessible. operationId: getAdminUsersIriUseririProject-admin-memberships parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserProjectAdminMembershipsGetResponseADM' '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' /admin/users/iri/{userIri}/group-memberships: get: tags: - Admin API description: Returns the user's group memberships for a user identified by their IRI. Publicly accessible. operationId: getAdminUsersIriUseririGroup-memberships parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserGroupMembershipsGetResponseADM' '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' /admin/users: get: tags: - Admin API description: Returns all users. Requires SystemAdmin or ProjectAdmin permissions in any project. operationId: getAdminUsers responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UsersResponse' '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: - Admin API description: Create a new user. Requires SystemAdmin permissions to create a system administrator. Requires SystemAdmin or ProjectAdmin permissions in any project to create a regular user. operationId: postAdminUsers requestBody: content: application/json: schema: $ref: '#/components/schemas/UserCreateRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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/users/iri/{userIri}: get: tags: - Admin API description: Returns a user identified by their IRI. Publicly accessible. Returns detailed information to SystemAdmin and the user themselves, restricted information to others. operationId: getAdminUsersIriUseriri parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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: Delete a user identified by IRI (change status to false). Users can delete themselves. SystemAdmin can delete any user. operationId: deleteAdminUsersIriUseriri parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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/users/email/{email}: get: tags: - Admin API description: Returns a user identified by their Email. Publicly accessible. Returns detailed information to SystemAdmin and the user themselves, restricted information to others. operationId: getAdminUsersEmailEmail parameters: - name: email in: path description: The user email. Must be URL-encoded. required: true schema: type: string pattern: ^.+@.+$ example: jane@example.com responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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/users/username/{username}: get: tags: - Admin API description: Returns a user identified by their Username. Publicly accessible. Returns detailed information to SystemAdmin and the user themselves, restricted information to others. operationId: getAdminUsersUsernameUsername parameters: - name: username in: path description: The user name. Must be URL-encoded. required: true schema: type: string example: JaneDoe responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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/users/iri/{userIri}/project-memberships/{projectIri}: post: tags: - Admin API description: Add a user to a project identified by IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: postAdminUsersIriUseririProject-membershipsProjectiri parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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: Remove a user from a project membership identified by IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: deleteAdminUsersIriUseririProject-membershipsProjectiri parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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/users/iri/{userIri}/project-admin-memberships/{projectIri}: post: tags: - Admin API description: Add a user as an admin to a project identified by IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: postAdminUsersIriUseririProject-admin-membershipsProjectiri parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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: Remove a user form an admin project membership identified by IRI. Requires SystemAdmin or ProjectAdmin permissions for the project. operationId: deleteAdminUsersIriUseririProject-admin-membershipsProjectiri parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ - name: projectIri in: path description: The IRI of a project. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/projects/0001 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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/users/iri/{userIri}/group-memberships/{groupIri}: post: tags: - Admin API description: Add a user to a group identified by IRI. Requires SystemAdmin or ProjectAdmin permissions for the group's project. operationId: postAdminUsersIriUseririGroup-membershipsGroupiri parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ - 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/UserResponse' '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: Remove a user form an group membership identified by IRI. Requires SystemAdmin or ProjectAdmin permissions for the group's project. operationId: deleteAdminUsersIriUseririGroup-membershipsGroupiri parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ - 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/UserResponse' '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/users/iri/{userIri}/BasicUserInformation: put: tags: - Admin API description: Update a user's basic information identified by IRI. Users can update their own information. SystemAdmin can update any user. operationId: putAdminUsersIriUseririBasicuserinformation parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ requestBody: content: application/json: schema: $ref: '#/components/schemas/BasicUserInformationChangeRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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/users/iri/{userIri}/Password: put: tags: - Admin API description: Change a user's password identified by IRI. Users can change their own password. SystemAdmin can change any user's password. operationId: putAdminUsersIriUseririPassword parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordChangeRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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/users/iri/{userIri}/Status: put: tags: - Admin API description: Change a user's status identified by IRI. Users can update their own status. SystemAdmin can update any user's status. operationId: putAdminUsersIriUseririStatus parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ requestBody: content: application/json: schema: $ref: '#/components/schemas/StatusChangeRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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/users/iri/{userIri}/SystemAdmin: put: tags: - Admin API description: Change a user's SystemAdmin status identified by IRI. Requires SystemAdmin permissions. operationId: putAdminUsersIriUseririSystemadmin parameters: - name: userIri in: path description: The user IRI. Must be URL-encoded. required: true schema: type: string example: http://rdfh.ch/users/U16pbDgNSb6pQgDSP9L-VQ requestBody: content: application/json: schema: $ref: '#/components/schemas/SystemAdminChangeRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserResponse' '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: [] components: schemas: UserDto: title: UserDto type: object required: - id - username - email - givenName - familyName - status - lang - permissions properties: id: type: string username: type: string email: type: string givenName: type: string familyName: type: string status: type: boolean lang: type: string groups: type: array items: $ref: '#/components/schemas/Group' projects: type: array items: $ref: '#/components/schemas/Project' permissions: $ref: '#/components/schemas/PermissionsDataADM' ProjectGetResponse: title: ProjectGetResponse type: object required: - project properties: project: $ref: '#/components/schemas/Project' Keyword: title: Keyword type: object required: - value properties: value: type: string CopyrightHolderAddRequest: title: CopyrightHolderAddRequest type: object properties: data: type: array uniqueItems: true items: type: string Watermark: title: Watermark type: object required: - value properties: value: type: boolean StringLiteralV2: title: StringLiteralV2 oneOf: - $ref: '#/components/schemas/LanguageTaggedStringLiteralV2' - $ref: '#/components/schemas/PlainStringLiteralV2' Shortname: title: Shortname type: object required: - value properties: value: type: string UserProjectAdminMembershipsGetResponseADM: title: UserProjectAdminMembershipsGetResponseADM type: object properties: projects: type: array items: $ref: '#/components/schemas/Project' UserResponse: title: UserResponse type: object required: - user properties: user: $ref: '#/components/schemas/UserDto' UsersResponse: title: UsersResponse type: object properties: users: type: array items: $ref: '#/components/schemas/UserDto' CreateAdministrativePermissionAPIRequestADM: title: CreateAdministrativePermissionAPIRequestADM type: object required: - forProject - forGroup properties: id: $ref: '#/components/schemas/PermissionIri' forProject: description: IRI for a project. type: string forGroup: $ref: '#/components/schemas/GroupIri' hasPermissions: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionADM' ListADM: title: ListADM type: object required: - listinfo properties: listinfo: $ref: '#/components/schemas/ListRootNodeInfoADM' children: type: array items: $ref: '#/components/schemas/ListChildNodeADM' SelfJoin: title: SelfJoin oneOf: - $ref: '#/components/schemas/CanJoin' - $ref: '#/components/schemas/CannotJoin' CannotJoin: title: CannotJoin type: object PasswordChangeRequest: title: PasswordChangeRequest type: object required: - requesterPassword - newPassword properties: requesterPassword: $ref: '#/components/schemas/Password' newPassword: $ref: '#/components/schemas/Password' Pagination: title: Pagination type: object required: - pageSize - totalItems - totalPages - currentPage properties: pageSize: type: integer format: int32 totalItems: type: integer format: int32 totalPages: type: integer format: int32 currentPage: type: integer format: int32 Username: title: Username type: object required: - value properties: value: type: string Labels: title: Labels type: object properties: value: type: array items: $ref: '#/components/schemas/StringLiteralV2' Group: title: Group type: object required: - id - name - status - selfjoin properties: id: type: string name: type: string descriptions: type: array items: $ref: '#/components/schemas/StringLiteralV2' project: $ref: '#/components/schemas/Project' status: type: boolean selfjoin: type: boolean ProjectOperationResponseADM: title: ProjectOperationResponseADM type: object required: - project properties: project: $ref: '#/components/schemas/Project' OntologyConstraintException: title: OntologyConstraintException type: object required: - message properties: message: type: string PermissionInfoADM: title: PermissionInfoADM type: object required: - iri - permissionType properties: iri: $ref: '#/components/schemas/PermissionIri' permissionType: type: string Shortcode: title: Shortcode type: object required: - value properties: value: type: string BasicUserInformationChangeRequest: title: BasicUserInformationChangeRequest type: object properties: username: $ref: '#/components/schemas/Username' email: type: string pattern: ^.+@.+$ givenName: $ref: '#/components/schemas/GivenName' familyName: $ref: '#/components/schemas/FamilyName' lang: type: string ErrorResponse: title: ErrorResponse type: object required: - message properties: message: type: string LanguageTaggedStringLiteralV2: title: LanguageTaggedStringLiteralV2 type: object required: - value - language properties: value: type: string language: type: string ProjectLicenseDto: title: ProjectLicenseDto type: object required: - id - uri - labelEn - isRecommended - isEnabled properties: id: type: string uri: type: string labelEn: type: string isRecommended: type: boolean isEnabled: type: boolean ListName: title: ListName type: object required: - value properties: value: type: string ListItemDeleteResponseADM: title: ListItemDeleteResponseADM oneOf: - $ref: '#/components/schemas/ChildNodeDeleteResponseADM' - $ref: '#/components/schemas/ListDeleteResponseADM' Inactive: title: Inactive type: object Description: title: Description type: object required: - value properties: value: $ref: '#/components/schemas/StringLiteralV2' CanDeleteListResponseADM: title: CanDeleteListResponseADM type: object required: - listIri - canDeleteList properties: listIri: $ref: '#/components/schemas/ListIri' canDeleteList: type: boolean ProjectRestrictedViewSettingsGetResponseADM: title: ProjectRestrictedViewSettingsGetResponseADM type: object required: - settings properties: settings: $ref: '#/components/schemas/ProjectRestrictedViewSettingsADM' Status: title: Status oneOf: - $ref: '#/components/schemas/Active' - $ref: '#/components/schemas/Inactive' ListChangeLabelsRequest: title: ListChangeLabelsRequest type: object required: - labels properties: labels: $ref: '#/components/schemas/Labels' CanJoin: title: CanJoin type: object SystemAdminChangeRequest: title: SystemAdminChangeRequest type: object required: - systemAdmin properties: systemAdmin: $ref: '#/components/schemas/SystemAdmin' Map_Seq_IRI: title: Map_Seq_IRI type: object additionalProperties: type: array items: type: string GroupMembersGetResponseADM: title: GroupMembersGetResponseADM type: object properties: members: type: array items: $ref: '#/components/schemas/UserDto' EditConflictException: title: EditConflictException type: object required: - message properties: message: type: string ListRootNodeInfoADM: title: ListRootNodeInfoADM type: object required: - id - projectIri - labels - comments - isRootNode properties: id: type: string projectIri: type: string name: type: string labels: $ref: '#/components/schemas/StringLiteralSequenceV2' comments: $ref: '#/components/schemas/StringLiteralSequenceV2' isRootNode: type: boolean UserProjectMembershipsGetResponseADM: title: UserProjectMembershipsGetResponseADM type: object properties: projects: type: array items: $ref: '#/components/schemas/Project' ProjectRestrictedViewSettingsADM: title: ProjectRestrictedViewSettingsADM type: object required: - watermark properties: size: type: string watermark: type: boolean AdministrativePermissionsForProjectGetResponseADM: title: AdministrativePermissionsForProjectGetResponseADM type: object properties: administrativePermissions: type: array items: $ref: '#/components/schemas/AdministrativePermissionADM' ValidationException: title: ValidationException type: object required: - msg properties: msg: type: string Active: title: Active type: object Comments: title: Comments type: object properties: value: type: array items: $ref: '#/components/schemas/StringLiteralV2' ListCreateRootNodeRequest: title: ListCreateRootNodeRequest type: object required: - comments - labels - projectIri properties: id: $ref: '#/components/schemas/ListIri' comments: $ref: '#/components/schemas/Comments' labels: $ref: '#/components/schemas/Labels' name: $ref: '#/components/schemas/ListName' projectIri: description: IRI for a project. type: string PagedResponse_CopyrightHolder: title: PagedResponse_CopyrightHolder type: object required: - data - pagination properties: data: type: array items: type: string pagination: $ref: '#/components/schemas/Pagination' NodeADM: title: NodeADM type: object required: - nodeinfo properties: nodeinfo: $ref: '#/components/schemas/ListChildNodeInfoADM' children: type: array items: $ref: '#/components/schemas/ListChildNodeADM' ListsGetResponseADM: title: ListsGetResponseADM type: object properties: lists: type: array items: $ref: '#/components/schemas/ListRootNodeInfoADM' Position: title: Position type: object required: - value properties: value: type: integer format: int32 ForbiddenException: title: ForbiddenException type: object required: - message properties: message: type: string ListItemGetResponseADM: title: ListItemGetResponseADM oneOf: - $ref: '#/components/schemas/ListGetResponseADM' - $ref: '#/components/schemas/ListNodeGetResponseADM' ChangePermissionHasPermissionsApiRequestADM: title: ChangePermissionHasPermissionsApiRequestADM type: object properties: hasPermissions: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionADM' NodePositionChangeResponseADM: title: NodePositionChangeResponseADM type: object required: - node properties: node: $ref: '#/components/schemas/ListNodeADM' GroupStatusUpdateRequest: title: GroupStatusUpdateRequest type: object required: - status properties: status: $ref: '#/components/schemas/GroupStatus' ListNodeCommentsDeleteResponseADM: title: ListNodeCommentsDeleteResponseADM type: object required: - nodeIri - commentsDeleted properties: nodeIri: type: string commentsDeleted: type: boolean PlainStringLiteralV2: title: PlainStringLiteralV2 type: object required: - value properties: value: type: string ListChangeNameRequest: title: ListChangeNameRequest type: object required: - name properties: name: $ref: '#/components/schemas/ListName' ChangeDoapRequest: title: ChangeDoapRequest type: object properties: forGroup: $ref: '#/components/schemas/GroupIri' forResourceClass: type: string forProperty: type: string hasPermissions: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionADM' GroupName: title: GroupName type: object required: - value properties: value: type: string AdministrativePermissionCreateResponseADM: title: AdministrativePermissionCreateResponseADM type: object required: - administrativePermission properties: administrativePermission: $ref: '#/components/schemas/AdministrativePermissionADM' GroupDescriptions: title: GroupDescriptions type: object properties: value: type: array items: $ref: '#/components/schemas/StringLiteralV2' DefaultObjectAccessPermissionADM: title: DefaultObjectAccessPermissionADM type: object required: - iri - forProject properties: iri: $ref: '#/components/schemas/PermissionIri' forProject: description: IRI for a project. type: string forGroup: $ref: '#/components/schemas/GroupIri' forResourceClass: type: string forProperty: type: string hasPermissions: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionADM' GroupsGetResponseADM: title: GroupsGetResponseADM type: object properties: groups: type: array items: $ref: '#/components/schemas/Group' SetRestrictedViewRequest: title: SetRestrictedViewRequest type: object properties: size: $ref: '#/components/schemas/Size' watermark: $ref: '#/components/schemas/Watermark' DefaultObjectAccessPermissionsForProjectGetResponseADM: title: DefaultObjectAccessPermissionsForProjectGetResponseADM type: object properties: defaultObjectAccessPermissions: type: array items: $ref: '#/components/schemas/DefaultObjectAccessPermissionADM' GroupCreateRequest: title: GroupCreateRequest type: object required: - name - descriptions - project - status - selfjoin properties: id: $ref: '#/components/schemas/GroupIri' name: $ref: '#/components/schemas/GroupName' descriptions: $ref: '#/components/schemas/GroupDescriptions' project: description: IRI for a project. type: string status: $ref: '#/components/schemas/GroupStatus' selfjoin: $ref: '#/components/schemas/GroupSelfJoin' ListCreateChildNodeRequest: title: ListCreateChildNodeRequest type: object required: - labels - parentNodeIri - projectIri properties: id: $ref: '#/components/schemas/ListIri' comments: $ref: '#/components/schemas/Comments' labels: $ref: '#/components/schemas/Labels' name: $ref: '#/components/schemas/ListName' parentNodeIri: $ref: '#/components/schemas/ListIri' position: $ref: '#/components/schemas/Position' projectIri: description: IRI for a project. type: string ChangePermissionPropertyApiRequestADM: title: ChangePermissionPropertyApiRequestADM type: object required: - forProperty properties: forProperty: type: string GroupIri: title: GroupIri type: object required: - value properties: value: type: string PermissionsDataADM: title: PermissionsDataADM type: object required: - groupsPerProject - administrativePermissionsPerProject properties: groupsPerProject: $ref: '#/components/schemas/Map_Seq_IRI' administrativePermissionsPerProject: $ref: '#/components/schemas/Map_Set_PermissionADM' UserStatus: title: UserStatus type: object required: - value properties: value: type: boolean ListDeleteResponseADM: title: ListDeleteResponseADM type: object required: - iri - deleted properties: iri: type: string deleted: type: boolean ProjectUpdateRequest: title: ProjectUpdateRequest type: object properties: longname: $ref: '#/components/schemas/Longname' description: type: array items: $ref: '#/components/schemas/Description' keywords: type: array items: $ref: '#/components/schemas/Keyword' logo: $ref: '#/components/schemas/Logo' status: $ref: '#/components/schemas/Status' selfjoin: $ref: '#/components/schemas/SelfJoin' GroupUpdateRequest: title: GroupUpdateRequest type: object properties: name: $ref: '#/components/schemas/GroupName' descriptions: $ref: '#/components/schemas/GroupDescriptions' status: $ref: '#/components/schemas/GroupStatus' selfjoin: $ref: '#/components/schemas/GroupSelfJoin' PermissionCodeAndProjectRestrictedViewSettings: title: PermissionCodeAndProjectRestrictedViewSettings type: object required: - permissionCode properties: permissionCode: type: integer format: int32 restrictedViewSettings: $ref: '#/components/schemas/ProjectRestrictedViewSettingsADM' Size: title: Size type: object required: - value properties: value: type: string Longname: title: Longname type: object required: - value properties: value: type: string PermissionGetResponseADM: title: PermissionGetResponseADM oneOf: - $ref: '#/components/schemas/AdministrativePermissionGetResponseADM' - $ref: '#/components/schemas/DefaultObjectAccessPermissionGetResponseADM' PermissionsForProjectGetResponseADM: title: PermissionsForProjectGetResponseADM type: object properties: permissions: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionInfoADM' GivenName: title: GivenName type: object required: - value properties: value: type: string SystemAdmin: title: SystemAdmin type: object required: - value properties: value: type: boolean ListGetResponseADM: title: ListGetResponseADM type: object required: - list properties: list: $ref: '#/components/schemas/ListADM' BadCredentialsException: title: BadCredentialsException type: object required: - message properties: message: type: string ListChildNodeADM: title: ListChildNodeADM type: object required: - id - labels - comments - position - hasRootNode properties: id: type: string name: type: string labels: $ref: '#/components/schemas/StringLiteralSequenceV2' comments: $ref: '#/components/schemas/StringLiteralSequenceV2' position: type: integer format: int32 hasRootNode: type: string children: type: array items: $ref: '#/components/schemas/ListChildNodeADM' ProjectKeywordsGetResponse: title: ProjectKeywordsGetResponse type: object properties: keywords: type: array items: type: string GravsearchException: title: GravsearchException type: object required: - message properties: message: type: string DuplicateValueException: title: DuplicateValueException type: object required: - message properties: message: type: string ListChangeRequest: title: ListChangeRequest type: object required: - listIri - projectIri properties: listIri: $ref: '#/components/schemas/ListIri' projectIri: description: IRI for a project. type: string hasRootNode: $ref: '#/components/schemas/ListIri' position: $ref: '#/components/schemas/Position' name: $ref: '#/components/schemas/ListName' labels: $ref: '#/components/schemas/Labels' comments: $ref: '#/components/schemas/Comments' GroupSelfJoin: title: GroupSelfJoin type: object required: - value properties: value: type: boolean PermissionDeleteResponseADM: title: PermissionDeleteResponseADM type: object required: - permissionIri - deleted properties: permissionIri: $ref: '#/components/schemas/PermissionIri' deleted: type: boolean UserGroupMembershipsGetResponseADM: title: UserGroupMembershipsGetResponseADM type: object properties: groups: type: array items: $ref: '#/components/schemas/Group' ListNodeADM: title: ListNodeADM oneOf: - $ref: '#/components/schemas/ListChildNodeADM' - $ref: '#/components/schemas/ListRootNodeADM' CopyrightHolderReplaceRequest: title: CopyrightHolderReplaceRequest type: object required: - old-value - new-value properties: old-value: type: string new-value: type: string UserCreateRequest: title: UserCreateRequest type: object required: - username - email - givenName - familyName - password - status - lang - systemAdmin properties: id: description: IRI for a user. type: string username: $ref: '#/components/schemas/Username' email: type: string pattern: ^.+@.+$ givenName: $ref: '#/components/schemas/GivenName' familyName: $ref: '#/components/schemas/FamilyName' password: $ref: '#/components/schemas/Password' status: $ref: '#/components/schemas/UserStatus' lang: type: string systemAdmin: $ref: '#/components/schemas/SystemAdmin' ListChangePositionRequest: title: ListChangePositionRequest type: object required: - position - parentNodeIri properties: position: $ref: '#/components/schemas/Position' parentNodeIri: $ref: '#/components/schemas/ListIri' ProjectMembersGetResponseADM: title: ProjectMembersGetResponseADM type: object properties: members: type: array items: $ref: '#/components/schemas/UserDto' ListChangeCommentsRequest: title: ListChangeCommentsRequest type: object required: - comments properties: comments: $ref: '#/components/schemas/Comments' Map_Set_PermissionADM: title: Map_Set_PermissionADM type: object additionalProperties: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionADM' ListIri: title: ListIri type: object required: - value properties: value: type: string Password: title: Password type: object required: - value properties: value: type: string ChangePermissionGroupApiRequestADM: title: ChangePermissionGroupApiRequestADM type: object required: - forGroup properties: forGroup: $ref: '#/components/schemas/GroupIri' StringLiteralSequenceV2: title: StringLiteralSequenceV2 type: object properties: stringLiterals: type: array items: $ref: '#/components/schemas/StringLiteralV2' ListChildNodeInfoADM: title: ListChildNodeInfoADM type: object required: - id - labels - comments - position - hasRootNode properties: id: type: string name: type: string labels: $ref: '#/components/schemas/StringLiteralSequenceV2' comments: $ref: '#/components/schemas/StringLiteralSequenceV2' position: type: integer format: int32 hasRootNode: type: string ListNodeGetResponseADM: title: ListNodeGetResponseADM type: object required: - node properties: node: $ref: '#/components/schemas/NodeADM' RestrictedViewResponse: title: RestrictedViewResponse type: object properties: size: $ref: '#/components/schemas/Size' watermark: $ref: '#/components/schemas/Watermark' PagedResponse_ProjectLicenseDto: title: PagedResponse_ProjectLicenseDto type: object required: - data - pagination properties: data: type: array items: $ref: '#/components/schemas/ProjectLicenseDto' pagination: $ref: '#/components/schemas/Pagination' AdministrativePermissionADM: title: AdministrativePermissionADM type: object required: - iri - forProject - forGroup properties: iri: $ref: '#/components/schemas/PermissionIri' forProject: description: IRI for a project. type: string forGroup: $ref: '#/components/schemas/GroupIri' hasPermissions: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionADM' StatusChangeRequest: title: StatusChangeRequest type: object required: - status properties: status: $ref: '#/components/schemas/UserStatus' PermissionIri: title: PermissionIri type: object required: - value properties: value: type: string RootNodeInfoGetResponseADM: title: RootNodeInfoGetResponseADM type: object required: - listinfo properties: listinfo: $ref: '#/components/schemas/ListRootNodeInfoADM' ProjectsKeywordsGetResponse: title: ProjectsKeywordsGetResponse type: object properties: keywords: type: array items: type: string Project: title: Project type: object required: - id - shortname - shortcode - status - selfjoin properties: id: description: IRI for a project. type: string shortname: $ref: '#/components/schemas/Shortname' shortcode: $ref: '#/components/schemas/Shortcode' longname: $ref: '#/components/schemas/Longname' description: type: array items: $ref: '#/components/schemas/StringLiteralV2' keywords: type: array items: type: string logo: $ref: '#/components/schemas/Logo' ontologies: type: array items: type: string status: $ref: '#/components/schemas/Status' selfjoin: $ref: '#/components/schemas/SelfJoin' allowedCopyrightHolders: type: array uniqueItems: true items: type: string enabledLicenses: type: array uniqueItems: true items: type: string GroupGetResponseADM: title: GroupGetResponseADM type: object required: - group properties: group: $ref: '#/components/schemas/Group' FamilyName: title: FamilyName type: object required: - value properties: value: type: string CreateDefaultObjectAccessPermissionAPIRequestADM: title: CreateDefaultObjectAccessPermissionAPIRequestADM type: object required: - forProject properties: id: $ref: '#/components/schemas/PermissionIri' forProject: description: IRI for a project. type: string forGroup: $ref: '#/components/schemas/GroupIri' forResourceClass: type: string forProperty: type: string hasPermissions: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionADM' GroupStatus: title: GroupStatus type: object required: - value properties: value: type: boolean ProjectsGetResponse: title: ProjectsGetResponse type: object properties: projects: type: array items: $ref: '#/components/schemas/Project' ChildNodeInfoGetResponseADM: title: ChildNodeInfoGetResponseADM type: object required: - nodeinfo properties: nodeinfo: $ref: '#/components/schemas/ListChildNodeInfoADM' AdministrativePermissionGetResponseADM: title: AdministrativePermissionGetResponseADM type: object required: - administrativePermission properties: administrativePermission: $ref: '#/components/schemas/AdministrativePermissionADM' NotFoundException: title: NotFoundException type: object required: - message properties: message: type: string BadRequestException: title: BadRequestException type: object required: - message properties: message: type: string ProjectAdminMembersGetResponseADM: title: ProjectAdminMembersGetResponseADM type: object properties: members: type: array items: $ref: '#/components/schemas/UserDto' Logo: title: Logo type: object required: - value properties: value: type: string PermissionADM: title: PermissionADM type: object required: - name properties: name: type: string additionalInformation: type: string permissionCode: type: integer format: int32 ListRootNodeADM: title: ListRootNodeADM type: object required: - id - projectIri - labels - comments - isRootNode properties: id: type: string projectIri: type: string name: type: string labels: $ref: '#/components/schemas/StringLiteralSequenceV2' comments: $ref: '#/components/schemas/StringLiteralSequenceV2' children: type: array items: $ref: '#/components/schemas/ListChildNodeADM' isRootNode: type: boolean ChangePermissionResourceClassApiRequestADM: title: ChangePermissionResourceClassApiRequestADM type: object required: - forResourceClass properties: forResourceClass: type: string ChildNodeDeleteResponseADM: title: ChildNodeDeleteResponseADM type: object required: - node properties: node: $ref: '#/components/schemas/ListNodeADM' PagedResponse_Authorship: title: PagedResponse_Authorship type: object required: - data - pagination properties: data: type: array items: type: string pagination: $ref: '#/components/schemas/Pagination' NodeInfoGetResponseADM: title: NodeInfoGetResponseADM oneOf: - $ref: '#/components/schemas/ChildNodeInfoGetResponseADM' - $ref: '#/components/schemas/RootNodeInfoGetResponseADM' DefaultObjectAccessPermissionGetResponseADM: title: DefaultObjectAccessPermissionGetResponseADM type: object required: - defaultObjectAccessPermission properties: defaultObjectAccessPermission: $ref: '#/components/schemas/DefaultObjectAccessPermissionADM' DefaultObjectAccessPermissionCreateResponseADM: title: DefaultObjectAccessPermissionCreateResponseADM type: object required: - defaultObjectAccessPermission properties: defaultObjectAccessPermission: $ref: '#/components/schemas/DefaultObjectAccessPermissionADM' ProjectCreateRequest: title: ProjectCreateRequest type: object required: - shortname - shortcode - status - selfjoin properties: id: description: IRI for a project. type: string shortname: $ref: '#/components/schemas/Shortname' shortcode: $ref: '#/components/schemas/Shortcode' longname: $ref: '#/components/schemas/Longname' description: type: array items: $ref: '#/components/schemas/Description' keywords: type: array items: $ref: '#/components/schemas/Keyword' logo: $ref: '#/components/schemas/Logo' status: $ref: '#/components/schemas/Status' selfjoin: $ref: '#/components/schemas/SelfJoin' allowedCopyrightHolders: type: array uniqueItems: true items: type: string enabledLicenses: type: array uniqueItems: true items: type: string securitySchemes: httpAuth: type: http scheme: bearer httpAuth1: type: http scheme: basic