参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Authorization | String | 是 | HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx | 详细介绍请查阅调用方式文档 |
X-Tenant | Int | 是 | 1 | 项目ID |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ApiAction | String | 是 | GetSubjects | 固定值，对应“请求说明”中的“接口名称” |
ApiVersionApiVersion | String | 是 | 2023-02-10 | 固定值，版本号： 2023-02-10 |
orgId | Int | 否 | 1 | 集团id |
无
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
code | Number | 0 | 状态码，0表示正常 |
msg | String | "" | 接口返回信息 |
data | Array | [] | 主体列表 |
SubjectMeta
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
orgId | Integer | 0 | 集团id |
subjectId | Integer | 0 | 主体id |
subjectName | String | string | 主体名称 |
subjectType | String | string | 主体类型 |
defaultIdType | IdTypes | {} | 默认的base实体 |
IdTypes
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
id | Number | 1 | idType 的 id |
code | String | baseid | idType 的 code |
name | String | 基准 | idType 的名称 |
dataType | String | Decimal | idType 的数据类型 |
subjectId | Number | 1 | 主体ID |
entityType | String | BaseId | IdType 的渠道标识 |
needEncrypt | String | false | 废弃 |
finderIdType | String | null | Finder ID 类型标识 |
GET /?ApiAction=GetSubjects&ApiVersion=2023-02-10&orgId=1
{ "code": 0, "msg": "成功", "data": [ { "orgId": 1, "subjectId": 1, "subjectName": "主体1", "subjectType": "Person", "defaultIdType": null, "baseIdCode": "baseid", "baseEntityId": 1, "dataType": null, "hasAuth": true } ] }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | invalidParameter | PARAMETER INVALID | 参数非法，检查入参。 |