API docs by Redocly

DocuMine API (1.0.0)

Download OpenAPI specification:Download

knecon Service Desk: [email protected] URL: https://support.documine.ai License: knecon License
Find out more about DocuMine

Introduction

The DocuMine API provides a comprehensive solution for managing resources such as dossiers and their associated files. Users can also retrieve components of files that have been processed and extracted by the system.

Authorization

All endpoints are secured using OAuth2, with the "authorizationCode" being the general supported authorization flow. Obtain a JWT token for authentication and send it in the 'Authorization' header with the format Bearer {JWT_TOKEN}.

Please also note that the authorizationUrl and tokenUrl in this specification contain {workspaceId} placeholders that must be replaced by your respective DocuMine workspace identifier.

Example Headers:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI...

1. Dossier Templates

Operations related to dossier templates.

Retrieve a list of all available dossier templates.

This endpoint provides a list of all dossier templates stored in the system.

It returns an object containing an array of dossier template objects under the key dossierTemplates. Each template object contains an identifier, a name, a dossier template status, and other fields with further details about the template.

Use this endpoint to fetch all templates before performing actions on specific ones.

Authorizations:
FF-OAUTH

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Retrieve a specific dossier template by its identifier.

Utilize this endpoint to retrieve comprehensive details about a designated dossier template. The response encompasses various attributes such as the dossier template's identifier, name, status, among other pertinent details.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Responses

Response samples

Content type
application/json
{
  • "id": "1e07cde0-d36a-4ab7-b389-494ca694a0cb",
  • "name": "DocuMine Example",
  • "description": "Typical settings for DocuMine.",
  • "dateAdded": "2020-01-23T04:56:07.000+00:00",
  • "dateModified": "2021-01-23T04:56:07.000+00:00",
  • "createdBy": "c2e33246-e50a-4c43-831c-6789a5637db6",
  • "modifiedBy": "c2e33246-e50a-4c43-831c-6789a5637db6",
  • "validFrom": "2020-01-01T00:00:00.000+00:00",
  • "validTo": "2030-12-31T23:59:59.999+00:00",
  • "status": "ACTIVE",
  • "removeWatermark": false,
  • "keepImageMetadata": true,
  • "ocrByDefault": true,
  • "keepHiddenText": true,
  • "keepOverlappingObjects": true,
  • "applyDictionaryUpdatesToAllDossiersByDefault": false,
  • "downloadFileTypes": [
    ]
}

Download the entity rules of a specific dossier template.

Utilize this endpoint to download the entity rules of a designated dossier template. The file is named 'entity-rules.drl' and contains the set of rules to annotate the entities in an analyzed file. The content of this file is in the Drools Rule Language (DRL) format. Please find more details about the DRL in the Drools Language Reference.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Upload or validate a entity rules file for a specific dossier template.

Utilize this endpoint to upload the entity rules to a designated dossier template. With the 'dryRun' parameter, you have the possibility to just validate the rules file without actually saving it in the dossier template.

The uploaded rule file will be saved only if 'dryRun' is set to false and the response code is 200. In this case, the response object does not contain errors.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

query Parameters
dryRun
boolean
Default: false

A toggle to activate the dry-run mode: If set to false (default), the request will update the system. If set to true, the request will just be evaluated without actual changes in the system.

Request Body schema: multipart/form-data
file
required
string <binary>

The binary content of the file to be uploaded.

Responses

Response samples

Content type
application/json
{
  • "errors": [ ]
}

Download the component rules of a specific dossier template.

Utilize this endpoint to download the component rules of a designated dossier template. The file is named 'component-rules.drl' and contains the set of rules to build components based on entities of an analyzed file. The content of this file is in the Drools Rule Language (DRL) format. Please find more details about the DRL in the Drools Language Reference.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Upload or validate a component rules file for a specific dossier template.

Utilize this endpoint to upload the component rules to a designated dossier template. With the 'dryRun' parameter, you have the possibility to just validate the rules file without actually saving it in the dossier template.

The uploaded rule file will be saved only if 'dryRun' is set to false and the response code is 200. In this case, the response object does not contain errors.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

query Parameters
dryRun
boolean
Default: false

A toggle to activate the dry-run mode: If set to false (default), the request will update the system. If set to true, the request will just be evaluated without actual changes in the system.

Request Body schema: multipart/form-data
file
required
string <binary>

The binary content of the file to be uploaded.

Responses

Response samples

Content type
application/json
{
  • "errors": [ ]
}

Download the date formats of a specific dossier template.

Utilize this endpoint to download the date formats of a designated dossier template. The file is named 'date-formats.txt' and contains the set of date formats used within the dossier template.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Upload and validate a date formats file for a specific dossier template.

Utilize this endpoint to upload the date formats to a designated dossier template. It will be validated first and if there are errors and the response code is not 200, the file will not be saved. In this case, the response object will contain the errors that occurred.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Request Body schema: multipart/form-data
file
required
string <binary>

The binary content of the file to be uploaded.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns the list of all existing dossier status definitions

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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Returns the list of all existing dossier attribute definitions

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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Returns the list of all existing file attribute definitions

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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Returns a list of all existing component mappings in a dossier template

Use this endpoint to retrieve a summary of all component mappings associated with a specific DossierTemplate.

The summary consists of the stored metadata of a component mapping file.
This endpoint is useful for clients to understand the available mappings under a particular DossierTemplate.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Responses

Response samples

Content type
application/json
{
  • "dossierTemplateId": "1e07cde0-d36a-4ab7-b389-494ca694a0cb",
  • "componentMappingList": [
    ]
}

Upload a new component mapping to a DossierTemplate.

Use this endpoint to upload a new component mapping to a specific DossierTemplate.

File Requirements

  • Format: The file must be in CSV (comma-separated values) format.
  • Header Row: The first row should contain the column labels.
  • Data Consistency: All rows must have the same number of columns to ensure rectangular data structure.

Sorting and Performance

  • Sorting: Rows are automatically sorted by the values in each column, from left to right, to enhance lookup speed.
  • Optimization Tip: Place keys to be queried in the first columns and the results to be mapped in the last column for best performance.

Customization Options

  • Users can specify the delimiter and encoding used in the CSV file.

Usage

  • The component mapping file can be utilized in component rules to relate components to existing master data.

Example

search_value mapped_value
Alice Manager
Bob Developer
Charlie Analyst
Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

query Parameters
name
string
Example: name=MasterDataMapping

The name with which the mapping should be associated with. If none is provided, the file name will be used.

encoding
string
Default: "UTF-8"
Enum: "UTF-8" "UTF-16" "UTF_16BE" "UTF_16LE" "ISO-8859-1" "US-ASCII"
Example: encoding=UTF-8

An identifier for the used encoding of the file. Only java's standard charsets are supported.

delimiter
string = 1 characters
Default: ","
Example: delimiter=,

The delimiter used as a separator in a csv file.

Request Body schema: multipart/form-data
file
required
string <binary>

The binary content of the file to be uploaded.

Responses

Response samples

Content type
application/json
{
  • "id": "24ff9c3c-4863-4aea-8eda-cab8838b9192",
  • "name": "MasterDataMapping",
  • "fileName": "master_data.csv",
  • "columnLabels": [
    ],
  • "numberOfLines": 100,
  • "encoding": "UTF-8",
  • "delimiter": ","
}

Download a specific component mapping file of a specific dossier template.

Use this endpoint to download a specific component mapping file of a designated DossierTemplate.

  • The file retains its original name and encoding as when it was uploaded.
  • The sorting of the file may have changed to enable faster lookups.
Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

componentMappingId
required
string

The identifier of a component mapping

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Update an existing component mapping of a DossierTemplate.

Use this endpoint to update an existing component mapping of a specific dossier template.

File Requirements

  • Format: The file must be in CSV (comma-separated values) format.
  • Header Row: The first row should contain the column labels.
  • Data Consistency: All rows must have the same number of columns to ensure rectangular data structure.

Sorting and Performance

  • Sorting: Rows are automatically sorted by the values in each column, from left to right, to enhance lookup speed.
  • Optimization Tip: Place keys to be queried in the first columns and the results to be mapped in the last column for best performance.

Customization Options

  • Users can specify the delimiter and encoding used in the CSV file.
Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

componentMappingId
required
string

The identifier of a component mapping

query Parameters
name
string
Example: name=MasterDataMapping

The name with which the mapping should be associated with. If none is provided, the file name will be used.

encoding
string
Default: "UTF-8"
Enum: "UTF-8" "UTF-16" "UTF_16BE" "UTF_16LE" "ISO-8859-1" "US-ASCII"
Example: encoding=UTF-8

An identifier for the used encoding of the file. Only java's standard charsets are supported.

delimiter
string = 1 characters
Default: ","
Example: delimiter=,

The delimiter used as a separator in a csv file.

Request Body schema: multipart/form-data
file
required
string <binary>

The binary content of the file to be uploaded.

Responses

Response samples

Content type
application/json
{
  • "id": "24ff9c3c-4863-4aea-8eda-cab8838b9192",
  • "name": "MasterDataMapping",
  • "fileName": "master_data.csv",
  • "columnLabels": [
    ],
  • "numberOfLines": 100,
  • "encoding": "UTF-8",
  • "delimiter": ","
}

Delete a specific component mapping file of a specific dossier template.

Use this endpoint to delete a specific component mapping file of a designated dossier template.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

componentMappingId
required
string

The identifier of a component mapping

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Returns the list of all available report templates

Use this endpoint to retrieve a collection of report templates associated with a specific dossier template. Each report template includes details such as the report's name, whether the report is per file or for multiple files, and if the UI should pre-select it in a download dialog.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

2. Dossiers

Operations for managing dossiers that are based on a dossier template.

Retrieve a list of dossiers based on a specific dossier template.

By default, this endpoint provides a list of all active dossiers that are based on a specific dossier template.

It returns an object containing an array of dossier objects under the key dossiers. Each dossier object contains an identifier, a name, a description, an owner, and other fields with further details about the dossier.

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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

query Parameters
includeActive
boolean
Default: true

A toggle to include or exclude active dossiers: If true (default), dossiers that are neither archived nor soft-deleted are included. If false, they are ignored.

includeArchived
boolean
Default: false

A toggle to include or exclude archived dossiers: If set to true, archived dossiers are included. If set to false (default), they are ignored.

includeSoftDeleted
boolean
Default: false

A toggle to include soft-deleted dossiers:

  • true: The response will include soft-deleted dossiers.
  • false (default): Soft-deleted dossiers are ignored and will not be part of the response.

Soft-deleted means that the dossier has not been deleted permanently.

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Creates or updates a dossier for a specific dossier template.

This endpoint is meant to create a new dossier or to update an existing one.

To create a new dossier, do not set the identifier of the dossier object provided in the request body.

To update an existing dossier, the set identifier needs to be valid.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Request Body schema: application/json
required
id
string <uuid>

The unique identifier of the dossier to update. This property needs to be null for create requests, as the system will generate it automatically. If the value is not a valid identifier, the endpoint will return a 400 Bad request error.

name
required
string

A human-readable name for the dossier. The name must be unique among all dossiers within the scope of the workspace (tenant).

description
string

A textual description providing additional context or information about the purpose and content of the dossier.

dueDate
string <date-time>

Specifies the deadline by which actions related to this dossier should be completed. The date is in ISO 8601 date-time format.

ownerId
string <uuid>

A unique identifier representing the user who owns or created this dossier. If null when creating the dossier, the current user will be set as the owner. Must not be null when updating a dossier.

memberIds
Array of strings unique

An array of unique identifiers for users who have access to the dossier.

approverIds
Array of strings unique

An array of unique identifiers for users who have approval permission in the dossier. Needed if using an approval workflow.

Note: The DocuMine application does not have an approval workflow and this list can be left empty. However, every member will be elevated to a privileged member to ensure full functionality.

reportTemplateIds
Array of strings <uuid> (ReportTemplateIdList) unique [ items <uuid > ]

List of template identifiers indicating which templates are used for generating reports or other outputs. The reports are generated when requesting a download package.

dossierStatusId
string

An identifier representing the current status of the dossier. Use null to unset the current status.

Responses

Request samples

Content type
application/json
{
  • "id": "dc28cc82-2682-4b7f-ae0b-2132b205d47a",
  • "name": "Project Beta",
  • "description": "Collection of documents for Project Beta.",
  • "dueDate": "2001-01-23T04:56:07.000+00:00",
  • "ownerId": "0d53a7c3-7b3a-4c57-857d-ec5e0fc3019b",
  • "memberIds": [
    ],
  • "approverIds": [ ],
  • "reportTemplateIds": [
    ],
  • "dossierStatusId": "b8280985-f558-43c0-852a-a3fa86803548"
}

Response samples

Content type
application/json
{
  • "id": "2ef05d6a-6fb3-4f27-b3c7-9a6438b38c3b",
  • "name": "Project Alpha",
  • "date": "2000-01-23T04:56:07.000+00:00",
  • "dossierTemplateId": "1ed2db85-9cd5-48b0-855f-77ca2a688501",
  • "description": "Collection of documents for Project Alpha.",
  • "ownerId": "a0044ae9-ddca-4f97-b0a1-3cb2517dbf39",
  • "memberIds": [
    ],
  • "approverIds": [
    ],
  • "visibility": "PRIVATE",
  • "startDate": null,
  • "dueDate": "2001-01-23T04:56:07.000+00:00",
  • "dossierStatusId": "b8280985-f558-43c0-852a-a3fa86803548",
  • "watermarkId": null,
  • "previewWatermarkId": null,
  • "dossierAttributes": {
    },
  • "downloadFileTypes": [
    ],
  • "reportTemplateIds": [
    ],
  • "archivedTime": null,
  • "softDeletedTime": null,
  • "hardDeletedTime": null
}

Deletes a specific dossier by its identifier.

Removes a dossier either in a recoverable manner (soft-delete) or permanently. By default, a soft-deleted dossier remains recoverable for a retention period determined by application settings. The default retention period is 96 hours (4 days) but may vary based on configuration.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

query Parameters
deletePermanently
boolean
Default: false

A toggle to determine the deletion mode for a dossier:

  • true: The dossier will be permanently deleted and can't be restored.
  • false (default): Soft-delete, allowing restoration within the application-configured retention period.

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.

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Retrieve a specific dossier by its identifier.

Utilize this endpoint to retrieve comprehensive details about a designated dossier. The response encompasses various attributes such as the dossier's unique ID, name, description, associated owner, among other pertinent details.

If the dossier has been soft-deleted but not yet permanently deleted, the includeSoftDeleted parameter can be utilized to get it. Without this, a soft-deleted dossier would return a 404 Dossier not found error.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

query Parameters
includeSoftDeleted
boolean
Default: false

A Toggle to return a soft-deleted dossier:

  • true: The system returns the dossier regardless whether it has been soft-deleted or not.
  • false (default): The system returns only non-deleted dossiers. It would return a 404 Dossier not found error if the requested dossier has been soft-deleted.

Soft-deleted means that the dossier has not been deleted permanently.

Responses

Response samples

Content type
application/json
{
  • "id": "2ef05d6a-6fb3-4f27-b3c7-9a6438b38c3b",
  • "name": "Project Alpha",
  • "date": "2000-01-23T04:56:07.000+00:00",
  • "dossierTemplateId": "1ed2db85-9cd5-48b0-855f-77ca2a688501",
  • "description": "Collection of documents for Project Alpha.",
  • "ownerId": "a0044ae9-ddca-4f97-b0a1-3cb2517dbf39",
  • "memberIds": [
    ],
  • "approverIds": [
    ],
  • "visibility": "PRIVATE",
  • "startDate": null,
  • "dueDate": "2001-01-23T04:56:07.000+00:00",
  • "dossierStatusId": "b8280985-f558-43c0-852a-a3fa86803548",
  • "watermarkId": null,
  • "previewWatermarkId": null,
  • "dossierAttributes": {
    },
  • "downloadFileTypes": [
    ],
  • "reportTemplateIds": [
    ],
  • "archivedTime": null,
  • "softDeletedTime": null,
  • "hardDeletedTime": null
}

Update or set attributes for a specific 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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "attributeIdToValue": {
    }
}

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Initiate the creation of a download package for all files of a dossier.

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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

Request Body schema: application/json
required
downloadFileTypes
Array of strings (DownloadFileTypes) unique
Items Enum: "ORIGINAL" "PREVIEW"

Specifies the types of files that will part of the created download package. The defaults can be defined in the dossier template and can be overwritten individually on each download.

DocuMine supports ORIGINAL and PREVIEW:

  • ORIGINAL Contrary to intuition, this is not the uploaded file, but the pre-processed, optimized PDF, which may also contain the OCR results. This is the PDF that used by the system for further processing.
  • PREVIEW The annotated version of the PDF, highlighting the found entities that were evaluated to extract the components.
reportTemplateIds
Array of strings <uuid> (ReportTemplateIdList) unique [ items <uuid > ]

List of template identifiers indicating which templates are used for generating reports or other outputs. The reports are generated when requesting a download package.

redactionPreviewColor
string

A hexadecimal color code that is used to define the highlighting color of the redaction annotations in the PREVIEW file.

  • Black is #000000
  • White is #ffffff
  • Grey is #cccccc

Responses

Request samples

Content type
application/json
{
  • "downloadFileTypes": [
    ],
  • "reportTemplateIds": [
    ],
  • "redactionPreviewColor": "#9398a0"
}

Response samples

Content type
application/json
{
  • "id": "b5e2cf01-8bb6-4fcd-ad88-0efb611195da",
  • "userId": "caa8b54a-eb5e-4134-8ae2-a3946a428ec7",
  • "filename": "my-dossier.zip",
  • "mimeType": "application/octet-stream",
  • "errorCause": "",
  • "status": "READY",
  • "creationDate": "2023-03-29T11:41:08.886Z",
  • "lastDownload": "2023-03-29T13:11:05.123Z",
  • "fileSize": 1654231,
  • "dossierId": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
  • "fileIds": [
    ],
  • "downloadFileTypes": [
    ],
  • "reportTemplateIds": [
    ]
}

3. Files

Operations for managing files within a dossier.

Retrieves the status of the files of a specific dossier.

This endpoint provides status information for each file within a designated dossier.

The file status encompasses attributes such as identifier, file name, number of pages, file size, processing and workflow status, among other pertinent details. By default, only active files are fetched. However, various parameters can be combined to adjust the scope of the response.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

query Parameters
includeActive
boolean
Default: true

A toggle to include or exclude active files: If set to true (default), files that neither belong to an archived dossier nor have been soft-deleted are included. If set to false, they are ignored.

includeArchived
boolean
Default: false

A toggle to include or exclude archived files (i.e., files of archived dossiers): If set to true, files of archived dossiers are included. If set to false (default), they are ignored.

includeSoftDeleted
boolean
Default: false

A toggle to include soft-deleted files:

  • true: The response will include soft-deleted files.
  • false (default): Soft-deleted files are ignored and will not be part of the response.

Soft-deleted means that the file or dossier of the file has not been deleted permanently.

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Upload a file and associate it with 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.

Supported file formats include PDF documents, Microsoft Office documents (if supported by your license), CSV files, and ZIP archives.

Notably, Microsoft office files (file extensions docx, xlsx, or pptx) are automatically converted into PDF format upon upload. Be aware that due to potential font discrepancies, the resulting PDF may slightly differ in appearance from the original. Nevertheless, our system ensures maximum fidelity to the original content.

CSV files offer support for bulk importing of file attributes. If the dossier is set up to map specific CSV fields to file attributes and the uploaded CSV aligns with this mapping, the system will process the CSV accordingly. Mismatched CSVs will be disregarded. For successfully processed CSV files, the response contains information about the file attributes and the annotated files.

ZIP archives offer support to upload multiple files at once. In case of an upload of a ZIP archive, the system returns a list of unique identifiers of the contained files. The archive can even contain a mix of files like some PDF files and a CSV file that will annotate some file attributes.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

query Parameters
keepManualChanges
boolean
Default: false

A toggle to keep manual changes, i.e., to preserve manually added annotations or manipulations on existing ones when overwriting a file:

  • true: The system keeps the manual changes on re-uploading (overwriting) the file.
  • false (default): Manual changes get discarded on re-uploading the file.
disableAutomaticAnalysis
boolean
Default: false

A toggle to disable automatic analysis, i.e., to just upload and process the file without applying any automatic annotations:

  • true: The system does not apply any automatic text annotations on the file. Images are detected and annotated anyway.
  • false (default): The system applies automatic annotations on the file.
Request Body schema: multipart/form-data
file
required
string <binary>

The binary content of the file to be uploaded.

Responses

Response samples

Content type
application/json
{
  • "fileIds": [
    ],
  • "processedFileIds": [
    ],
  • "processedAttributes": [
    ]
}

Deletes a specific file associated with a dossier and its template.

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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

fileId
required
string

The identifier of a file

query Parameters
deletePermanently
boolean
Default: false

Determines the deletion mode for a file.

  • true: The file will be permanently deleted and can't be restored.
  • false (default): Soft-delete, allowing restoration within the retention period, provided its parent dossier hasn't been deleted. If the parent dossier has been deleted meanwhile, it needs to be restored first.

Using this parameter, you can also permanently delete a previously soft-deleted file during its retention period.

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Retrieves the status of a particular file.

This endpoint is designed to fetch the status of a specific file associated to a dossier based on a dossier template. If the file has been soft-deleted but not yet permanently deleted, the includeSoftDeleted parameter can be utilized to get the status of such files. Without this, a soft-deleted file would return a 404 File not found error.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

fileId
required
string

The identifier of a file

query Parameters
includeSoftDeleted
boolean
Default: false

A Toggle to return the status of soft-deleted files:

  • true: The system returns the status of the file regardless whether it has been soft-deleted or not.
  • false (default): The system returns only non-deleted files. It would return a 404 File not found error if the requested file has been soft-deleted.

Soft-deleted means that the file or dossier of the file has not been deleted permanently.

Responses

Response samples

Content type
application/json
{
  • "hasRedactions": true,
  • "added": "2000-01-23T04:56:07.000+00:00",
  • "workflowStatus": "NEW",
  • "hasAnnotationComments": true,
  • "rulesVersion": 2,
  • "excluded": true,
  • "lastUpdated": "2000-01-23T04:56:07.000+00:00",
  • "lastManualChangeDate": "2000-01-23T04:56:07.000+00:00",
  • "lastProcessed": "2000-01-23T04:56:07.000+00:00",
  • "excludedFromAutomaticAnalysis": true,
  • "dictionaryVersion": 5,
  • "dossierArchived": true,
  • "hasRequests": true,
  • "lastFileAttributeChange": "2000-01-23T04:56:07.000+00:00",
  • "id": "a7f0303d-a33c-4f2e-bd7a-a2adc1b8f92b",
  • "analysisDuration": 9,
  • "hasHighlights": true,
  • "dossierStatusId": "dossierStatusId",
  • "fileErrorInfo": {
    },
  • "processingStatus": "ANALYSE",
  • "numberOfAnalyses": 6,
  • "filename": "filename",
  • "fileAttributes": {
    },
  • "lastOCRTime": "2000-01-23T04:56:07.000+00:00",
  • "legalBasisVersion": 7,
  • "excludedPages": [
    ],
  • "redactionModificationDate": "2000-01-23T04:56:07.000+00:00",
  • "fileSize": 4,
  • "fileManipulationDate": "2000-01-23T04:56:07.000+00:00",
  • "dossierId": "dossierId",
  • "lastUploaded": "2000-01-23T04:56:07.000+00:00",
  • "assignee": "assignee",
  • "analysisRequired": true,
  • "approvalDate": "2000-01-23T04:56:07.000+00:00",
  • "numberOfPagesToOCR": 1,
  • "ocrEndTime": "2000-01-23T04:56:07.000+00:00",
  • "hasHints": true,
  • "softDeletedTime": "2000-01-23T04:56:07.000+00:00",
  • "numberOfPages": 0,
  • "uploader": "uploader",
  • "lastReviewer": "lastReviewer",
  • "lastIndexed": "2000-01-23T04:56:07.000+00:00",
  • "numberOfOCRedPages": 5,
  • "analysisVersion": 7,
  • "lastLayoutProcessed": "2000-01-23T04:56:07.000+00:00",
  • "lastApprover": "lastApprover",
  • "ocrStartTime": "2000-01-23T04:56:07.000+00:00",
  • "dossierDictionaryVersion": 3,
  • "dossierTemplateId": "dossierTemplateId",
  • "hasImages": true,
  • "hasUpdates": true,
  • "hasSuggestions": true
}

Initiate the creation of a download package for a single file of a dossier.

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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

fileId
required
string

The identifier of a file

Request Body schema: application/json
required
downloadFileTypes
Array of strings (DownloadFileTypes) unique
Items Enum: "ORIGINAL" "PREVIEW"

Specifies the types of files that will part of the created download package. The defaults can be defined in the dossier template and can be overwritten individually on each download.

DocuMine supports ORIGINAL and PREVIEW:

  • ORIGINAL Contrary to intuition, this is not the uploaded file, but the pre-processed, optimized PDF, which may also contain the OCR results. This is the PDF that used by the system for further processing.
  • PREVIEW The annotated version of the PDF, highlighting the found entities that were evaluated to extract the components.
reportTemplateIds
Array of strings <uuid> (ReportTemplateIdList) unique [ items <uuid > ]

List of template identifiers indicating which templates are used for generating reports or other outputs. The reports are generated when requesting a download package.

redactionPreviewColor
string

A hexadecimal color code that is used to define the highlighting color of the redaction annotations in the PREVIEW file.

  • Black is #000000
  • White is #ffffff
  • Grey is #cccccc

Responses

Request samples

Content type
application/json
{
  • "downloadFileTypes": [
    ],
  • "reportTemplateIds": [
    ],
  • "redactionPreviewColor": "#9398a0"
}

Response samples

Content type
application/json
{
  • "id": "b5e2cf01-8bb6-4fcd-ad88-0efb611195da",
  • "userId": "caa8b54a-eb5e-4134-8ae2-a3946a428ec7",
  • "filename": "my-dossier.zip",
  • "mimeType": "application/octet-stream",
  • "errorCause": "",
  • "status": "READY",
  • "creationDate": "2023-03-29T11:41:08.886Z",
  • "lastDownload": "2023-03-29T13:11:05.123Z",
  • "fileSize": 1654231,
  • "dossierId": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
  • "fileIds": [
    ],
  • "downloadFileTypes": [
    ],
  • "reportTemplateIds": [
    ]
}

Bulk delete specific files within a dossier. (DELETE with body payload)

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 deleted files are irrevocably removed and cannot be restored.

Use this route to manage large file deletions efficiently.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

query Parameters
deletePermanently
boolean
Default: false

Determines the deletion mode for a list of files:

  • true: The files will be permanently deleted and can't be restored.
  • false (default): Soft-delete, allowing restoration within the retention period, provided the files' parent dossier hasn't been deleted. If the parent dossier has been deleted meanwhile, it needs to be restored first.

Using this parameter, you can also permanently delete a previously soft-deleted files during their retention period.

Request Body schema: application/json
required
fileIds
Array of strings

A list of unique identifiers for the files to be deleted.

Responses

Request samples

Content type
application/json
{
  • "fileIds": [
    ]
}

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Initiate the creation of a download package for specific files within a dossier.

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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

Request Body schema: application/json
required
downloadFileTypes
Array of strings (DownloadFileTypes) unique
Items Enum: "ORIGINAL" "PREVIEW"

Specifies the types of files that will part of the created download package. The defaults can be defined in the dossier template and can be overwritten individually on each download.

DocuMine supports ORIGINAL and PREVIEW:

  • ORIGINAL Contrary to intuition, this is not the uploaded file, but the pre-processed, optimized PDF, which may also contain the OCR results. This is the PDF that used by the system for further processing.
  • PREVIEW The annotated version of the PDF, highlighting the found entities that were evaluated to extract the components.
reportTemplateIds
Array of strings <uuid> (ReportTemplateIdList) unique [ items <uuid > ]

List of template identifiers indicating which templates are used for generating reports or other outputs. The reports are generated when requesting a download package.

redactionPreviewColor
string

A hexadecimal color code that is used to define the highlighting color of the redaction annotations in the PREVIEW file.

  • Black is #000000
  • White is #ffffff
  • Grey is #cccccc
fileIds
Array of strings

A list with unique identifiers of the files for which the download is to be prepared.

Responses

Request samples

Content type
application/json
{
  • "downloadFileTypes": [
    ],
  • "reportTemplateIds": [
    ],
  • "redactionPreviewColor": "#9398a0",
  • "fileIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "b5e2cf01-8bb6-4fcd-ad88-0efb611195da",
  • "userId": "caa8b54a-eb5e-4134-8ae2-a3946a428ec7",
  • "filename": "my-dossier.zip",
  • "mimeType": "application/octet-stream",
  • "errorCause": "",
  • "status": "READY",
  • "creationDate": "2023-03-29T11:41:08.886Z",
  • "lastDownload": "2023-03-29T13:11:05.123Z",
  • "fileSize": 1654231,
  • "dossierId": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
  • "fileIds": [
    ],
  • "downloadFileTypes": [
    ],
  • "reportTemplateIds": [
    ]
}

Update or set attributes for a specific file.

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.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

fileId
required
string

The identifier of a file

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "attributeIdToValue": {
    }
}

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

4. Components

Operations related to components of a file within a dossier.

Fetch the components associated with a specific file.

This endpoint retrieves the derived and extracted components from a given file within a dossier. Components represent various aspects, metadata or content of the file. Entity and component rules define these components based on the file's content. They can give a structured view on a document's text.

To include detailed component information, set the includeDetails query parameter to true.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

fileId
required
string

The identifier of a file

query Parameters
includeDetails
boolean
Default: false

A toggle to decide whether to include detailed component information in the response:

  • true: The component object's field componentDetails stores detailed information about the source of its respective value(s).
  • false (default): The component object does not contain a field componentDetails.

Responses

Response samples

Content type
{
  • "dossierTemplateId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "dossierId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "fileId": "1fdbd888b39059c8cf171df26f62f8a5",
  • "filename": "MyFile.pdf",
  • "components": {
    },
  • "componentDetails": [
    ]
}

Returns the FileComponents of all files in a dossier

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.

To include detailed component information, set the includeDetails query parameter to true.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

query Parameters
includeDetails
boolean
Default: false

A toggle to decide whether to include detailed component information in the response:

  • true: The component object's field componentDetails stores detailed information about the source of its respective value(s).
  • false (default): The component object does not contain a field componentDetails.

Responses

Response samples

Content type
{
  • "files": [
    ]
}

Add the component overrides associated with a specific file.

This endpoint allows the user to add one or more overrides for a specific component of a dossier file. The component override data is provided in the request body.

Use this route to add overrides to the specified component.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

fileId
required
string

The identifier of a file

Request Body schema: application/json
required
name
string

The name of the component.

Array of objects (ComponentValue)

A list of value objects associated with the component.

Responses

Request samples

Content type
application/json
{
  • "name": "the component name",
  • "componentValues": [
    ]
}

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Returns all overrides from components associated with a specific file.

This endpoint retrieves all the overrides for components within a dossier file. The response includes a list of all component overrides associated with the specified file.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

fileId
required
string

The identifier of a file

Responses

Response samples

Content type
{
  • "dossierTemplateId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "dossierId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "fileId": "1fdbd888b39059c8cf171df26f62f8a5",
  • "componentOverrideModels": [
    ]
}

Reverts the component overrides associated with a specific file.

Reverts all overrides for the specified components associated with a specific file.

Use this route to revert all overrides specified by the component names.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

dossierId
required
string

The identifier of a dossier

fileId
required
string

The identifier of a file

Request Body schema: application/json
required
components
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "components": [
    ]
}

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

5. Downloads

Operations related to download packages.

Get the list of downloads for the current user

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

Authorizations:
FF-OAUTH

Responses

Response samples

Content type
application/json
{
  • "downloadStatus": [
    ]
}

Get the status for a specific download of the current user

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.

Authorizations:
FF-OAUTH
path Parameters
downloadId
required
string

The identifier for the file to download.

Responses

Response samples

Content type
application/json
{
  • "id": "b5e2cf01-8bb6-4fcd-ad88-0efb611195da",
  • "userId": "caa8b54a-eb5e-4134-8ae2-a3946a428ec7",
  • "filename": "my-dossier.zip",
  • "mimeType": "application/octet-stream",
  • "errorCause": "",
  • "status": "READY",
  • "creationDate": "2023-03-29T11:41:08.886Z",
  • "lastDownload": "2023-03-29T13:11:05.123Z",
  • "fileSize": 1654231,
  • "dossierId": "20354d7a-e4fe-47af-8ff6-187bca92f3f9",
  • "fileIds": [
    ],
  • "downloadFileTypes": [
    ],
  • "reportTemplateIds": [
    ]
}

Deletes a specific download.

Use this endpoint to remove a download.

Authorizations:
FF-OAUTH
path Parameters
downloadId
required
string

The identifier for the file to download.

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Download the download package.

Use this endpoint to actually download the created download package. The request will only be successful if the status of the download is READY.

Authorizations:
FF-OAUTH
path Parameters
downloadId
required
string

The identifier for the file to download.

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

6. Users

Operations related to users.

Get a list of 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.

Authorizations:
FF-OAUTH
query Parameters
username
string

If the username parameter is set, the user list is filtered for that specific user name. This means the list either has one matching entry or is empty.

Responses

Response samples

Content type
application/json
{
  • "downloadStatus": [
    ]
}

Retrieve a specific user by its identifier.

Use this endpoint to retrieve a specific user.

Authorizations:
FF-OAUTH
path Parameters
userId
required
string <uuid>

The identifier of a user

Responses

Response samples

Content type
application/json
{
  • "id": "efe7eedd-89c5-56f5-984c-0712ee41a2eb",
  • "username": "myusername",
  • "email": "[email protected]",
  • "firstName": "John",
  • "lastName": "Doe",
  • "roles": [
    ],
  • "active": true
}

7. License

Operations related to license information and usage metrics.

Generate and retrieve a license usage report.

This endpoint enables users to create and fetch a report detailing the active usage of licenses. The report contains valuable insights and metrics that can aid in monitoring and managing license consumption. Ensure your request body contains the necessary parameters for generating this report.

Authorizations:
FF-OAUTH
Request Body schema: application/json
required
startDate
string <date-time>

The start date for the requested report.

endDate
string <date-time>

The end date for the requested report.

Responses

Request samples

Content type
application/json
{
  • "startDate": "2000-01-01T00:00:00.000+00:00",
  • "endDate": "2001-01-01T00:00:00.000+00:00"
}

Response samples

Content type
application/json
{
  • "startDate": "2000-01-01T00:00:00.000+00:00",
  • "endDate": "2001-01-01T00:00:00.000+00:00",
  • "numberOfAnalyzedFiles": 5,
  • "numberOfAnalyzedPages": 9,
  • "analyzedFilesBytes": 30000,
  • "totalFilesUploadedBytes": 30000,
  • "activeFilesUploadedBytes": 20000,
  • "archivedFilesUploadedBytes": 5000,
  • "trashFilesUploadedBytes": 5000,
  • "numberOfOcrFiles": 2,
  • "numberOfOcrPages": 2,
  • "numberOfDossiers": 1,
  • "monthlyData": [
    ]
}

Component Definitions

Create new component definitions

Create new component definitions for a given dossier template. The component will have a technical name which is automatically converted to snake case that can't be updated after the creation. The rank is used to determine the order in which the components are displayed. The component's rank will automatically be appended at the end based on the current number of components of this dossier template.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Request Body schema: application/json
required
Array
technicalName
required
string

The technical name of the component.

displayName
required
string

The display name of the component.

description
string

A brief description of the component.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get all component definitions

Get all the component definitions in a given dossier template. includeSoftDeleted is false by default and will not return soft deleted components. If set to true, this endpoint will also return components that have been soft deleted.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

query Parameters
includeSoftDeleted
required
boolean
Default: false

A toggle to include or exclude soft-deleted components: If false (default), soft-deleted components are not included. If true, they are included.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update existing component definitions

Update specific existing component definitions. The rank and technical name cannot be updated via this endpoint. The technical name cannot be updated at all after creation. To update the rank, use the reorder endpoint.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

Request Body schema: application/json
required
Array
id
required
string <uuid>

The unique identifier for the component to be updated.

displayName
required
string

The new display name of the component.

description
required
string

The new description of the component.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Soft delete component definitions

Soft delete existing component definitions by their IDs. Soft deletion is done by setting the softDeletedTime value to the current time of the request. If a component does not have softDeletedTime set, it means the component is not soft deleted.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

query Parameters
componentIds
required
Array of strings

The IDs of the component definitions to soft delete

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2023-09-21T12:45:00Z",
  • "message": "An error occurred while processing the request."
}

Reorder component definitions

Reorder the component definitions based on the provided list. Their ranks will be updated based on the order provided in the request, starting from rank 1.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

query Parameters
componentIds
required
Array of strings

The IDs of the component definitions in the order in which they will be reordered.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get specific component by ID

Get details about a specific component based on its ID for a given dossier template.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

componentId
required
string

The identifier of a component definition.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Restore soft deleted components by ID

Restore a previously soft-deleted component. The restored component will be placed at the end of the rank order. For example, if there are 5 components ranked 1, 2, 3, 4, and 5, and the third component is soft-deleted, the ranks will be updated to 1, 2, 4, and 5. If the soft-deleted component is then restored, it will be appended to the end, resulting in ranks 1, 2, 4, 5, and 6.

Authorizations:
FF-OAUTH
path Parameters
dossierTemplateId
required
string

The identifier of a dossier template

query Parameters
componentIds
required
Array of strings

The IDs of the component definitions to restore.

Responses

Response samples

Content type
application/json
[
  • {
    }
]