tencent cloud

APIs

DokumentasiAPIsBusiness IntelligenceData Types

Data Types

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-06-16 17:20:56

ApiDatasourceConfig

API data source connection configuration

Used by actions: CreateDataTable.

Name Type Required Description
FieldsJsonData String No API data source parsing result
Note: This field may return null, indicating that no valid values can be obtained.
ConnectionType Integer No Connection Type 1: Direct Connection 2: Extraction
Note: This field may return null, indicating that no valid values can be obtained.
FrequencyConfig FrequencyConfig No Extraction frequency configuration
Note: This field may return null, indicating that no valid values can be obtained.
Url String No Request URL
Note: This field may return null, indicating that no valid values can be obtained.
RequestMethod Integer No 1:GET 2:POST
Note: This field may return null, indicating that no valid values can be obtained.
RequestHeader String No Request headers
Note: This field may return null, indicating that no valid values can be obtained.
RequestParams String No Request parameter
Note: This field may return null, indicating that no valid values can be obtained.
RequestBody String No request body
Note: This field may return null, indicating that no valid values can be obtained.
UserName String No Username.
Note: This field may return null, indicating that no valid values can be obtained.
Password String No Password.
Note: This field may return null, indicating that no valid values can be obtained.
AuthorizationType Integer No Valid values: 1: no authentication; 2: BASIC_AUTH.
Note: This field may return null, indicating that no valid values can be obtained.
TableId Integer No Table ID.
Note: This field may return null, indicating that no valid values can be obtained.
JsonPathDbNameMap String No Mapping path DbName
Note: This field may return null, indicating that no valid values can be obtained.
AuthApi String No Authentication API
Note: This field may return null, indicating that no valid values can be obtained.
AppKey String No Application Key
Note: This field may return null, indicating that no valid values can be obtained.
AppSecret String No application key
Note: This field may return null, indicating that no valid values can be obtained.
SecretKey String No Data Key
Note: This field may return null, indicating that no valid values can be obtained.
SecretIv String No Data key initialization vector
Note: This field may return null, indicating that no valid values can be obtained.

ApplyEmbedTokenInfo

Token deferral request

Used by actions: ApplyEmbedInterval.

Name Type Description
Result Boolean Request result.
Note: This field may return null, indicating that no valid values can be obtained.

BaseStateAction

Operation attributes of every record returned by a list query

Used by actions: DescribeDatasourceList.

Name Type Required Description
ShowEdit Boolean No Whether the edit button is visible.
Note: This field may return null, indicating that no valid values can be obtained.
IsEdit Boolean No Whether the edit button is clickable.
Note: This field may return null, indicating that no valid values can be obtained.
EditText String No Edit button text.
Note: This field may return null, indicating that no valid values can be obtained.
EditTips String No Edit-disabled hint.
Note: This field may return null, indicating that no valid values can be obtained.
ShowDel Boolean No Whether the deletion button is visible.
Note: This field may return null, indicating that no valid values can be obtained.
IsDel Boolean No Whether the deletion button is clickable.
Note: This field may return null, indicating that no valid values can be obtained.
DelText String No Delete button text.
Note: This field may return null, indicating that no valid values can be obtained.
DelTips String No Delete-disabled hint.
Note: This field may return null, indicating that no valid values can be obtained.
ShowCopy Boolean No Whether the copy button is visible.
Note: This field may return null, indicating that no valid values can be obtained.
ShowView Boolean No Whether it is visible.
Note: This field may return null, indicating that no valid values can be obtained.
ShowRename Boolean No Whether renaming is allowed.
Note: This field may return null, indicating that no valid values can be obtained.

CorpUserListData

Enterprise user list

Used by actions: DescribeUserProjectList.

Name Type Description
List Array of UserIdAndUserName List.
Note: This field may return null, indicating that no valid values can be obtained.
Total Integer Total number.
TotalPages Integer Number of pages.

Data

Data

Used by actions: CreateProject.

Name Type Description
Id Integer Project ID.
EditUrl String url
Note: This field may return null, indicating that no valid values can be obtained.

DataId

Data ID

Used by actions: CreateUserRole, CreateUserRoleProject.

Name Type Description
Id Integer Data ID.
Note: This field may return null, indicating that no valid values can be obtained.

DatasourceInfo

Data source details

Used by actions: DescribeDatasourceList.

Name Type Description
Id Integer Database ID.
DbName String Database name.
ServiceType String Domain type. Valid values: 1: Tencent Cloud; 2: local.
Note: This field may return null, indicating that no valid values can be obtained.
SourceName String Database alias.
DbType String Database driver.
DbHost String HOST
DbPort Integer Port.
DbUser String Username.
Charset String Database encoding.
CreatedAt String Creation time.
UpdatedAt String Modification time.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
Catalog String Catalog value.
Note: This field may return null, indicating that no valid values can be obtained.
ConnectType String Connection type.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
Desc String Data source description.
Note: This field may return null, indicating that no valid values can be obtained.
Status String Data source status.
Note: This field may return null, indicating that no valid values can be obtained.
SourcePlat String Source platform.
Note: This field may return null, indicating that no valid values can be obtained.
ExtraParam String Extension parameter.
Note: This field may return null, indicating that no valid values can be obtained.
AddInfo String Additional information.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String Project name.
Note: This field may return null, indicating that no valid values can be obtained.
EngineType String Engine type.
Note: This field may return null, indicating that no valid values can be obtained.
Manager String Data source owner.
Note: This field may return null, indicating that no valid values can be obtained.
OperatorWhitelist String Operation personnel allowlist.
Note: This field may return null, indicating that no valid values can be obtained.
VpcId String VPC information of the data source.
Note: This field may return null, indicating that no valid values can be obtained.
UniqVpcId String uniqVpc information of the data source.
Note: This field may return null, indicating that no valid values can be obtained.
RegionId String Data source region information.
Note: This field may return null, indicating that no valid values can be obtained.
StateAction BaseStateAction Operation attributes.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String Updater.
Note: This field may return null, indicating that no valid values can be obtained.
PermissionList Array of PermissionGroup Permission list.
Note: This field may return null, indicating that no valid values can be obtained.
AuthList Array of String Permission value list.
Note: This field may return null, indicating that no valid values can be obtained.
DataOrigin String Third-party data source identifier.
Note: This field may return null, indicating that no valid values can be obtained.
DataOriginProjectId String Third-party project ID.
Note: This field may return null, indicating that no valid values can be obtained.
DataOriginDatasourceId String Third-party data source ID.
Note: This field may return null, indicating that no valid values can be obtained.
ClusterId String Cluster ID.
Note: This field may return null, indicating that no valid values can be obtained.
DbTypeName String Data source name.
Note: This field may return null, indicating that no valid values can be obtained.
UseVPC Boolean Enable VPC.
Note: This field may return null, indicating that no valid values can be obtained.
Owner String Associated person ID.
Note: This field may return null, indicating that no valid values can be obtained.
OwnerName String Associated person name.
Note: This field may return null, indicating that no valid values can be obtained.
Schema String Database schema.
Note: This field may return null, indicating that no valid values can be obtained.
DbVersion String Database version.
Note: This field may return null, indicating that no valid values can be obtained.

DatasourceInfoData

Data source details list

Used by actions: DescribeDatasourceList.

Name Type Description
List Array of DatasourceInfo Data source details list.
Note: This field may return null, indicating that no valid values can be obtained.
Total Integer Total number.
Note: This field may return null, indicating that no valid values can be obtained.
TotalPages Integer Total number of pages.
Note: This field may return null, indicating that no valid values can be obtained.

EmbedTokenInfo

Report embedding data structure with strong authentication

Used by actions: CreateEmbedToken.

Name Type Description
Id Integer Information identifier.
Note: This field may return null, indicating that no valid values can be obtained.
BIToken String Token.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String Updater.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String Update time.
Note: This field may return null, indicating that no valid values can be obtained.
PageId String Page ID.
Note: This field may return null, indicating that no valid values can be obtained.
ExtraParam String Backup.
Note: This field may return null, indicating that no valid values can be obtained.
Scope String Embedding type.
Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime Integer Expiration time (in minutes), with a maximum value of 240.
Note: This field may return null, indicating that no valid values can be obtained.
UserCorpId String User enterprise ID (only used for multi-user).
Note: This field may return null, indicating that no valid values can be obtained.
UserId String User ID (only used for multi-user).
Note: This field may return null, indicating that no valid values can be obtained.
TicketNum Integer Access count limit (range: 1–99999). Leave empty to disable access restrictions.
Note: This field may return null, indicating that no valid values can be obtained.
GlobalParam String Global parameter.
Note: This field may return null, indicating that no valid values can be obtained.
Intention String "embed" indicates page dashboard embedding, and "chatBIEmbed" indicates ChatBI embedding.
Note: This field may return null, indicating that no valid values can be obtained.
TokenType Integer 100: no bound user.
200: single token per user.
300: multiple tokens per user.
Note: This field may return null, indicating that no valid values can be obtained.
TokenNum Integer Number of tokens.
Note: This field may return null, indicating that no valid values can be obtained.
SingleUserMultiToken Boolean Whether it is multiple tokens per user.
Note: This field may return null, indicating that no valid values can be obtained.
ConfigParam String Embedded display configurations: Currently for ChatBI embedding scenarios; TableFilter represents data table list filtering, SqlView represents SQL view feature.
Note: This field may return null, indicating that no valid values can be obtained.

EmptyValue

Empty value display style configuration value structure

Used by actions: CreateDataTable, DescribeSourceFieldList.

Name Type Required Description
Type String No Empty value display style type
Note: This field may return null, indicating that no valid values can be obtained.
Custom String No Display style type for null values corresponds to specific display string
Note: This field may return null, indicating that no valid values can be obtained.

EmptyValueConfig

Empty value display style configuration structure

Used by actions: CreateDataTable, DescribeSourceFieldList.

Name Type Required Description
Number EmptyValue No Numeric value field null style configuration
Note: This field may return null, indicating that no valid values can be obtained.
String EmptyValue No Style configuration for empty string fields
Note: This field may return null, indicating that no valid values can be obtained.

ErrorInfo

Custom error information object

Used by actions: ApplyEmbedInterval, ClearEmbedToken, CreateDataTable, CreateDatasource, CreateDatasourceCloud, CreateEmbedToken, CreatePermissionRanks, CreateProject, CreateUserRole, CreateUserRoleProject, DeleteDatasource, DeleteProject, DeleteUserRole, DeleteUserRoleProject, DescribeDatasourceList, DescribePageWidgetList, DescribeProjectInfo, DescribeProjectList, DescribeSourceFieldList, DescribeUserProjectList, DescribeUserRoleList, DescribeUserRoleProjectList, ExportScreenPage, ModifyDatasource, ModifyDatasourceCloud, ModifyProject, ModifyResourceUser, ModifyResourceUserGroupResource, ModifyUserRole, ModifyUserRoleProject.

Name Type Description
ErrorTip String Error description field.
Note: This field may return null, indicating that no valid values can be obtained.
ErrorMessage String Original exception message.
Note: This field may return null, indicating that no valid values can be obtained.
ErrorLevel String Error level field.
ERROR
WARN
INFO
Note: This field may return null, indicating that no valid values can be obtained.
DocLink String Documentation link.
Note: This field may return null, indicating that no valid values can be obtained.
FAQ String Quick start guide.
Note: This field may return null, indicating that no valid values can be obtained.
ReservedField String Reserved field 1.
Note: This field may return null, indicating that no valid values can be obtained.

FieldRemarkDTO

Field remarks

Used by actions: CreateDataTable.

Name Type Required Description
FieldName String No field name
Note: This field may return null, indicating that no valid values can be obtained.
Comment Array of String No Field remarks list
Note: This field may return null, indicating that no valid values can be obtained.

FrequencyConfig

Scheduled task execution frequency configuration

Used by actions: CreateDataTable.

Name Type Required Description
Frequency String No Cycle
Note: This field may return null, indicating that no valid values can be obtained.
Dates Array of Integer No Date
Note: This field may return null, indicating that no valid values can be obtained.
Time String No Time
Note: This field may return null, indicating that no valid values can be obtained.
IntervalTime Integer No Interval
Note: This field may return null, indicating that no valid values can be obtained.
IntervalTimeUnit Integer No 1:SECOND,2:MINUTE,3:HOUR,4:DAY
Note: This field may return null, indicating that no valid values can be obtained.
Hours Array of Integer No hourly list
Note: This field may return null, indicating that no valid values can be obtained.
Minute Array of Integer No Minute list
Note: This field may return null, indicating that no valid values can be obtained.

IdDTO

Object containing only ID

Used by actions: CreateDataTable, CreateDatasource, CreateDatasourceCloud.

Name Type Required Description
Id Integer Yes Request ID.
Note: This field may return null, indicating that no valid values can be obtained.
AccessKey String No key
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer No id
Note: This field may return null, indicating that no valid values can be obtained.
TranId String No Transaction ID.
Note: This field may return null, indicating that no valid values can be obtained.
TranStatus Integer No Transaction status.
Value range:.
Processing.
2: processing is successful.
3: processing failure.
Note: This field may return null, indicating that no valid values can be obtained.

JoinRelation

Join tables and view association information between original tables

Used by actions: CreateDataTable.

Name Type Required Description
JoinId String No Association relationship id, used by the frontend
Note: This field may return null, indicating that no valid values can be obtained.
SourceTableNodeId String No Original table node id
Note: This field may return null, indicating that no valid values can be obtained.
TargetTableNodeId String No Target table node id
Note: This field may return null, indicating that no valid values can be obtained.
JoinType String No Association type of multi-table join
Note: This field may return null, indicating that no valid values can be obtained.
Fields Array of JoinRelationField No Field list for joined tables
Note: This field may return null, indicating that no valid values can be obtained.

JoinRelationField

Join tables and view association information between original tables

Used by actions: CreateDataTable.

Name Type Required Description
FieldJoinId String No Field association id, frontend usage
Note: This field may return null, indicating that no valid values can be obtained.
SourceField TableField No Original table field
Note: This field may return null, indicating that no valid values can be obtained.
TargetField TableField No Target table field
Note: This field may return null, indicating that no valid values can be obtained.

JoinSourceTable

Join tables and view original table information

Used by actions: CreateDataTable.

Name Type Required Description
TableNodeType Integer No 1: Data source original table, 2: Local table, 3: Excel table, 4: API table
Note: This field may return null, indicating that no valid values can be obtained.
TableNodeId String No Base Table Node Id
Note: This field may return null, indicating that no valid values can be obtained.
ParentId String No Parent node ID
Note: This field may return null, indicating that no valid values can be obtained.
TableId String No Optional, the data source has no ID in the original table.
Note: This field may return null, indicating that no valid values can be obtained.
TableName String No Required. Use the original table name for the data source. Use the logical table name for other types.
Note: This field may return null, indicating that no valid values can be obtained.
Fields Array of TableField No Field list to display in the base table
Note: This field may return null, indicating that no valid values can be obtained.
DatasourceId Integer No Data source ID.
Note: This field may return null, indicating that no valid values can be obtained.
TableAlias String No Optional, alias of the data source displayed on the front-end, excel table creation is required
Note: This field may return null, indicating that no valid values can be obtained.

PageScreenListVO

Screenshot list

Used by actions: ExportScreenPage.

Name Type Description
PicType String Image export type. Valid values: Base64, and URL.
Note: This field may return null, indicating that no valid values can be obtained.
List Array of PageScreenVO Image list.
Note: This field may return null, indicating that no valid values can be obtained.
TranId String Async transaction ID.
Note: This field may return null, indicating that no valid values can be obtained.
TranStatus Integer Transaction status.
1: processing; 2: processing successful; 3: processing failed (error content in outer Msg).
Note: This field may return null, indicating that no valid values can be obtained.

PageScreenVO

Page screenshot information

Used by actions: ExportScreenPage.

Name Type Description
Content String Screenshot Base64 or URL.
Note: This field may return null, indicating that no valid values can be obtained.
WidgetId String Component ID.
Note: This field may return null, indicating that no valid values can be obtained.

ParamCreateDTO

1

Used by actions: CreateDataTable, DescribeSourceFieldList.

Name Type Required Description
ParamName String No Parameter name.
Note: This field may return null, indicating that no valid values can be obtained.
DefaultValue String No Default value
Note: This field may return null, indicating that no valid values can be obtained.
ParamType String No Parameter type, string/datetime/number
Note: This field may return null, indicating that no valid values can be obtained.
FormatRule String No Format type, yyyy-MM-dd HH:mm:ss.SSS (only time required)
Note: This field may return null, indicating that no valid values can be obtained.
ComplexType String No Complex type, another format expression, such as YYYY-MM
Note: This field may return null, indicating that no valid values can be obtained.
Scope String No Application scope
Note: This field may return null, indicating that no valid values can be obtained.

PermissionComponent

Business edition permission unit

Used by actions: DescribeDatasourceList.

Name Type Required Description
ModuleId String No Permission value.
Note: This field may return null, indicating that no valid values can be obtained.
IncludeType String No Availability.
Valid values:.

- usable.
- visible.
- disabled: unavailable.
- hidden: hide.

Default value: disabled.
Example value: disabled.
Note: This field may return null, indicating that no valid values can be obtained.
UpgradeVersionType String No Target upgrade version.
Note: This field may return null, indicating that no valid values can be obtained.
Tips String No Supplemental information.
Note: This field may return null, indicating that no valid values can be obtained.
TipsKey String No Key for supplementary information.
Note: This field may return null, indicating that no valid values can be obtained.

PermissionGroup

Commercial version permission grouping

Used by actions: DescribeDatasourceList.

Name Type Required Description
ModuleGroup String No Group name.
Note: This field may return null, indicating that no valid values can be obtained.
Components Array of PermissionComponent No Permission list.
Note: This field may return null, indicating that no valid values can be obtained.

Project

Project description

Used by actions: DescribeProjectInfo, DescribeProjectList.

Name Type Description
Id Integer Project ID.
Logo String Project logo.
Note: This field may return null, indicating that no valid values can be obtained.
Name String Project name.
Note: This field may return null, indicating that no valid values can be obtained.
ColorCode String Background color of the logo.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
MemberCount Integer Number of members.
Note: This field may return null, indicating that no valid values can be obtained.
PageCount Integer Number of pages.
Note: This field may return null, indicating that no valid values can be obtained.
LastModifyName String Last modified report and dashboard names.
Note: This field may return null, indicating that no valid values can be obtained.
Source String ""
Note: This field may return null, indicating that no valid values can be obtained.
Apply Boolean ""
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String ""
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String ""
Note: This field may return null, indicating that no valid values can be obtained.
CorpId String ""
Note: This field may return null, indicating that no valid values can be obtained.
Mark String ""
Note: This field may return null, indicating that no valid values can be obtained.
Seed String ""
Note: This field may return null, indicating that no valid values can be obtained.
AuthList Array of String Permission list in the project.
Note: This field may return null, indicating that no valid values can be obtained.
PanelScope String Default dashboard.
Note: This field may return null, indicating that no valid values can be obtained.
IsExternalManage Boolean Whether it is managed.
Note: This field may return null, indicating that no valid values can be obtained.
ManagePlatform String Management platform name.
Note: This field may return null, indicating that no valid values can be obtained.
ConfigList Array of ProjectConfigList Customization parameter.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUserName String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
Owner String Associated person ID.
Note: This field may return null, indicating that no valid values can be obtained.
OwnerName String Associated person.
Note: This field may return null, indicating that no valid values can be obtained.
NormalCount Integer Number of dashboard pages.
Note: This field may return null, indicating that no valid values can be obtained.
FreeCount Integer Number of free canvas pages.
Note: This field may return null, indicating that no valid values can be obtained.
AdhocCount Integer Number of ad-hoc analysis pages.
Note: This field may return null, indicating that no valid values can be obtained.
BriefingCount Integer Number of pages in the briefing
Note: This field may return null, indicating that no valid values can be obtained.

ProjectConfigList

Customized query

Used by actions: DescribeProjectInfo.

Name Type Required Description
ModuleGroup String No Module group.
Note: This field may return null, indicating that no valid values can be obtained.
Components Array of ProjectConfigResult No Content.
Note: This field may return null, indicating that no valid values can be obtained.

ProjectConfigResult

Customized query

Used by actions: DescribeProjectInfo.

Name Type Required Description
ModuleId String No Configuration name.
Note: This field may return null, indicating that no valid values can be obtained.
IncludeType String No Configuration mode.
Valid values:.

- usable.
- visible.
- disabled: unavailable.
- hidden: hide.

Default value: disabled.
Example value: disabled.
Note: This field may return null, indicating that no valid values can be obtained.
Params String No Additional parameters.
Note: This field may return null, indicating that no valid values can be obtained.

ProjectListData

Project list data

Used by actions: DescribeProjectList.

Name Type Description
List Array of Project Array.
Note: This field may return null, indicating that no valid values can be obtained.
Total Integer Total number.

Note: This field may return null, indicating that no valid values can be obtained.
TotalPages Integer 1
Note: This field may return null, indicating that no valid values can be obtained.

ResourceItem

resource

Used by actions: ModifyResourceUser, ModifyResourceUserGroupResource.

Name Type Required Description
ResourceName String No Resource name
Note: This field may return null, indicating that no valid values can be obtained.
ResourceValue Boolean No resource value
Note: This field may return null, indicating that no valid values can be obtained.
CanChange Boolean No Changeable
Note: This field may return null, indicating that no valid values can be obtained.
Tips String No Prompt message
Note: This field may return null, indicating that no valid values can be obtained.

RowColumnConfig

Row/column permission configuration

Used by actions: CreatePermissionRanks.

Name Type Required Description
RulerInfo String No Row column permission rule
Note: This field may return null, indicating that no valid values can be obtained.
TagValueList Array of RowColumnTagValue No Tag value list
Note: This field may return null, indicating that no valid values can be obtained.

RowColumnTagValue

Row/column permission tag input/output parameter

Used by actions: CreatePermissionRanks.

Name Type Required Description
Id Integer No Tag ID.
Note: This field may return null, indicating that no valid values can be obtained.
Name String No Tag name.
Note: This field may return null, indicating that no valid values can be obtained.
Values Array of String No Tag value list
Note: This field may return null, indicating that no valid values can be obtained.

TableColumn

Column data abstraction of a table

Used by actions: DescribeSourceFieldList.

Name Type Description
DbName String Column name
Note: This field may return null, indicating that no valid values can be obtained.
AliasName String alias name
Note: This field may return null, indicating that no valid values can be obtained.
DbType String Column type
Note: This field may return null, indicating that no valid values can be obtained.
FieldType String Segment type
Note: This field may return null, indicating that no valid values can be obtained.
Mark String Remarks.
Note: This field may return null, indicating that no valid values can be obtained.
ExcelName String excel name
Note: This field may return null, indicating that no valid values can be obtained.
DictId Integer Associated dictionary table Id
Note: This field may return null, indicating that no valid values can be obtained.
DictName String Associated dictionary table name
Note: This field may return null, indicating that no valid values can be obtained.
TableNodeId String Join tables and add fields
Note: This field may return null, indicating that no valid values can be obtained.
TableName String Table name to which the field belongs
Note: This field may return null, indicating that no valid values can be obtained.
FieldComplexType String Complex format of the target set by the user
Note: This field may return null, indicating that no valid values can be obtained.
FormatRule String format rule
Note: This field may return null, indicating that no valid values can be obtained.
IsFilter Boolean Whether to filter empty data fields
Note: This field may return null, indicating that no valid values can be obtained.
CalcType String Compute field type
Note: This field may return null, indicating that no valid values can be obtained.
CalcFormula String Formula content of the calculated field
Note: This field may return null, indicating that no valid values can be obtained.
CalcDesc String Chinese formula content of the calculated field
Note: This field may return null, indicating that no valid values can be obtained.
JsonPathName String Api data source json path name
Note: This field may return null, indicating that no valid values can be obtained.
Granularity String Geographic type identifier
Note: This field may return null, indicating that no valid values can be obtained.
GeoJsonId Integer Custom map Id
Note: This field may return null, indicating that no valid values can be obtained.
EmptyValueConfig EmptyValueConfig Style configuration for null value display
Note: This field may return null, indicating that no valid values can be obtained.
DbFieldName String Original column name
Note: This field may return null, indicating that no valid values can be obtained.
IsCopyOperation Boolean Whether to copy field operation
Note: This field may return null, indicating that no valid values can be obtained.
IsCopyFromNormal Boolean Whether to copy from common fields
Note: This field may return null, indicating that no valid values can be obtained.

TableColumnListData

Data list of all column names in the table

Used by actions: DescribeSourceFieldList.

Name Type Description
List Array of TableColumn Column list in the table
Note: This field may return null, indicating that no valid values can be obtained.
TranId String async transaction id
Note: This field may return null, indicating that no valid values can be obtained.
TranStatus Integer Async transaction status
Note: This field may return null, indicating that no valid values can be obtained.

TableField

Table field description

Used by actions: CreateDataTable.

Name Type Required Description
DbName String Yes Field name in the db
AliasName String Yes bi display name
DbType String Yes Field type in the db
FieldType String Yes Abstract field types after BI categorization, such as string, number, time
FieldComplexType String No Complex detail type generated after calculation formula of combination of fields
Note: This field may return null, indicating that no valid values can be obtained.
Mark String No Field description
Note: This field may return null, indicating that no valid values can be obtained.
FormatRule String No Field calculation formula
Note: This field may return null, indicating that no valid values can be obtained.
IsFilter Boolean No Whether to filter empty data fields
Note: This field may return null, indicating that no valid values can be obtained.
CalcType String No Compute field type
Note: This field may return null, indicating that no valid values can be obtained.
CalcFormula String No Formula content of the calculated field
Note: This field may return null, indicating that no valid values can be obtained.
CalcDesc String No Chinese formula content of the calculated field, displayed on the front-end
Note: This field may return null, indicating that no valid values can be obtained.
DictId Integer No Associate dictionary table id
Note: This field may return null, indicating that no valid values can be obtained.
DictName String No Associate dictionary table name
Note: This field may return null, indicating that no valid values can be obtained.
TableNodeId String No Optional, join tables to add field
Note: This field may return null, indicating that no valid values can be obtained.
ExcelName String No excel
Note: This field may return null, indicating that no valid values can be obtained.
TableName String No Optional, join tables to add field, name of the table the field belongs to
Note: This field may return null, indicating that no valid values can be obtained.
JsonPathName String No api data source path name
Note: This field may return null, indicating that no valid values can be obtained.
Granularity String No Geographic field identifier
Note: This field may return null, indicating that no valid values can be obtained.
GeoJsonId Integer No Map id
Note: This field may return null, indicating that no valid values can be obtained.
EmptyValueConfig EmptyValueConfig No Style configuration for null value display
Note: This field may return null, indicating that no valid values can be obtained.
DbFieldName String No Original column name
Note: This field may return null, indicating that no valid values can be obtained.
IsCopyOperation Boolean No Whether to copy field operation
Note: This field may return null, indicating that no valid values can be obtained.
IsCopyFromNormal Boolean No Whether to copy from common fields
Note: This field may return null, indicating that no valid values can be obtained.

UserGroupDTO

User group

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Required Description
Id Integer No id
Note: This field may return null, indicating that no valid values can be obtained.
GroupName String No User group name.
Note: This field may return null, indicating that no valid values can be obtained.
ParentId Integer No Parent node ID.
Note: This field may return null, indicating that no valid values can be obtained.
IsDefault Integer No Whether it is default.
Note: This field may return null, indicating that no valid values can be obtained.
AdminUserId String No Administrator user ID.
Note: This field may return null, indicating that no valid values can be obtained.
Description String No Description.
Note: This field may return null, indicating that no valid values can be obtained.
Location Integer No Location.
Note: This field may return null, indicating that no valid values can be obtained.

UserIdAndUserName

User ID and username

Used by actions: DescribeUserProjectList.

Name Type Required Description
UserId String No User ID.
UserName String No Username.
CorpId String No Enterprise ID.
Note: This field may return null, indicating that no valid values can be obtained.
Email String No Email.
Note: This field may return null, indicating that no valid values can be obtained.
LastLogin Timestamp ISO8601 No Last login time.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer No User status.
Valid values:.

- 1: Enable.
- 0: disabled.

The default value is 1.
Example value: 1.
Note: This field may return null, indicating that no valid values can be obtained.
FirstModify Integer No Whether to change password on first login.
Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber String No Mobile number.
Note: This field may return null, indicating that no valid values can be obtained.
AreaCode String No Telephone country code.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String No Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt Timestamp ISO8601 No Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String No Modifier.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt Timestamp ISO8601 No Change time.
Note: This field may return null, indicating that no valid values can be obtained.
GlobalUserName String No System global role.
Note: This field may return null, indicating that no valid values can be obtained.
GlobalUserCode String No System global role code.
Note: This field may return null, indicating that no valid values can be obtained.
Mobile String No Mobile number.

Note: This field may return null, indicating that no valid values can be obtained.
AppId String No 1
Note: This field may return null, indicating that no valid values can be obtained.
AppUserId String No 1
Note: This field may return null, indicating that no valid values can be obtained.
AppUserAliasName String No 1
Note: This field may return null, indicating that no valid values can be obtained.
AppUserName String No 1
Note: This field may return null, indicating that no valid values can be obtained.
InValidateAppRange Boolean No 1
Note: This field may return null, indicating that no valid values can be obtained.
EmailActivationStatus Integer No -1: No activation required. 0: Inactivated. 1: Activated. Null value represents pending binding.
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer No 1
Note: This field may return null, indicating that no valid values can be obtained.

UserInfo

User ID and username

Used by actions: CreateUserRole, CreateUserRoleProject.

Name Type Required Description
UserId String No User ID.
UserName String No Username.
Email String No Email.
Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber String No Mobile number.

Note: This field may return null, indicating that no valid values can be obtained.
AreaCode String No Telephone country code.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserId String No WeCom account ID.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserName String No WeCom account name.
Note: This field may return null, indicating that no valid values can be obtained.

UserResourceDTO

User resource input parameter

Used by actions: ModifyResourceUser, ModifyResourceUserGroupResource.

Name Type Required Description
CorpId String No Enterprise ID.
Note: This field may return null, indicating that no valid values can be obtained.
UserId String No User ID
Note: This field may return null, indicating that no valid values can be obtained.
UserName String No Username.
Note: This field may return null, indicating that no valid values can be obtained.
ResourceList Array of ResourceItem No Resource list
Note: This field may return null, indicating that no valid values can be obtained.

UserRoleListData

User role information

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Description
Total Integer Total number.
Note: This field may return null, indicating that no valid values can be obtained.
TotalPages Integer Total number of pages.
Note: This field may return null, indicating that no valid values can be obtained.
List Array of UserRoleListDataUserRoleInfo List.
Note: This field may return null, indicating that no valid values can be obtained.

UserRoleListDataRoleInfo

Role information of the user role list

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Description
RoleName String Role Name.
Note: This field may return null, indicating that no valid values can be obtained.
RoleId Integer Role ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String Project name.
Note: This field may return null, indicating that no valid values can be obtained.
ScopeType Integer Whether it is a global role (0: no; 1: yes).
Note: This field may return null, indicating that no valid values can be obtained.
ModuleCollection String Role key.
Note: This field may return null, indicating that no valid values can be obtained.

UserRoleListDataUserRoleInfo

User role information

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Description
Id Integer Business ID.
RoleList Array of UserRoleListDataRoleInfo This API is used to obtain the role list.
Note: This field may return null, indicating that no valid values can be obtained.
RoleIdList Array of Integer Role ID list.
Note: This field may return null, indicating that no valid values can be obtained.
UserId String User ID.
UserName String Username.
CorpId String Enterprise ID.
Email String Email.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String Updater.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String Update time.
Note: This field may return null, indicating that no valid values can be obtained.
LastLogin Timestamp ISO8601 Last login time.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Account status.
Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber String Mobile number.
Note: This field may return null, indicating that no valid values can be obtained.
AreaCode String Telephone country code.
Note: This field may return null, indicating that no valid values can be obtained.
RootAccount Boolean Whether it is the root account.
Note: This field may return null, indicating that no valid values can be obtained.
CorpAdmin Boolean Whether it is an enterprise administrator.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserId String WeCom user ID.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserAliasName String Nickname.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserName String Application username.
Note: This field may return null, indicating that no valid values can be obtained.
InValidateAppRange Boolean Whether it is within the visible range.
Note: This field may return null, indicating that no valid values can be obtained.
AppOpenUserId String User openID.
Note: This field may return null, indicating that no valid values can be obtained.
EmailActivationStatus Integer Activation status of email.
Note: This field may return null, indicating that no valid values can be obtained.
UserGroupList Array of UserGroupDTO User group information.
Note: This field may return null, indicating that no valid values can be obtained.

WidgetListVO

Page component information

Used by actions: DescribePageWidgetList.

Name Type Description
CorpId String uin
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
PageId String Page ID.
Note: This field may return null, indicating that no valid values can be obtained.
WidgetList Array of WidgetVO Component array.
Note: This field may return null, indicating that no valid values can be obtained.

WidgetVO

Component information

Used by actions: DescribePageWidgetList.

Name Type Description
WidgetId String Component ID.
Note: This field may return null, indicating that no valid values can be obtained.
WidgetName String Component name.
Note: This field may return null, indicating that no valid values can be obtained.
Topik sebelumnya: DescribeDatasourceListTopik selanjutnya: Error Codes

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan