数据源相关--客户数据平台-火山引擎

文档中心

立即注册

导航

数据源相关

最近更新时间：2023.12.04 17:35:50首次发布时间：2023.10.08 10:43:09

说明

暂不支持权限校验

1. 获取数据源列表

基本信息

生效版本	1.18
功能描述	按租户获取数据源列表
接口模块	DatasourceApi
接口名称	QueryDataSourceList
请求类型	GET
权限校验	不支持

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	App id
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
sourceName	String	否	数据源名称，不传获取所有

Body（无）

响应参数

名称	数据类型	描述
id	int	数据源id
projectId	int	项目id
entityType	string	所在实体名
sourceType	int	数据源类型（1：属性，2：明细，3；行为）
sourceName	string	数据源名称
owner	string	数据源owner
syncType	int	更新类型（0：离线，1：实时）
templateOrNot	boolean	是否为模版

返回示例：

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": 0,
      "projectId": 0,
      "entityType": "string",
      "sourceType": 0,
      "sourceName": "string",
      "owner": "string",
      "sourceTag": "string",
      "syncType": 0,
      "templateOrNot": true
    }
  ]
}

2. 获取数据源字段列表

基本信息

生效版本	1.18
功能描述	按数据源id获取CDP数据源字段列表，对应CDP元数据管理中的数据源
接口模块	DatasourceApi
接口名称	QuerypropertyList
请求类型	GET
权限校验	不支持

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
dataSourceId	Int	是	数据源id

Body（无）

响应参数

名称	数据类型	描述
id	int	字段id
dataSourceId	int	数据源id
fieldName	string	字段名
filedType	string	字段类型
fieldDesc	string	字段名称
expr	string	字段表达式
showName	string	展示名
display	int	是否展示

返回示例：

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": 0,
      "dataSourceId": 0,
      "fieldName": "string",
      "filedType": "string",
      "fieldDesc": "string",
      "expr": "string",
      "showName": "string",
      "display": 0
    }
  ]
}

3. 获取字段枚举值

基本信息

生效版本	1.18
功能描述	按数据源和字段获取字段枚举值
接口模块	DatasourceApi
接口名称	QuerypropertyValues
请求类型	GET
权限校验	不支持

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
id	Integer	是	字段id
dataSourceId	Integer	是	数据源id

Body（无）

响应参数

名称	数据类型	描述
data	Array	枚举值列表

返回示例：

{
  "code": 0,
  "msg": "string",
  "data": [
    "string"
  ]
}

4. 获取行为下事件列表

基本信息

生效版本	1.18
功能描述	按数据源获取事件列表
接口模块	DatasourceApi
接口名称	QueryeventList
请求类型	GET
权限校验	不支持

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
dataSourceId	Int	否	数据源id

Body（无）

响应参数

名称	数据类型	描述
id	int	事件id
eventId	int	事件id
enName	string	事件名
cnName	string	事件展示名
description	string	事件描述
eventType	int	事件类型
originId	string	原始id
isDisplay	boolean	是否显示
editBan	boolean	是否可编辑
dataSourceId	int	数据源id
dataSourceName	string	数据源名
sourceTag	string	数据源注册来源
sourceType	int	数据源类型

返回示例：

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": 0,
      "eventId": 0,
      "enName": "string",
      "cnName": "string",
      "description": "string",
      "eventType": 0,
      "originId": 0,
      "isDisplay": true,
      "editBan": true,
      "dataSourceId": 0,
      "dataSourceName": "string",
      "sourceTag": "string",
      "sourceType": 0
    }
  ]
}

5. 获取行为事件的属性列表

基本信息

生效版本	1.18
功能描述	按事件获取事件属性列表
接口模块	DatasourceApi
接口名称	QueryeventPropertyList
请求类型	GET
权限校验	不支持

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	String	是	App id

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
eventId	Int	是	事件id

Body

响应参数

名称	数据类型	描述
propertyId	int	事件属性id
eventId	int	关联事件id
enName	string	事件属性名
cnName	string	事件属性展示名
expr	string	属性表达式
dataType	string	数据类型
description	string	描述
originId	string	原始id
isDisplay	boolean	是否显示
editBan	boolean	是否可编辑
dataSourceId	int	数据源id
dataSourceName	string	数据源名
sourceTag	string	数据源注册来源
sourceType	int	数据源类型

返回示例：

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "propertyId": 0,    // 事件属性id
      "eventId": 0,       // 关联事件id，仅在使用事件id作为过滤条件查询时返回
      "enName": "string",
      "cnName": "string",
      "expr": "string",
      "dataType": "string",
      "description": "string",
      "originId": 0,
      "isDisplay": true,
      "editBan": true,
      "dataSourceId": 0,
      "dataSourceName": "string",
      "sourceTag": "string",
      "sourceType": 0
    }
  ]

6. 获取明细数据源的枚举值

基本信息

生效版本	1.18
功能描述	获取明细数据源的枚举值
接口模块	DetailDatasourceApi
接口名称	GetDetailAttributes
请求类型	POST
权限校验	不支持

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
tenantCode	String	是	租户code
attributeId	Int	是	要查的数据源字段id

Body

名称	数据类型	是否必选	描述
datasourceId	Int	是	数据源id
times	JsonValue	是	描述时间范围的类型

body示例：

{
    "datasourceId": 33,
    "times": {
        "startTime": "2023-02-01",
        "endTime": "2023-02-05",
        "type": "Range"
    }
}

响应参数：

名称	数据类型	描述
data	Array	返回一个数组，其中包括所有该字段出现过的枚举值

返回示例：

{"data":["\"2022-01-06 12:30:30\"","\"2022-01-07 12:30:30\"","\"2022-01-08 12:30:30\"","\"2022-01-14 12:30:30\"","\"2022-01-15 12:30:30\"","\"2022-01-16 12:30:30\"","\"2022-01-20 12:30:30\"","\"2022-01-24 12:30:30\"","\"2022-01-29 12:30:30\"","\"2022-02-01 12:30:30\"","\"2022-02-06 12:30:30\"","\"2022-02-07 12:30:30\"","\"2022-02-13 12:30:30\"","\"2022-02-18 12:30:30\"","\"2022-02-20 12:30:30\"","\"2022-02-22 12:30:30\"","\"2022-02-25 12:30:30\"","\"2022-02-28 12:30:30\"","\"2022-03-01 12:30:30\"","\"2022-03-03 12:30:30\"","\"2022-03-04 12:30:30\"","\"2022-03-08 12:30:30\"","\"2022-03-15 12:30:30\"","\"2022-03-17 12:30:30\"","\"2022-03-18 12:30:30\"","\"2022-03-19 12:30:30\"","\"2022-03-28 12:30:30\"","\"2022-03-31 12:30:30\"","\"2022-04-07 12:30:30\"","\"2022-04-14 12:30:30\"","\"2022-04-20 12:30:30\"","\"2022-04-23 12:30:30\"","\"2022-04-26 12:30:30\"","\"2022-04-28 12:30:30\"","\"2022-04-29 12:30:30\"","\"2022-05-12 12:30:30\"","\"2022-05-13 12:30:30\"","\"2022-05-15 12:30:30\"","\"2022-05-16 12:30:30\"","\"2022-05-29 12:30:30\"","\"2022-05-30 12:30:30\"","\"2022-05-31 12:30:30\"","\"2022-06-03 12:30:30\"","\"2022-06-04 12:30:30\"","\"2022-06-06 12:30:30\"","\"2022-06-08 12:30:30\"","\"2022-06-12 12:30:30\"","\"2022-06-15 12:30:30\"","\"2022-06-20 12:30:30\"","\"2022-06-23 12:30:30\"","\"2022-06-25 12:30:30\"","\"2022-06-27 12:30:30\"","\"2022-06-28 12:30:30\"","\"2022-06-29 12:30:30\"","\"2022-06-30 12:30:30\"","\"2022-07-03 12:30:30\"","\"2022-07-04 12:30:30\"","\"2022-07-06 12:30:30\"","\"2022-07-16 12:30:30\"","\"2022-07-18 12:30:30\"","\"2022-07-19 12:30:30\"","\"2022-07-20 12:30:30\"","\"2022-07-21 12:30:30\"","\"2022-07-22 12:30:30\"","\"2022-07-24 12:30:30\"","\"2022-07-26 12:30:30\"","\"2022-07-31 12:30:30\"","\"2022-08-04 12:30:30\"","\"2022-08-13 12:30:30\"","\"2022-08-14 12:30:30\"","\"2022-08-16 12:30:30\"","\"2022-01-03 12:30:30\"","\"2022-01-04 12:30:30\"","\"2022-01-11 12:30:30\"","\"2022-01-12 12:30:30\"","\"2022-01-21 12:30:30\"","\"2022-01-23 12:30:30\"","\"2022-01-25 12:30:30\"","\"2022-02-04 12:30:30\"","\"2022-02-05 12:30:30\"","\"2022-02-11 12:30:30\"","\"2022-02-12 12:30:30\"","\"2022-02-15 12:30:30\"","\"2022-03-05 12:30:30\"","\"2022-03-06 12:30:30\"","\"2022-03-09 12:30:30\"","\"2022-03-16 12:30:30\"","\"2022-03-22 12:30:30\"","\"2022-03-26 12:30:30\"","\"2022-03-29 12:30:30\"","\"2022-04-01 12:30:30\"","\"2022-04-03 12:30:30\"","\"2022-04-05 12:30:30\"","\"2022-04-06 12:30:30\"","\"2022-04-09 12:30:30\"","\"2022-04-15 12:30:30\"","\"2022-04-16 12:30:30\"","\"2022-04-17 12:30:30\"","\"2022-04-18 12:30:30\"","\"2022-04-21 12:30:30\"","\"2022-04-27 12:30:30\"","\"2022-05-01 12:30:30\"","\"2022-05-04 12:30:30\"","\"2022-05-05 12:30:30\"","\"2022-05-06 12:30:30\"","\"2022-05-07 12:30:30\"","\"2022-05-09 12:30:30\"","\"2022-05-10 12:30:30\"","\"2022-05-11 12:30:30\"","\"2022-05-20 12:30:30\"","\"2022-05-22 12:30:30\"","\"2022-05-23 12:30:30\"","\"2022-05-24 12:30:30\"","\"2022-05-25 12:30:30\"","\"2022-06-01 12:30:30\"","\"2022-06-02 12:30:30\"","\"2022-06-10 12:30:30\"","\"2022-06-13 12:30:30\"","\"2022-06-16 12:30:30\"","\"2022-06-19 12:30:30\"","\"2022-06-26 12:30:30\"","\"2022-07-01 12:30:30\"","\"2022-07-02 12:30:30\"","\"2022-07-08 12:30:30\"","\"2022-07-12 12:30:30\"","\"2022-07-13 12:30:30\"","\"2022-07-15 12:30:30\"","\"2022-07-23 12:30:30\"","\"2022-01-01 12:30:30\"","\"2022-01-02 12:30:30\"","\"2022-01-05 12:30:30\"","\"2022-01-09 12:30:30\"","\"2022-01-10 12:30:30\"","\"2022-01-17 12:30:30\"","\"2022-01-18 12:30:30\"","\"2022-01-19 12:30:30\"","\"2022-01-22 12:30:30\"","\"2022-01-26 12:30:30\"","\"2022-01-27 12:30:30\"","\"2022-01-28 12:30:30\"","\"2022-01-30 12:30:30\"","\"2022-01-31 12:30:30\"","\"2022-02-02 12:30:30\"","\"2022-02-03 12:30:30\"","\"2022-02-08 12:30:30\"","\"2022-02-09 12:30:30\"","\"2023-02-10 12:30:30\"","\"2022-02-14 12:30:30\"","\"2022-02-16 12:30:30\"","\"2022-02-19 12:30:30\"","\"2022-02-21 12:30:30\"","\"2022-02-23 12:30:30\"","\"2022-02-24 12:30:30\"","\"2022-02-26 12:30:30\"","\"2022-02-27 12:30:30\"","\"2022-03-02 12:30:30\"","\"2022-03-07 12:30:30\"","\"2022-03-10 12:30:30\"","\"2022-03-11 12:30:30\"","\"2022-03-12 12:30:30\"","\"2022-03-13 12:30:30\"","\"2022-03-14 12:30:30\"","\"2022-03-20 12:30:30\"","\"2022-03-21 12:30:30\"","\"2022-03-23 12:30:30\"","\"2022-03-24 12:30:30\"","\"2022-03-25 12:30:30\"","\"2022-03-27 12:30:30\"","\"2022-03-30 12:30:30\"","\"2022-04-02 12:30:30\"","\"2022-04-04 12:30:30\"","\"2022-04-08 12:30:30\"","\"2022-04-10 12:30:30\"","\"2022-04-11 12:30:30\"","\"2022-04-12 12:30:30\"","\"2022-04-13 12:30:30\"","\"2022-04-19 12:30:30\"","\"2022-04-22 12:30:30\"","\"2022-04-24 12:30:30\"","\"2022-04-25 12:30:30\"","\"2022-04-30 12:30:30\"","\"2022-05-02 12:30:30\"","\"2022-05-03 12:30:30\"","\"2022-05-08 12:30:30\"","\"2022-05-14 12:30:30\"","\"2022-05-17 12:30:30\"","\"2022-05-18 12:30:30\"","\"2022-05-19 12:30:30\"","\"2022-05-21 12:30:30\"","\"2022-05-26 12:30:30\"","\"2022-05-27 12:30:30\"","\"2022-05-28 12:30:30\"","\"2022-06-05 12:30:30\"","\"2022-06-07 12:30:30\"","\"2022-06-09 12:30:30\"","\"2022-06-11 12:30:30\"","\"2022-06-14 12:30:30\"","\"2022-06-17 12:30:30\"","\"2022-06-18 12:30:30\"","\"2022-06-21 12:30:30\"","\"2022-06-22 12:30:30\"","\"2022-06-24 12:30:30\"","\"2022-07-05 12:30:30\"","\"2022-07-07 12:30:30\"","\"2022-07-09 12:30:30\"","\"2022-07-10 12:30:30\"","\"2022-07-11 12:30:30\"","\"2022-07-14 12:30:30\"","\"2022-07-17 12:30:30\"","\"2022-07-25 12:30:30\"","\"2022-07-27 12:30:30\"","\"2022-07-28 12:30:30\"","\"2022-07-29 12:30:30\"","\"2022-07-30 12:30:30\"","\"2022-08-01 12:30:30\"","\"2022-08-02 12:30:30\"","\"2022-08-03 12:30:30\"","\"2022-08-05 12:30:30\"","\"2022-08-06 12:30:30\"","\"2022-08-07 12:30:30\"","\"2022-08-08 12:30:30\"","\"2022-08-09 12:30:30\"","\"2022-08-10 12:30:30\"","\"2022-08-11 12:30:30\"","\"2022-08-12 12:30:30\"","\"2022-08-15 12:30:30\"","\"2022-08-17 12:30:30\"","\"2022-08-18 12:30:30\"","\"2022-01-13 12:30:30\"","\"2022-02-17 12:30:30\""],"code":0}