Skip to main content
API docs by Redocly

DocuDesk API (1.0.0)

Download OpenAPI specification:Download

URL: https://github.com/yourusername/docudesk License: AGPL-3.0

API documentation for DocuDesk, a document management application for Nextcloud

documents

Operations related to documents

List all documents

Returns a list of all documents the user has access to

query Parameters
folder_id
string

Filter documents by folder ID

tag
string

Filter documents by tag

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new document

Creates a new document in the system

Request Body schema: application/json
required
name
required
string

Name of the document

description
string

Description of the document

file_id
required
string

Nextcloud file ID

folder_id
string

ID of the folder to place this document in

tags
Array of strings

List of tags to associate with the document

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "file_id": "string",
  • "folder_id": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "file_id": "string",
  • "folder_id": "string",
  • "mime_type": "string",
  • "size": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tags": [
    ]
}

folders

Operations related to folders

tags

Operations related to document tags

search

Operations related to searching documents

privacy

Operations related to privacy and GDPR compliance

List all files with privacy data

Returns a list of all files that contain privacy-related data

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get privacy data for a specific file

Returns the privacy data associated with a specific file

path Parameters
fileId
required
string

ID of the file to get privacy data for

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "file_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "mime_type": "string",
  • "contains_personal_data": true,
  • "data_categories": [
    ],
  • "anonymization_status": "not_required",
  • "anonymization_date": "2019-08-24T14:15:22Z",
  • "retention_period": 0,
  • "retention_expiry": "2019-08-24T14:15:22Z",
  • "legal_basis": "consent",
  • "data_controller": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update privacy data for a file

Updates the privacy data associated with a specific file

path Parameters
fileId
required
string

ID of the file to update privacy data for

Request Body schema: application/json
required
contains_personal_data
boolean

Whether the file contains personal data

data_categories
Array of strings
Items Enum: "name" "address" "email" "phone" "id_number" "financial" "health" "biometric" "location" "other"

Categories of personal data contained in the file

anonymization_status
string
Enum: "not_required" "pending" "in_progress" "completed" "failed"

Status of anonymization process

anonymization_date
string <date-time>

Date when the file was anonymized

retention_period
integer

Retention period in days (0 for indefinite)

legal_basis
string
Enum: "consent" "contract" "legal_obligation" "vital_interests" "public_interest" "legitimate_interests"

Legal basis for processing the data under GDPR

data_controller
string

Name of the data controller

Responses

Request samples

Content type
application/json
{
  • "contains_personal_data": true,
  • "data_categories": [
    ],
  • "anonymization_status": "not_required",
  • "anonymization_date": "2019-08-24T14:15:22Z",
  • "retention_period": 0,
  • "legal_basis": "consent",
  • "data_controller": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "file_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "mime_type": "string",
  • "contains_personal_data": true,
  • "data_categories": [
    ],
  • "anonymization_status": "not_required",
  • "anonymization_date": "2019-08-24T14:15:22Z",
  • "retention_period": 0,
  • "retention_expiry": "2019-08-24T14:15:22Z",
  • "legal_basis": "consent",
  • "data_controller": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

parsing

Operations related to document parsing and processing

List parsing logs

Returns a list of parsing logs for processed files

query Parameters
file_id
string

Filter logs by file ID

status
string
Enum: "pending" "processing" "completed" "failed"

Filter logs by parsing status

from_date
string <date-time>

Filter logs from this date (ISO format)

to_date
string <date-time>

Filter logs until this date (ISO format)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new parsing log

Creates a new parsing log entry for a file

Request Body schema: application/json
required
file_id
required
string

Nextcloud file ID of the file to parse

file_name
required
string

Name of the file to parse

file_path
string

Path to the file in Nextcloud

mime_type
string

MIME type of the file

parsing_type
required
string
Enum: "text_extraction" "metadata_extraction" "anonymization" "format_conversion" "accessibility_check" "validation"

Type of parsing operation to perform

output_format
string

Desired format of the output file

Responses

Request samples

Content type
application/json
{
  • "file_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "mime_type": "string",
  • "parsing_type": "text_extraction",
  • "output_format": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "file_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "mime_type": "string",
  • "parsing_type": "text_extraction",
  • "status": "pending",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "duration_ms": 0,
  • "result_summary": "string",
  • "error_message": "string",
  • "output_file_id": "string",
  • "output_format": "string",
  • "user_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get a specific parsing log

Returns a specific parsing log by ID

path Parameters
logId
required
string

ID of the parsing log to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "file_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "mime_type": "string",
  • "parsing_type": "text_extraction",
  • "status": "pending",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "duration_ms": 0,
  • "result_summary": "string",
  • "error_message": "string",
  • "output_file_id": "string",
  • "output_format": "string",
  • "user_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a parsing log

Updates a specific parsing log entry

path Parameters
logId
required
string

ID of the parsing log to update

Request Body schema: application/json
required
status
string
Enum: "pending" "processing" "completed" "failed"

Status of the parsing operation

completed_at
string <date-time>

When the parsing operation completed

duration_ms
integer

Duration of the parsing operation in milliseconds

result_summary
string

Summary of the parsing result

error_message
string

Error message if the parsing failed

output_file_id
string

ID of the output file

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "duration_ms": 0,
  • "result_summary": "string",
  • "error_message": "string",
  • "output_file_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "file_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "mime_type": "string",
  • "parsing_type": "text_extraction",
  • "status": "pending",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "duration_ms": 0,
  • "result_summary": "string",
  • "error_message": "string",
  • "output_file_id": "string",
  • "output_format": "string",
  • "user_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

reports

Operations related to document analysis reports

List all document reports

Returns a list of all document analysis reports

query Parameters
node_id
string

Filter reports by Nextcloud node ID

status
string
Enum: "pending" "processing" "completed" "failed"

Filter reports by status

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new document report

Creates a new document analysis report

Request Body schema: application/json
required
node_id
required
string

Nextcloud node ID of the document

file_name
required
string

Name of the document

file_path
string

Path to the document in Nextcloud

file_hash
required
string

Hash of the file content

mime_type
string

MIME type of the document

file_size
integer

Size of the document in bytes

analysis_types
required
Array of strings
Items Enum: "anonymization" "wcag_compliance" "language_level"

Types of analysis to perform

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "file_size": 0,
  • "analysis_types": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "file_size": 0,
  • "status": "pending",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_message": "string",
  • "anonymization_results": {
    },
  • "wcag_compliance_results": {
    },
  • "language_level_results": {
    },
  • "user_id": "string"
}

Get a specific document report

Returns a specific document analysis report by ID

path Parameters
reportId
required
string

ID of the report to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "file_size": 0,
  • "status": "pending",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_message": "string",
  • "anonymization_results": {
    },
  • "wcag_compliance_results": {
    },
  • "language_level_results": {
    },
  • "user_id": "string"
}

Update a document report

Updates a specific document analysis report

path Parameters
reportId
required
string

ID of the report to update

Request Body schema: application/json
required
status
string
Enum: "pending" "processing" "completed" "failed"

Status of the report generation

completed_at
string <date-time>

When the report generation was completed

error_message
string

Error message if report generation failed

object (AnonymizationResults)

Results of anonymization analysis

object (WcagComplianceResults)

Results of WCAG compliance analysis

object (LanguageLevelResults)

Results of language level analysis

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_message": "string",
  • "anonymization_results": {
    },
  • "wcag_compliance_results": {
    },
  • "language_level_results": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "file_size": 0,
  • "status": "pending",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_message": "string",
  • "anonymization_results": {
    },
  • "wcag_compliance_results": {
    },
  • "language_level_results": {
    },
  • "user_id": "string"
}

Get the latest report for a node

Returns the latest document analysis report for a specific Nextcloud node

path Parameters
nodeId
required
string

Nextcloud node ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "file_size": 0,
  • "status": "pending",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "error_message": "string",
  • "anonymization_results": {
    },
  • "wcag_compliance_results": {
    },
  • "language_level_results": {
    },
  • "user_id": "string"
}

anonymization

Operations related to document anonymization

List anonymization logs

Returns a list of anonymization logs

query Parameters
node_id
string

Filter logs by Nextcloud node ID

status
string
Enum: "pending" "processing" "completed" "failed"

Filter logs by status

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new anonymization log

Creates a new anonymization log entry

Request Body schema: application/json
required
node_id
required
string

Nextcloud node ID of the document to anonymize

file_name
required
string

Name of the document

file_path
string

Path to the document in Nextcloud

file_hash
string

Hash of the file content

mime_type
string

MIME type of the document

confidence_threshold
number <float> [ 0 .. 1 ]

Confidence threshold for entity detection (default 0.7)

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "confidence_threshold": 1
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "status": "pending",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "duration_ms": 0,
  • "error_message": "string",
  • "output_node_id": "string",
  • "anonymization_key": "string",
  • "original_text": "string",
  • "anonymized_text": "string",
  • "entity_replacements": [
    ],
  • "entities_found": [
    ],
  • "total_entities_found": 0,
  • "total_entities_replaced": 0,
  • "confidence_threshold": 1,
  • "user_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get a specific anonymization log

Returns a specific anonymization log by ID

path Parameters
logId
required
string

ID of the anonymization log to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "status": "pending",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "duration_ms": 0,
  • "error_message": "string",
  • "output_node_id": "string",
  • "anonymization_key": "string",
  • "original_text": "string",
  • "anonymized_text": "string",
  • "entity_replacements": [
    ],
  • "entities_found": [
    ],
  • "total_entities_found": 0,
  • "total_entities_replaced": 0,
  • "confidence_threshold": 1,
  • "user_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an anonymization log

Updates a specific anonymization log entry

path Parameters
logId
required
string

ID of the anonymization log to update

Request Body schema: application/json
required
status
string
Enum: "pending" "processing" "completed" "failed"

Status of the anonymization operation

completed_at
string <date-time>

When the anonymization operation completed

duration_ms
integer

Duration of the anonymization operation in milliseconds

error_message
string

Error message if anonymization failed

output_node_id
string

Nextcloud node ID of the anonymized document

original_text
string

Original text of the document

anonymized_text
string

Anonymized text of the document

Array of objects (EntityReplacement)

List of entity replacements made during anonymization

Array of objects (EntityFound)

List of entities found during anonymization

total_entities_found
integer

Total number of entities found

total_entities_replaced
integer

Total number of entities replaced

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "duration_ms": 0,
  • "error_message": "string",
  • "output_node_id": "string",
  • "original_text": "string",
  • "anonymized_text": "string",
  • "entity_replacements": [
    ],
  • "entities_found": [
    ],
  • "total_entities_found": 0,
  • "total_entities_replaced": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "status": "pending",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "duration_ms": 0,
  • "error_message": "string",
  • "output_node_id": "string",
  • "anonymization_key": "string",
  • "original_text": "string",
  • "anonymized_text": "string",
  • "entity_replacements": [
    ],
  • "entities_found": [
    ],
  • "total_entities_found": 0,
  • "total_entities_replaced": 0,
  • "confidence_threshold": 1,
  • "user_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get the latest anonymization log for a node

Returns the latest anonymization log for a specific Nextcloud node

path Parameters
nodeId
required
string

Nextcloud node ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "node_id": "string",
  • "file_name": "string",
  • "file_path": "string",
  • "file_hash": "string",
  • "mime_type": "string",
  • "status": "pending",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "duration_ms": 0,
  • "error_message": "string",
  • "output_node_id": "string",
  • "anonymization_key": "string",
  • "original_text": "string",
  • "anonymized_text": "string",
  • "entity_replacements": [
    ],
  • "entities_found": [
    ],
  • "total_entities_found": 0,
  • "total_entities_replaced": 0,
  • "confidence_threshold": 1,
  • "user_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

De-anonymize a document

Restores the original text in an anonymized document using the anonymization key

Request Body schema: application/json
required
anonymized_node_id
required
string

Nextcloud node ID of the anonymized document

anonymization_key
required
string

Key used to de-anonymize the document

Responses

Request samples

Content type
application/json
{
  • "anonymized_node_id": "string",
  • "anonymization_key": "string"
}

Response samples

Content type
application/json
{
  • "original_node_id": "string",
  • "success": true
}