1. 获取类的定义
获取类的定义。
请求方式：GET
请求地址：/bosfoundationservice/{appKey}/datamodel/{key}
1.1. 请求参数：
Headers：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| key | string | NULL | 是 | 类的className |
SearchParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| NULL | NULL | NULL | NULL | NULL |
Body：
application/json：
NULL
1.2. 参数说明：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回：
（Http Status Code：200）
{
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"attributeGroup": [],
"_rev": "_cUlWIZy---",
"_id": "class_object/documents",
"_key": "documents",
"relation": [
{
"relateship": "communications",
"left": "communications",
"name": "irCommunicationDocument",
"right": "documents",
"ratio": "N:N",
"hasChild": false,
"userDefined": false,
"collection": "communication_document",
"parentKey": "relationship"
},
...
],
"attributes": [
{
"code": "bosclass",
"attributeType": "system",
"definedClass": "system",
"group": [],
"description": "class key",
"dataType": "string",
"require": true
},
{
"code": "code",
"attributeType": "system",
"definedClass": "system",
"group": [],
"description": "文档编码",
"dataType": "string",
"require": true
},
{
"code": "description",
"attributeType": "system",
"definedClass": "system",
"group": [],
"description": "文档描述",
"dataType": "string",
"require": false
},
...
],
"classDefinition": {
"baseclass": "entity",
"type": "doc",
"hasChild": true,
"ratio": null,
"userDefined": false,
"tree": false,
"isPublic": false,
"objectName": "文档",
"relType": null,
"permissionClass": false,
"className": "documents",
"collection": "documents",
"parentKey": "base",
"entity": null,
"classDescription": "用于存储文档信息，一个文档可包含多个不同格式的物理文件",
"rightObjectName": null,
"leftObjectName": null,
"rightObjectClass": null,
"leftObjectClass": null
}
}
}
}
1.4. 错误返回：
| 状态码 | code | message | data | 原因 |
|---|---|---|---|---|
| 200 | ENTITY_BOSCLASS_NOTFOUND | 实体类{key}不存在 | NULL | className为key的实体类不存在 |
1.5. 注意事项：
- 返回实体类的所有信息。