Cloud Storage List #

🔑 Need JWT Authorization

Description #

List cloud storage file and directory

Method And Path #

POST /v2/cloud-storage/list

Request #

Header #

{
    "authorization": string;
    "x-request-id": string;
    "x-session-id": string;
}

Body #

{
    "page": number;
    "directoryPath": string;
    "size"?: number;
    "order"?: "ASC" | "DESC";
}

page #

• minimum: 1
• maximum: 50

directoryPath #

Path to the folder to be viewed

• minLength: 1
• maxLength: 300
• format: directory-path

size #

Number of displays per page

• default: 50
• minimum: 1
• maximum: 50

order #

Sort by file creation time

• enum: ASC | DESC
• default: ASC

Response #

Success #

HTTP Status Code: 200

{
    status: Status.Success,
    data: {
        totalUsage: number;
        files: Array<{
            fileUUID: string;
            fileName: string;
            fileSize: number;
            fileURL: string;
            resourceType: FileResourceType;
            createAt: number;
            meta: {
                whiteboardConvert?: WhiteboardConvertPayload;
                whiteboardProjector?: WhiteboardProjectorPayload;
            }
        }>;
        canCreateDirectory: boolean;
    }
}

Extends Type: Status, WhiteboardConvertPayload, WhiteboardProjectorPayload, FileResourceType

totalUsage #

Total usage of current users

files[].fileUUID #

UUID of the current document

files[].fileName #

Current file name

files[].fileSize #

Only the following file categories exist with file sizes

• FileResourceType.WhiteboardConvert
• FileResourceType.WhiteboardProjector
• FileResourceType.NormalResources

For other categories, this value is 0

files[].fileURL #

When FileResourceType.Directory, this value is a meaningless string and can be ignored

files[].createAt #

Creation time of the document

files[].resourceType #

For more information: FileResourceType

files[].meta?.whiteboardConvert #

For more information: WhiteboardConvertPayload

files[].meta?.whiteboardProjector #

For more information: WhiteboardProjectorPayload

canCreateDirectory #

Is it possible to continue creating new directories in the current directory

Failed #

HTTP Status Code: 200

{
    status: Status.Failed,
    code: ErrorCode
}

Extends Type: Status, ErrorCode