Skip to content
On this page

Cloud Storage Finish Convert

🔑 Need JWT Authorization

Description

Finish convert file to cloud storage

INFO

Only support WhiteboardConvert and WhiteboardProjector file resource type.

ConvertStep must is FileConvertStep.Converting or FileConvertStep.Done

  1. Upload file Finish (ppt / pptx / pdf e.g.)
  2. Request /v2/cloud-storage/convert/start
  3. Use /v2/cloud-storage/convert/start response data query convert progress
  4. Query file convert finish (Native)
  5. Request /v2/cloud-storage/convert/finish
  6. Done

Method And Path

js
POST /v2/cloud-storage/convert/finish

Request

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

Body

ts
{
    "fileUUID": string;
}

fileUUID

File uuid

Response

Success

HTTP Status Code: 200

ts
{
    status: Status.Success,
    data: {}
}

Extends Type: Status

TIP

If server query status is Waiting / Converting, or convertStep is FileConvertStep.None, request will failed.

If query status is Finished, database will update convertStep to FileConvertStep.Done

If query status is Fail, database will update convertStep to FileConvertStep.Failed

Failed

HTTP Status Code: 200

ts
{
    status: Status.Failed,
    code: ErrorCode
}

Extends Type: Status, ErrorCode

Released under the MIT License.