Marmelator/persistence-service
1
0
Fork 0
Code Issues Pull Requests 17 Actions Packages Projects Releases 1.1k Wiki Activity

RedactManager API Specs for BASF - Improved descriptions

Browse Source 
Cherry-picked from 55922a85.
This commit is contained in:
Kresnadi Budisantoso 2024-05-28 18:57:43 +02:00
parent 8865f6b9bf
commit b982d4190e
2 changed files with 195 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

166
persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml
View File

@ -279,9 +279,15 @@ paths:
tags:
- 1. Dossier Templates
description: |
Retrieves a collection of dossier status definitions associated with a specific dossier template. Each dossier
status definition includes details such as the status name, description, and other relevant metadata. This endpoint
is useful for clients needing to display or set the status of a dossier associated with a specific dossier template.
Retrieves a collection of dossier status definitions associated with a specific dossier template.
This endpoint is useful for clients needing to display or set the status of a dossier associated
with a specific dossier template.
#### Response
Each dossier status definition includes details such as the status name, description, and other
relevant metadata.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
responses:
@ -310,10 +316,15 @@ paths:
tags:
- 1. Dossier Templates
description: |
Retrieves a collection of dossier attribute definitions associated with a specific dossier template. Each dossier
attribute definition includes details such as attribute type, name, and other relevant metadata. This endpoint
is useful for clients needing to understand what attributes are expected or allowed for dossiers associated with
a specific dossier template.
Retrieves a collection of dossier attribute definitions associated with a specific dossier template.
This endpoint is useful for clients needing to understand what attributes are expected or allowed
for dossiers associated with a specific dossier template.
#### Response
Each dossier attribute definition includes details such as attribute type, name, and other relevant
metadata.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
responses:
@ -342,7 +353,7 @@ paths:
tags:
- 1. Dossier Templates
description: |
Retrieves a collection of file attribute definitions associated with a specific dossier template. Each file
Use this endpoint to retrieve a collection of file attribute definitions associated with a specific dossier template. Each file
attribute definition includes details such as attribute type, name, and other relevant metadata. This endpoint
is useful for clients needing to understand what attributes are expected or allowed for files associated with
a specific dossier template.
@ -382,7 +393,7 @@ paths:
Use this endpoint to fetch the required dossiers before performing actions on specific ones. Use the query parameters
to modify the response. E.g., set the `includeArchivedDossiers` parameter to `true` so that the response also contains
*archived* dossiers.
*archived* dossiers.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
- $ref: '#/components/parameters/includeActiveDossiers'
@ -533,7 +544,7 @@ paths:
- 2. Dossiers
summary: Update or set attributes for a specific dossier.
description: |
This endpoint facilitates the updating or setting of specific dossier attributes for a given dossier.
Use this endpoint to update or set dossier attributes for a given dossier.
Ensure you provide the necessary dossier attributes within the request body.
Use this route to maintain or enhance dossier metadata and properties.
@ -569,11 +580,18 @@ paths:
- 2. Dossiers
summary: Initiate the creation of a download package for all files of a dossier.
description: |
To download files and reports, a download package needs to be prepared. This endpoint
facilitates to define the content of the download package and to start the creation of it for all
files of the dossier. The response of this endpoint contains an identifier for the download that
is needed to query the status until the download package is prepared, and finally to actually
download the file once it is available.
This endpoint allows you to define the content and initiate the creation of a
download package for all files within a dossier.
#### Request
* Specify the files and reports to be included in the download package.
* Start the process of creating the download package.
#### Response
Includes an identifier for the download. Use this identifier to query the status
of the download package preparation and download the file once it is available.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
- $ref: '#/components/parameters/dossierId'
@ -650,7 +668,7 @@ paths:
- 3. Files
summary: Upload a file and associate it with a specific dossier.
description: |
This endpoint facilitates the upload of files to a specific dossier.
Use this endpoint to upload files to a specific dossier.
Upon successful upload, the system returns the unique identifier of the uploaded file. In cases where the dossier already
contains a file with the same name, the new file will replace the existing one.
@ -708,7 +726,7 @@ paths:
- 3. Files
summary: Deletes a specific file associated with a dossier and its template.
description: |
This endpoint facilitates the removal of a file linked to a specific dossier under a dossier template. By default, the
Use this endpoint to remove of a file linked to a specific dossier under a dossier template. By default, the
file undergoes a soft-delete, meaning it can be restored within the retention period determined by application settings.
The default retention period is 96 hours (4 days) but may vary based on configuration. Use the `deletePermanently` query
parameter to opt for a permanent deletion, preventing any future restoration.
@ -774,11 +792,18 @@ paths:
- 3. Files
summary: Initiate the creation of a download package for a single file of a dossier.
description: |
To download files and reports, a download package needs to be prepared. This endpoint
facilitates to define the content of the download package and to start the creation of it for the
file. The response of this endpoint contains an identifier for the download that is needed to
query the status until the download package is prepared for download, and finally to actually
download the file once it is available.
This endpoint allows you to define the content and initiate the creation of a
download package for a files of a dossier.
#### Request
* Specify the files and reports to be included in the download package.
* Start the process of creating the download package.
#### Response
Includes an identifier for the download. Use this identifier to query the status
of the download package preparation and download the file once it is available.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
- $ref: '#/components/parameters/dossierId'
@ -816,7 +841,7 @@ paths:
- 3. Files
summary: Bulk delete specific files within a dossier. (DELETE with body payload)
description: |
This endpoint allows for the bulk deletion of specified files associated with a certain dossier.
This endpoint allows for the bulk deletion of specified files associated with a certain dossier.
It provides the flexibility to perform either a soft-delete (by default) or a permanent deletion. A soft-deleted
file remains restorable within the retention period set by the application (96h by default). In contrast, permanently
@ -856,11 +881,18 @@ paths:
- 3. Files
summary: Initiate the creation of a download package for specific files within a dossier.
description: |
To download files and reports, a download package needs to be prepared. This endpoint
facilitates to define the content of the download package and to start the creation of it for
multiple files of a dossier. The response of this endpoint contains an identifier for the download
that is needed to query the status until the download package is prepared for download, and finally
to actually download the file once it is available.
This endpoint allows you to define the content and initiate the creation of a
download package for specific files of a dossier.
#### Request
* Specify the files and reports to be included in the download package.
* Start the process of creating the download package.
#### Response
Includes an identifier for the download. Use this identifier to query the status
of the download package preparation and download the file once it is available.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
- $ref: '#/components/parameters/dossierId'
@ -897,7 +929,7 @@ paths:
- 3. Files
summary: Update or set attributes for a specific file.
description: |
This endpoint facilitates the updating or setting of specific file attributes for a given file within a dossier.
Use this endpoint to update or setting of specific file attributes for a given file within a dossier.
Ensure you provide the necessary file attributes within the request body.
Use this route to maintain or enhance file metadata and properties.
@ -972,9 +1004,9 @@ paths:
operationId: getComponentsOfDossier
tags:
- 4. Components
summary: Returns the RSS response for all files of a dossier
summary: Returns the FileComponents of all files in a dossier
description: |
This endpoint fetches components for all files associated with a specified dossier. Like individual file components,
This endpoint fetches components for all files associated with a specific dossier. Like individual file components,
these represent various aspects, metadata or content of the files. Entity and component rules define these components based on the file's
content. They can give a *structured view* on a document's text.
@ -1014,9 +1046,12 @@ paths:
- 5. Downloads
summary: Get the list of downloads for the current user
description: |
This endpoint facilitates to retrieve the list of downloads for the current user. The response contains
status objects that represent each download and provide information on whether the download is still
in preparation, is already available or whether an error occurred when the download package was created.
Use this endpoint to retrieve the list of downloads for the current user.
The response contains the status of each download.
A download may be queued, generating, finished or failed. When it is finished, the
download package may be obtained using the download endpoint
responses:
"200":
content:
@ -1041,7 +1076,7 @@ paths:
- 5. Downloads
summary: Get the status for a specific download of the current user
description: |
This endpoint facilitates to retrieve the status for a specific download. In addition to other
Use this endpoint to retrieve the status for a specific download. In addition to other
information, the status indicates whether the download is still being prepared, is already
available, or whether an error occurred when the download package was created.
parameters:
@ -1071,7 +1106,7 @@ paths:
- 5. Downloads
summary: Deletes a specific download.
description: |
This endpoint facilitates the removal of a download.
Use this endpoint to remove a download.
parameters:
- $ref: '#/components/parameters/downloadId'
responses:
@ -1097,7 +1132,7 @@ paths:
- 5. Downloads
summary: Download the download package.
description: |
This endpoint facilitates to actually download the created download package. The request will
Use this endpoint to actually download the created download package. The request will
only be successful if the status of the download is `READY`.
parameters:
- $ref: '#/components/parameters/downloadId'
@ -1133,7 +1168,7 @@ paths:
- 6. Users
summary: Get a list of users
description: |
This endpoint facilitates to retrieve a list of known users.
Use this endpoint to retrieve a list of known users.
With the `username` parameter you can filter for a specific user name. If the parameter is
used, the returned list either contains a single matching entry or is empty.
@ -1163,7 +1198,7 @@ paths:
- 6. Users
summary: Retrieve a specific user by its identifier.
description: |
This endpoint facilitates to retrieve a specific user.
Use this endpoint to retrieve a specific user.
parameters:
- $ref: '#/components/parameters/userId'
responses:
@ -1230,14 +1265,14 @@ components:
responses:
"400":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
The request was malformed or invalid. Double-check the request structure or parameters.
"401":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
@ -1245,21 +1280,21 @@ components:
resource. This error can happen if the access token was revoked or has expired.
"403":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Forbidden. Your credentials are valid, but you do not have permission to access this resource.
"404-dossier-template":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Dossier template not found. This happens if the requested dossier template does not exist.
"404-dossier":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
@ -1269,7 +1304,7 @@ components:
for a previously existing dossier only if it is actually deleted permanently.
"404-file":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
@ -1279,42 +1314,42 @@ components:
only if the file is deleted permanently.
"404-download":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Download not found. This happens if the requested download does not exist for the current user.
"404-user":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
User not found. This happens if the requested user does not exist.
"409-dossier-conflict":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Name conflict: The provided name is already in use by another dossier. It needs to be unique in the scope of your workspace.
422-rules:
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/RuleValidation'
description: |
Invalid rules file: There were validation errors, the rules file is unprocessable.
"429":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Too many requests have been made in a given time frame. Rate limiting is in place to prevent abuse.
"500":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Internal Server Error. An unexpected error occurred on the server side. Please try again later or contact support.
@ -1328,6 +1363,15 @@ components:
style: simple
explode: false
description: The identifier of a dossier template
componentMappingId:
name: componentMappingId
in: path
required: true
schema:
type: string
style: simple
explode: false
description: The identifier of a component mapping
dryRun:
name: dryRun
in: query
@ -1487,7 +1531,7 @@ components:
Using this parameter, you can also permanently delete a previously soft-deleted dossier during its retention period.
Note: Deleting a dossier also deletes all associated files.
> **Note:** Deleting a dossier also deletes all associated files.
permanentlyDeleteFile:
name: deletePermanently
in: query
@ -1590,11 +1634,11 @@ components:
description: |
The unique identifier for the entity.
Note: In general, it is a valid UUID. Only if an entity spans over multiple pages, it is split on page breaks. Each
part becomes an own entity object and the first one keeps the UUID while the following get an additional suffix.
Example: Even is `bcd22239-c3df-442f-a5a1-1664cba94dc6_2` is not a valid UUID it is still a valid identifier for an
entity object.
> **Note:** In general, it is a valid UUID. Only if an entity spans over multiple pages, it is split on page breaks. Each
> part becomes an own entity object and the first one keeps the UUID while the following get an additional suffix.
>
> Example: Even if `bcd22239-c3df-442f-a5a1-1664cba94dc6_2` is not a valid UUID it is still a valid identifier for an
> entity object.
entityRuleId:
type: string
description: An identifier that represents a specific rule associated with the entity.
@ -2249,8 +2293,8 @@ components:
description: |
List of unique user identifiers with elevated permissions. Needed if using an approval workflow.
The DocuMine application does not have an approval workflow. However, every member will be
elevated to a privileged member to ensure full functionality.
> **Note:** The DocuMine application does not have an approval workflow. However, every member will be
> elevated to a privileged member to ensure full functionality.
visibility:
type: string
enum:
@ -2279,13 +2323,13 @@ components:
format: uuid
deprecated: true
description: |
In DocuMine, watermarks are not supported.
> **Note:** In DocuMine, watermarks are not supported.
previewWatermarkId:
type: string
format: uuid
deprecated: true
description: |
In DocuMine, watermarks are not supported.
> **Note:** In DocuMine, watermarks are not supported.
dossierAttributes:
$ref: '#/components/schemas/DossierAttributes'
downloadFileTypes:

145
persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/redactmanager.yaml
View File

@ -119,9 +119,15 @@ paths:
tags:
- 1. Dossier Templates
description: |
Retrieves a collection of dossier status definitions associated with a specific dossier template. Each dossier
status definition includes details such as the status name, description, and other relevant metadata. This endpoint
is useful for clients needing to display or set the status of a dossier associated with a specific dossier template.
Retrieves a collection of dossier status definitions associated with a specific dossier template.
This endpoint is useful for clients needing to display or set the status of a dossier associated
with a specific dossier template.
#### Response
Each dossier status definition includes details such as the status name, description, and other
relevant metadata.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
responses:
@ -150,10 +156,15 @@ paths:
tags:
- 1. Dossier Templates
description: |
Retrieves a collection of dossier attribute definitions associated with a specific dossier template. Each dossier
attribute definition includes details such as attribute type, name, and other relevant metadata. This endpoint
is useful for clients needing to understand what attributes are expected or allowed for dossiers associated with
a specific dossier template.
Retrieves a collection of dossier attribute definitions associated with a specific dossier template.
This endpoint is useful for clients needing to understand what attributes are expected or allowed
for dossiers associated with a specific dossier template.
#### Response
Each dossier attribute definition includes details such as attribute type, name, and other relevant
metadata.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
responses:
@ -182,7 +193,7 @@ paths:
tags:
- 1. Dossier Templates
description: |
Retrieves a collection of file attribute definitions associated with a specific dossier template. Each file
Use this endpoint to retrieve a collection of file attribute definitions associated with a specific dossier template. Each file
attribute definition includes details such as attribute type, name, and other relevant metadata. This endpoint
is useful for clients needing to understand what attributes are expected or allowed for files associated with
a specific dossier template.
@ -373,7 +384,7 @@ paths:
- 2. Dossiers
summary: Update or set attributes for a specific dossier.
description: |
This endpoint facilitates the updating or setting of specific dossier attributes for a given dossier.
Use this endpoint to update or set dossier attributes for a given dossier.
Ensure you provide the necessary dossier attributes within the request body.
Use this route to maintain or enhance dossier metadata and properties.
@ -409,13 +420,20 @@ paths:
- 2. Dossiers
summary: Initiate the creation of a download package for all files of a dossier.
description: |
To download the results of a redaction, a download package needs to be prepared. This endpoint
facilitates to define the content of the download package and to start the creation of it for all
files of the dossier. The response of this endpoint contains an identifier for the download that
is needed to query the status until the download package is prepared, and finally to actually
download the file once it is available.
This endpoint allows you to define the content and initiate the creation of a
download package for all files within a dossier.
#### Request
Note: The redacted file will be created for `APPROVED` files only.
* Specify the files and reports to be included in the download package.
* Start the process of creating the download package.
#### Response
Includes an identifier for the download. Use this identifier to query the status
of the download package preparation and download the file once it is available.
> **Note:** The redacted file will be created for `APPROVED` files only.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
- $ref: '#/components/parameters/dossierId'
@ -492,7 +510,7 @@ paths:
- 3. Files
summary: Upload a file and associate it with a specific dossier.
description: |
This endpoint facilitates the upload of files to a specific dossier.
Use this endpoint to upload files to a specific dossier.
Upon successful upload, the system returns the unique identifier of the uploaded file. In cases where the dossier already
contains a file with the same name, the new file will replace the existing one.
@ -550,7 +568,7 @@ paths:
- 3. Files
summary: Deletes a specific file associated with a dossier and its template.
description: |
This endpoint facilitates the removal of a file linked to a specific dossier under a dossier template. By default, the
Use this endpoint to remove of a file linked to a specific dossier under a dossier template. By default, the
file undergoes a soft-delete, meaning it can be restored within the retention period determined by application settings.
The default retention period is 96 hours (4 days) but may vary based on configuration. Use the `deletePermanently` query
parameter to opt for a permanent deletion, preventing any future restoration.
@ -616,13 +634,20 @@ paths:
- 3. Files
summary: Initiate the creation of a download package for a single file of a dossier.
description: |
To download the results of a redaction, a download package needs to be prepared. This endpoint
facilitates to define the content of the download package and to start the creation of it for the
file. The response of this endpoint contains an identifier for the download that is needed to
query the status until the download package is prepared for download, and finally to actually
download the file once it is available.
This endpoint allows you to define the content and initiate the creation of a
download package for a files of a dossier.
#### Request
Note: The redacted PDF will be created for `APPROVED` files only.
* Specify the files and reports to be included in the download package.
* Start the process of creating the download package.
#### Response
Includes an identifier for the download. Use this identifier to query the status
of the download package preparation and download the file once it is available.
> **Note:** The redacted file will be created for `APPROVED` files only.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
- $ref: '#/components/parameters/dossierId'
@ -700,13 +725,20 @@ paths:
- 3. Files
summary: Initiate the creation of a download package for specific files within a dossier.
description: |
To download the results of a redaction, a download package needs to be prepared. This endpoint
facilitates to define the content of the download package and to start the creation of it for
multiple files of a dossier. The response of this endpoint contains an identifier for the download
that is needed to query the status until the download package is prepared for download, and finally
to actually download the file once it is available.
This endpoint allows you to define the content and initiate the creation of a
download package for specific files of a dossier.
#### Request
Note: The redacted PDF will be created for `APPROVED` files only.
* Specify the files and reports to be included in the download package.
* Start the process of creating the download package.
#### Response
Includes an identifier for the download. Use this identifier to query the status
of the download package preparation and download the file once it is available.
> **Note:** The redacted file will be created for `APPROVED` files only.
parameters:
- $ref: '#/components/parameters/dossierTemplateId'
- $ref: '#/components/parameters/dossierId'
@ -743,7 +775,7 @@ paths:
- 3. Files
summary: Update or set attributes for a specific file.
description: |
This endpoint facilitates the updating or setting of specific file attributes for a given file within a dossier.
Use this endpoint to update or setting of specific file attributes for a given file within a dossier.
Ensure you provide the necessary file attributes within the request body.
Use this route to maintain or enhance file metadata and properties.
@ -780,9 +812,12 @@ paths:
- 5. Downloads
summary: Get the list of downloads for the current user
description: |
This endpoint facilitates to retrieve the list of downloads for the current user. The response contains
status objects that represent each download and provide information on whether the download is still
in preparation, is already available or whether an error occurred when the download package was created.
Use this endpoint to retrieve the list of downloads for the current user.
The response contains the status of each download.
A download may be queued, generating, finished or failed. When it is finished, the
download package may be obtained using the download endpoint
responses:
"200":
content:
@ -807,7 +842,7 @@ paths:
- 5. Downloads
summary: Get the status for a specific download of the current user
description: |
This endpoint facilitates to retrieve the status for a specific download. In addition to other
Use this endpoint to retrieve the status for a specific download. In addition to other
information, the status indicates whether the download is still being prepared, is already
available, or whether an error occurred when the download package was created.
parameters:
@ -837,7 +872,7 @@ paths:
- 5. Downloads
summary: Deletes a specific download.
description: |
This endpoint facilitates the removal of a download.
Use this endpoint to remove a download.
parameters:
- $ref: '#/components/parameters/downloadId'
responses:
@ -863,7 +898,7 @@ paths:
- 5. Downloads
summary: Download the download package.
description: |
This endpoint facilitates to actually download the created download package. The request will
Use this endpoint to actually download the created download package. The request will
only be successful if the status of the download is `READY`.
parameters:
- $ref: '#/components/parameters/downloadId'
@ -899,7 +934,7 @@ paths:
- 6. Users
summary: Get a list of users
description: |
This endpoint facilitates to retrieve a list of known users.
Use this endpoint to retrieve a list of known users.
With the `username` parameter you can filter for a specific user name. If the parameter is
used, the returned list either contains a single matching entry or is empty.
@ -929,7 +964,7 @@ paths:
- 6. Users
summary: Retrieve a specific user by its identifier.
description: |
This endpoint facilitates to retrieve a specific user.
Use this endpoint to retrieve a specific user.
parameters:
- $ref: '#/components/parameters/userId'
responses:
@ -996,14 +1031,14 @@ components:
responses:
"400":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
The request was malformed or invalid. Double-check the request structure or parameters.
"401":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
@ -1011,21 +1046,21 @@ components:
resource. This error can happen if the access token was revoked or has expired.
"403":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Forbidden. Your credentials are valid, but you do not have permission to access this resource.
"404-dossier-template":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Dossier template not found. This happens if the requested dossier template does not exist.
"404-dossier":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
@ -1035,7 +1070,7 @@ components:
for a previously existing dossier only if it is actually deleted permanently.
"404-file":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
@ -1045,35 +1080,35 @@ components:
only if the file is deleted permanently.
"404-download":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Download not found. This happens if the requested download does not exist for the current user.
"404-user":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
User not found. This happens if the requested user does not exist.
"409-dossier-conflict":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Name conflict: The provided name is already in use by another dossier. It needs to be unique in the scope of your workspace.
"429":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: |
Too many requests have been made in a given time frame. Rate limiting is in place to prevent abuse.
"500":
content:
'*/*':
'application/json':
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Internal Server Error. An unexpected error occurred on the server side. Please try again later or contact support.
@ -1246,7 +1281,7 @@ components:
Using this parameter, you can also permanently delete a previously soft-deleted dossier during its retention period.
Note: Deleting a dossier also deletes all associated files.
> **Note:** Deleting a dossier also deletes all associated files.
permanentlyDeleteFile:
name: deletePermanently
in: query
@ -1335,11 +1370,11 @@ components:
description: |
The unique identifier for the entity.
Note: In general, it is a valid UUID. Only if an entity spans over multiple pages, it is split on page breaks. Each
part becomes an own entity object and the first one keeps the UUID while the following get an additional suffix.
Example: Even is `bcd22239-c3df-442f-a5a1-1664cba94dc6_2` is not a valid UUID it is still a valid identifier for an
entity object.
> **Note:** In general, it is a valid UUID. Only if an entity spans over multiple pages, it is split on page breaks. Each
> part becomes an own entity object and the first one keeps the UUID while the following get an additional suffix.
>
> Example: Even if `bcd22239-c3df-442f-a5a1-1664cba94dc6_2` is not a valid UUID it is still a valid identifier for an
> entity object.
entityRuleId:
type: string
description: An identifier that represents a specific rule associated with the entity.