Upload
workspace_id required | string Workspace ID |
parent_id | string Parent ID |
{- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
{- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
{- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
Copy
id required | string ID |
Body
ids required | Array of strings |
{- "ids": [
- "string"
]
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
{- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
[- {
- "group": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "updateTime": "string"
}, - "id": "string",
- "permission": "string"
}
]
[- {
- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
]
[- {
- "id": "string",
- "permission": "string",
- "user": {
- "createTime": "string",
- "email": "string",
- "fullName": "string",
- "id": "string",
- "picture": "string",
- "updateTime": "string",
- "username": "string"
}
}
]
ListByID
id required | string ID |
type | string Type |
page | string Page |
size | string Size |
sort_by | string Sort By |
sort_order | string Sort Order |
{- "data": [
- {
- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
], - "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0
}
Move
id required | string ID |
Body
ids required | Array of strings |
{- "ids": [
- "string"
]
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
Rename
id required | string ID |
Body
name required | string <= 255 characters |
{- "name": "string"
}
{- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
Revoke group permission
id required | string ID |
Body
groupId required | string |
ids required | Array of strings |
{- "groupId": "string",
- "ids": [
- "string"
]
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
Update OCR language
id required | string ID |
Body
id required | string |
{- "id": "string"
}
{- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
{- "ids": [
- "string"
]
}
[- {
- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
]
Update snapshot
Body
object (model.S3Object) | |
object (client.PipelineRunOptions) | |
object (model.S3Object) | |
object (model.S3Object) | |
object (model.S3Object) | |
object (model.Thumbnail) |
{- "ocr": {
- "bucket": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "key": "string",
- "language": "string",
- "size": 0
}, - "options": {
- "bucket": "string",
- "fileId": "string",
- "isAutomaticOcrEnabled": true,
- "key": "string",
- "ocrLanguageId": "string",
- "snapshotId": "string"
}, - "original": {
- "bucket": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "key": "string",
- "language": "string",
- "size": 0
}, - "preview": {
- "bucket": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "key": "string",
- "language": "string",
- "size": 0
}, - "text": {
- "bucket": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "key": "string",
- "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
Create
Body
name required | string <= 255 characters |
parentId | string |
workspaceId required | string |
{- "name": "string",
- "parentId": "string",
- "workspaceId": "string"
}
{- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
{- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
Grant group permission
id required | string ID |
Body
groupId required | string |
ids required | Array of strings |
permission required | string Enum: "viewer" "editor" "owner" |
{- "groupId": "string",
- "ids": [
- "string"
], - "permission": "viewer"
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
Grant user permission
id required | string ID |
Body
ids required | Array of strings |
permission required | string Enum: "viewer" "editor" "owner" |
userId required | string |
{- "ids": [
- "string"
], - "permission": "viewer",
- "userId": "string"
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
[- {
- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
]
Revoke user permission
id required | string ID |
Body
ids required | Array of strings |
userId required | string |
{- "ids": [
- "string"
], - "userId": "string"
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
Search
page required | string Page |
size required | string Size |
Body
createTimeAfter | integer |
createTimeBefore | integer |
parentId | string |
text required | string |
type | string Enum: "file" "folder" |
updateTimeAfter | integer |
updateTimeBefore | integer |
workspaceId required | string |
{- "createTimeAfter": 0,
- "createTimeBefore": 0,
- "parentId": "string",
- "text": "string",
- "type": "file",
- "updateTimeAfter": 0,
- "updateTimeBefore": 0,
- "workspaceId": "string"
}
{- "data": [
- {
- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "parentId": "string",
- "permission": "string",
- "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "snapshots": [
- {
- "id": "string",
- "language": "string",
- "ocr": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "original": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "preview": {
- "extension": "string",
- "image": {
- "height": 0,
- "width": 0
}, - "language": "string",
- "size": 0
}, - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "version": 0
}
], - "thumbnail": {
- "base64": "string",
- "height": 0,
- "width": 0
}, - "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"
}
], - "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0
}
List
query | string Query |
organization_id | string Organization ID |
page | string Page |
size | string Size |
sort_by | string Sort By |
sort_order | string Sort Order |
{- "data": [
- {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "updateTime": "string"
}
], - "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0
}
Create
Body
image | string |
name required | string <= 255 characters |
organizationId required | string |
{- "image": "string",
- "name": "string",
- "organizationId": "string"
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "updateTime": "string"
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "updateTime": "string"
}
Remove member
id required | string ID |
Body
userId required | string |
{- "userId": "string"
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
Update name
id required | string ID |
Body
name required | string <= 255 characters |
{- "name": "string"
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "updateTime": "string"
}
Create
id required | string ID |
Body
emails required | Array of strings |
organizationId required | string |
{- "emails": [
- "string"
], - "organizationId": "string"
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
Get incoming
page | string Page |
size | string Size |
sort_by | string Sort By |
sort_order | string Sort Order |
{- "data": [
- {
- "createTime": "string",
- "email": "string",
- "id": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "owner": {
- "createTime": "string",
- "email": "string",
- "fullName": "string",
- "id": "string",
- "picture": "string",
- "updateTime": "string",
- "username": "string"
}, - "status": "string",
- "updateTime": "string"
}
], - "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0
}
Get outgoing
organization_id required | string Organization ID |
page | string Page |
size | string Size |
sort_by | string Sort By |
sort_order | string Sort Order |
{- "data": [
- {
- "createTime": "string",
- "email": "string",
- "id": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "owner": {
- "createTime": "string",
- "email": "string",
- "fullName": "string",
- "id": "string",
- "picture": "string",
- "updateTime": "string",
- "username": "string"
}, - "status": "string",
- "updateTime": "string"
}
], - "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0
}
List
query | string Query |
page | string Page |
size | string Size |
sort_by | string Sort By |
sort_order | string Sort Order |
{- "data": [
- {
- "id": "string",
- "iso639pt3": "string",
- "name": "string"
}
], - "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0
}
List
query | string Query |
page | string Page |
size | string Size |
sort_by | string Sort By |
sort_order | string Sort Order |
{- "data": [
- {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"
}
], - "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0
}
Create
Body
image | string |
name required | string <= 255 characters |
{- "image": "string",
- "name": "string"
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}
Remove member
id required | string ID |
Body
userId required | string |
{- "userId": "string"
}
{- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"
}
Update name
id required | string ID |
Body
name required | string <= 255 characters |
{- "name": "string"
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}
List
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 |
{- "data": [
- {
- "createTime": "string",
- "email": "string",
- "fullName": "string",
- "id": "string",
- "picture": "string",
- "updateTime": "string",
- "username": "string"
}
], - "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0
}
List
query | string Query |
page | string Page |
size | string Size |
sort_by | string Sort By |
sort_order | string Sort Order |
{- "data": [
- {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"
}
], - "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0
}
Create
Body
image | string |
name required | string <= 255 characters |
organizationId required | string |
storageCapacity | integer |
{- "image": "string",
- "name": "string",
- "organizationId": "string",
- "storageCapacity": 0
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"
}
Update is automatic OCR enabled
id required | string ID |
Body
isEnabled required | boolean |
{- "isEnabled": true
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"
}
Update name
id required | string ID |
Body
name required | string <= 255 characters |
{- "name": "string"
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"
}
Update storage capacity
id required | string Id |
Body
storageCapacity required | integer >= 1 |
{- "storageCapacity": 1
}
{- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization": {
- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"
}, - "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"
}