修改关系

接口说明

本接口用于在指标平台中修改一个数据集关联关系。

接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/relation/update

anymetrics_host:anymetrics_port 获取方式请参考：调用方式

请求参数

公共请求参数(HEADERS)

参数	类型	是否必选	描述
tenant-id	String	是	租户ID，用于指标查询内容所在的租户
auth-type	String	是	认证方式。支持 UID、TOKEN、ACCOUNT、APIKEY
auth-value	String	是	与 auth-type 对应的认证值

公共参数获取方式

tenant-id 可在 Aloudata CAN 顶部导航栏选择指标应用，左边菜单栏选择 API 集成，在 API 集成界面获取；auth-value 请按 auth-type 填写对应认证值。

Body 请求参数

参数	类型	是否必选	最大长度	描述	示例值
id	String	是	128	待修改的关系 ID	1772
relationName	String	是	128	关系英文名/标识。修改关系时也需要传入	rel_fact_shop
relationDisplayName	String	是	128	关系展示名。修改关系时也需要传入	订单门店关系
type	String	是	32	关系类型。枚举值：ONE_TO_ONE、MANY_TO_ONE	MANY_TO_ONE
srcDatasetName	String	是	128	来源数据集名称。填写 AnyMetrics 数据集名称，不是物理表名	fact_orders
dstDatasetName	String	是	128	目标数据集名称。填写 AnyMetrics 数据集名称，不是物理表名	dim_shop
relationConditions	List	是	-	关系条件列表，详见 relationConditions 参数说明	-

relationConditions 参数说明

参数	类型	是否必选	描述	示例值
srcExpr	String	是	来源数据集字段表达式	[fact_orders/shop_code]
dstExpr	String	是	目标数据集字段表达式	[dim_shop/tr_shop_code]

响应参数

参数	类型	是否必选	描述
code	String	是	接口响应码
success	Boolean	是	请求是否成功
errorMsg	String	否	报错信息
detailErrorMsg	String	否	报错详情
traceId	String	是	跟踪 ID，用于问题排查
data	String	是	修改后的关系 ID

请求示例

{
  "id": "1772",
  "relationName": "rel_fact_shop",
  "relationDisplayName": "订单门店关系",
  "srcDatasetName": "fact_orders",
  "type": "MANY_TO_ONE",
  "relationConditions": [
    {
      "srcExpr": "[fact_orders/shop_code]",
      "dstExpr": "[dim_shop/tr_shop_code]"
    }
  ],
  "dstDatasetName": "dim_shop"
}

响应示例

{
  "data": "relation_13",
  "success": true,
  "code": "200",
  "errorMsg": null,
  "detailErrorMsg": null,
  "traceId": "f6e656798ed241c789f7132823c46c6b.141.17194028392300357"
}