openapi: 3.1.0 info: title: DSP-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 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: [] /v2/authentication: get: tags: - API v2 operationId: getV2Authentication responses: '200': description: '' headers: Set-Cookie: required: false schema: type: array items: type: string content: application/json: schema: $ref: '#/components/schemas/CheckResponse' '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] post: tags: - API v2 operationId: postV2Authentication requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginPayload' required: true responses: '200': description: '' headers: Set-Cookie: required: false schema: type: array items: type: string content: application/json: schema: $ref: '#/components/schemas/TokenResponse' '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' delete: tags: - API v2 operationId: deleteV2Authentication parameters: - name: KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 in: cookie required: false schema: type: string responses: '200': description: '' headers: Set-Cookie: required: false schema: type: array items: type: string content: application/json: schema: $ref: '#/components/schemas/LogoutResponse' '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - {} - httpAuth: [] /v2/lists/{listIri}: get: tags: - API v2 description: Returns a list (a graph with all list nodes). operationId: getV2ListsListiri parameters: - name: listIri in: path description: The iri to a list. required: true schema: type: string example: http://rdfh.ch/lists/0001/FCIjX3J7R8SburI_yz7oeA - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/node/{listIri}: get: tags: - API v2 description: Returns a list node. operationId: getV2NodeListiri parameters: - name: listIri in: path description: The iri to a list. required: true schema: type: string example: http://rdfh.ch/lists/0001/FCIjX3J7R8SburI_yz7oeA - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resources/info: get: tags: - API v2 description: Get information about resources of a specific class in a project. Publicly accessible. operationId: getV2ResourcesInfo parameters: - name: x-knora-accept-project in: header required: true schema: type: string - name: resourceClass in: query required: true schema: type: string - name: order in: query description: Sort the results in ascending (asc) or descending (desc) order. required: false schema: default: Asc type: string - name: orderBy in: query description: Sort the results by the specified property. required: false schema: default: LastModificationDate type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ListResponseDto' '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /v2/values/{resourceIri}/{valueUuid}: get: tags: - API v2 description: Get a value of a resource. Publicly accessible. Requires appropriate object access permissions on the resource. Find detailed documentation on docs.dasch.swiss. operationId: getV2ValuesResourceiriValueuuid parameters: - name: resourceIri in: path description: The IRI of a Resource. required: true schema: type: string - name: valueUuid in: path description: The UUID of a Value. required: true schema: type: string - name: version in: query required: false schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/json: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/values: put: tags: - API v2 description: Update a value of a resource. Requires appropriate object access permissions on the resource. Find detailed documentation on docs.dasch.swiss. operationId: putV2Values requestBody: content: application/json: schema: type: string example: '@id': http://rdfh.ch/0001/a-thing '@type': anything:Thing anything:hasInteger: '@id': http://rdfh.ch/0001/a-thing/values/vp96riPIRnmQcbMhgpv_Rg '@type': knora-api:IntValue knora-api:intValueAsInt: 5 '@context': knora-api: http://api.knora.org/ontology/knora-api/v2# anything: http://0.0.0.0:3333/ontology/0001/anything/v2# required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/json: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] post: tags: - API v2 description: Create a new value for a resource. Requires appropriate object access permissions on the resource. Find detailed documentation on docs.dasch.swiss. operationId: postV2Values requestBody: content: application/json: schema: type: string example: '@id': http://rdfh.ch/0001/a-thing '@type': anything:Thing anything:hasInteger: '@type': knora-api:IntValue knora-api:intValueAsInt: 4 '@context': knora-api: http://api.knora.org/ontology/knora-api/v2# anything: http://0.0.0.0:3333/ontology/0001/anything/v2# required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/json: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/values/order: put: tags: - API v2 description: Reorder values of a property on a resource. Requires modify permission on the resource. Find detailed documentation on docs.dasch.swiss. operationId: putV2ValuesOrder requestBody: content: application/json: schema: $ref: '#/components/schemas/ReorderValuesRequest' example: resourceIri: http://rdfh.ch/0001/resource-1 propertyIri: http://0.0.0.0:3333/ontology/0001/anything/v2#hasText orderedValueIris: - http://rdfh.ch/0001/value-3 - http://rdfh.ch/0001/value-1 - http://rdfh.ch/0001/value-2 required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ReorderValuesResponse' '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/values/delete: post: tags: - API v2 description: Mark a value as deleted. Requires appropriate object access permissions on the resource. Find detailed documentation on docs.dasch.swiss. operationId: postV2ValuesDelete requestBody: content: application/json: schema: type: string example: '@id': http://rdfh.ch/0001/a-thing '@type': anything:Thing anything:hasInteger: '@id': http://rdfh.ch/0001/a-thing/values/vp96riPIRnmQcbMhgpv_Rg '@type': knora-api:IntValue '@context': knora-api: http://api.knora.org/ontology/knora-api/v2# anything: http://0.0.0.0:3333/ontology/0001/anything/v2# required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/json: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/values/erase: post: tags: - API v2 description: Erase a Value and all of its old versions from the database completely. Requires SystemAdmin permissions. Find detailed documentation on docs.dasch.swiss. operationId: postV2ValuesErase requestBody: content: application/json: schema: type: string example: '@id': http://rdfh.ch/0001/a-thing '@type': anything:Thing anything:hasInteger: '@id': http://rdfh.ch/0001/a-thing/values/vp96riPIRnmQcbMhgpv_Rg '@type': knora-api:IntValue '@context': knora-api: http://api.knora.org/ontology/knora-api/v2# anything: http://0.0.0.0:3333/ontology/0001/anything/v2# required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/json: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/values/erasehistory: post: tags: - API v2 description: Erase all old versions of a Value from the database completely and keep only the latest version. Requires SystemAdmin permissions. Find detailed documentation on docs.dasch.swiss. operationId: postV2ValuesErasehistory requestBody: content: application/json: schema: type: string example: '@id': http://rdfh.ch/0001/a-thing '@type': anything:Thing anything:hasInteger: '@id': http://rdfh.ch/0001/a-thing/values/vp96riPIRnmQcbMhgpv_Rg '@type': knora-api:IntValue '@context': knora-api: http://api.knora.org/ontology/knora-api/v2# anything: http://0.0.0.0:3333/ontology/0001/anything/v2# required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/json: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/metadata/projects/{projectShortcode}/resources: get: tags: - API v2 description: Get metadata of all resources in a project. The metadata is returned with complex schema IRIs in the payload. This endpoint is only available for system and project admins. operationId: getV2MetadataProjectsProjectshortcodeResources 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: format in: query description: The format of the response. required: false schema: $ref: '#/components/schemas/ExportFormat' - name: classIris in: query description: List of resource class IRIs to filter the resources. If not present, all resources of the project will be returned. required: false schema: default: [] type: array items: type: string responses: '200': description: Depending on the format the response will be rendered as CSV,TSV,JSON. The example is CSV. headers: Content-Type: description: 'The content type of the response, depends on the format: CSV => text/csv, TSV => text/tab-separated-values, JSON => application/json' required: true schema: type: string Content-Disposition: description: Will be set to attachment. The filename contains project shortcode, export timestamp and the format. required: true schema: type: string content: text/plain: schema: type: string example: |2- Resource IRI,ARK URL (Permalink),Resource Class,Label,Created by,Creation Date,Last Modification Date (if available),Deletion Date (if available) http://rdfh.ch/0803/00014b43f902,http://0.0.0.0:3336/ark:/72163/1/0803/00014b43f902l,http://0.0.0.0:3333/ontology/0803/incunabula/v2#page,t8r,http://rdfh.ch/users/91e19f1e01,2016-03-02T15:05:37Z,, http://rdfh.ch/0803/0015627fe303,http://0.0.0.0:3336/ark:/72163/1/0803/0015627fe303e,http://0.0.0.0:3333/ontology/0803/incunabula/v2#page,m8v,http://rdfh.ch/users/91e19f1e01,2016-03-02T15:05:49Z,, '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resources/candelete: get: tags: - API v2 description: Check if a resource can be deleted. Publicly accessible. Requires appropriate object access permissions on the resource. operationId: getV2ResourcesCandelete parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: jsonLd in: query required: true schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/graph/{resourceIri}: get: tags: - API v2 description: Get a graph of resources starting from a specific resource. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2GraphResourceiri parameters: - name: resourceIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: depth in: query required: false schema: default: 4 type: integer format: int32 minimum: 1 maximum: 10 - name: direction in: query required: false schema: default: outbound type: string - name: excludeProperty in: query required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resources/iiifmanifest/{resourceIri}: get: tags: - API v2 description: Get the IIIF manifest for a resource. Publicly accessible. Requires appropriate object access permissions on the resource. operationId: getV2ResourcesIiifmanifestResourceiri parameters: - name: resourceIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resourcespreview: get: tags: - API v2 description: Get a preview of one or more resources. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2Resourcespreview parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resources/projectHistoryEvents/{projectIri}: get: tags: - API v2 description: Get history events for all resources in a project. Publicly accessible. Requires appropriate object access permissions. operationId: getV2ResourcesProjecthistoryeventsProjectiri parameters: - name: projectIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resources/resourceHistoryEvents/{resourceIri}: get: tags: - API v2 description: Get history events for a specific resource. Publicly accessible. Requires appropriate object access permissions on the resource. operationId: getV2ResourcesResourcehistoryeventsResourceiri parameters: - name: resourceIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resources/history/{resourceIri}: get: tags: - API v2 description: Get the version history of a resource. Publicly accessible. Requires appropriate object access permissions on the resource. operationId: getV2ResourcesHistoryResourceiri parameters: - name: resourceIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: startDate in: query required: false schema: type: string - name: start date in: query required: false schema: type: string - name: endDate in: query required: false schema: type: string - name: end date in: query required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resources: get: tags: - API v2 description: Search for resources by class and project. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2Resources parameters: - name: resourceClass in: query required: true schema: type: string - name: orderByProperty in: query required: false schema: type: string - name: page in: query required: true schema: type: integer format: int32 minimum: 0 - name: x-knora-accept-project in: header required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] put: tags: - API v2 description: Update resource metadata. Requires appropriate object access permissions on the resource. operationId: putV2Resources parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] post: tags: - API v2 description: Create a new resource. Requires appropriate object access permissions. operationId: postV2Resources parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/tei/{resourceIri}: get: tags: - API v2 description: Get a resource as TEI/XML. Publicly accessible. Requires appropriate object access permissions on the resource. operationId: getV2TeiResourceiri parameters: - name: resourceIri in: path required: true schema: type: string - name: mappingIri in: query required: false schema: type: string - name: textProperty in: query required: true schema: type: string - name: gravsearchTemplateIri in: query required: false schema: type: string - name: headerXSLTIri in: query required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resources/erase: post: tags: - API v2 description: Erase a Resource and all of its values from the database completely. Requires SystemAdmin or ProjectAdmin permissions for the resource's project. operationId: postV2ResourcesErase parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/resources/delete: post: tags: - API v2 description: Mark a resource as deleted. Requires appropriate object access permissions on the resource. operationId: postV2ResourcesDelete parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/search/{searchTerm}: get: tags: - API v2 description: Full-text search for resources. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchSearchterm parameters: - name: searchTerm in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: offset in: query description: The offset to be used for paging. required: false schema: default: 0 type: integer format: int32 exclusiveMinimum: -1 - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string - name: limitToResourceClass in: query description: The resource class to limit the search to. required: false schema: type: string - name: limitToStandoffClass in: query description: The standoff class to limit the search to. required: false schema: type: string - name: returnFiles in: query description: Whether to return files in the search results. required: false schema: default: false type: boolean responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/search/count/{searchTerm}: get: tags: - API v2 description: Count full-text search results. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchCountSearchterm parameters: - name: searchTerm in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string - name: limitToResourceClass in: query description: The resource class to limit the search to. required: false schema: type: string - name: limitToStandoffClass in: query description: The standoff class to limit the search to. required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchbylabel/{searchTerm}: get: tags: - API v2 description: Search for resources by label. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchbylabelSearchterm parameters: - name: searchTerm in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: offset in: query description: The offset to be used for paging. required: false schema: default: 0 type: integer format: int32 exclusiveMinimum: -1 - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string - name: limitToResourceClass in: query description: The resource class to limit the search to. required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchbylabel/count/{searchTerm}: get: tags: - API v2 description: Count resources by label. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchbylabelCountSearchterm parameters: - name: searchTerm in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string - name: limitToResourceClass in: query description: The resource class to limit the search to. required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchextended: post: tags: - API v2 description: Search for resources using a Gravsearch query. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: postV2Searchextended parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string requestBody: description: The Gravsearch query. See https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/query-language/ content: text/plain: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchextended/{p1}: get: tags: - API v2 description: Search for resources using a Gravsearch query. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchextendedP1 parameters: - name: p1 in: path description: The Gravsearch query. See https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/query-language/ required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchextended/count: post: tags: - API v2 description: Count resources using a Gravsearch query. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: postV2SearchextendedCount parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string requestBody: description: The Gravsearch query. See https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/query-language/ content: text/plain: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchextended/count/{p1}: get: tags: - API v2 description: Count resources using a Gravsearch query. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchextendedCountP1 parameters: - name: p1 in: path description: The Gravsearch query. See https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/query-language/ required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchIncomingLinks/{resourceIri}: get: tags: - API v2 description: Search for incoming links using a Gravsearch query with an offset. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchincominglinksResourceiri parameters: - name: resourceIri in: path description: The IRI of the resource to retrieve required: true schema: type: string - name: offset in: query description: The offset to be used for paging. required: false schema: default: 0 type: integer format: int32 exclusiveMinimum: -1 - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchStillImageRepresentations/{resourceIri}: get: tags: - API v2 description: Search for StillImageRepresentations using a Gravsearch query with an offset. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchstillimagerepresentationsResourceiri parameters: - name: resourceIri in: path description: The IRI of the resource to retrieve required: true schema: type: string - name: offset in: query description: The offset to be used for paging. required: false schema: default: 0 type: integer format: int32 exclusiveMinimum: -1 - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchStillImageRepresentationsCount/{resourceIri}: get: tags: - API v2 description: Count SearchStillImageRepresentations using a Gravsearch query. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchstillimagerepresentationscountResourceiri parameters: - name: resourceIri in: path description: The IRI of the resource to retrieve required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/searchIncomingRegions/{resourceIri}: get: tags: - API v2 description: Search for incoming regions using a Gravsearch query with an offset. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: getV2SearchincomingregionsResourceiri parameters: - name: resourceIri in: path description: The IRI of the resource to retrieve required: true schema: type: string - name: offset in: query description: The offset to be used for paging. required: false schema: default: 0 type: integer format: int32 exclusiveMinimum: -1 - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: limitToProject in: query description: The project to limit the search to. required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/mapping: post: tags: - API v2 description: Create a standoff mapping for XML to standoff conversion. Requires authentication. operationId: postV2Mapping parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/CreateStandoffMappingForm' required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/json: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/metadata: get: tags: - API v2 description: Get the metadata of an ontology. Publicly accessible. operationId: getV2OntologiesMetadata parameters: - name: x-knora-accept-project in: header required: false schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' put: tags: - API v2 description: Change the metadata of an ontology. Requires ProjectAdmin permissions for the ontology's project. operationId: putV2OntologiesMetadata parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /ontology: get: tags: - API v2 description: This is the route used to dereference an actual ontology IRI. If the URL path looks like it belongs to a built-in API ontology (which has to contain "knora-api"), prefix it with http://api.knora.org to get the ontology IRI. Otherwise, if it looks like it belongs to a project-specific API ontology, prefix it with routeData.appConfig.externalOntologyIriHostAndPort to get the ontology IRI. operationId: getOntology parameters: - name: allLanguages in: query required: false schema: default: false type: boolean - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/allentities/{ontologyIri}: get: tags: - API v2 description: Get all entities of an ontology. Publicly accessible. operationId: getV2OntologiesAllentitiesOntologyiri parameters: - name: ontologyIri in: path required: true schema: type: string - name: allLanguages in: query required: false schema: default: false type: boolean - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/canreplacecardinalities/{resourceClassIri}: get: tags: - API v2 description: If only a class IRI is provided, this endpoint checks if any cardinality of any of the class properties can be replaced. If a property IRI and a new cardinality are provided, it checks if the cardinality can be set for the property on the specific class. Fails if not both a property IRI and a new cardinality is provided. Fails if the user does not have write access to the ontology of the class. operationId: getV2OntologiesCanreplacecardinalitiesResourceclassiri parameters: - name: resourceClassIri in: path required: true schema: type: string - name: propertyIri in: query required: false schema: type: string - name: newCardinality in: query description: 'The new cardinality to be set for the property, must be provided when propertyIri is given. Valid values are: 1-n, 1, 0-n, 0-1' required: false schema: type: string example: 1-n - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/classes/{classIri}: get: tags: - API v2 description: Get a class definition by IRI. Publicly accessible. operationId: getV2OntologiesClassesClassiri parameters: - name: classIri in: path required: true schema: type: string - name: allLanguages in: query required: false schema: default: false type: boolean - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/candeleteclass/{resourceClassIri}: get: tags: - API v2 description: Check if a class can be deleted. Publicly accessible. operationId: getV2OntologiesCandeleteclassResourceclassiri parameters: - name: resourceClassIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/properties/{propertyIri}: get: tags: - API v2 description: Get a property definition by IRI. Publicly accessible. operationId: getV2OntologiesPropertiesPropertyiri parameters: - name: propertyIri in: path required: true schema: type: string - name: allLanguages in: query required: false schema: default: false type: boolean - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] delete: tags: - API v2 description: Delete a property from an ontology. Requires ProjectAdmin permissions for the ontology's project. operationId: deleteV2OntologiesPropertiesPropertyiri parameters: - name: propertyIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: lastModificationDate in: query required: true schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/candeleteproperty/{propertyIri}: get: tags: - API v2 description: Check if a property can be deleted. Publicly accessible. operationId: getV2OntologiesCandeletepropertyPropertyiri parameters: - name: propertyIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/candeleteontology/{ontologyIri}: get: tags: - API v2 description: Check if an ontology can be deleted. Requires authentication. operationId: getV2OntologiesCandeleteontologyOntologyiri parameters: - name: ontologyIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/classes/comment/{resourceClassIri}: delete: tags: - API v2 description: Delete the comment of a class definition. Requires ProjectAdmin permissions for the ontology's project. operationId: deleteV2OntologiesClassesCommentResourceclassiri parameters: - name: resourceClassIri in: path required: true schema: type: string - name: lastModificationDate in: query required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/classes/{resourceClassIri}: delete: tags: - API v2 description: Delete a class from an ontology. Requires ProjectAdmin permissions for the ontology's project. operationId: deleteV2OntologiesClassesResourceclassiri parameters: - name: resourceClassIri in: path required: true schema: type: string - name: lastModificationDate in: query required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/comment/{ontologyIri}: delete: tags: - API v2 description: Delete the comment of an ontology. Requires ProjectAdmin permissions for the ontology's project. operationId: deleteV2OntologiesCommentOntologyiri parameters: - name: ontologyIri in: path required: true schema: type: string - name: lastModificationDate in: query required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/properties/comment/{propertyIri}: delete: tags: - API v2 description: Delete the comment of a property definition. Requires ProjectAdmin permissions for the ontology's project. operationId: deleteV2OntologiesPropertiesCommentPropertyiri parameters: - name: propertyIri in: path required: true schema: type: string - name: lastModificationDate in: query required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/{ontologyIri}: delete: tags: - API v2 description: Delete an ontology. Requires ProjectAdmin permissions for the ontology's project. operationId: deleteV2OntologiesOntologyiri parameters: - name: ontologyIri in: path required: true schema: type: string - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: lastModificationDate in: query required: true schema: type: string responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/cardinalities: put: tags: - API v2 description: Update cardinalities of a class. Requires ProjectAdmin permissions for the ontology's project. operationId: putV2OntologiesCardinalities parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] post: tags: - API v2 description: Add cardinalities to a class. Requires ProjectAdmin permissions for the ontology's project. For more info check out the documentation. operationId: postV2OntologiesCardinalities parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] patch: tags: - API v2 description: Delete cardinalities from a class. Requires ProjectAdmin permissions for the ontology's project. operationId: patchV2OntologiesCardinalities parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/classes: put: tags: - API v2 description: Change the labels or comments of a class. Requires ProjectAdmin permissions for the ontology's project. operationId: putV2OntologiesClasses parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] post: tags: - API v2 description: Create a new class. Requires ProjectAdmin permissions for the ontology's project. operationId: postV2OntologiesClasses parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/candeletecardinalities: post: tags: - API v2 description: Check if cardinalities can be deleted from a class. Publicly accessible. operationId: postV2OntologiesCandeletecardinalities parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/properties: put: tags: - API v2 description: Update a property's labels or comments. Requires ProjectAdmin permissions for the ontology's project. operationId: putV2OntologiesProperties parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] post: tags: - API v2 description: Create a new property. Requires ProjectAdmin permissions for the ontology's project. operationId: postV2OntologiesProperties parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies: post: tags: - API v2 description: Create a new ontology. Requires ProjectAdmin permissions for the project. operationId: postV2Ontologies parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/guiorder: put: tags: - API v2 description: Update the GUI order of properties in a class. Requires ProjectAdmin permissions for the ontology's project. operationId: putV2OntologiesGuiorder parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v2/ontologies/properties/guielement: put: tags: - API v2 description: Update the GUI element of a property. Requires ProjectAdmin permissions for the ontology's project. operationId: putV2OntologiesPropertiesGuielement parameters: - name: x-knora-accept-schema in: header description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: schema in: query description: |- The ontology schema to be used for the request. If not specified, the default schema ApiV2Complex will be used. required: false schema: type: string - name: x-knora-json-ld-rendering in: header description: |- The JSON-LD rendering to be used for the request (flat or hierarchical). If not specified, hierarchical JSON-LD will be used. required: false schema: type: string - name: markup in: query description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string - name: x-knora-accept-markup in: header description: The markup rendering to be used for the request (XML or standoff). required: false schema: type: string requestBody: content: application/json: schema: type: string required: true responses: '200': description: '' headers: Content-Type: required: true schema: type: string content: application/ld+json: schema: type: string text/turtle: schema: type: string application/trig: schema: type: string application/rdf+xml: schema: type: string application/n-quads: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] /v3/projects/{projectIri}/resourcesPerOntology: get: tags: - API v3 description: This endpoint returns all ontologies in a project along with their resource classes and the count of resource instances for each class. Note that the `itemCount` includes only non-deleted resources and it includes resources even if the current user may not be permitted to see some of them, for performance reasons. operationId: getV3ProjectsProjectiriResourcesperontology 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: type: array items: $ref: '#/components/schemas/OntologyAndResourceClasses' example: - ontology: iri: http://0.0.0.0:3333/ontology/0001/anything/v2 label: The anything ontology comment: A sample ontology for anything classesAndCount: - resourceClass: iri: http://0.0.0.0:3333/ontology/0001/anything/v2#ImageThing representationClass: StillImageRepresentation label: - value: Thing with image representation language: en comment: - value: A thing which is has an image language: en itemCount: 42 '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: project_not_found: description: |- Example template string for code `project_not_found`: ``` The project '{id}' was not found. ``` value: message: The project '{id}' was not found. errors: - code: project_not_found message: The project '{id}' was not found. details: id: example_id /v3/export/resources: post: tags: - API v3 description: Export resources to CSV format. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: postV3ExportResources requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportRequest' example: resourceClass: classLink selectedProperties: - http://www.knora.org/ontology/knora-base#hasStillImageFileValue language: en includeIris: false includeArkUrls: false required: true responses: '200': description: '' headers: Content-Disposition: required: true schema: type: string content: text/csv: schema: type: string format: binary '400': description: '' content: application/json: schema: $ref: '#/components/schemas/BadRequest' example: message: Bad request example message errors: [] '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/NotFound' - $ref: '#/components/schemas/NotFound' - $ref: '#/components/schemas/NotFound' examples: project_not_found: description: |- Example template string for code `project_not_found`: ``` The project '{id}' was not found. ``` value: message: The project '{id}' was not found. errors: - code: project_not_found message: The project '{id}' was not found. details: id: example_id ontology_not_found: description: |- Example template string for code `ontology_not_found`: ``` The ontology '{id}' was not found. ``` value: message: The ontology '{id}' was not found. errors: - code: ontology_not_found message: The ontology '{id}' was not found. details: id: example_id resourceClass_not_found: description: |- Example template string for code `resourceClass_not_found`: ``` The resource class '{id}' was not found. ``` value: message: The resource class '{id}' was not found. errors: - code: resourceclass_not_found message: The resource class '{id}' was not found. details: id: example_id security: - {} - httpAuth: [] /v3/export/resources/oai: post: tags: - API v3 description: Export resources to CSV format. Publicly accessible. Requires appropriate object access permissions on the resources. operationId: postV3ExportResourcesOai requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportRequestOai' example: shortcode: '0803' required: true responses: '200': description: '' content: text/plain: schema: type: string '400': description: 'Invalid value for: body' content: text/plain: schema: type: string '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: project_not_found: description: |- Example template string for code `project_not_found`: ``` The project '{id}' was not found. ``` value: message: The project '{id}' was not found. errors: - code: project_not_found message: The project '{id}' was not found. details: id: example_id security: - {} - httpAuth: [] /v3/ontologies/{ontologyIri}/classes/{classIri}/mapping: put: tags: - Ontology Mappings - API v3 description: Adds rdfs:subClassOf triples from the given class to the listed external IRIs. Existing external super-class mappings are not removed - use DELETE first to replace them. operationId: putV3OntologiesOntologyiriClassesClassiriMapping parameters: - name: ontologyIri in: path required: true schema: type: string - name: classIri in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddClassMappingsRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ClassMappingResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/BadRequest' example: message: Bad request example message errors: [] '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: ontology_not_found: description: |- Example template string for code `ontology_not_found`: ``` The ontology '{id}' was not found. ``` value: message: The ontology '{id}' was not found. errors: - code: ontology_not_found message: The ontology '{id}' was not found. details: id: example_id class_not_found: description: |- Example template string for code `class_not_found`: ``` The class '{id}' was not found in ontology '{ontologyIri}'. ``` value: message: The class '{id}' was not found in ontology '{ontologyIri}'. errors: - code: class_not_found message: The class '{id}' was not found in ontology '{ontologyIri}'. details: id: example_id ontologyIri: example_ontologyIri security: - httpAuth: [] delete: tags: - Ontology Mappings - API v3 description: 'Removes a single rdfs:subClassOf triple from the given class to the specified external IRI. Idempotent: deleting an absent triple is a no-op.' operationId: deleteV3OntologiesOntologyiriClassesClassiriMapping parameters: - name: ontologyIri in: path required: true schema: type: string - name: classIri in: path required: true schema: type: string - name: mapping in: query description: The external IRI to remove from rdfs:subClassOf. Must be URL-encoded. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ClassMappingResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/BadRequest' example: message: Bad request example message errors: [] '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: ontology_not_found: description: |- Example template string for code `ontology_not_found`: ``` The ontology '{id}' was not found. ``` value: message: The ontology '{id}' was not found. errors: - code: ontology_not_found message: The ontology '{id}' was not found. details: id: example_id class_not_found: description: |- Example template string for code `class_not_found`: ``` The class '{id}' was not found in ontology '{ontologyIri}'. ``` value: message: The class '{id}' was not found in ontology '{ontologyIri}'. errors: - code: class_not_found message: The class '{id}' was not found in ontology '{ontologyIri}'. details: id: example_id ontologyIri: example_ontologyIri security: - httpAuth: [] /v3/ontologies/{ontologyIri}/properties/{propertyIri}/mapping: put: tags: - Ontology Mappings - API v3 description: Adds rdfs:subPropertyOf triples from the given property to the listed external IRIs. Existing external super-property mappings are not removed - use DELETE first to replace them. operationId: putV3OntologiesOntologyiriPropertiesPropertyiriMapping parameters: - name: ontologyIri in: path required: true schema: type: string - name: propertyIri in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddPropertyMappingsRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PropertyMappingResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/BadRequest' example: message: Bad request example message errors: [] '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: ontology_not_found: description: |- Example template string for code `ontology_not_found`: ``` The ontology '{id}' was not found. ``` value: message: The ontology '{id}' was not found. errors: - code: ontology_not_found message: The ontology '{id}' was not found. details: id: example_id property_not_found: description: |- Example template string for code `property_not_found`: ``` The property '{id}' was not found in ontology '{ontologyIri}'. ``` value: message: The property '{id}' was not found in ontology '{ontologyIri}'. errors: - code: property_not_found message: The property '{id}' was not found in ontology '{ontologyIri}'. details: id: example_id ontologyIri: example_ontologyIri security: - httpAuth: [] delete: tags: - Ontology Mappings - API v3 description: 'Removes a single rdfs:subPropertyOf triple from the given property to the specified external IRI. Idempotent: deleting an absent triple is a no-op.' operationId: deleteV3OntologiesOntologyiriPropertiesPropertyiriMapping parameters: - name: ontologyIri in: path required: true schema: type: string - name: propertyIri in: path required: true schema: type: string - name: mapping in: query description: The external IRI to remove from rdfs:subPropertyOf. Must be URL-encoded. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PropertyMappingResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/BadRequest' example: message: Bad request example message errors: [] '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: ontology_not_found: description: |- Example template string for code `ontology_not_found`: ``` The ontology '{id}' was not found. ``` value: message: The ontology '{id}' was not found. errors: - code: ontology_not_found message: The ontology '{id}' was not found. details: id: example_id property_not_found: description: |- Example template string for code `property_not_found`: ``` The property '{id}' was not found in ontology '{ontologyIri}'. ``` value: message: The property '{id}' was not found in ontology '{ontologyIri}'. errors: - code: property_not_found message: The property '{id}' was not found in ontology '{ontologyIri}'. details: id: example_id ontologyIri: example_ontologyIri security: - httpAuth: [] /v3/projects/{projectIri}/exports: post: tags: - API v3 description: Initiates an export of the project. The export will be performed asynchronously, and the response will contain an export ID that can be used to check the status of the export. An export can only be triggered when no other export exists. operationId: postV3ProjectsProjectiriExports 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: skipAssets in: query description: When true, binary assets are not included in the export. required: false schema: default: false type: boolean responses: '202': description: '' content: application/json: schema: $ref: '#/components/schemas/DataTaskStatusResponse' '400': description: 'Invalid value for: query parameter skipAssets' content: text/plain: schema: type: string '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: project_not_found: description: |- Example template string for code `project_not_found`: ``` The project '{id}' was not found. ``` value: message: The project '{id}' was not found. errors: - code: project_not_found message: The project '{id}' was not found. details: id: example_id '409': description: '' content: application/json: schema: $ref: '#/components/schemas/Conflict' examples: export_exists: description: |- Example template string for code `export_exists`: ``` Export '{id}' exists for project '{projectIri}'. ``` value: message: Export '{id}' exists for project '{projectIri}'. errors: - code: export_exists message: Export '{id}' exists for project '{projectIri}'. details: id: example_id projectIri: example_projectIri security: - httpAuth: [] /v3/projects/{projectIri}/exports/{exportId}: get: tags: - API v3 description: Checks the status of an export. The response will indicate whether the export is still in progress, has completed successfully, or has failed. operationId: getV3ProjectsProjectiriExportsExportid 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: exportId in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DataTaskStatusResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: project_not_found: description: |- Example template string for code `project_not_found`: ``` The project '{id}' was not found. ``` value: message: The project '{id}' was not found. errors: - code: project_not_found message: The project '{id}' was not found. details: id: example_id export_not_found: description: |- Example template string for code `export_not_found`: ``` The export '{id}' in project '{projectIri}' was not found. ``` value: message: The export '{id}' in project '{projectIri}' was not found. errors: - code: export_not_found message: The export '{id}' in project '{projectIri}' was not found. details: id: example_id projectIri: example_projectIri security: - httpAuth: [] delete: tags: - API v3 description: Deletes an export irrevocably. Only exports in state failed or completed can be deleted. operationId: deleteV3ProjectsProjectiriExportsExportid 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: exportId in: path required: true schema: type: string responses: '204': description: '' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: project_not_found: description: |- Example template string for code `project_not_found`: ``` The project '{id}' was not found. ``` value: message: The project '{id}' was not found. errors: - code: project_not_found message: The project '{id}' was not found. details: id: example_id export_not_found: description: |- Example template string for code `export_not_found`: ``` The export '{id}' in project '{projectIri}' was not found. ``` value: message: The export '{id}' in project '{projectIri}' was not found. errors: - code: export_not_found message: The export '{id}' in project '{projectIri}' was not found. details: id: example_id projectIri: example_projectIri '409': description: '' content: application/json: schema: $ref: '#/components/schemas/Conflict' examples: export_in_progress: description: |- Example template string for code `export_in_progress`: ``` Export '{id}' in progress for project '{projectIri}'. ``` value: message: Export '{id}' in progress for project '{projectIri}'. errors: - code: export_in_progress message: Export '{id}' in progress for project '{projectIri}'. details: id: example_id projectIri: example_projectIri security: - httpAuth: [] /v3/projects/{projectIri}/exports/{exportId}/download: get: tags: - API v3 description: Download an export. An export can only be downloaded when it has completed successfully. If it is still in progress or has failed, the response will be 409 Conflict. operationId: getV3ProjectsProjectiriExportsExportidDownload 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: exportId in: path required: true schema: type: string responses: '200': description: '' headers: Content-Disposition: required: true schema: type: string content: application/zip: schema: type: string format: binary '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: project_not_found: description: |- Example template string for code `project_not_found`: ``` The project '{id}' was not found. ``` value: message: The project '{id}' was not found. errors: - code: project_not_found message: The project '{id}' was not found. details: id: example_id export_not_found: description: |- Example template string for code `export_not_found`: ``` The export '{id}' in project '{projectIri}' was not found. ``` value: message: The export '{id}' in project '{projectIri}' was not found. errors: - code: export_not_found message: The export '{id}' in project '{projectIri}' was not found. details: id: example_id projectIri: example_projectIri '409': description: '' content: application/json: schema: $ref: '#/components/schemas/Conflict' examples: export_in_progress: description: |- Example template string for code `export_in_progress`: ``` Export '{id}' in progress for project '{projectIri}'. ``` value: message: Export '{id}' in progress for project '{projectIri}'. errors: - code: export_in_progress message: Export '{id}' in progress for project '{projectIri}'. details: id: example_id projectIri: example_projectIri export_failed: description: |- Example template string for code `export_failed`: ``` Export '{id}' failed for project '{projectIri}'. ``` value: message: Export '{id}' failed for project '{projectIri}'. errors: - code: export_failed message: Export '{id}' failed for project '{projectIri}'. details: id: example_id projectIri: example_projectIri security: - httpAuth: [] /v3/projects/{projectIri}/imports: post: tags: - API v3 description: Initiates an import of a project from an export zip file. The import will be performed asynchronously, and the response will indicate that the import has been accepted. An import can only be triggered when no other import exists. operationId: postV3ProjectsProjectiriImports 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: The export zip file to import content: application/zip: schema: type: string format: binary required: true responses: '202': description: '' content: application/json: schema: $ref: '#/components/schemas/DataTaskStatusResponse' '400': description: 'Invalid value for: body' content: text/plain: schema: type: string '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '409': description: '' content: application/json: schema: $ref: '#/components/schemas/Conflict' examples: import_exists: description: |- Example template string for code `import_exists`: ``` Import '{id}' exists for project '{projectIri}'. ``` value: message: Import '{id}' exists for project '{projectIri}'. errors: - code: import_exists message: Import '{id}' exists for project '{projectIri}'. details: id: example_id projectIri: example_projectIri security: - httpAuth: [] /v3/projects/{projectIri}/imports/{importId}: get: tags: - API v3 description: Checks the status of an import. The response will indicate whether the import is still in progress, has completed successfully, or has failed. operationId: getV3ProjectsProjectiriImportsImportid 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: importId in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DataTaskStatusResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: import_not_found: description: |- Example template string for code `import_not_found`: ``` The import '{id}' in project '{projectIri}' was not found. ``` value: message: The import '{id}' in project '{projectIri}' was not found. errors: - code: import_not_found message: The import '{id}' in project '{projectIri}' was not found. details: id: example_id projectIri: example_projectIri security: - httpAuth: [] delete: tags: - API v3 description: Deletes an import. Only imports in state failed or completed can be deleted. If it is still in progress, the response will be 409 Conflict. operationId: deleteV3ProjectsProjectiriImportsImportid 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: importId in: path required: true schema: type: string responses: '204': description: '' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: message: Invalid token. errors: [] '403': description: '' content: application/json: schema: $ref: '#/components/schemas/Forbidden' example: message: User not active. errors: [] '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFound' examples: import_not_found: description: |- Example template string for code `import_not_found`: ``` The import '{id}' in project '{projectIri}' was not found. ``` value: message: The import '{id}' in project '{projectIri}' was not found. errors: - code: import_not_found message: The import '{id}' in project '{projectIri}' was not found. details: id: example_id projectIri: example_projectIri '409': description: '' content: application/json: schema: $ref: '#/components/schemas/Conflict' examples: import_in_progress: description: |- Example template string for code `import_in_progress`: ``` Import '{id}' in progress for project '{projectIri}'. ``` value: message: Import '{id}' in progress for project '{projectIri}'. errors: - code: import_in_progress message: Import '{id}' in progress for project '{projectIri}'. details: id: example_id projectIri: example_projectIri security: - httpAuth: [] /version: get: tags: - Management API description: Get version information. Publicly accessible. operationId: getVersion responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/VersionResponse' example: webapi: v35.10.0 buildCommit: 5aac2e073 buildTime: '2026-06-01T14:27:01Z' fuseki: 6.1.0-0 scala: 3.3.7 sipi: v4.1.1 name: version '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' /health: get: tags: - Management API description: Get health status. Publicly accessible. operationId: getHealth responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/HealthResponse' '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' /start-compaction: post: tags: - Management API description: Start triplestore compaction. Requires SystemAdmin permissions. operationId: postStart-compaction responses: '200': description: '' content: application/json: schema: type: string '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/OntologyConstraintException' - $ref: '#/components/schemas/DuplicateValueException' - $ref: '#/components/schemas/ValidationException' - $ref: '#/components/schemas/BadRequestException' - $ref: '#/components/schemas/GravsearchException' - $ref: '#/components/schemas/EditConflictException' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/BadCredentialsException' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - httpAuth: [] - httpAuth1: [] components: schemas: Active: title: Active type: object AddClassMappingsRequest: title: AddClassMappingsRequest type: object properties: mappings: type: array items: type: string AddPropertyMappingsRequest: title: AddPropertyMappingsRequest type: object properties: mappings: type: array items: type: string 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' AdministrativePermissionCreateResponseADM: title: AdministrativePermissionCreateResponseADM type: object required: - administrativePermission properties: administrativePermission: $ref: '#/components/schemas/AdministrativePermissionADM' AdministrativePermissionGetResponseADM: title: AdministrativePermissionGetResponseADM type: object required: - administrativePermission properties: administrativePermission: $ref: '#/components/schemas/AdministrativePermissionADM' AdministrativePermissionsForProjectGetResponseADM: title: AdministrativePermissionsForProjectGetResponseADM type: object properties: administrativePermissions: type: array items: $ref: '#/components/schemas/AdministrativePermissionADM' BadCredentialsException: title: BadCredentialsException type: object required: - message properties: message: type: string BadRequest: title: BadRequest type: object required: - message properties: message: type: string errors: type: array items: $ref: '#/components/schemas/ErrorDetail' BadRequestException: title: BadRequestException type: object required: - message properties: message: 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 CanDeleteListResponseADM: title: CanDeleteListResponseADM type: object required: - listIri - canDeleteList properties: listIri: $ref: '#/components/schemas/ListIri' canDeleteList: type: boolean CanJoin: title: CanJoin type: object CannotJoin: title: CannotJoin type: object 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' ChangePermissionGroupApiRequestADM: title: ChangePermissionGroupApiRequestADM type: object required: - forGroup properties: forGroup: $ref: '#/components/schemas/GroupIri' ChangePermissionHasPermissionsApiRequestADM: title: ChangePermissionHasPermissionsApiRequestADM type: object properties: hasPermissions: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionADM' ChangePermissionPropertyApiRequestADM: title: ChangePermissionPropertyApiRequestADM type: object required: - forProperty properties: forProperty: type: string ChangePermissionResourceClassApiRequestADM: title: ChangePermissionResourceClassApiRequestADM type: object required: - forResourceClass properties: forResourceClass: type: string CheckResponse: title: CheckResponse type: object required: - message properties: message: type: string ChildNodeDeleteResponseADM: title: ChildNodeDeleteResponseADM type: object required: - node properties: node: $ref: '#/components/schemas/ListNodeADM' ChildNodeInfoGetResponseADM: title: ChildNodeInfoGetResponseADM type: object required: - nodeinfo properties: nodeinfo: $ref: '#/components/schemas/ListChildNodeInfoADM' ClassMappingResponse: title: ClassMappingResponse type: object required: - classIri - ontologyIri - lastModificationDate properties: classIri: type: string ontologyIri: type: string subClassOf: type: array items: type: string label: type: array items: $ref: '#/components/schemas/LanguageStringDto' comment: type: array items: $ref: '#/components/schemas/LanguageStringDto' lastModificationDate: type: string format: date-time Comments: title: Comments type: object properties: value: type: array items: $ref: '#/components/schemas/StringLiteralV2' Conflict: title: Conflict type: object required: - message properties: message: type: string errors: type: array items: $ref: '#/components/schemas/ErrorDetail' CopyrightHolderAddRequest: title: CopyrightHolderAddRequest type: object properties: data: type: array uniqueItems: true items: type: string CopyrightHolderReplaceRequest: title: CopyrightHolderReplaceRequest type: object required: - old-value - new-value properties: old-value: type: string new-value: type: string 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' 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' CreateStandoffMappingForm: title: CreateStandoffMappingForm type: object required: - json - xml properties: json: type: string xml: type: string DataTaskStatusResponse: title: DataTaskStatusResponse type: object required: - id - projectIri - status - createdBy - createdAt properties: id: description: A unique identifier. type: string projectIri: description: IRI for a project. type: string status: description: The status of a task. One of 'in_progress,completed,failed' expected. type: string createdBy: description: IRI for a user. type: string createdAt: type: string format: date-time errorMessage: type: string 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' DefaultObjectAccessPermissionCreateResponseADM: title: DefaultObjectAccessPermissionCreateResponseADM type: object required: - defaultObjectAccessPermission properties: defaultObjectAccessPermission: $ref: '#/components/schemas/DefaultObjectAccessPermissionADM' DefaultObjectAccessPermissionGetResponseADM: title: DefaultObjectAccessPermissionGetResponseADM type: object required: - defaultObjectAccessPermission properties: defaultObjectAccessPermission: $ref: '#/components/schemas/DefaultObjectAccessPermissionADM' DefaultObjectAccessPermissionsForProjectGetResponseADM: title: DefaultObjectAccessPermissionsForProjectGetResponseADM type: object properties: defaultObjectAccessPermissions: type: array items: $ref: '#/components/schemas/DefaultObjectAccessPermissionADM' Description: title: Description type: object required: - value properties: value: $ref: '#/components/schemas/StringLiteralV2' DuplicateValueException: title: DuplicateValueException type: object required: - message properties: message: type: string EditConflictException: title: EditConflictException type: object required: - message properties: message: type: string EmailPassword: title: EmailPassword type: object required: - email - password properties: email: type: string pattern: ^.+@.+$ password: type: string ErrorDetail: title: ErrorDetail type: object required: - code - message - details properties: code: $ref: '#/components/schemas/V3ErrorCode' message: type: string details: $ref: '#/components/schemas/Map_String' ErrorResponse: title: ErrorResponse type: object required: - message properties: message: type: string ExportFormat: title: ExportFormat default: CSV type: string enum: - CSV - JSON - TSV ExportRequest: title: ExportRequest type: object required: - resourceClass - language - includeIris - includeArkUrls properties: resourceClass: type: string selectedProperties: type: array items: type: string language: type: string includeIris: type: boolean includeArkUrls: type: boolean ExportRequestOai: title: ExportRequestOai type: object required: - shortcode properties: shortcode: $ref: '#/components/schemas/Shortcode' FamilyName: title: FamilyName type: object required: - value properties: value: type: string Forbidden: title: Forbidden type: object required: - message properties: message: type: string errors: type: array items: $ref: '#/components/schemas/ErrorDetail' ForbiddenException: title: ForbiddenException type: object required: - message properties: message: type: string GivenName: title: GivenName type: object required: - value properties: value: type: string GravsearchException: title: GravsearchException type: object required: - message properties: message: type: string 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 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' GroupDescriptions: title: GroupDescriptions type: object properties: value: type: array items: $ref: '#/components/schemas/StringLiteralV2' GroupGetResponseADM: title: GroupGetResponseADM type: object required: - group properties: group: $ref: '#/components/schemas/Group' GroupIri: title: GroupIri type: object required: - value properties: value: type: string GroupMembersGetResponseADM: title: GroupMembersGetResponseADM type: object properties: members: type: array items: $ref: '#/components/schemas/UserDto' GroupName: title: GroupName type: object required: - value properties: value: type: string GroupSelfJoin: title: GroupSelfJoin type: object required: - value properties: value: type: boolean GroupStatus: title: GroupStatus type: object required: - value properties: value: type: boolean GroupStatusUpdateRequest: title: GroupStatusUpdateRequest type: object required: - status properties: status: $ref: '#/components/schemas/GroupStatus' 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' GroupsGetResponseADM: title: GroupsGetResponseADM type: object properties: groups: type: array items: $ref: '#/components/schemas/Group' HealthResponse: title: HealthResponse type: object required: - name - severity - status - message properties: name: type: string severity: type: string status: type: boolean message: type: string Inactive: title: Inactive type: object IriPassword: title: IriPassword type: object required: - iri - password properties: iri: description: IRI for a user. type: string password: type: string Keyword: title: Keyword type: object required: - value properties: value: type: string Labels: title: Labels type: object properties: value: type: array items: $ref: '#/components/schemas/StringLiteralV2' LanguageStringDto: title: LanguageStringDto type: object required: - value - language properties: value: type: string language: type: string LanguageTaggedStringLiteralV2: title: LanguageTaggedStringLiteralV2 type: object required: - value - language properties: value: type: string language: type: string ListADM: title: ListADM type: object required: - listinfo properties: listinfo: $ref: '#/components/schemas/ListRootNodeInfoADM' children: type: array items: $ref: '#/components/schemas/ListChildNodeADM' ListChangeCommentsRequest: title: ListChangeCommentsRequest type: object required: - comments properties: comments: $ref: '#/components/schemas/Comments' ListChangeLabelsRequest: title: ListChangeLabelsRequest type: object required: - labels properties: labels: $ref: '#/components/schemas/Labels' ListChangeNameRequest: title: ListChangeNameRequest type: object required: - name properties: name: $ref: '#/components/schemas/ListName' ListChangePositionRequest: title: ListChangePositionRequest type: object required: - position - parentNodeIri properties: position: $ref: '#/components/schemas/Position' parentNodeIri: $ref: '#/components/schemas/ListIri' 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' 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' 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 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 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 ListDeleteResponseADM: title: ListDeleteResponseADM type: object required: - iri - deleted properties: iri: type: string deleted: type: boolean ListGetResponseADM: title: ListGetResponseADM type: object required: - list properties: list: $ref: '#/components/schemas/ListADM' ListIri: title: ListIri type: object required: - value properties: value: type: string ListItemDeleteResponseADM: title: ListItemDeleteResponseADM oneOf: - $ref: '#/components/schemas/ChildNodeDeleteResponseADM' - $ref: '#/components/schemas/ListDeleteResponseADM' ListItemGetResponseADM: title: ListItemGetResponseADM oneOf: - $ref: '#/components/schemas/ListGetResponseADM' - $ref: '#/components/schemas/ListNodeGetResponseADM' ListName: title: ListName type: object required: - value properties: value: type: string ListNodeADM: title: ListNodeADM oneOf: - $ref: '#/components/schemas/ListChildNodeADM' - $ref: '#/components/schemas/ListRootNodeADM' ListNodeCommentsDeleteResponseADM: title: ListNodeCommentsDeleteResponseADM type: object required: - nodeIri - commentsDeleted properties: nodeIri: type: string commentsDeleted: type: boolean ListNodeGetResponseADM: title: ListNodeGetResponseADM type: object required: - node properties: node: $ref: '#/components/schemas/NodeADM' ListResponseDto: title: ListResponseDto type: object required: - count properties: resources: type: array items: $ref: '#/components/schemas/ResourceInfoDto' count: 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 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 ListsGetResponseADM: title: ListsGetResponseADM type: object properties: lists: type: array items: $ref: '#/components/schemas/ListRootNodeInfoADM' LoginPayload: title: LoginPayload oneOf: - $ref: '#/components/schemas/EmailPassword' - $ref: '#/components/schemas/IriPassword' - $ref: '#/components/schemas/UsernamePassword' Logo: title: Logo type: object required: - value properties: value: type: string LogoutResponse: title: LogoutResponse type: object required: - status - message properties: status: type: integer format: int32 message: type: string Longname: title: Longname type: object required: - value properties: value: type: string Map_Seq_IRI: title: Map_Seq_IRI type: object additionalProperties: type: array items: type: string Map_Set_PermissionADM: title: Map_Set_PermissionADM type: object additionalProperties: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionADM' Map_String: title: Map_String type: object additionalProperties: type: string NodeADM: title: NodeADM type: object required: - nodeinfo properties: nodeinfo: $ref: '#/components/schemas/ListChildNodeInfoADM' children: type: array items: $ref: '#/components/schemas/ListChildNodeADM' NodeInfoGetResponseADM: title: NodeInfoGetResponseADM oneOf: - $ref: '#/components/schemas/ChildNodeInfoGetResponseADM' - $ref: '#/components/schemas/RootNodeInfoGetResponseADM' NodePositionChangeResponseADM: title: NodePositionChangeResponseADM type: object required: - node properties: node: $ref: '#/components/schemas/ListNodeADM' NotFound: title: NotFound type: object required: - message properties: message: type: string errors: type: array items: $ref: '#/components/schemas/ErrorDetail' NotFoundException: title: NotFoundException type: object required: - message properties: message: type: string OntologyAndResourceClasses: title: OntologyAndResourceClasses type: object required: - ontology properties: ontology: $ref: '#/components/schemas/OntologyDto' classesAndCount: type: array items: $ref: '#/components/schemas/ResourceClassAndCountDto' OntologyConstraintException: title: OntologyConstraintException type: object required: - message properties: message: type: string OntologyDto: title: OntologyDto type: object required: - iri - label - comment properties: iri: type: string label: type: string comment: type: string PagedResponse_Authorship: title: PagedResponse_Authorship type: object required: - data - pagination properties: data: type: array items: type: string pagination: $ref: '#/components/schemas/Pagination' PagedResponse_CopyrightHolder: title: PagedResponse_CopyrightHolder type: object required: - data - pagination properties: data: type: array items: type: string pagination: $ref: '#/components/schemas/Pagination' PagedResponse_ProjectLicenseDto: title: PagedResponse_ProjectLicenseDto type: object required: - data - pagination properties: data: type: array items: $ref: '#/components/schemas/ProjectLicenseDto' pagination: $ref: '#/components/schemas/Pagination' 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 Password: title: Password type: object required: - value properties: value: type: string PasswordChangeRequest: title: PasswordChangeRequest type: object required: - requesterPassword - newPassword properties: requesterPassword: $ref: '#/components/schemas/Password' newPassword: $ref: '#/components/schemas/Password' PermissionADM: title: PermissionADM type: object required: - name properties: name: type: string additionalInformation: type: string permissionCode: type: integer format: int32 PermissionCodeAndProjectRestrictedViewSettings: title: PermissionCodeAndProjectRestrictedViewSettings type: object required: - permissionCode properties: permissionCode: type: integer format: int32 restrictedViewSettings: $ref: '#/components/schemas/ProjectRestrictedViewSettingsADM' PermissionDeleteResponseADM: title: PermissionDeleteResponseADM type: object required: - permissionIri - deleted properties: permissionIri: $ref: '#/components/schemas/PermissionIri' deleted: type: boolean PermissionGetResponseADM: title: PermissionGetResponseADM oneOf: - $ref: '#/components/schemas/AdministrativePermissionGetResponseADM' - $ref: '#/components/schemas/DefaultObjectAccessPermissionGetResponseADM' PermissionInfoADM: title: PermissionInfoADM type: object required: - iri - permissionType properties: iri: $ref: '#/components/schemas/PermissionIri' permissionType: type: string PermissionIri: title: PermissionIri 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' PermissionsForProjectGetResponseADM: title: PermissionsForProjectGetResponseADM type: object properties: permissions: type: array uniqueItems: true items: $ref: '#/components/schemas/PermissionInfoADM' PlainStringLiteralV2: title: PlainStringLiteralV2 type: object required: - value properties: value: type: string Position: title: Position type: object required: - value properties: value: type: integer format: int32 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 ProjectAdminMembersGetResponseADM: title: ProjectAdminMembersGetResponseADM type: object properties: members: type: array items: $ref: '#/components/schemas/UserDto' 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 ProjectGetResponse: title: ProjectGetResponse type: object required: - project properties: project: $ref: '#/components/schemas/Project' ProjectKeywordsGetResponse: title: ProjectKeywordsGetResponse type: object properties: keywords: type: array items: 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 ProjectMembersGetResponseADM: title: ProjectMembersGetResponseADM type: object properties: members: type: array items: $ref: '#/components/schemas/UserDto' ProjectOperationResponseADM: title: ProjectOperationResponseADM type: object required: - project properties: project: $ref: '#/components/schemas/Project' ProjectRestrictedViewSettingsADM: title: ProjectRestrictedViewSettingsADM type: object required: - watermark properties: size: type: string watermark: type: boolean ProjectRestrictedViewSettingsGetResponseADM: title: ProjectRestrictedViewSettingsGetResponseADM type: object required: - settings properties: settings: $ref: '#/components/schemas/ProjectRestrictedViewSettingsADM' 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' ProjectsGetResponse: title: ProjectsGetResponse type: object properties: projects: type: array items: $ref: '#/components/schemas/Project' ProjectsKeywordsGetResponse: title: ProjectsKeywordsGetResponse type: object properties: keywords: type: array items: type: string PropertyMappingResponse: title: PropertyMappingResponse type: object required: - propertyIri - ontologyIri - lastModificationDate properties: propertyIri: type: string ontologyIri: type: string subPropertyOf: type: array items: type: string label: type: array items: $ref: '#/components/schemas/LanguageStringDto' comment: type: array items: $ref: '#/components/schemas/LanguageStringDto' lastModificationDate: type: string format: date-time ReorderValuesRequest: title: ReorderValuesRequest type: object required: - resourceIri - propertyIri properties: resourceIri: type: string propertyIri: type: string orderedValueIris: type: array items: type: string ReorderValuesResponse: title: ReorderValuesResponse type: object required: - resourceIri - propertyIri - valuesReordered properties: resourceIri: type: string propertyIri: type: string valuesReordered: type: integer format: int32 RepresentationClass: title: RepresentationClass type: string enum: - ArchiveRepresentation - AudioRepresentation - DDDRepresentation - DocumentRepresentation - MovingImageRepresentation - StillImageRepresentation - TextRepresentation - WithoutRepresentation ResourceClassAndCountDto: title: ResourceClassAndCountDto type: object required: - resourceClass - itemCount properties: resourceClass: $ref: '#/components/schemas/ResourceClassDto' itemCount: type: integer format: int32 ResourceClassDto: title: ResourceClassDto type: object required: - iri - representationClass properties: iri: type: string representationClass: $ref: '#/components/schemas/RepresentationClass' label: type: array items: $ref: '#/components/schemas/LanguageStringDto' comment: type: array items: $ref: '#/components/schemas/LanguageStringDto' ResourceInfoDto: title: ResourceInfoDto type: object required: - resourceIri - creationDate - lastModificationDate - isDeleted properties: resourceIri: type: string creationDate: type: string format: date-time lastModificationDate: type: string format: date-time deleteDate: type: string format: date-time isDeleted: type: boolean RestrictedViewResponse: title: RestrictedViewResponse type: object properties: size: $ref: '#/components/schemas/Size' watermark: $ref: '#/components/schemas/Watermark' RootNodeInfoGetResponseADM: title: RootNodeInfoGetResponseADM type: object required: - listinfo properties: listinfo: $ref: '#/components/schemas/ListRootNodeInfoADM' SelfJoin: title: SelfJoin oneOf: - $ref: '#/components/schemas/CanJoin' - $ref: '#/components/schemas/CannotJoin' SetRestrictedViewRequest: title: SetRestrictedViewRequest type: object properties: size: $ref: '#/components/schemas/Size' watermark: $ref: '#/components/schemas/Watermark' Shortcode: title: Shortcode type: object required: - value properties: value: type: string Shortname: title: Shortname type: object required: - value properties: value: type: string Size: title: Size type: object required: - value properties: value: type: string Status: title: Status oneOf: - $ref: '#/components/schemas/Active' - $ref: '#/components/schemas/Inactive' StatusChangeRequest: title: StatusChangeRequest type: object required: - status properties: status: $ref: '#/components/schemas/UserStatus' StringLiteralSequenceV2: title: StringLiteralSequenceV2 type: object properties: stringLiterals: type: array items: $ref: '#/components/schemas/StringLiteralV2' StringLiteralV2: title: StringLiteralV2 oneOf: - $ref: '#/components/schemas/LanguageTaggedStringLiteralV2' - $ref: '#/components/schemas/PlainStringLiteralV2' SystemAdmin: title: SystemAdmin type: object required: - value properties: value: type: boolean SystemAdminChangeRequest: title: SystemAdminChangeRequest type: object required: - systemAdmin properties: systemAdmin: $ref: '#/components/schemas/SystemAdmin' TokenResponse: title: TokenResponse type: object required: - token properties: token: type: string Unauthorized: title: Unauthorized type: object required: - message properties: message: type: string errors: type: array items: $ref: '#/components/schemas/ErrorDetail' 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' 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' UserGroupMembershipsGetResponseADM: title: UserGroupMembershipsGetResponseADM type: object properties: groups: type: array items: $ref: '#/components/schemas/Group' UserProjectAdminMembershipsGetResponseADM: title: UserProjectAdminMembershipsGetResponseADM type: object properties: projects: type: array items: $ref: '#/components/schemas/Project' UserProjectMembershipsGetResponseADM: title: UserProjectMembershipsGetResponseADM type: object properties: projects: type: array items: $ref: '#/components/schemas/Project' UserResponse: title: UserResponse type: object required: - user properties: user: $ref: '#/components/schemas/UserDto' UserStatus: title: UserStatus type: object required: - value properties: value: type: boolean Username: title: Username type: object required: - value properties: value: type: string UsernamePassword: title: UsernamePassword type: object required: - username - password properties: username: $ref: '#/components/schemas/Username' password: type: string UsersResponse: title: UsersResponse type: object properties: users: type: array items: $ref: '#/components/schemas/UserDto' V3ErrorCode: title: V3ErrorCode type: string enum: - class_not_found - export_exists - export_failed - export_in_progress - export_not_found - feature_missing - import_exists - import_in_progress - import_not_found - invalid_ontology_mapping_iri - ontology_not_found - project_not_found - property_not_found - resourceClass_not_found - resource_not_found ValidationException: title: ValidationException type: object required: - msg properties: msg: type: string VersionResponse: title: VersionResponse type: object required: - webapi - buildCommit - buildTime - fuseki - scala - sipi - name properties: webapi: type: string buildCommit: type: string buildTime: type: string fuseki: type: string scala: type: string sipi: type: string name: type: string Watermark: title: Watermark type: object required: - value properties: value: type: boolean securitySchemes: httpAuth: type: http scheme: bearer httpAuth1: type: http scheme: basic