You need to enable JavaScript to run this app.
导航
客户数据平台
  • 文档首页
    • /客户数据平台/开放能力/OpenAPI/IDMapping/GetSubjects - 按项目id获取主体列表
GetSubjects - 按项目id获取主体列表
最近更新时间：2024.07.25 14:48:00首次发布时间：2024.07.12 14:50:49
我的收藏

请求说明

  • 请求方式：GET
  • 接口名称：GetSubjects
  • 请求地址：https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

是

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

X-Tenant

Int

是

1

项目id

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

是

GetSubjects

对应“请求说明”中的“接口名称”

ApiVersion

String

是

2023-02-10

版本号： 2023-02-10

orgId

Int

否

集团id

Body

无

返回参数

data数组元素字段内容

参数

类型

示例值

描述

orgId

Integer

0

集团id

subjectId

Integer

0

主体id

subjectName

String

string

主体名称

subjectType

String

string

主体类型

defaultIdType

Object

{
        "id": 0,
        "subjectId": 0,
        "code": "string",
        "name": "string",
        "dataType": "string",
        "entityType": "string",
        "needEncrypt": "string",
        "finderIdType": "string"
      }

默认的base实体

defaultIdType.id

Integer

0

baseid的id

defaultIdType.subjectId

Integer

0

主体id

defaultIdType.code

String

string

基准code

defaultIdType.name

String

string

基准名

defaultIdType.dataType

String

string

基准ID类型的数据类型

defaultIdType.entityType

String

string

渠道标识

defaultIdType.needEncrypt

String

string

废弃

defaultIdType.finderIdType

String

string

Finder ID类型标识

请求示例

无

返回示例

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "orgId": 0,
      "subjectId": 0,
      "subjectName": "string",
      "subjectType": "string",
      "defaultIdType": {
        "id": 0,
        "subjectId": 0,
        "code": "string",
        "name": "string",
        "dataType": "string",
        "entityType": "string",
        "needEncrypt": "string",
        "finderIdType": "string"
      }
    }
  ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。