以PDF或者图片模式导出仪表板

POST

/public-api/page/export

接口简介

如果指定了具体的用户信息，将以特定的用户名义（数据权限）导出PDF或者图片。
特别说明：
① 该接口为限时免费API接口。不排除未来额外收费可能。
② 6.0 仅支持导出PC视图的图片与PDF。

请求参数

Body 参数application/json

token

string

应用Token

必需

在观远平台管理员设置-系统集成-统一账户集成中获得

pgId

string

页面ID

必需

selectorValues

array [object {2}]

必需

selectorId

string

必需

defaultValue

string

必需

loginId

string

账号

可选

如a@b.com; 如果uId也填写了，优先使用loginId

uId

string

用户ID

可选

系统中的ID，为一个字符串。如果LoginID与uId都不填写，则以管理员名义导出

orientation

string | null

导出模式

可选

分页模式填写 vertical 或者 horizontal ；单页模式填写导出宽度，如 1400 或者 1024

locale

string

语言偏好

可选

默认值zh-CN

exportType

string

导出类型

必需

支持PDF、IMAGE；默认PDF

示例

{
    "token": "string",
    "pgId": "string",
    "selectorValues": [
        {
            "selectorId": "string",
            "defaultValue": "string"
        }
    ],
    "loginId": "string",
    "uId": "string",
    "orientation": "string",
    "locale": "string",
    "exportType": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/page/export' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string",
    "pgId": "string",
    "selectorValues": [
        {
            "selectorId": "string",
            "defaultValue": "string"
        }
    ],
    "loginId": "string",
    "uId": "string",
    "orientation": "string",
    "locale": "string",
    "exportType": "string"
}'

返回响应

🟢200成功

application/json

Body

result

string

请求状态

必需

枚举值: ok、fail

response

object

响应结果

必需

taskId

string

任务ID

必需

status

string

状态

必需

result

string

结果

必需

fileName

string

文件名

必需

示例

{
    "result": "ok",
    "response": {
        "taskId": "c86ab4a0-8867-11ef-b68b-15a5321b68c9",
        "status": "已提交",
        "result": "处理中",
        "fileName": "a66dc01f2cb664284b3927d0_c97640db7948f4e718692ad9.png"
    }
}

修改于 2025-10-31 01:28:23

以树状结构获取页面列表

获取仪表板导出文件