观远数据开放平台
返回最新版
当前版本V7.2.0
观远数据开放平台
  • 开发指南
  • 用户
  • 数据集
  • 仪表板
    • 获取页面列表POST
    • 根据页面名称关键词搜索页面POST
    • 获取指定页面有读权限的用户列表POST
    • 以树状结构获取页面列表POST
    • 以PDF或者图片模式导出仪表板POST
    • 获取仪表板导出文件POST
    • 获取页面基本信息GET
    • 获取页面信息GET
  • 订阅预警
  • 卡片
  • 权限
  • 资源操作
  • 卡片导出
  • session
  • 文件夹
  • 数据账户
  • 身份认证
  • 用户管理
logoPowered by Apifox

    获取页面信息

    GET/public-api/page/{pgId}

    :::note[接口简介]
    通过指定页面id,获取页面信息,BI V7.1及以上版本支持该接口
    :::

    请求参数

    Path 参数
    pgId
    string 
    必需
    示例值:
    bbb8ee5556b1c4ad2bf7f61e
    Header 参数
    token
    string 
    必需

    参考 token 鉴权, 获取应用token. GET请求 token 放在header里

    示例值:
    s5de3b9fa689140419b0b73f

    示例代码

    返回响应

    成功(200)
    HTTP 状态码: 200
    内容格式: JSONapplication/json
    数据结构
    result
    string 
    状态
    必需
    response
    #/definitions/349296
    可选
    Could not resolve '#/definitions/349296'
    error
    object 
    错误信息
    可选
    status
    number 
    错误码
    必需
    message
    string 
    信息
    必需
    detail
    object 
    详情
    必需
    示例
    成功示例
    {
      "result": "ok",
      "response": {
        "pgId": "f88ecade37f234d7aa0f7fb6",
        "domId": "guanbi",
        "name": "人力指数",
        "pgType": "PAGE",
        "description": "",
        "parentDirId": "o8e47ca4c959a4fbc93c27f3",
        "ctime": "2024-04-16 19:09:41+0800",
        "utime": "2024-04-16 19:10:30+0800",
        "cards": [
          {
            "cdType": "CHART",
            "cdId": "w54625bffb1c84a9885101fd",
            "name": "迷你图值不展示",
            "description": "描述信息",
            "dsId": "r6962c818892942b4aefb588",
            "ctime": "2024-04-16 19:09:46+0800",
            "utime": "2024-12-13 18:04:26+0800"
          }
        ],
        "dsInfos": [
          {
            "dsId": "r6962c818892942b4aefb588",
            "name": "人力指数",
            "columns": [
              {
                "name": "编号ID",
                "fdType": "LONG",
                "fdId": "bdf5fe24dc90748a493e240e"
              },
              {
                "name": "配送数",
                "fdType": "LONG",
                "fdId": "ecdde89b277df4dafb2cfc17"
              },
              {
                "name": "省份",
                "fdType": "STRING",
                "fdId": "h0fc56cec830744628aec864"
              },
              {
                "name": "日期",
                "fdType": "DATE",
                "fdId": "i8d1efb1411f84c1c86e1ec4"
              },
              {
                "name": "产地",
                "fdType": "STRING",
                "fdId": "ic37729f3ff3b43af81dadae"
              },
              {
                "name": "区县",
                "fdType": "STRING",
                "fdId": "if81dd884f7b04ee28c404f7"
              },
              {
                "name": "人力指数",
                "fdType": "DECIMAL",
                "fdId": "j02e2a3adde474e3b8ff0edc"
              },
              {
                "name": "单位",
                "fdType": "STRING",
                "fdId": "keebfa984ea0d4d0b9375043"
              },
              {
                "name": "商品分类",
                "fdType": "STRING",
                "fdId": "l739f8e4a15a142aa82cd3a1"
              },
              {
                "name": "商品编号",
                "fdType": "LONG",
                "fdId": "m1760bb6da1934996a27953e"
              },
              {
                "name": "订购数量",
                "fdType": "LONG",
                "fdId": "mda3f6b92d9f845a98e5a9c3"
              },
              {
                "name": "商品条码",
                "fdType": "LONG",
                "fdId": "nae761f9c69e640208ead2a2"
              },
              {
                "name": "城市代码",
                "fdType": "LONG",
                "fdId": "o3549de108c074289b8d6fc7"
              },
              {
                "name": "规格",
                "fdType": "STRING",
                "fdId": "o9154773a20d645a2a3cec8f"
              },
              {
                "name": "城市",
                "fdType": "STRING",
                "fdId": "paa209cddc5bd4a26adf07d0"
              },
              {
                "name": "经度",
                "fdType": "DOUBLE",
                "fdId": "pcf1e408b67894e9ebe0ed38"
              },
              {
                "name": "大区",
                "fdType": "STRING",
                "fdId": "pd086ee727d06429db1932c4"
              },
              {
                "name": "纬度",
                "fdType": "DOUBLE",
                "fdId": "pf219822d2c914b7b85b58f1"
              },
              {
                "name": "省份代码",
                "fdType": "LONG",
                "fdId": "r0bbb185e6a9641feafeffc4"
              },
              {
                "name": "销售金额",
                "fdType": "DOUBLE",
                "fdId": "t077332f9022a48999256074"
              },
              {
                "name": "销售数量",
                "fdType": "LONG",
                "fdId": "tfd36b44fb9ab4d0886d4d79"
              },
              {
                "name": "库存状况",
                "fdType": "STRING",
                "fdId": "va7da3e99218347e1b5fd708"
              },
              {
                "name": "商品名称",
                "fdType": "STRING",
                "fdId": "vfb72519ff0db48c6984cc70"
              },
              {
                "name": "成本价",
                "fdType": "DOUBLE",
                "fdId": "x2269799b1ccb46568d34428"
              },
              {
                "name": "零售价",
                "fdType": "DOUBLE",
                "fdId": "x6488e421b197423dbe6ff4e"
              },
              {
                "name": "区县代码",
                "fdType": "LONG",
                "fdId": "xbdbf24cc0e7f4b578e121bb"
              }
            ]
          }
        ]
      }
    }
    最后修改时间: 3 个月前
    上一页
    GET获取页面基本信息
    举报