Skip to content

E
entity-list
提交 7b8cdb49 authored 作者: ZTL's avatar ZTL
浏览文件
操作

新增：

1.接口文档
上级 eaec24d4
隐藏空白字符变更
内嵌 并排
正在显示 包含 266 行增加 和 0 行删除
doc/实体清单-实体链接功能接口需求.md 0 → 100644
浏览文件 @ 7b8cdb49
## 数据库连接方式：
数据库：达梦
IP：8.140.26.4
端口：10001
Schema：PROCESS_DB
用户名：IECAS
密码：Aircas.123
## 实体清单事件获取
- 接口： `/application_system/risk_list`
- 方法：`GET`
- 描述：从`D_EVENTS`表中获取并返回所有`event_type`为`实体清单`的事件
- 参数：
- | 参数名 | 注释 | 类型 |
| ------ | ---------- | ------ |
| page | 页码 | int |
| size | 页大小 | int |
| sortBy | 排序字段名 | String |
- 返回数据格式：
- 事件列表，具体格式如下：
```json
{
"event_id": "事件ID，对应`D_EVENTS`表中的`id`字段",
"title": "事件标题",
"title_en": "事件标题英文",
"type": "事件类型，对应`D_EVENTS`表中的`event_type`字段",
"date": "事件发布日期，对应`D_EVENTS`表中的`post_date`字段",
}
```
- 例如：
```json
{
"code": 200,
"msg": "success",
"data": {
"content": [
{
"event_id": "2013-00767",
"title": "",
"title_en": "xxxxx",
"type": "实体清单",
"date": "2013-01-16"
},
{
"event_id": "2013-05387",
"title": "",
"title_en": "Addition of Certain Persons to the Entity List",
"type": "实体清单",
"date": "2013-03-08"
}
],
"pageable": {
"sort": {
"empty": false,
"sorted": true,
"unsorted": false
},
"offset": 0,
"pageSize": 10,
"pageNumber": 0,
"unpaged": false,
"paged": true
},
"last": false,
"totalPages": 14,
"totalElements": 135,
"size": 10,
"number": 0,
"sort": {
"empty": false,
"sorted": true,
"unsorted": false
},
"first": true,
"numberOfElements": 10,
"empty": false
}
}
```
## 指定事件对应的实体
- 接口：`/application_system/event_entity_list`
- 方法：`GET`
- 描述：根据事件ID，从`D_ENTITIES`表中获取所有`event_id`为该事件的实体
- 参数：
- | 参数名 | 注释 | 类型 |
| -------- | ---------- | ------ |
| event_id | 事件id | String |
| page | 页码 | int |
| size | 页大小 | int |
| sortBy | 排序字段名 | String |
- 返回数据格式：
- 实体列表，具体格式如下：
```json
{
"event_entity_id": "实体在`D_ENTITIES`表中的ID，对应表中的`id`字段",
"entity_name": "实体名称，对应`D_ENTITIES`表中的`name`字段",
"entity_type": "实体类型，对应`D_ENTITIES`表中的`entity_type`字段",
"status": "实体状态，对应`D_ENTITIES`表中的`status`字段",
}
```
- 例如：
- ```json
{
"code": 200,
"msg": "success",
"data": {
"content": [
{
"event_entity_id": "0",
"entity_name": "Abdul Satar Ghoura",
"entity_type": "",
"status": "未校验"
},
{
"event_entity_id": "1",
"entity_name": "Afghan-German Construction Company",
"entity_type": "",
"status": "未校验"
}
],
"pageable": {
"sort": {
"empty": false,
"sorted": true,
"unsorted": false
},
"offset": 0,
"pageNumber": 0,
"pageSize": 10,
"paged": true,
"unpaged": false
},
"last": false,
"totalPages": 336,
"totalElements": 3351,
"size": 10,
"number": 0,
"sort": {
"empty": false,
"sorted": true,
"unsorted": false
},
"numberOfElements": 10,
"first": true,
"empty": false
}
}
```
## 获取实体详情
- 接口：`/application_system/event_entity_detail`
- 方法：`GET`
- 描述：根据实体在事件下的临时ID，从`D_ENTITIES`表中获取该实体的详情，并从`D_ALIASES`表中获取该实体的别名，从`D_ADDRESS`表中获取该实体的地址信息，从`D_AREA`表中获取该实体的领域信息
- 参数：
- `event_entity_id`：接口`/application_system/event_entity_list`返回数据中的`event_entity_id`字段
- 返回值：
- `id`：实体在`D_ENTITIES`表中的ID，对应表中的`id`字段
- `entity_id`：实体在机构库或任务库中的ID，对应`D_ENTITIES`表中的`entity_id`字段
- `entity_name`：实体名称，对应`D_ENTITIES`表中的`name`字段
- `entity_type`：实体类型，对应`D_ENTITIES`表中的`entity_type`字段
- `status`：实体状态，对应`D_ENTITIES`表中的`status`字段
- 返回数据格式：
- 实体详情，具体格式如下：
```json
{
"entity_id": "实体在`D_ENTITIES`表中的ID，对应表中的`id`字段",
"name": "实体名称，对应`D_ENTITIES`表中的`name`字段",
"entity_type": "实体类型，对应`D_ENTITIES`表中的`entity_type`字段",
"status": "实体状态，对应`D_ENTITIES`表中的`status`字段",
"sanction_reason": "实体受制裁的原因，对应`D_ENTITIES`表中的`sanction_reason`字段",
"domain": [
{
"id": "实体所属领域，根据entity_id从`D_DOMAIN`表中获取该实体对应的领域列表",
"name": "实体所属领域，对应`D_DOMAIN`表中的`name`字段",
}
],
"address": [
{
"id": "实体地址，根据entity_id从`D_ADDRESS`表中获取该实体对应的地址列表",
"text": "实体地址，对应`D_ADDRESS`表中的`text`字段",
"text_zh": "实体地址，对应`D_ADDRESS`表中的`text_zh`字段",
"province": "实体地址，对应`D_ADDRESS`表中的`province`字段",
"city": "实体地址，对应`D_ADDRESS`表中的`city`字段",
"province_zh": "实体地址，对应`D_ADDRESS`表中的`province_zh`字段",
"city_zh": "实体地址，对应`D_ADDRESS`表中的`city_zh`字段",
}
],
"alias": [
{
"id": "实体别名，根据entity_id从`D_ALIASES`表中获取该实体对应的别名列表",
"name": "实体别名，对应`D_ALIASES`表中的`name`字段",
"name_zh": "实体别名，对应`D_ALIASES`表中的`name_zh`字段",
}
],
}
```
- 示例：
- ```json
{
"code": 200,
"msg": "success",
"data": {
"entity_id": "1",
"name": "Afghan-German Construction Company",
"entity_type": "",
"status": "未校验",
"sanction_reason": null,
"domains": [],
"addresses": [
{
"id": "2",
"text": "Golaye Park, Shari Naw, Kabul, Afghanistan",
"text_zh": "阿富汗喀布尔沙里瑙街戈拉耶公园",
"province": "Kabul Province",
"city": "Kabul",
"province_zh": "喀布尔省",
"city_zh": "喀布尔"
},
{
"id": "3",
"text": "Dasht Qala, Takhar Province, Afghanistan",
"text_zh": "阿富汗塔哈尔省达什特卡拉",
"province": "Takhar Province",
"city": "Dasht Qala",
"province_zh": "塔哈尔省",
"city_zh": "达什特卡拉"
}
],
"aliases": [
{
"id": "0",
"name": "AGCC",
"name_zh": "阿富汗-德国建筑公司"
}
]
}
}
```
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论