百数帮助
首页
帮助文档
后端python
开放平台
私有云
场景案例
更新日志
返回控制台
返回控制台
为你搜索到35个相关结果
搜索热词:
数据权限
注册
登录
导出与导入
对外展示
数据管理
百数
全部
帮助文档
后端python
开放平台 (
35
)
私有云
场景案例
webhook开发指南
数据推送成功。其他的
返回
结果
则为
返回
信息错误,用户可以根据HTTP状态码自行定义推送错误的情况给百数的
返回
码,百数接受后,可在推送日志中显示出。
结果
处理所有推送的详情可在日志中查询。错误处理一次推送重试最多5次,如果单次推送连续重试5次均失败,则该次推送失败,此时会记录该数据在失败记录里。同一数据推送,推送失败10次,该推送功能将被关闭,管理会获得消息通知(站内信息),则需要管理员在推送设置中重新
表单webhook
的时间、地址、事件、
结果
、推送详情。推送详情中可以查看到推送内容、状态码、推送时间、错误详情等信息,如果事件推送错误了还以在此处查看到具体信息。放弃推送重新推送当数据推送失败后,可以选择重新推送或者放弃推送。表单数据结构字段对照表及JSON样例表单数据结构字段对照表及JSON样例中可以查询表单数据及其字段的具体类型格式信息,用户在开发时可以在此处参照相关信息。表单数据结构:字段对照表及JSON样例
通讯录webhook
的时间、地址、事件、
结果
、推送详情。推送详情中可以查看到推送内容、状态码、推送时间、错误详情等信息,如果事件推送错误了还以在此处查看到具体信息。放弃推送重新推送当数据推送失败后,可以选择重新推送或者放弃推送。推送事件通讯录页面操作、功能插件、后端、开放平台接口等方式更新表单均会触发通讯录webhook推送。推送事件详情成员变更(普通团队):推送事件eventType触发场景通讯录用户增加[页面]u
开发指南
误原因。接口正确统一
返回
HTTP状态码为2xx的正确响应。接口错误统一
返回
HTTP状态码为400的错误响应,同时响应内容会
返回
错误码(code)和错误信息(message)。如:HTTP/1.1400ContentType:application/json{"code":4004,"message":"超出请求频率限制",}状态
返回
码对照表如下:错误码(code)说明2xx响应成功400响应失败当
新增数据
dataObject
返回
数据内容data.appId572177e6951f4dc54168c1ebString应用iddata.entryId5ebc5c2deee7ea61f7ac25dfString表单iddata.creatorObject提交人data.deleternullObject删除人data.updaternullObject更新人data.createTime20220119
查询单条数据
dataObject
返回
数据内容data.appId572177e6951f4dc54168c1ebString应用iddata.entryId5ebc5c2deee7ea61f7ac25dfString表单iddata.creatorObject提交人data.deleternullObject删除人data.updaterObject更新人data.createTime2022011911:4
查询多条数据
dataObject
返回
数据内容data.appId572177e6951f4dc54168c1ebString应用iddata.entryId5ebc5c2deee7ea61f7ac25dfString表单iddata._id5a0a96541a1edd8f444a9181Stringdata.flowStateString流程状态,该字段仅流程表单支持2表示流程手动结束1表示流程已结束0表示流
新增唯一数据
新增唯一数据描述根据指定的字段在指定表单新增一条数据,当指定字段的值已经存在的时候,不进行新增,并
返回
已经存在的数据的ID使用须知开发前,请仔细阅读[开发指南]。POST请求头{"Authorization":"BearerYOUR_APIKEY"}YOUR_APIKEY请阅读开发指南了解。接口URLPOST/openapi/v1/app/{app_id}/entry/{entry_id}/uni
新增多条唯一数据
新增多条唯一数据描述根据指定的字段在指定表单新增多条数据,当指定字段的值已经存在的时候,不进行新增,并
返回
已经存在的数据的ID使用须知开发前,请仔细阅读[开发指南]。POST请求头{"Authorization":"BearerYOUR_APIKEY"}YOUR_APIKEY请阅读开发指南了解。接口URLPOST/openapi/v1/app/{app_id}/entry/{entry_id}/b
查询流程待办信息
dataObject
返回
数据data.dataId562429be4c270a7ad636e808String数据iddata.appId572177e6951f4dc54168c1ebString应用iddata.entryId5ebc5c2deee7ea61f7ac25dfString表单iddata.entryName流程表单String表单名称data.flowId1Number节点idd
查询数据视图数据
dataObject
返回
数据响应数据样例{"count":17,"data":[{"单行文本":"张三","多行文本":"webapi","数字":8,"日期时间":"2019010100:00:00","单选按钮组":"一年级","复选框组":["选项1"],"下拉框":"女","下拉复选框":["选项1"],"地址":{"province":"湖南省","city":"长沙市","distri
查询聚合表数据
数dataArray
返回
数据data.dataId213eb543547e16454a403a07String聚合表数据id响应数据样例{"count":6,"data":[{"dataId":"213eb543547e16454a403a07","商品名称":"布丁智能手机","规格":"V3","单位":"台","库存":1}]}
修改外部联系人分组名称
dataObject
返回
数据data.group_idbc8e38f3668b2c11c0594554String外部联系人分组iddata.name外部分组String外部联系人分组名称响应数据样例{"data":{"group_id":"bc8e38f3668b2c11c0594554","name":"外部分组"}}
登录账号
登录成功String
返回
文字描述urlString登录跳转url,url有效时间为60秒响应数据样例{"msg":"登录成功","url":"https://www.xxxxx.com/sso/loginjump?responseeyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqdW1wdXJsIiwiYXVkIjoiY29tLmJhaWJhb3l1
POST接口
POST接口简介以下接口路径中的app_id表示应用ID,可以前往开放平台的API文档进行查看。POST/openapi/v1/app/{app_id}/post请求参数:能自定义传入json结构数据,将传入的数据发送给后端事件_webapi,
返回
自定义json结构数据。请求数据样例:POST链接:/openapi/v1/app/53088c7168f355d186424f72/post{"tim
单点登录
的安全断言和用户信息
返回
给本系统,本系统将用户与系统内账号系统关联。2.自定义接口:简化的SAML协议,企业客户可在现有SSO接口基础上进行修改,按照本系统的要求调用服务和
返回
参数,并将认证后的用户信息
返回
给本系统,完成账号关联。工作原理SAML(安全断言标记语言)是一种XML开放标准,SAML2.0和自定义接口都基于这种协议。SAML用于在服务提供者(SP,ServiceProvider,这里指
开发指南
并将其通过配置的方式
返回
给本系统,本系统即可识别此成员并提供后续服务。本系统支持两种协议的单点登录:SAML主要针对认证系统中已经集成了相关功能,或背景知识较强的用户。优点:通用协议,如果已集成了相关功能则可以直接配置复用,也可以使用如OneLogin这样的认证服务提供者。缺点:如果没有集成相关功能,用户需要自行开发对接层,开发难度较高。自定义接口主要针对自己开发相关接口与本系统对接的用户。优点:
SAML2.0配置
SAML2.0配置功能说明SAML2.0:安全断言标记语言,使用统一的身份提供服务(IDP)验证用户身份,然后将认证后的安全断言和用户信息
返回
给本系统,并将用户与本系统内的账号系统关联。单点登录需要在开放平台进行设置。使用现有系统的SAML功能如果用户使用的系统中集成了SAML功能,用户可以自行查阅相关资料进行配置。同阿里云IDaaS对接实例(SAML2.0)1.在阿里云IDaaS中创建SAML应
自定义接口配置
自定义接口配置功能简介SAML2是一个标准的SSO协议,并受WindowsAD支持,因此在SSO领域有着广泛的应用,但其要求开发者具有一定的背景知识(),对接成本较高,因此我们补充实现了自定义接口。自定义接口是简化的SAML协议,企业客户可在现有SSO接口基础上进行修改,按照本系统的要求调用服务和
返回
参数,并将认证后的用户信息
返回
给本系统,完成账号关联。IdP配置说明自定义接口的整体配置与SAML
查询账号列表
查询账号列表描述查询指定账号基本信息使用须知开发前,请仔细阅读[开发指南]。POST请求头{"Authorization":"BearerYOUR_APIKEY"}YOUR_APIKEY请阅读开发指南了解。接口URLPOST/openapi/v1/account/account_list请求参数参数名示例值参数类型是否必填参数描述uid0Number否上一次查询
结果
的最后条数据的uid,默认为0l
为用户赠送指定配置
sgString成功
返回
文字描述响应数据样例{"code":200,"msg":"成功"}
安装模板应用
sg成功String
返回
文字描述响应数据样例{"code":200,"msg":"成功"}
应用分组重命名
sg成功String
返回
文字描述响应数据样例{"code":200,"msg":"成功"}
应用分组删除
sg成功String
返回
文字描述响应数据样例{"code":200,"msg":"成功"}
修改站点公告
sg成功String
返回
文字描述响应数据样例{"code":200,"msg":"成功"}
错误对照表
错误对照表所有API使用【状态码+错误码】的响应方式来表示错误原因。接口正确统一
返回
HTTP状态码为2xx的正确响应。接口错误统一
返回
HTTP状态码为400的错误响应,同时响应内容会
返回
错误码(code)和错误信息(message)。如:HTTP/1.1400ContentType:application/json{"code":4004,"message":"超出请求频率限制",}状态
返回
码对照
查询登录日志
logsObject
返回
数据内容logs.corp_id5593fa9494be5331b6215267String团队idlogs.corp_name团队名称String团队名称logs.user_id5d66359813f33ef2e45916f2String登录用户idlogs.username张三String登录用户名称logs.avatarurlString登录用户头像链接logs.lo
查询日志类型
ypesObject
返回
内容types.201导出通讯录String类型id和对应类型名称响应数据样例{"types":{"201":"导出通讯录","202":"邀请成员","203":"转为已删除成员","204":"删除成员","205":"修改成员信息","206":"添加部门","207":"删除部门","208":"修改部门名称","209":"添加普通管理组","210":"删除普通
查询平台操作日志
logsObject
返回
数据内容logs.corp_id5593fa9494be5331b6215267String团队idlogs.corp_name团队名称String团队名称logs.type251String日志类型idlogs.type_name删除密钥String日志类型名称logs.detailsObject操作内容logs.details.content删除了密钥「密钥名称」Str
查询应用日志
logsObject
返回
数据内容logs.corp_id5593fa9494be5331b6215267String团队idlogs.corp_name团队名称String团队名称logs.app_id5bcb4b8c43da8fec55021cb4String应用idlogs.app_name应用名称String应用名称logs.app_removedfalseBoolean应用是否删除logs
自定义数据打印
hGg"}]]}}}
返回
参数参数说明::url打印文件URL链接size打印文件大小响应示例:{"url":"https://XXX.XXX.com/e6159bd0c0318281bcc2265e9af06e03","size":52803}使用接口步骤以调用Word打印模板为例:第一步:本地设计Word打印模板,并将${mark\_key}写入Word打印模板。Word打印模板设计第二步:表单
修改webhook
cessString
返回
文字描述响应数据样例{"code":200,"msg":"success"}
删除webhook
cessString
返回
文字描述响应数据样例{"code":200,"msg":"success"}
文件上传
文件上传描述在指定表单中通过url上传文件,
返回
文件信息,
返回
的信息直接用于创建和修改接口填写在附件或图片控件值中使用须知开发前,请仔细阅读[开发指南]。POST请求头{"Authorization":"BearerYOUR_APIKEY"}YOUR_APIKEY请阅读开发指南了解。名词解释名称说明app_id应用IDentry_id该应用内的表单IDapp_id+entry_id表示全局唯一的表
自定义数据批量打印
g"}]]}}}]}
返回
参数参数说明::url打印文件URL链接size打印文件大小响应示例:[{"url":"https://xxx.XXX.com/ba9c4565fb767f9d1e0a23149d9ef87c","size":100029},{"url":"https://xxx.XXX.com/ba9c4565fb787f9d1e0a23149d9ef87c","size":100030
© 2016-2024 baishuyun Inc. All Rights Reserved
长沙百数科技有限公司版权所有
(湘ICP备15007281号-4)