Use cases

DocuMine Documentation

Use cases

This section provides practical examples to help you understand how to use the API for common scenarios, ensuring smooth integration with DocuMine.

Adding custom properties to a file

This use case explains how to add custom properties to file attributes.

Note that you can only add properties to predefined attribute IDs (file attributes need to be created by a DocuMine user holding the Admin role).

Retrieve the available attribute names and their corresponding IDs via the following endpoint:

GET    /api/dossier-templates/{{dossierTemplateId}}/file-attribute-definitions

Retrieve all files of the dossier, including each file's attribute IDs map and values:

GET    /api/dossier-templates/{{dossierTemplateId}}/dossiers/{{dossierId}}/files

Retrieve the attribute IDs map and values for a specific file:

GET    /api/dossier-templates/{{dossierTemplateId}}/dossiers/{{dossierId}}/files/{{fileId}}

Update the file attributes of a file. The request body should contain the entire map of attribute IDs and values. Missing entries will be considered deletions; values can be set to null.

POST    /api/dossier-templates/{{dossierTemplateId}}/dossiers/{{dossierId}}/files/{{fileId}}/attributes

In this section:

Was this helpful?

DocuMine Documentation

Use cases

Adding custom properties to a file

Search results