反馈已提交

网络繁忙

您好,只有最新版本的6.X支持在线编辑修改,如果想创建/编辑文档,请移步到 *最新版本*

数据更新接口

  • 文档创建者:Carly
  • 历史版本:7
  • 最近更新:Carly 于 2024-04-26
  • 概述

    版本

    FineBI服务器版本
    功能变更
    5.1-

    功能简介

    本文讲解FineBI5.1中数据更新相关接口。

    触发全局更新

    接口简介



    接口作用触发全局更新
    接口URL/v5/api/conf/update/generate
    请求类型GET
    注意事项

    1)该接口仅适用于2020-11-03 及之后的 JAR

    2)必须对应内容存在更新任务方可触发更新

    响应实



    请求示例

    http://172.17.0.20:37799/webroot/decision/v5/api/conf/update/generate?fine_auth_token=xxx

    注:使用接口时需要登录,需要传递token参数。

    响应成功

    callback({

        "success"true,

        "code""200",

        "message""success",

        "data": {

            "taskInstanceId""5531f80d-05ac-463d-8622-39da062f6e40",

            "failBeans": []

        },

        "errorCode"null,

        "detailErrorMsg"null,

        "errorMsg"null

    })

    截图示意

    触发单表/文件夹更新

    接口简介



    接口作用根据表转义名,进行单表/文件夹更新。
    接口URL/v5/api/conf/update/pack/table
    请求类型GET
    注意事项

    1)该接口仅适用于2020-11-03 及之后的 JAR

    2)必须对应内容存在更新任务方可触发更新

    请求参数-Query参数

    参数名
    参数值是否必填描述说明
    info{"packageId":"业务包ID","tableName":"表转义名","fullLoad":"false"}
    注:参数值格式为JSON,使用时需要进行编码 encodeURIComponent()

    1)业务包ID:

    2)表转义名:

    表转义名即为在数据准备中看到的表名称

    3)fullload:

       false:增量更新

       true:全量更新

       不填:默认为 true

    响应实例



    请求示例

    编码前参数值:

    {"packageId":"c9dcb29695ba4d77a71fed73ea259720","tableName":"各省招生人数表","fullLoad":"true"}

    编码后参数值:

    %7B%22packageId%22%3A%22c9dcb29695ba4d77a71fed73ea259720%22%2C%22tableName%22%3A%22%E5%90%84%E7%9C%81%E6%8B%9B%E7%94%9F%E4%BA%BA%E6%95%B0%E8%A1%A8%22%2C%22fullLoad%22%3A%22true%22%7D

    链接:

    http://172.17.0.20:37799/webroot/decision/v5/api/conf/update/pack/table?info=%7B%22packageId%22%3A%22c9dcb29695ba4d77a71fed73ea259720%22%2C%22tableName%22%3A%22%E5%90%84%E7%9C%81%E6%8B%9B%E7%94%9F%E4%BA%BA%E6%95%B0%E8%A1%A8%22%2C%22fullLoad%22%3A%22true%22%7D&fine_auth_token=xxx

    注:使用接口时需要登录,需要传递token参数。

    响应成功

    callback({

        "success"true,

        "code""200",

        "message""success",

        "data": {

            "taskInstanceId""295dbc3f-cfa5-41bb-8077-bb19597a9ce9",

            "failBeans": []

        },

        "errorCode"null,

        "detailErrorMsg"null,

        "errorMsg"null

    })

    截图示意

    触发批量更新

    接口简介



    接口作用根据业务包ID,进行批量更新。
    接口URL

    /v5/api/conf/update/batch

    请求类型POST
    注意事项

    1)该接口仅适用于2020-11-03 及之后的 JAR

    2)必须对应内容存在更新任务方可触发更新

    请求参数-body参数

    body是否必填描述说明

    [

    {"packageId":"业务包ID","fullLoad":false}

    ]

    1)业务包ID:

    2)fullload:

       false:增量更新

       true:全量更新

       不填:默认为 true

    响应实例



    请求链接

    http://172.17.0.20:37799/webroot/decision/v5/api/conf/update/batch?fine_auth_token=xxx

    注:使用接口时需要登录,需要传递token参数。

    请求body

    [

    {"packageId":"c9dcb29695ba4d77a71fed73ea259720","fullLoad":false}

    ]

    响应成功

    callback({

        "success"true,

        "code""200",

        "message""success",

        "data": {

            "taskInstanceId""db810347-7605-4d7e-af25-e26fb039abc0",

            "failBeans": []

        },

        "errorCode"null,

        "detailErrorMsg"null,

        "errorMsg"null

    })

    截图示意

    获取此次更新实例的信息

    接口简介



    接口作用根据更新任务ID,获取此次更新信息。
    接口URL

    /v5/api/conf/update/instance/{taskInstanceId}

    请求类型GET
    注意事项1)taskInstanceId为更新任务ID
    2)该接口仅适用于2020-11-03 及之后的 JAR

    响应实例



    请求示例

    http://172.17.0.20:37799/webroot/decision/v5/api/conf/update/instance/f648e5eb-33ee-4ec9-94de-433c4699c272?fine_auth_token=xxx

    注:使用接口时需要登录,需要传递token参数。

    响应成功

    callback({

        "success"true,

        "code""200",

        "message""success",

        "data": {

            "taskInstanceId""f648e5eb-33ee-4ec9-94de-433c4699c272",

            "taskName""全局更新任务",

            "startTime"1667209490102,

            "endTime"1667209540668,

            "state"1,

            "triggerType"1,

            "resultType"1,

            "roleName""API",

            "baseTableExpect"126,

            "baseTableFinish"126,

            "analysisTableExpect"30,

            "analysisTableFinish"30,

            "relationExpect"47,

            "relationFinish"47,

            "auth"true,

            "process"0.0

        },

        "errorCode"null,

        "detailErrorMsg"null,

        "errorMsg"null

    })

    截图示意

    响应参数说明

    参数
    值说明
    taskInstanceId更新任务ID
    taskName更新任务名称
    startTime更新开始时间
    endTime更新结束时间
    state

    更新状态

    1:已结束

    2:正在运行中

    triggerType

    触发方式

    1:手动

    2:定时

    3:内部

    resultType运行结果

    1:全部成功

    2:部分成功


    附件列表


    主题: 部署集成
    已经是第一篇
    已经是最后一篇
    • 有帮助
    • 没帮助
    • 只是浏览

    售前咨询电话

    400-811-8890转1

    在线技术支持

    请前往「服务平台」,选择「在线支持」

    热线电话:400-811-8890转2

    在线QQ(将在2023.01.03关停):800049425

    总裁办24H投诉

    热线电话:173-1278-1526

    文 档反 馈

    鼠标选中内容,快速反馈问题

    鼠标选中存在疑惑的内容,即可快速反馈问题,我们将会跟进处理。

    不再提示

    10s后关闭