Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
project
v1

Method marks the whole project (remove_all=True) / the project's documents (remove_all=False) for deleting. These marked documents (and the project) will become hidden in API. Documents, listed in excluded_ids list, will not be marked for deleting.

Params:
    - all: bool - mark all filtered by a user documents
    - remove_all: bool - mark project+documents
    - exclude_document_ids: list[int]
post/api/v1/project/projects/{id}/mark_delete/

Path parameters

idstring required

A unique integer value identifying this project.

Request body

allboolean
remove_allboolean
exclude_document_idsinteger[]

Example request

{
  "all": true,
  "remove_all": true,
  "exclude_document_ids": [
    0,
    0
  ]
}

Response

count_deletedinteger required

Example response

{
  "count_deleted": 0
}