Create a task

POST 
/wiki/convert/tasks

History

Version	Changes
v6.15.0	Added in v6.15.0

Create an import or export task.

Different page types support different export formats, as follows:

Page Type	Export Format
default	pdf,docx
collaboration	pdf,png,markdown
word	pdf,docx
excel	pdf,xlsx
ppt	pdf,pptx
collaborationPlugin	No restrictions, the supported formats are defined by the plugin

Request

Query Parameters

teamID stringrequired

The team ID

requestUserID string

User ID, this parameter can only be passed when calling as an Oauth bot. It is used to perform operations as the specified user

application/json

Body

required

taskType string

Possible values: [ExportPage]

Task type

payload

object

Task parameters

oneOf

MOD1

pageID string

Page ID

format string

Possible values: [pdf, png, docx, xlsx, pptx, markdown]

Export format

hideTitle boolean

Whether to hide the title, valid when the format is png

width integer

Possible values: <= 2560

Default value: 1280

Image width, valid when the format is png

height integer

Possible values: <= 1600

Default value: 800

Image height, valid when the format is png

Responses

200

Create successfully

application/json

Schema

Schema

data

object

id string

Task ID

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

errorData object

Error meta data for this request.

Example (from schema)

{
  "data": {
    "id": "string"
  },
  "result": "string",
  "errorCode": "string",
  "errorMsg": "string",
  "errorData": {}
}

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

Loading...