本文介绍了Dataphin BPMS对接第三方审批流时,提交审批的Body结构与参数含义,以及不同审批场景所对应的审批元数据信息。
Body的结构与参数含义
结构示例
{
"applyId": "001",
"applyUser": "1234567890",
"applyUserInfo": {
"userId": "1000000001",
"userSourceId": "1234567890",
"userName": "test_userName"
},
"title": "test_title",
"content": "test_content",
"type": "AUTH",
"templateCode": "123",
"approveNodes": [
{
"approveOrder": "1",
"approveUsers": [
{
"userId": "300000005",
"userSourceId": "00112233445566778899",
"userName": "test_UserName"
}
],
"approveOperator": "OR"
}
]
}
参数含义
参数名称 | 参数类型 | 描述 |
applyId | String | Dataphin审批单ID。 |
applyUser | String | 审批发起者在来源账号系统中的ID。 |
applyUserInfo | List<approveNodes> | 审批发起者的信息。 |
userId | String | 审批发起者在Dataphin中的ID。 |
userSourceId | String | 审批发起者在来源账号系统中的ID。 |
userName | String | 审批发起者在Dataphin中的名称。 |
title | String | Dataphin审批单标题。 |
content | String | Dataphin审批单内容。 |
type | String | 审批单类型:
|
templateCode | String | 审批模板code,可为空,与页面配置有关。 |
approveNodes | List<approveNodes> | 审批节点列表。 |
approveOrder | String | 审批节点的顺序。 |
approveUsers | List<approveUsers> | 审批人的相关信息列表。 |
approveOperator | String | 审批节点的关系。 |
不同审批单的content和参数含义
不同表类型的权限申请
content信息
{
"resourceType": "PHYSICAL_TABLE",
"grantToUsers": [
{
"account": {
"accountType": "PERSONAL",
"userId": "1000000001",
"userName": "test_userName"
},
"period": {
"periodType": "DAYS_30",
"periodEnd": "2022-07-01"
}
}
],
"bpmsEnvironment": {
"projectName": "test_projectName",
"bizUnitName": "test_bizUnitName",
"bizUnitDisplayName": "test_bizUnitDisplayName",
"resourceEnv": "PROD",
"projectDisplayName": "test_projectDisplayName"
},
"operates": [
"SELECT"
],
"resources": [
{
"resourceProject": {
"projectName": "test_projectName",
"projectCnName": "test_projectCnName"
},
"resourceEnv": "PROD",
"resourceBizUnit": {
"bizUnitName": "test_bizUnitName",
"bizUnitCnName": "test_bizUnitCnName"
},
"resourceType": "PHYSICAL_TABLE",
"resourceName": "test_resourceName",
"resourceCnName": "test_resourceCnName",
"children": [
{
"resourceName": "id",
"resourceProperties": {
"columnType": "int",
"columnIsPartition": "false",
"columnIsPk": "false",
"classifyPath": "/test_classifyPath/",
"classifyName": "test_classifyName",
"securityLevel": "test_securityLevel"
}
}
],
"operations": [
"SELECT"
]
}
],
"applyObject": {},
"reason": "test_reason"
}
参数含义
参数名称 | 参数类型 | 描述 |
resourceType | String | 申请的资源类型
|
GrantToUser | List<GrantToUser> | 申请/授权用户列表。 |
account | List<account> | 申请/授权用户的账号信息。 |
accountType | String | 账号类型:个人账号、生产账号、用户组
|
userName | String | 账号名称。 |
userId | String | 账号ID。 |
period | List<period> | 申请/授权期限列表。 |
periodType | String | 有效期类型:
|
periodEnd | String | 权限到期时间,格式为yyyy-mm-dd。 |
bpmsEnvironment | List<bpmsEnvironment> | 所申请对象的信息。 |
projectName | String | 项目名称。 |
projectDisplayName | String | 项目中文名称。 |
bizUnitName | String | 板块名称。 |
bizUnitDisplayName | String | 板块中文名称。 |
resourceEnv | String | 环境信息:
|
operates | List<String> | 申请的权限类型:
|
resources | List<resources> | 资源内容。 |
resourceProject | List<resourceProject> | 资源的项目信息。 |
projectName | String | 项目名称。 |
projectCnName | String | 项目中文名称。 |
resourceBizUnit | List<resourceBizUnit> | 资源的板块信息。 |
bizUnitName | String | 板块名称。 |
bizUnitCnName | String | 板块中文名称。 |
resourceName | String | 申请的资源名。 |
resourceCnName | String | 申请资源的描述信息。 |
children | List<children> | 申请表中的字段信息。 |
columnType | String | 字段类型。 |
columnIsPartition | String | 是否是分区字段。 |
columnIsPk | String | 是否是主键。 |
classifyName | String | 字段的分类。 |
securityLevel | String | 字段的分级。 |
reason | String | 申请/授权原因。 |
代码审核
content信息
{
"bpmsEnvironment": {
"projectName": "test_projectName",
"bizUnitName": "test_bizUnitName",
"bizUnitDisplayName": "test_bizUnitDisplayName",
"projectDisplayName": "test_projectDisplayName"
},
"applyObject": {
"objectName": "test_objectName",
"codeContent": "test_codeContent",
"globalVariable": [
"test_globalVariable"
]
}
}
参数含义
参数名称 | 参数类型 | 描述 |
bpmsEnvironment | List<bpmsEnvironment> | 所申请对象的信息。 |
projectName | String | 项目名称。 |
projectDisplayName | String | 项目中文名称。 |
bizUnitName | String | 板块名称。 |
bizUnitDisplayName | String | 板块中文名称。 |
applyObject | List<applyObject> | 申请对象信息列表。 |
objectName | String | 申请对象名称。 |
codeContent | String | 需要审核的代码。 |
globalVariable | List<String> | 代码中包含的全局变量。 |
发布审批
content信息
{
"approveUserNames": "[\"test_approveUserName\"]",
"applyReason": "test_applyReason",
"publishRecords": [
{
"projectCnName": "test_projectCnName",
"owner": "test_owner",
"bizCnName": "test_bizCnName",
"changeType": "CREATE",
"developOwner": "test_developOwner",
"objectType": "MAX_COMPUTE_SQL",
"bizEnName": "test_bizEnName",
"objectVersion": "test_objectVersion",
"submitComment": "test_submitComment",
"submitUserName": "test_submitUserName",
"devopsOwner": "test_devopsOwner",
"submitTime": "1701137735511",
"projectEnName": "test_projectEnName",
"cnName": "test_cnName",
"dataDomain": "test_dataDomain",
"summaryTableCn": "test_summaryTableCn",
"objectName": "test_objectName",
"businessOwner": "test_businessOwner",
"objectId": "test_objectId"
}
]
}
参数含义
参数名称 | 参数类型 | 描述 |
approveUserNames | String | 负责审批的用户。 |
applyReason | String | 申请原因。 |
publishRecords | List<publishRecords> | 发布对象的相关信息。 |
projectCnName | String | 项目中文名称。 |
owner | String | 负责人。 |
bizCnName | String | 板块中文名称。 |
changeType | String | 变更类型:
|
developOwner | String | 对象的开发负责人。 |
objectType | String | 对象类型
|
bizEnName | String | 板块英文名称。 |
objectVersion | String | 提交对象的版本。 |
submitComment | String | 提交备注。 |
submitUserName | String | 提交人信息。 |
devopsOwner | String | 对象的运维负责人。 |
submitTime | String | 格式为时间戳的提交时间。 |
projectEnName | String | 项目英文名称。 |
cnName | String | 对象中文名。 |
dataDomain | String | 主题域。 |
summaryTableCn | String | 汇总表中文名。 |
objectName | String | 待审核对象的名称。 |
businessOwner | String | 业务负责人。 |
objectId | String | 待审核对象的ID。 |
数据服务相关权限申请
content信息
{
"grantToUsers": [
{
"account": {
"accountType": "PERSONAL",
"userId": "1000000001"
},
"period": {
"periodType": "SHORT_TIME",
"periodEnd": "2022-07-01",
"periodStart": "2022-06-02"
}
}
],
"bpmsEnvironment": {
"resourceEnv": "PROD"
},
"operations": [
"USE"
],
"levels": [
"MIDDLE"
],
"resources": [
{
"resourceType": "OS_APP",
"resourceName": "test_resourceName"
}
],
"applyObject": {},
"reason": "test_reason"
}
参数含义
参数名称 | 参数类型 | 描述 |
GrantToUser | List<GrantToUser> | 申请/授权用户列表。 |
UserID | String | 审批发起者在Dataphin中的ID。 |
accountType | String | 申请权限的账号类型。 |
UserName | String | 审批发起者的名称。 |
bpmsEnvironment | List<bpmsEnvironment> | 所申请对象的信息。 |
resourceEnv | String | 环境信息,申请应用默认是PROD。
|
levels | List<String> | 权限等级分为HIGH、MIDDLE、LOW。 |
operations | List<String> | 申请的操作类型
|
Period | List<String> | 有效期的相关信息。 |
periodType | string | 有效期类型,例如:SHORT_TIME。 |
periodStart | String | 有效期开始时间,格式为yyyy-mm-dd。 |
periodEnd | String | 有效期结束时间,格式为yyyy-mm-dd。 |
resources | List<String> | 申请的资源对象。 |
resourceType | String | 资源类型
|
resourceName | String | 资源名称。 |
children | List<String> | 申请对象的子字段信息,申请对象为数据服务API、服务单元、Dataphin数据源时存在。 |
reason | String | 申请原因。 |
数据源权限申请
content信息
{
"resourceType": "DATASOURCE",
"grantToUsers": [
{
"account": {
"accountType": "PERSONAL",
"userId": "1000000001",
"userName": "test_userName"
},
"period": {
"periodType": "DAYS_30",
"periodEnd": "2022-07-01"
}
}
],
"bpmsEnvironment": {
"resourceEnv": "PROD"
},
"operates": [
"SYNC_READ"
],
"resources": [
{
"resourceEnv": "PROD",
"resourceType": "DATASOURCE",
"resourceName": "test_resourceName",
"resourceCnName": "test_resourceCnName",
"operations": [
"SYNC_READ"
]
}
],
"applyObject": {},
"reason": "test_reason"
}
参数含义
参数名称 | 参数类型 | 描述 |
resourceType | String | 申请的资源类型 DATASOURCE:数据源。 |
GrantToUser | List<GrantToUser> | 申请/授权用户列表。 |
account | List<account> | 申请/授权用户的账号信息。 |
accountType | String | 账号类型:个人账号、生产账号、用户组
|
userName | String | 账号名称。 |
userId | String | 账号ID。 |
period | List<period> | 申请/授权期限列表。 |
periodType | String | 有效期类型:
|
periodEnd | String | 权限到期时间,格式为yyyy-mm-dd。 |
bpmsEnvironment | List<bpmsEnvironment> | 所申请对象的信息。 |
resourceEnv | String | 环境信息:
|
operates | List<operates> | 申请的权限类型:
|
resources | List<resources> | 资源内容。 |
resourceName | String | 申请的资源名。 |
resourceCnName | String | 申请资源中文名。 |
reason | String | 申请/授权原因。 |
概念设计流程管控
content信息
{
"bpmsEnvironment": {
"bizUnitName": "test_bizUnitName",
"bizUnitDisplayName": "test_bizUnitDisplayName"
},
"applyObject": {
"bizEntityId": "100000001",
"name": "test_name",
"bizProcessCn": "test_bizProcessCn",
"bizProcessType": "业务活动/业务事件",
"bizProcessChangeType": "新增活动",
"bizProcessNodes": "test_node",
"bizEntityTypeCode": "test_bizEntityTypeCode",
"dataDomainId": "test_dataDomainId",
"dataDomainName": "test_dataDomainName",
"dataDomainCnName": "test_dataDomainCnName",
"bizProcessTypeCode": "test_bizProcessTypeCode"
}
}
参数含义
参数名称 | 参数类型 | 描述 |
bpmsEnvironment | List<bpmsEnvironment> | 所申请对象的信息。 |
bizUnitName | String | 板块名称。 |
bizUnitDisplayName | String | 板块中文名称。 |
applyObject | List<bpmsEnvironment> | 上线对象的相关信息。 |
bizEntityId | String | 上线对象的ID。 |
name | String | 上线对象的编码。 |
bizProcessCn | String | 上线对象的名称。 |
bizProcessType | String | 上线对象的类型。 |
bizProcessChangeType | String | 上线对象的变更状态。 |
bizProcessNodes | String | 上线对象的节点。 |
bizEntityTypeCode | String | 上线对象的类型code。 |
dataDomainId | String | 上线对象的主题域ID。 |
dataDomainName | String | 上线对象的主题域编码。 |
dataDomainCnName | String | 上线对象的主题域名称。 |
bizProcessTypeCode | String | 上线对象的类型code。 |
变量权限申请
content信息
{
"resourceType": "GLOBAL_PARAM",
"grantToUsers": [
{
"account": {
"accountType": "PERSONAL",
"userId": "1000000001",
"userName": "test_userName"
},
"period": {
"periodType": "DAYS_30",
"periodEnd": "2022-07-01"
}
}
],
"bpmsEnvironment": {
"resourceEnv": "PROD"
},
"operates": [
"USE"
],
"resources": [
{
"resourceEnv": "PROD",
"resourceType": "GLOBAL_PARAM",
"resourceName": "test_resourceName",
"resourceCnName": "test_resourceCnName",
"operations": [
"USE"
]
}
],
"applyObject": {},
"reason": "test_reason"
}
参数含义
参数名称 | 参数类型 | 描述 |
resourceType | String | 申请的资源类型: GLOBAL_PARAM:变量。 |
GrantToUser | List<GrantToUser> | 申请/授权用户列表。 |
account | List<account> | 申请/授权用户的账号信息。 |
accountType | String | 账号类型:个人账号、生产账号、用户组:
|
userName | String | 账号名称。 |
userId | String | 账号ID。 |
period | List<period> | 申请/授权期限列表。 |
periodType | String | 有效期类型:
|
periodEnd | String | 权限到期时间,格式为yyyy-mm-dd。 |
bpmsEnvironment | List<bpmsEnvironment> | 所申请对象的信息。 |
resourceEnv | String | 环境信息:
|
operates | List<operates> | 申请的权限类型: USE:使用。 |
resources | List<resources> | 资源内容。 |
resourceType | String | 申请的资源类型: GLOBAL_PARAM:变量。 |
resourceName | String | 变量的名称。 |
resourceCnName | String | 变量中文名。 |
reason | String | 申请/授权原因。 |
密钥权限申请
content信息
{
"resourceType": "SECRET_KEY",
"grantToUsers": [
{
"account": {
"accountType": "PERSONAL",
"userId": "1000000001",
"userName": "test_userName"
},
"period": {
"periodType": "DAYS_30",
"periodEnd": "2022-07-01"
}
}
],
"bpmsEnvironment": {
"resourceEnv": "PROD"
},
"operations": [
"SECRET_KEY_VIEW"
],
"resources": [
{
"resourceEnv": "PROD",
"resourceType": "SECRET_KEY",
"resourceName": "test_resourceName",
"resourceCnName": "test_resourceCnName",
"operations": [
"SECRET_KEY_VIEW"
]
}
],
"applyObject": {},
"reason": "test_reason"
}
参数含义
参数名称 | 参数类型 | 描述 |
resourceType | String | 申请的资源类型: SECRET_KEY:密钥。 |
GrantToUser | List<GrantToUser> | 申请/授权用户列表。 |
account | List<account> | 申请/授权用户的账号信息。 |
accountType | String | 账号类型:个人账号、生产账号、用户组:
|
userName | String | 账号名称。 |
userId | String | 账号ID。 |
period | List<period> | 申请/授权期限列表。 |
periodType | String | 有效期类型:
|
periodEnd | String | 权限到期时间,格式为yyyy-mm-dd。 |
bpmsEnvironment | List<bpmsEnvironment> | 所申请对象的信息。 |
resourceEnv | String | 环境信息:
|
operations | List<operates> | 申请的权限类型:
|
resources | List<resources> | 资源内容。 |
resourceType | String | 申请的资源类型: SECRET_KEY:密钥。 |
resourceName | String | 密钥的名称。 |
resourceCnName | String | 密钥中文名。 |
reason | String | 申请/授权原因。 |
函数权限申请
content信息
{
"resourceType": "FUNCTION",
"grantToUsers": [
{
"account": {
"accountType": "PERSONAL",
"userId": "1000000001",
"userName": "test_userName"
},
"period": {
"periodType": "DAYS_30",
"periodEnd": "2022-07-01"
}
}
],
"bpmsEnvironment": {
"projectName": "test_projectName",
"resourceEnv": "PROD",
"projectDisplayName": "test_projectDisplayName"
},
"operates": [
"SELECT"
],
"resources": [
{
"resourceProject": {
"projectName": "test_projectName",
"projectCnName": "test_projectCnName"
},
"resourceEnv": "PROD",
"resourceType": "FUNCTION",
"resourceName": "test_resourceName",
"operations": [
"SELECT"
]
}
],
"applyObject": {},
"reason": "test_reason"
}
参数含义
参数名称 | 参数类型 | 描述 |
resourceType | String | 申请的资源类型: FUNCTION:函数。 |
GrantToUser | List<GrantToUser> | 申请/授权用户列表。 |
account | List<account> | 申请/授权用户的账号信息。 |
accountType | String | 账号类型:个人账号、生产账号、用户组:
|
userName | String | 账号名称。 |
userId | String | 账号ID。 |
period | List<period> | 申请/授权期限列表。 |
periodType | String | 有效期类型:
|
periodEnd | String | 权限到期时间,格式为yyyy-mm-dd。 |
bpmsEnvironment | List<bpmsEnvironment> | 所申请对象的信息。 |
projectName | String | 项目名称。 |
projectDisplayName | String | 项目中文名称。 |
resourceEnv | String | 环境信息:
|
operates | List<operates> | 申请的权限类型: SELECT:使用权限。 |
resources | List<resources> | 资源内容。 |
resourceType | String | 申请的资源类型: FUNCTION:函数。 |
projectName | String | 项目名称。 |
projectCnName | String | 项目中文名称。 |
resourceName | String | 密钥的名称。 |
reason | String | 申请/授权原因。 |
一键转交
content信息
{
"oldOwnerId": "1000000001",
"newOwnerName": "test_newOwnerName",
"oldOwnerName": "test_oldOwnerName",
"description": "test_reason",
"newOwnerId": "1000000002",
"proposalId": "001"
}
参数含义
参数名称 | 参数类型 | 描述 |
oldOwnerId | String | 转交发起人的用户ID。 |
oldOwnerName | String | 转交发起人的用户名称。 |
newOwnerId | String | 接收人的用户ID。 |
newOwnerName | String | 接收人的用户名称。 |
description | String | 转交原因。 |
proposalId | String | 流程ID。 |
标准审核
content信息
{
"reason": "test_reason",
"standardTemplateId": "test_standardTemplateId",
"effectiveTimeType": "TIME_PERIOD",
"attributeWithValueList": [
{
"name": "test_name",
"value": "test_value"
}
],
"finishEffectiveTime": "2023-02-28 23:59:59",
"standardId": "test_standardId",
"description": "test_description",
"lastModifier": "test_lastModifier",
"standardSetId": "test_standardSetId",
"standardTemplateVersion": "test_standardTemplateVersion",
"standardVersion": "test_standardVersion",
"lookupTableRelations": [
{
"lookupTableId": "test_lookupTableId",
"lookupTableName": "test_lookupTableName",
"attributeValue": "test_attributeValue",
"referType": "test_referType",
"attributeName": "test_attributeName"
}
],
"standardStage": "test_standardStage",
"ownerName": "test_ownerName",
"standardSetName": "test_standardSetName",
"startEffectiveTime": "2023-02-24 23:59:59"
}
参数含义
参数名称 | 参数类型 | 描述 |
standardId | String | 标准ID。 |
standardSetId | String | 标准集ID。 |
standardVersion | String | 标准版本。 |
standardTemplateId | String | 标准模板ID。 |
standardTemplateVersion | String | 标准集模板版本。 |
description | String | 标准描述。 |
lastModifier | String | 最后修改人。 |
lookupTableRelations | List<LookupTableRelation> | 关联码表。 |
lookupTableId | String | 码表ID。 |
lookupTableName | String | 码表名称。 |
attributeValue | String | 码值。 |
referType | String | 关联关系。 |
attributeName | String | 关联属性名称。 |
standardStage | String | 标准研发阶段。 |
ownerName | String | 标准负责人。 |
effectiveTimeType | String | 标准的生效时间类型:
|
attributeWithValueList | List<oldOwner> | 待审核标准的属性信息。 |
name | String | 属性名称。 |
value | String | 属性值。 |
startEffectiveTime | String | 生效时间,格式为YY-MM-DD HH:MM:SS。 |
finishEffectiveTime | String | 生效时间,格式为YY-MM-DD HH:MM:SS。 |
standardSetName | String | 标准集名称。 |
reason | String | 申请理由。 |
数据下载
content信息
{
"fileExceedDate": "2023-12-24",
"tableInfoList": [
{
"columnInfoList": [
{
"securityLevel": "L2",
"columnName": "test_columnName"
}
],
"tableNameCn": "test_tableNameCn",
"tableName": "test_tableName"
}
],
"fileSize": "100kb",
"highestSecurityLevel": "test_highestSecurityLevel",
"sqlContent": "test_sqlContent",
"approvalReason": "test_approvalReason",
"projectName": "test_projectName",
"rowNumber": "1000",
"projectId": "test_projectId",
"applyUserId": "test_applyUserId"
}
参数含义
参数名称 | 参数类型 | 描述 |
fileExceedDate | String | 文件过期时间。 |
tableInfoList | List<String> | 表信息列表。 |
columnInfoList | List<String> | 字段信息列表。 |
securityLevel | String | 字段的安全等级。 |
columnName | String | 字段名称。 |
tableName | String | 表名称。 |
tableNameCn | String | 表中文名(可为空)。 |
fileSize | String | 文件大小,只有下载样例数据时存在。 |
rowNumber | String | 数据行数,只有下载样例数据时存在。 |
highestSecurityLevel | String | 最高安全等级。 |
sqlContent | String | SQL内容。 |
approvalReason | String | 申请原因。 |
projectName | String | 项目名称。 |
projectId | String | 项目ID。 |
applyUserId | String | 申请用户ID。 |
目录专题发布审批
content信息
{
"resourceType": "ASSET_TOPIC",
"records": [
{
"topic": "${asset_topic}",
"desc": "${asset_topic_desc}",
"cats": [
{
"nm": "${catalog_name}",
"desc": "${catalog_desc}",
"lvl":${catalog_level}
"prt":"${parent_catalog}",
"mb": "${modified_by}",
"mt": "${modified_time}",
"dt": [
{
"ty": "${diff_type}",
"log": [
{
"cf": "${change_fields}",
"bf": "${bebore_change}",
"af": "${after_change}"
}
]
}
]
"sub": [
]
}
]
}
]
}
参数含义
参数名称 | 参数类型 | 描述 |
resourceType | String | 固定值,ASSET_TOPIC代表专题发布审批。 |
records | 数组 | 变更记录,每个对象为一个专题的变更。 |
records.topic | String | 专题的名称。 |
records.desc | String | 专题的描述。 |
records.cats | Array | 每个目录的变更。 |
records.cats.nm | String | 目录名称。 |
records.cats.desc | String | 目录描述。 |
records.cats.lvl | Integer | 目录层级。 |
records.cats.prt | String | 父目录名称。 |
records.cats.mb | String | 更新人名称。 |
records.cats.mt | String | 单位毫秒,信息发送时间戳。 |
records.cats.dt | Array | 目录的变更详情。 |
records.cats.dt.ty | Integer | 变更类型:
|
records.cats.dt.log | Array | 目录的变更记录。 |
records.cats.dt.log.cf | String | 变更内容,不同的变更类型的内容有所不同。
|
records.cats.dt.log.bf | String | 变更前的值。 |
records.cats.dt.log.af | String | 变更后的值。 |
records.cats.subs | Array | 子目录,包含的内容与一级目录相同,可嵌套包含下级目录。示例如下:
|