diff --git a/api/cache/file_cache.go b/api/cache/file_cache.go index 8cb8fe894..f52cd0bc9 100644 --- a/api/cache/file_cache.go +++ b/api/cache/file_cache.go @@ -67,6 +67,17 @@ func (c *FileCache) Refresh(id string) (model.File, error) { return res, nil } +func (c *FileCache) RefreshWithExisting(file model.File, userID string) (model.File, error) { + err := c.fileRepo.PopulateModelFieldsForUser([]model.File{file}, userID) + if err != nil { + return nil, err + } + if err = c.Set(file); err != nil { + return nil, err + } + return file, nil +} + func (c *FileCache) Delete(id string) error { if err := c.redis.Delete(c.keyPrefix + id); err != nil { return nil diff --git a/api/docs/index.html b/api/docs/index.html index dc4fb422b..a6f58da66 100644 --- a/api/docs/index.html +++ b/api/docs/index.html @@ -12,352 +12,352 @@ margin: 0; } - -

Voltaserve API (2.0.0)

Download OpenAPI specification:Download

Files

Delete

Delete

-
Request Body schema: application/json
required

Body

-
ids
required
Array of strings

Responses

Request samples

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

Response samples

Content type
application/json
[
  • "string"
]

Get by Path

Get by Path

-
path Parameters
id
required
string

ID

-
query Parameters
path
required
string

Path

-

Responses

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

-
workspace_id
required
string

Workspace ID

-
parent_id
string

Parent ID

-
name
string

Name

-

Responses

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

Get

-
path Parameters
id
required
string

ID

-

Responses

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

-

Responses

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

Copy

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
ids
required
Array of strings

Responses

Request samples

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

Response samples

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

Count

Count

-
path Parameters
id
required
string

ID

-

Responses

Response samples

Content type
application/json
0
0

Get Group Permissions

Get Group Permissions

-
path Parameters
id
required
string

ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List

List

-
path Parameters
id
required
string

ID

-
query Parameters
type
string

Type

-
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-
query
string

Query

-

Responses

Response samples

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

Move

Move

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
ids
required
Array of strings

Responses

Request samples

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

Response samples

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

Patch Name

Patch Name

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
name
required
string <= 255 characters

Responses

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

-
query Parameters
access_token
required
string

Access Token

-
ext
required
string

Extension

-

Responses

Response samples

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

Patch from S3

Patch from S3

-
path Parameters
id
required
string

ID

-
query Parameters
api_key
required
string

API Key

-
access_token
required
string

Access Token

-
s3_key
required
string

S3 Key

-
s3_bucket
required
string

S3 Bucket

-
size
required
string

Size

-

Responses

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

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download Preview

Download Preview

-
path Parameters
id
required
string

ID

-
query Parameters
access_token
required
string

Access Token

-
ext
required
string

Extension

-

Responses

Response samples

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

Revoke Group Permission

Revoke Group Permission

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
groupId
required
string
ids
required
Array of strings

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

Get Size

-
path Parameters
id
required
string

ID

-

Responses

Response samples

Content type
application/json
0
0

Download Thumbnail

Download Thumbnail

-
path Parameters
id
required
string

ID

-
query Parameters
access_token
required
string

Access Token

-
ext
required
string

Extension

-

Responses

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

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create from S3

Create from S3

-
query Parameters
api_key
required
string

API Key

-
access_token
required
string

Access Token

-
workspace_id
required
string

Workspace ID

-
parent_id
string

Parent ID

-
name
string

Name

-
s3_key
required
string

S3 Key

-
s3_bucket
required
string

S3 Bucket

-
size
required
string

Size

-

Responses

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

-
Request Body schema: application/json
required

Body

-
groupId
required
string
ids
required
Array of strings
permission
required
string
Enum: "viewer" "editor" "owner"

Responses

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

-
Request Body schema: application/json
required

Body

-
ids
required
Array of strings
permission
required
string
Enum: "viewer" "editor" "owner"
userId
required
string

Responses

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

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Revoke User Permission

Revoke User Permission

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
ids
required
Array of strings
userId
required
string

Responses

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

-
organization_id
string

Organization ID

-
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-

Responses

Response samples

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

Create

Create

-
Request Body schema: application/json
required

Body

-
image
string
name
required
string <= 255 characters
organizationId
required
string

Responses

Request samples

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

Response samples

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

Delete

Delete

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Get

Get

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Remove Member

Remove Member

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
userId
required
string

Responses

Request samples

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

Response samples

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

Add Member

Add Member

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Patch Name

Patch Name

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
name
required
string <= 255 characters

Responses

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",
  • "updateTime": "string"
}

Health

Get

Get

-

Responses

Response samples

Content type
application/json
"string"

Insights

Delete

Delete

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Patch

Patch

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Create

Create

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
languageId
required
string

Responses

Request samples

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

Response samples

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

List Entities

List Entities

-
path Parameters
id
required
string

ID

-
query Parameters
query
string

Query

-
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Info

Get Info

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Download OCR

Download OCR

-
path Parameters
id
required
string

ID

-
query Parameters
access_token
required
string

Access Token

-
ext
required
string

Extension

-

Responses

Response samples

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

Download Text

Download Text

-
path Parameters
id
required
string

ID

-
query Parameters
access_token
required
string

Access Token

-
ext
required
string

Extension

-

Responses

Response samples

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

Get Languages

Get Languages

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invitations

Create

Create

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
emails
required
Array of strings
organizationId
required
string

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "organizationId": "string"
}

Response samples

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

Delete

Delete

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Accept

Accept

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Decline

Decline

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Resend

Resend

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Get Incoming

Get Incoming

-
query Parameters
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-

Responses

Response samples

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

Get Incoming Count

Get Incoming Count

-

Responses

Response samples

Content type
application/json
0
0

Get Outgoing

Get Outgoing

-
query Parameters
organization_id
required
string

Organization ID

-
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-

Responses

Response samples

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

Mosaic

Delete

Delete

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Create

Create

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Get Info

Get Info

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Download Tile

Download Tile

-
path Parameters
id
required
string

ID

-
zoom_level
required
string

Zoom Level

-
row
required
string

Row

-
col
required
string

Col

-

Responses

Response samples

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

Organizations

List

List

-
query Parameters
query
string

Query

-
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-

Responses

Response samples

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

Create

Create

-
Request Body schema: application/json
required

Body

-
image
string
name
required
string <= 255 characters

Responses

Request samples

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

Response samples

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

Delete

Delete

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Get

Get

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Leave

Leave

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Remove Member

Remove Member

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
userId
required
string

Responses

Request samples

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

Response samples

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

Patch Name

Patch Name

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
name
required
string <= 255 characters

Responses

Request samples

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

Response samples

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

Snapshots

List

List

-
query Parameters
file_id
required
string

File ID

-
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-

Responses

Response samples

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

Patch

Patch

-
path Parameters
id
required
string

ID

-
query Parameters
api_key
required
string

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

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

Activate

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
fileId
required
string

Responses

Request samples

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

Response samples

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

Detach

Detach

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
fileId
required
string

Responses

Request samples

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

Response samples

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

Storage

Get Account Usage

Get Account Usage

-

Responses

Response samples

Content type
application/json
{
  • "bytes": 0,
  • "maxBytes": 0,
  • "percentage": 0
}

Get file usage

Get file usage

-
query Parameters
id
required
string

File ID

-

Responses

Response samples

Content type
application/json
{
  • "bytes": 0,
  • "maxBytes": 0,
  • "percentage": 0
}

Get workspace usage

Get workspace usage

-
query Parameters
id
required
string

Workspace ID

-

Responses

Response samples

Content type
application/json
{
  • "bytes": 0,
  • "maxBytes": 0,
  • "percentage": 0
}

Tasks

List

List

-
query Parameters
query
string

Query

-
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-

Responses

Response samples

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

Create

Create

-
path Parameters
id
required
string

ID

-
query Parameters
api_key
required
string

API Key

-
Request Body schema: application/json
required

Body

-
error
string
isIndeterminate
boolean
name
string
percentage
integer
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

Dismiss

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Get

Get

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Patch

Patch

-
path Parameters
id
required
string

ID

-
query Parameters
api_key
required
string

API Key

-
Request Body schema: application/json
required

Body

-
error
string
fields
Array of strings
isIndeterminate
boolean
name
string
object
percentage
integer
status
string
userId
string

Responses

Request samples

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

Response samples

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

Dismiss

Dismiss

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Get Count

Get Count

-

Responses

Response samples

Content type
application/json
0
0

Dismiss All

Dismiss All

-

Responses

Response samples

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

Users

List

List

-
query Parameters
query
string

Query

-
organization_id
string

Organization ID

-
group
string

Group ID

-
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-

Responses

Response samples

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

Workspaces

List

List

-
query Parameters
query
string

Query

-
page
string

Page

-
size
string

Size

-
sort_by
string

Sort By

-
sort_order
string

Sort Order

-

Responses

Response samples

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

Create

Create

-
Request Body schema: application/json
required

Body

-
image
string
name
required
string <= 255 characters
organizationId
required
string
storageCapacity
integer

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "name": "string",
  • "organizationId": "string",
  • "storageCapacity": 0
}

Response samples

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

Delete

Delete

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Get

Get

-
path Parameters
id
required
string

ID

-

Responses

Response samples

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

Patch Storage Capacity

Patch Storage Capacity

-
path Parameters
id
required
string

Id

-
Request Body schema: application/json
required

Body

-
storageCapacity
required
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "storageCapacity": 1
}

Response samples

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

Patch Name

Patch Name

-
path Parameters
id
required
string

ID

-
Request Body schema: application/json
required

Body

-
name
required
string <= 255 characters

Responses

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"
}
+ " fill="currentColor">

Voltaserve API (2.0.0)

Download OpenAPI specification:Download

Files

Delete

Delete

+
Request Body schema: application/json
required

Body

+
ids
required
Array of strings

Responses

Request samples

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

Response samples

Content type
application/json
[
  • "string"
]

Get by Path

Get by Path

+
path Parameters
id
required
string

ID

+
query Parameters
path
required
string

Path

+

Responses

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

+
workspace_id
required
string

Workspace ID

+
parent_id
string

Parent ID

+
name
string

Name

+

Responses

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

Get

+
path Parameters
id
required
string

ID

+

Responses

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

+

Responses

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

+
targetId
required
string

Target ID

+

Responses

Response samples

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

Count

Count

+
path Parameters
id
required
string

ID

+

Responses

Response samples

Content type
application/json
0
0

Get Group Permissions

Get Group Permissions

+
path Parameters
id
required
string

ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List

List

+
path Parameters
id
required
string

ID

+
query Parameters
type
string

Type

+
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+
query
string

Query

+

Responses

Response samples

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

Move

Move

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
ids
required
Array of strings

Responses

Request samples

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

Response samples

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

Patch Name

Patch Name

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
name
required
string <= 255 characters

Responses

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

+
query Parameters
access_token
required
string

Access Token

+
ext
required
string

Extension

+

Responses

Response samples

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

Patch from S3

Patch from S3

+
path Parameters
id
required
string

ID

+
query Parameters
api_key
required
string

API Key

+
access_token
required
string

Access Token

+
s3_key
required
string

S3 Key

+
s3_bucket
required
string

S3 Bucket

+
size
required
string

Size

+

Responses

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

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download Preview

Download Preview

+
path Parameters
id
required
string

ID

+
query Parameters
access_token
required
string

Access Token

+
ext
required
string

Extension

+

Responses

Response samples

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

Revoke Group Permission

Revoke Group Permission

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
groupId
required
string
ids
required
Array of strings

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

Get Size

+
path Parameters
id
required
string

ID

+

Responses

Response samples

Content type
application/json
0
0

Download Thumbnail

Download Thumbnail

+
path Parameters
id
required
string

ID

+
query Parameters
access_token
required
string

Access Token

+
ext
required
string

Extension

+

Responses

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

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Copy Many

Copy Many

+
Request Body schema: application/json
required

Body

+
sourceIds
required
Array of strings
targetId
required
string

Responses

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

+
access_token
required
string

Access Token

+
workspace_id
required
string

Workspace ID

+
parent_id
string

Parent ID

+
name
string

Name

+
s3_key
required
string

S3 Key

+
s3_bucket
required
string

S3 Bucket

+
size
required
string

Size

+

Responses

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

+
Request Body schema: application/json
required

Body

+
groupId
required
string
ids
required
Array of strings
permission
required
string
Enum: "viewer" "editor" "owner"

Responses

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

+
Request Body schema: application/json
required

Body

+
ids
required
Array of strings
permission
required
string
Enum: "viewer" "editor" "owner"
userId
required
string

Responses

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

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Revoke User Permission

Revoke User Permission

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
ids
required
Array of strings
userId
required
string

Responses

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

+
organization_id
string

Organization ID

+
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+

Responses

Response samples

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

Create

Create

+
Request Body schema: application/json
required

Body

+
image
string
name
required
string <= 255 characters
organizationId
required
string

Responses

Request samples

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

Response samples

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

Delete

Delete

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Get

Get

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Remove Member

Remove Member

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
userId
required
string

Responses

Request samples

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

Response samples

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

Add Member

Add Member

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Patch Name

Patch Name

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
name
required
string <= 255 characters

Responses

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",
  • "updateTime": "string"
}

Health

Get

Get

+

Responses

Response samples

Content type
application/json
"string"

Insights

Delete

Delete

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Patch

Patch

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Create

Create

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
languageId
required
string

Responses

Request samples

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

Response samples

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

List Entities

List Entities

+
path Parameters
id
required
string

ID

+
query Parameters
query
string

Query

+
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Info

Get Info

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Download OCR

Download OCR

+
path Parameters
id
required
string

ID

+
query Parameters
access_token
required
string

Access Token

+
ext
required
string

Extension

+

Responses

Response samples

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

Download Text

Download Text

+
path Parameters
id
required
string

ID

+
query Parameters
access_token
required
string

Access Token

+
ext
required
string

Extension

+

Responses

Response samples

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

Get Languages

Get Languages

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invitations

Create

Create

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
emails
required
Array of strings
organizationId
required
string

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "organizationId": "string"
}

Response samples

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

Delete

Delete

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Accept

Accept

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Decline

Decline

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Resend

Resend

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Get Incoming

Get Incoming

+
query Parameters
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+

Responses

Response samples

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

Get Incoming Count

Get Incoming Count

+

Responses

Response samples

Content type
application/json
0
0

Get Outgoing

Get Outgoing

+
query Parameters
organization_id
required
string

Organization ID

+
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+

Responses

Response samples

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

Mosaic

Delete

Delete

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Create

Create

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Get Info

Get Info

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Download Tile

Download Tile

+
path Parameters
id
required
string

ID

+
zoom_level
required
string

Zoom Level

+
row
required
string

Row

+
col
required
string

Col

+

Responses

Response samples

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

Organizations

List

List

+
query Parameters
query
string

Query

+
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+

Responses

Response samples

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

Create

Create

+
Request Body schema: application/json
required

Body

+
image
string
name
required
string <= 255 characters

Responses

Request samples

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

Response samples

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

Delete

Delete

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Get

Get

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Leave

Leave

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Remove Member

Remove Member

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
userId
required
string

Responses

Request samples

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

Response samples

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

Patch Name

Patch Name

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
name
required
string <= 255 characters

Responses

Request samples

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

Response samples

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

Snapshots

List

List

+
query Parameters
file_id
required
string

File ID

+
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+

Responses

Response samples

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

Patch

Patch

+
path Parameters
id
required
string

ID

+
query Parameters
api_key
required
string

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

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

Activate

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
fileId
required
string

Responses

Request samples

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

Response samples

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

Detach

Detach

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
fileId
required
string

Responses

Request samples

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

Response samples

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

Storage

Get Account Usage

Get Account Usage

+

Responses

Response samples

Content type
application/json
{
  • "bytes": 0,
  • "maxBytes": 0,
  • "percentage": 0
}

Get file usage

Get file usage

+
query Parameters
id
required
string

File ID

+

Responses

Response samples

Content type
application/json
{
  • "bytes": 0,
  • "maxBytes": 0,
  • "percentage": 0
}

Get workspace usage

Get workspace usage

+
query Parameters
id
required
string

Workspace ID

+

Responses

Response samples

Content type
application/json
{
  • "bytes": 0,
  • "maxBytes": 0,
  • "percentage": 0
}

Tasks

List

List

+
query Parameters
query
string

Query

+
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+

Responses

Response samples

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

Create

Create

+
path Parameters
id
required
string

ID

+
query Parameters
api_key
required
string

API Key

+
Request Body schema: application/json
required

Body

+
error
string
isIndeterminate
boolean
name
string
percentage
integer
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

Dismiss

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Get

Get

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Patch

Patch

+
path Parameters
id
required
string

ID

+
query Parameters
api_key
required
string

API Key

+
Request Body schema: application/json
required

Body

+
error
string
fields
Array of strings
isIndeterminate
boolean
name
string
object
percentage
integer
status
string
userId
string

Responses

Request samples

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

Response samples

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

Dismiss

Dismiss

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Get Count

Get Count

+

Responses

Response samples

Content type
application/json
0
0

Dismiss All

Dismiss All

+

Responses

Response samples

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

Users

List

List

+
query Parameters
query
string

Query

+
organization_id
string

Organization ID

+
group
string

Group ID

+
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+

Responses

Response samples

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

Workspaces

List

List

+
query Parameters
query
string

Query

+
page
string

Page

+
size
string

Size

+
sort_by
string

Sort By

+
sort_order
string

Sort Order

+

Responses

Response samples

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

Create

Create

+
Request Body schema: application/json
required

Body

+
image
string
name
required
string <= 255 characters
organizationId
required
string
storageCapacity
integer

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "name": "string",
  • "organizationId": "string",
  • "storageCapacity": 0
}

Response samples

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

Delete

Delete

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Get

Get

+
path Parameters
id
required
string

ID

+

Responses

Response samples

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

Patch Storage Capacity

Patch Storage Capacity

+
path Parameters
id
required
string

Id

+
Request Body schema: application/json
required

Body

+
storageCapacity
required
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "storageCapacity": 1
}

Response samples

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

Patch Name

Patch Name

+
path Parameters
id
required
string

ID

+
Request Body schema: application/json
required

Body

+
name
required
string <= 255 characters

Responses

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"
}