diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index f25b1cc09..afb8e2692 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -148,6 +148,7 @@ brew install --cask libreoffice ```shell brew install \ ocrmypdf \ + qpdf \ exiftool \ poppler \ imagemagick \ diff --git a/api/docs/index.html b/api/docs/index.html index b8c4c8622..1d1e1eab9 100644 --- a/api/docs/index.html +++ b/api/docs/index.html @@ -357,7 +357,7 @@ -
API docs by Redocly
API docs by Redocly

Not Found

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Create

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Create

Create

query Parameters
type
required
string

Type

@@ -413,7 +413,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Delete One

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Delete One

Delete One

path Parameters
id
required
string

ID

@@ -433,7 +433,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Patch

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Patch

Patch

path Parameters
id
required
string

ID

@@ -445,7 +445,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Copy One

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Copy One

Copy One

path Parameters
id
required
string

ID

@@ -497,7 +497,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "query": {
    },
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

Move One

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "query": {
    },
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

Move One

Move One

path Parameters
id
required
string

ID

@@ -519,7 +519,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Download Original

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Download Original

Download Original

path Parameters
id
required
string

ID

@@ -553,7 +553,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Get Path

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Get Path

Get Path

path Parameters
id
required
string

ID

@@ -563,14 +563,14 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
[
  • {
    }
]

Download Preview

Response samples

Content type
application/json
[
  • {
    }
]

Download Preview

Download Preview

-
path Parameters
id
required
string
path Parameters
id
required
string

ID

-
query Parameters
access_token
required
string

Access Token

ext
required
string

Extension

+
query Parameters
access_token
required
string

Access Token

Responses

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Get Size

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Download Segmentation Page

Download Segmentation Page

+
path Parameters
id
required
string

ID

+
page
required
string

Page

+
query Parameters
access_token
required
string

Access Token

+

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Download Segmentation Thumbnail

Download Segmentation Thumbnail

+
path Parameters
id
required
string

ID

+
page
required
string

Page

+
query Parameters
access_token
required
string

Access Token

+

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Get Size

Get Size

path Parameters
id
required
string

ID

@@ -595,19 +619,19 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
0
0

Download Thumbnail

Response samples

Content type
application/json
0
0

Download Thumbnail

Download Thumbnail

-
path Parameters
id
required
string
path Parameters
id
required
string

ID

-
query Parameters
access_token
required
string

Access Token

ext
required
string

Extension

+
query Parameters
access_token
required
string

Access Token

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Get User Permissions

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Get User Permissions

Get User Permissions

path Parameters
id
required
string

ID

@@ -617,7 +641,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
[
  • {
    }
]

Copy Many

Response samples

Content type
application/json
[
  • {
    }
]

Copy Many

Copy Many

Request Body schema: application/json
required

Body

@@ -627,7 +651,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Request samples

Content type
application/json
{
  • "sourceIds": [
    ],
  • "targetId": "string"
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "new": [
    ],
  • "succeeded": [
    ]
}

Create from S3

Request samples

Content type
application/json
{
  • "sourceIds": [
    ],
  • "targetId": "string"
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "new": [
    ],
  • "succeeded": [
    ]
}

Create from S3

Create from S3

query Parameters
api_key
required
string

API Key

@@ -653,7 +677,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Grant Group Permission

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "isShared": true,
  • "name": "string",
  • "parentId": "string",
  • "permission": "string",
  • "snapshot": {
    },
  • "type": "string",
  • "updateTime": "string",
  • "workspaceId": "string"
}

Grant Group Permission

Grant Group Permission

path Parameters
id
required
string

ID

@@ -663,7 +687,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "ids": [
    ],
  • "permission": "viewer"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Grant User Permission

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "ids": [
    ],
  • "permission": "viewer"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Grant User Permission

Grant User Permission

path Parameters
id
required
string

ID

@@ -673,7 +697,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "permission": "viewer",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

List by Path

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "permission": "viewer",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

List by Path

List by Path

query Parameters
path
required
string

Path

@@ -683,7 +707,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
[
  • {
    }
]

Move Many

Response samples

Content type
application/json
[
  • {
    }
]

Move Many

Move Many

Request Body schema: application/json
required

Body

@@ -693,7 +717,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Request samples

Content type
application/json
{
  • "sourceIds": [
    ],
  • "targetId": "string"
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "succeeded": [
    ]
}

Revoke User Permission

Request samples

Content type
application/json
{
  • "sourceIds": [
    ],
  • "targetId": "string"
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "succeeded": [
    ]
}

Revoke User Permission

Revoke User Permission

path Parameters
id
required
string

ID

@@ -703,7 +727,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Groups

List

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Groups

List

List

query Parameters
query
string

Query

@@ -863,7 +887,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
{
  • "isAvailable": true,
  • "isOutdated": true,
  • "snapshot": {
    }
}

Download OCR

Response samples

Content type
application/json
{
  • "isAvailable": true,
  • "isOutdated": true,
  • "snapshot": {
    }
}

Download OCR

Download OCR

path Parameters
id
required
string

ID

@@ -1011,7 +1035,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
{
  • "isAvailable": true,
  • "isOutdated": true,
  • "metadata": {
    },
  • "snapshot": {
    }
}

Download Tile

Response samples

Content type
application/json
{
  • "isAvailable": true,
  • "isOutdated": true,
  • "metadata": {
    },
  • "snapshot": {
    }
}

Download Tile

Download Tile

path Parameters
id
required
string

ID

@@ -1127,7 +1151,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Not Found

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

Patch

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

Patch

Patch

path Parameters
id
required
string

ID

@@ -1135,13 +1159,13 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA">

API Key

Request Body schema: application/json
required

Body

-
object (model.S3Object)
fields
Array of strings
object (model.S3Object)
object (model.S3Object)
object (client.PipelineRunOptions)
object (model.S3Object)
object (model.S3Object)
status
string
taskId
string
object (model.S3Object)
object (model.S3Object)

Responses

object (model.S3Object)
fields
Array of strings
object (model.S3Object)
object (model.S3Object)
object (client.PipelineRunOptions)
object (model.S3Object)
object (model.S3Object)
object (model.S3Object)
status
string
taskId
string
object (model.S3Object)
object (model.S3Object)

Responses

Request samples

Content type
application/json
{
  • "entities": {
    },
  • "fields": [
    ],
  • "mosaic": {
    },
  • "ocr": {
    },
  • "options": {
    },
  • "original": {
    },
  • "preview": {
    },
  • "status": "string",
  • "taskId": "string",
  • "text": {
    },
  • "thumbnail": {
    }
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "entities": {
    },
  • "id": "string",
  • "isActive": true,
  • "language": "string",
  • "mosaic": {
    },
  • "ocr": {
    },
  • "original": {
    },
  • "preview": {
    },
  • "status": "string",
  • "task": {
    },
  • "text": {
    },
  • "thumbnail": {
    },
  • "updateTime": "string",
  • "version": 0
}

Activate

Request samples

Content type
application/json
{
  • "entities": {
    },
  • "fields": [
    ],
  • "mosaic": {
    },
  • "ocr": {
    },
  • "options": {
    },
  • "original": {
    },
  • "preview": {
    },
  • "segmentation": {
    },
  • "status": "string",
  • "taskId": "string",
  • "text": {
    },
  • "thumbnail": {
    }
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "entities": {
    },
  • "id": "string",
  • "isActive": true,
  • "language": "string",
  • "mosaic": {
    },
  • "ocr": {
    },
  • "original": {
    },
  • "preview": {
    },
  • "segmentation": {
    },
  • "status": "string",
  • "task": {
    },
  • "text": {
    },
  • "thumbnail": {
    },
  • "updateTime": "string",
  • "version": 0
}

Activate

Activate

path Parameters
id
required
string

ID

@@ -1211,13 +1235,13 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA">

API Key

Request Body schema: application/json
required

Body

-
error
string
isIndeterminate
boolean
name
string
percentage
integer
userId
string

Responses

error
string
isIndeterminate
boolean
name
string
object
percentage
integer
status
string
userId
string

Responses

Request samples

Content type
application/json
{
  • "error": "string",
  • "isIndeterminate": true,
  • "name": "string",
  • "percentage": 0,
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Dismiss

Request samples

Content type
application/json
{
  • "error": "string",
  • "isIndeterminate": true,
  • "name": "string",
  • "payload": {
    },
  • "percentage": 0,
  • "status": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "moreInfo": "string",
  • "status": 0,
  • "userMessage": "string"
}

Dismiss

Dismiss

path Parameters
id
required
string

ID

@@ -1367,7 +1391,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">

Internal Server Error

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "organization": {
    },
  • "permission": "string",
  • "rootId": "string",
  • "storageCapacity": 0,
  • "updateTime": "string"
}