Dataphin BPMS third-party approval metadata reference - Dataphin

Describes the request body structure, parameters, and approval metadata for integrating third-party approval flows with Dataphin BPMS.

Request Body Structure and Parameters

Example

{
  "applyId": "001",
  "applyUser": "1234567890",
  "applyUserInfo": {
    "userId": "1000000001",
    "userSourceId": "1234567890",
    "userName": "test_userName"
  },
  "title": "test_title",
  "content": "test_content",
  "tenantId":"100000001",
  "type": "AUTH",
  "templateCode": "123",
  "approveNodes": [
    {
      "approveOrder": "1",
      "approveUsers": [
        {
          "userId": "300000005",
          "userSourceId": "00112233445566778899",
          "userName": "test_UserName"
        }
      ],
      "approveOperator": "OR"
    }
  ]
}

Parameters

Parameter Name	Parameter Type	Description
applyId	String	Dataphin approval form ID.
applyUser	String	Approval initiator ID in the source account system.
applyUserInfo	List<approveNodes>	Approval initiator details.
userId	String	Approval initiator ID in Dataphin.
tenantId	String	Source tenant ID for the current approval request.
userSourceId	String	Approval initiator ID in the source account system.
userName	String	Approval initiator name in Dataphin.
title	String	Dataphin approval form title.
content	String	Dataphin approval form content.
type	String	Approval form type: CODE_REVIEW: Code review. PUBLISH: Release control. BIZ_PLANNING: Business planning. AUTH: Permission approval. DEFAULT: Default. STANDARD_APPROVAL: Standard review.
templateCode	String	Approval template code. Can be empty. Related to page configuration.
approveNodes	List<approveNodes>	List of approval nodes.
approveOrder	String	Approval node order.
approveUsers	List<approveUsers>	Approver details.
approveOperator	String	Approval node relationship.

Approval Form Parameters by Scenario

Table Permission Requests

Example

{
  "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"
}

Parameters

Parameter Name	Parameter Type	Description
resourceType	String	Resource type: PHYSICAL_TABLE: Physical table. LOGICAL_TABLE: Logical modeling table. REALTIME_LOGICAL_TABLE: Meta table. REALTIME_MIRROR_TABLE: Mirror table. PHYSICAL_VIEW: Physical view. LOGICAL_VIEW: Logical view. PHYSICAL_MATERIALIZED_VIEW: Materialized view. LABEL_TABLE: Logical tag table.
GrantToUser	List<GrantToUser>	List of applicants/authorized users.
account	List<account>	Account information of applicants/authorized users.
accountType	String	Account type: personal account, tenant account, user group PERSONAL: Personal account. PRODUCE: Tenant account. USER_GROUP: User group.
userName	String	The account name.
userId	String	The account ID.
period	List<period>	List of application/authorization periods.
periodType	String	Validity period type: DAYS_xx: xx days. LONG_TERM: Long term.
periodEnd	String	Permission expiration date in yyyy-mm-dd format.
bpmsEnvironment	List<bpmsEnvironment>	Applied object details.
projectName	String	The project name.
projectDisplayName	String	The project's Chinese name.
bizUnitName	String	The name of the business unit.
bizUnitDisplayName	String	The Chinese name of the business unit.
resourceEnv	String	Environment information: PROD: Production. DEV: Development.
operates	List<String>	Permission type: SELECT: Query table data. UPDATE: Modify table data. DELETE: Delete table. ALTER: Modify table structure.
resources	List<resources>	Resource content.
resourceProject	List<resourceProject>	The project information of the resource.
projectName	String	The project name.
projectCnName	String	The display name of the project.
resourceBizUnit	List<resourceBizUnit>	Business unit information of the resource.
bizUnitName	String	The name of the business unit.
bizUnitCnName	String	The Chinese name of the business unit.
resourceName	String	Resource name.
resourceCnName	String	Resource description.
children	List<children>	Field information in the application form.
columnType	String	Field type.
columnIsPartition	String	Whether the field is a partition field.
columnIsPk	String	Whether the field is the primary key.
classifyName	String	Field classification.
securityLevel	String	Field classification.
reason	String	Application/authorization reason.

Data source table permissions

Example

"resourceType":"DATASOURCE_TABLE"
"grantToUsers": [
    {
      "account": {
        "accountType": "PERSONAL",
        "userId": "1000000001",
        "userName": "test_userName"
      },
      "period": {
        "periodType": "DAYS_30",
        "periodEnd": "2022-07-01"
      }
    }
  ],
"bpmsEnvironment": {
    "BusinessSystem": "test_BusinessSystem",
    "DataBaseName": "test_DataBaseName",
    "resourceEnv": "PROD",
  },
"resources": [
    {
      "resourceType": "DATASOURCE_TABLE",
      "resourceName": "test_resourceName",
      "resourceCnName": "test_resourceCnName",
      "children": [
        {
          "resourceName": "id",
          "resourceProperties": {
            "columnType": "int",
            "columnIsPartition": "false",
            "columnIsPk": "false"
          }
        }
      ],
      "operations": [
        "SELECT"
      ]
    }
  ],
"reason": "test_reason";  
}

Parameters

Parameter Name	Parameter Type	Description
resourceType	String	Resource type: DATASOURCE_TABLE: Data source table. DATASOURCE_VIEW: Data source view. DATASOURCE_MATERIALIZED_VIEW: Data source materialized view.
GrantToUser	List<GrantToUser>	List of applicants/authorized users.
account	List<account>	Account information of applicants/authorized users.
accountType	String	Account type: PERSONAL: Personal account. PRODUCE: Tenant account. USER_GROUP: User group.
userId	String	The account ID.
userName	String	The account name.
period	List<period>	List of application/authorization periods.
periodType	String	Validity period type: DAYS_xx: xx days. LONG_TERM: Long term.
periodEnd	String	Permission expiration date in yyyy-mm-dd format.
bpmsEnvironment	List<bpmsEnvironment>	Applied object details.
BusinessSystem	String	Business system.
DataBaseName	String	Name of the data source.
resourceEnv	String	Environment information: PROD: Production environment. DEV: Development environment.
resources	List<resources>	Resource content.
resourceName	String	The name of the requested resource.
Chinese Name	String	Resource name.
Children	List<children>	Application form fields.
columnType	String	Field type.
columnIsPartition	String	Whether the field is a partition field.
columnIsPk	String	Specifies whether the column is a primary key.
Classification Name	String	Field classification
securityLevel	String	Field classification.
Properties	Map<String, String>	This is an additional field that can be left empty.
reason	String	Application/authorization reason.

Code Review

Example

{
  "bpmsEnvironment": {
    "projectName": "test_projectName",
    "bizUnitName": "test_bizUnitName",
    "bizUnitDisplayName": "test_bizUnitDisplayName",
    "projectDisplayName": "test_projectDisplayName"
  },
  "applyObject": {
    "objectName": "test_objectName",
    "codeContent": "test_codeContent",
    "globalVariable": [
      "test_globalVariable"
    ]
  }
}

Parameters

Parameter Name	Parameter Type	Description
bpmsEnvironment	List<bpmsEnvironment>	Applied object details.
projectName	String	The name of the project.
projectDisplayName	String	The Chinese name of the project.
bizUnitName	String	The name of the business unit.
bizUnitDisplayName	String	The Chinese name of the business unit.
applyObject	List<applyObject>	Applied object details.
objectName	String	Applied object name.
codeContent	String	Code to review.
globalVariable	List<String>	Global variables included in the code.

Release Approval

Example

{
  "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"
    }
  ]
}

Parameters

Parameter Name	Parameter Type	Description
approveUserNames	String	The user responsible for approval.
applyReason	String	The reason for the application.
publishRecords	List<publishRecords>	Related information about the published object.
projectCnName	String	The Chinese name of the project.
owner	String	The owner.
bizCnName	String	The Chinese name of the business unit.
changeType	String	The type of change: CREATE: New. UPDATE: Update. DELETE: Delete.
developOwner	String	The development owner of the object.
objectType	String	The type of the object OFFLINE_PIPELINE: Offline integration. DATA_X: Sync task. REAL_TIME_PIPELINE: Real-time integration. FCT_LOGICAL_TABLE: Logical fact table. DIM_LOGICAL_TABLE: Logical dimension table. BIZ_CONDITION: Business filter. ATOM_INDEX: Atomic metric. DERIVED_INDEX: Derived metric. UNIT_SUMMARY_TABLE: Logical aggregate table. CALC_DERIVED_INDEX: Derived metric. IDE_RESOURCE: Resource. UDF: Function. DATA_PROCESS_PHYSICAL_TABLE: Physical table. META_TABLE: Meta table. MIRROR_TABLE: Mirror table. TASK_TEMPLATE: Offline computing template. STREAM_TEMPLATE: Real-time computing template. MAX_COMPUTE_SQL: Computing task. MAX_COMPUTE_MR: Computing task. SPARK_JAR_ON_MAX_COMPUTE: Computing task. SHELL: Computing task. PYTHON: Computing task. PAI_DESIGNER: Computing task. VIRTUAL: Computing task.
bizEnName	String	The English name of the business unit.
objectVersion	String	The version of the submitted object.
submitComment	String	Submission comment.
submitUserName	String	Information about the submitter.
devopsOwner	String	The DevOps owner of the object.
submitTime	String	The submission time in timestamp format.
projectEnName	String	The English name of the project.
cnName	String	The Chinese name of the object.
dataDomain	String	The subject area.
summaryTableCn	String	The Chinese name of the aggregate table.
objectName	String	The name of the object to be reviewed.
businessOwner	String	The business owner.
objectId	String	The ID of the object to be reviewed.

Data Service Permissions

Example

{
  "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"
}

Parameters

Parameter Name	Parameter Type	Description
GrantToUser	List<GrantToUser>	List of applicants/authorized users.
UserID	String	The ID of the approval initiator in Dataphin.
accountType	String	The type of account applying for permission.
UserName	String	The name of the approval initiator.
bpmsEnvironment	List<bpmsEnvironment>	Applied object details.
resourceEnv	String	Environment information, the default for application is PROD. PROD: Production. DEV: Development.
levels	List<String>	Permission levels are divided into HIGH, MIDDLE, LOW.
operations	List<String>	The type of operation applied for USE: Use permission. DEV: Development permission. SQL_QUERY: Query permission (query permission for data service Dataphin data source). SQL_WRITE: Write permission (write permission for data service Dataphin data source).
Period	List<String>	Related information about the validity period.
periodType	string	Validity period type, for example: SHORT_TIME.
periodStart	String	The start time of the validity period, in the format yyyy-mm-dd.
periodEnd	String	The end time of the validity period, in the format yyyy-mm-dd.
resources	List<String>	The resource object applied for.
resourceType	String	The type of resource OS_APP: Application of data service. OS_API: API of data service. OS_LOGIC_UNIT: Service unit of data service. OS_DS_TABLE: Dataphin data source of data service.
resourceName	String	The name of the resource.
children	List<String>	Information about the subfields of the applied object, existing when the applied object is a data service API, service unit, or Dataphin data source.
reason	String	The reason for the application.

Data Source Permissions

Example

{
  "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"
}

Parameters

Parameter Name	Parameter Type	Description
resourceType	String	Resource type: DATASOURCE: Data source.
GrantToUser	List<GrantToUser>	List of applicants/authorized users.
account	List<account>	Account information of applicants/authorized users.
accountType	String	Account type: personal account, tenant account, user group PERSONAL: Personal account. PRODUCE: Tenant account. USER_GROUP: User group.
userName	String	The account name.
userId	String	The account ID.
period	List<period>	List of application/authorization periods.
periodType	String	Validity period type: DAYS_xx: xx days. LONG_TERM: Long term.
periodEnd	String	Permission expiration date in yyyy-mm-dd format.
bpmsEnvironment	List<bpmsEnvironment>	Applied object details.
resourceEnv	String	Environment information: PROD: Production. DEV: Development.
operates	List<operates>	Permission type: SYNC_READ: Read-through. SYNC_WRITE: Write-through.
resources	List<resources>	Resource content.
resourceName	String	Resource name.
resourceCnName	String	The Chinese name of the resource applied for.
reason	String	Application/authorization reason.

Conceptual Design Process Control

Example

{
  "bpmsEnvironment": {
    "bizUnitName": "test_bizUnitName",
    "bizUnitDisplayName": "test_bizUnitDisplayName"
  },
  "applyObject": {
    "bizEntityId": "100000001",
    "name": "test_name",
    "bizProcessCn": "test_bizProcessCn",
    "bizProcessType": "Business Activity/Business Event",
    "bizProcessChangeType": "New Activity",
    "bizProcessNodes": "test_node",
    "bizEntityTypeCode": "test_bizEntityTypeCode",
    "dataDomainId": "test_dataDomainId",
    "dataDomainName": "test_dataDomainName",
    "dataDomainCnName": "test_dataDomainCnName",
    "bizProcessTypeCode": "test_bizProcessTypeCode"
  }
}

Parameters

Parameter Name	Parameter Type	Description
bpmsEnvironment	List<bpmsEnvironment>	Applied object details.
bizUnitName	String	The name of the business unit.
bizUnitDisplayName	String	The Chinese name of the business unit.
applyObject	List<bpmsEnvironment>	Related information about the published object.
bizEntityId	String	The ID of the published object.
name	String	The code of the published object.
bizProcessCn	String	The name of the published object.
bizProcessType	String	The type of the published object.
bizProcessChangeType	String	The change status of the published object.
bizProcessNodes	String	The node of the published object.
bizEntityTypeCode	String	The type code of the published object.
dataDomainId	String	The ID of the subject area of the published object.
dataDomainName	String	The code of the subject area of the published object.
dataDomainCnName	String	The name of the subject area of the published object.
bizProcessTypeCode	String	The type code of the published object.

Variable Permissions

Example

{
  "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"
}

Parameters

Parameter Name	Parameter Type	Description
resourceType	String	Resource type: GLOBAL_PARAM: Variable.
GrantToUser	List<GrantToUser>	List of applicants/authorized users.
account	List<account>	Account information of applicants/authorized users.
accountType	String	Account type: personal account, tenant account, user group: PERSONAL: Personal account. PRODUCE: Tenant account. USER_GROUP: User group.
userName	String	The account name.
userId	String	The account ID.
period	List<period>	List of application/authorization periods.
periodType	String	Validity period type: DAYS_xx: xx days. LONG_TERM: Long term.
periodEnd	String	Permission expiration date in yyyy-mm-dd format.
bpmsEnvironment	List<bpmsEnvironment>	Applied object details.
resourceEnv	String	Environment information: PROD: Production. DEV: Development.
operates	List<operates>	Permission type: USE: Use.
resources	List<resources>	Resource content.
resourceType	String	Resource type: GLOBAL_PARAM: Variable.
resourceName	String	The name of the variable.
resourceCnName	String	The Chinese name of the variable.
reason	String	Application/authorization reason.

Key Permissions

Example

{
  "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"
}

Parameters

Parameter Name	Parameter Type	Description
resourceType	String	Resource type: SECRET_KEY: Key.
GrantToUser	List<GrantToUser>	List of applicants/authorized users.
account	List<account>	Account information of applicants/authorized users.
accountType	String	Account type: personal account, tenant account, user group: PERSONAL: Personal account. Production tenant account. USER_GROUP: User group.
userName	String	The account name.
userId	String	The account ID.
period	List<period>	List of application/authorization periods.
periodType	String	Validity period type: DAYS_xx: xx days. LONG_TERM: Long term.
periodEnd	String	Permission expiration date in yyyy-mm-dd format.
bpmsEnvironment	List<bpmsEnvironment>	Applied object details.
resourceEnv	String	Environment information: PROD: Production. DEV: Development.
operations	List<operates>	Permission type: SECRET_KEY_VIEW: View key value. SECRET_KEY_PIPELINE_ENCRYPT: Data integration encryption. SECRET_KEY_PIPELINE_DECREPT: Data integration decryption.
resources	List<resources>	Resource content.
resourceType	String	Resource type: SECRET_KEY: Key.
properties	Map<String, Stirng>	Additional attribute fields. When the key type is a regular key, the value of the ownerManageOnly field in the attributes is false. When the key type is a key that can only be managed by the owner, the value of the ownerManageOnly field in the attributes is true.
resourceName	String	The name of the key.
resourceCnName	String	The Chinese name of the key.
reason	String	Application/authorization reason.

Function Permissions

Example

{
  "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"
}

Parameters

Parameter Name	Parameter Type	Description
resourceType	String	Resource type: FUNCTION: Function.
GrantToUser	List<GrantToUser>	List of applicants/authorized users.
account	List<account>	Account information of applicants/authorized users.
accountType	String	Account type: personal account, tenant account, user group: PERSONAL: Personal account. PRODUCE: Tenant account. USER_GROUP: User group.
userName	String	The account name.
userId	String	The account ID.
period	List<period>	List of application/authorization periods.
periodType	String	Validity period type: DAYS_xx: xx days. LONG_TERM: Long term.
periodEnd	String	Permission expiration date in yyyy-mm-dd format.
bpmsEnvironment	List<bpmsEnvironment>	Applied object details.
projectName	String	The name of the project.
projectDisplayName	String	The Chinese name of the project.
resourceEnv	String	Environment information: PROD: Production. DEV: Development.
operates	List<operates>	Permission type: SELECT: Use permission.
resources	List<resources>	Resource content.
resourceType	String	Resource type: FUNCTION: Function.
projectName	String	The name of the project.
projectCnName	String	The Chinese name of the project.
resourceName	String	The name of the key.
reason	String	Application/authorization reason.

One-Click Change Owner

Example

{
  "oldOwnerId": "1000000001",
  "newOwnerName": "test_newOwnerName",
  "oldOwnerName": "test_oldOwnerName",
  "description": "test_reason",
  "newOwnerId": "1000000002",
  "proposalId": "001"
}

Parameters

Parameter Name	Parameter Type	Description
oldOwnerId	String	The user ID of the initiator of the change owner.
oldOwnerName	String	The user name of the initiator of the change owner.
newOwnerId	String	The user ID of the recipient.
newOwnerName	String	The user name of the recipient.
description	String	Reason for changing ownership.
proposalId	String	The process ID.

Standard Review

Example

{
  "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"
}

Parameters

Parameter Name	Parameter Type	Description
standardId	String	The standard ID.
standardSetId	String	The ID of the data standard set.
standardVersion	String	The version of the standard.
standardTemplateId	String	The ID of the standard template.
standardTemplateVersion	String	The version of the standard set template.
description	String	The description of the standard.
lastModifier	String	The last modifier.
lookupTableRelations	List<LookupTableRelation>	Associated lookup table.
lookupTableId	String	The ID of the lookup table.
lookupTableName	String	The name of the lookup table.
attributeValue	String	The code value.
referType	String	The association relationship.
attributeName	String	The name of the associated attribute.
standardStage	String	The standard development stage.
ownerName	String	The owner of the standard.
effectiveTimeType	String	The type of effective time for the standard: TIME_PERIOD: Effective within a specified time. FOREVER: Permanent.
attributeWithValueList	List<oldOwner>	Attribute information of the standard to be reviewed.
name	String	The name of the attribute.
value	String	The value of the attribute.
startEffectiveTime	String	The effective time, in the format YY-MM-DD HH:MM:SS.
finishEffectiveTime	String	The effective time, in the format YY-MM-DD HH:MM:SS.
standardSetName	String	The name of the data standard set.
reason	String	The reason for the application.

Data Download

Example

{
  "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"
}

Parameter Meaning

Parameter name	Parameter type	Description
fileExceedDate	String	The time when the object expires.
tableInfoList	List<String>	Table information list.
columnInfoList	List<String>	Field information list.
securityLevel	String	The security level of the field.
columnName	String	Field name.
tableName	String	Table name.
tableNameCn	String	Table Chinese name (can be empty).
fileSize	String	File size, only available when downloading sample data.
rowNumber	String	Number of data rows, only available when downloading sample data.
highestSecurityLevel	String	Highest security level.
sqlContent	String	The content of the SQL statement.
approvalReason	String	The reason for the request.
projectName	String	The name of the project.
projectId	String	The ID of the project.
applyUserId	String	You can request a User ID.

Folder topic release approval

Example

{
    "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": [
                      ]
                }
            ]
        }
    ]
}

Parameter Meaning

Parameter name	Parameter type	Description
resourceType	String	Static field, ASSET_TOPIC represents topic release approval.
records	Array	Change records, each object represents a change in a topic.
records.topic	String	The name of the topic.
records.desc	String	The description of the topic.
records.cats	Array	Changes in each folder.
records.cats.nm	String	The name of the directory.
records.cats.desc	String	The description of the directory.
records.cats.lvl	Integer	The directory level.
records.cats.prt	String	The name of the parent directory.
records.cats.mb	String	Name of the updater.
records.cats.mt	String	Timestamp in milliseconds when the information is sent.
records.cats.dt	Array	Details of the directory changes.
records.cats.dt.ty	Integer	Change type: 1-Add. 2-Change. 3-Shift. 4-Delete.
records.cats.dt.log	Array	Change records of the directory.
records.cats.dt.log.cf	String	Change content, varies with different change types. nm: Directory name. desc: Directory description. prt: Parent directory change, and shift directory. sort: Subdirectory sort.
records.cats.dt.log.bf	String	The value before the change.
records.cats.dt.log.af	String	The value after the change.
records.cats.subs	Array	Subdirectory, contains the same content as the primary directory, can nest lower-level directories. TExamples are as follows: `"sub": [ { "nm": "This is the subdirectory of the first directory", "desc": "This is the subdirectory of the first directory", "lvl": 2, "prt": "This is the first directory", "mb": "liyi", "mt": 1718761372242, "dt": [ ], "sub": [ ] } ]`

Row-level permission requests

Content

 "applyId": "7206426532807936",
  "applyUser": "229372341924692767",
  "tenantId": "300073302",
  "applyUserInfo": {
    "userId": "300000913",
    "userSourceId": "229372341924692767",
    "userName": "SuperAdmin"
  },
  "title": "Row-level permission: Approval request for view permissions restricted by region",
  "content": "{\"resourceType\":\"ROW_PERMISSION\",\"grantToUsers\":[{\"account\":{\"accountType\":\"PERSONAL\",\"userId\":\"300000913\",\"userName\":\"SuperAdmin\"},\"period\":{\"periodType\":\"DAYS_30\",\"periodEnd\":\"2025-11-19\"}},{\"account\":{\"accountType\":\"PRODUCE\",\"userId\":\"300073313\",\"userName\":\"ROW1\"},\"period\":{\"periodType\":\"LONG_TERM\"}},{\"account\":{\"accountType\":\"USER_GROUP\",\"userId\":\"300388227\",\"userName\":\"user_liyi\"},\"period\":{\"periodType\":\"DAYS_30\",\"periodEnd\":\"2025-11-19\"}}],\"bpmsEnvironment\":{},\"operates\":[\"SELECT_ROW\"],\"resources\":[{\"resourceType\":\"ROW_PERMISSION\",\"resourceName\":\"View restricted by region\",\"resourceCnName\":\"View restricted by region\",\"children\":[{\"resourceName\":\"Rule 1\"},{\"resourceName\":\"All\"}],\"operations\":[\"SELECT_ROW\"],\"properties\":{\"ROW_PERMISSION_TABLE\":\"[{\\\"columnName\\\":\\\"id\\\",\\\"creator\\\":\\\"300000913\\\",\\\"gmtCreate\\\":1760689227841,\\\"gmtModified\\\":1760689227841,\\\"id\\\":300507776,\\\"mappingColumnId\\\":\\\"1a5c42b4-dec0-44ee-a8b3-5d6689b1d407\\\",\\\"modifier\\\":\\\"300000913\\\",\\\"resourceCnName\\\":\\\"\\\",\\\"resourceId\\\":\\\"odps.300073302.row2.liyi_hj_test0001\\\",\\\"resourceName\\\":\\\"liyi_hj_test0001\\\",\\\"resourceProperties\\\":{\\\"authResourceKey\\\":\\\"7203999664125056.liyi_hj_test0001\\\"},\\\"rowPermissionId\\\":300388222,\\\"tenantId\\\":300073302}]\",\"ROW_PERMISSION_DESC\":\"Test description\"}}],\"applyObject\":{},\"reason\":\"1111111111111111\"}",
  "type": "AUTH",
  "templateCode": "System default template for row-level permission requests",
  "approveNodes": [
    {
      "approveOrder": "1",
      "approveUsers": [
        {
          "userId": "300000913",
          "userSourceId": "229372341924692767",
          "userName": "SuperAdmin"
        }
      ],
      "approveOperator": "OR"
    }
  ]
}

Parameter Definitions

Parameter	Type	Description
resourceType	String	The type of the requested resource. PHYSICAL_TABLE: Physical table. LOGICAL_TABLE: Logical table. REALTIME_LOGICAL_TABLE: Metadata table. REALTIME_MIRROR_TABLE: Image. PHYSICAL_VIEW: Physical view. LOGICAL_VIEW: Logical view. PHYSICAL_MATERIALIZED_VIEW: Materialized view. LABEL_TABLE: Logical tag table. ROW_PERMISSION: Row-level permissions.
GrantToUser	List<GrantToUser>	The list of requesters or authorized users.
account	List<account>	The account information of the requesters or authorized users.
accountType	String	The account type. Valid values: personal account, tenant account, and user group. PERSONAL: Personal account. PRODUCE: Tenant account. USER_GROUP: User group.
userName	String	The account name.
userId	String	The account ID.
period	List<period>	The list of request or authorization periods.
periodType	String	The type of the effective period. DAYS_xx: xx days. LONG_TERM: Long-term.
periodEnd	String	The expiration time of the permission. The time is in the yyyy-mm-dd format.
operates	List<String>	The type of the requested permission. SELECT_ROW: Query with row-level permissions.
resources	List<resources>	The resource content.
resourceType	String	The resource type.
resourceName	String	The resource name.
resoruceCnName	String	The display name of the resource.
children	List<children>	The field information in the request.
resourceName	String	The field name.
operations	List<String>	The type of the requested operation. SELECT_ROW: Query with row-level permissions.
properties	Map<String, Stirng>	Additional attribute information. The `rowPermissionDesc` key indicates the description of the row-level permission. The `rowPermissionTable` key indicates the information about the table associated with the row-level permission.
reason	String	The reason for the request.