compliance/mvp/assets/doc/井筒API示例_simple.json
gongwenxin 936714242f mvp
2025-05-28 15:55:46 +08:00

430 lines
23 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[
{
"index": 0,
"name": "公共分类",
"desc": "公共分类",
"add_time": 1730355210,
"up_time": 1730355210,
"list": [
{
"query_path": {
"path": "/api/dms/{dms_instance_code}/v1/message/push/{schema}/{version}",
"params": []
},
"edit_uid": 0,
"status": "undone",
"type": "var",
"req_body_is_json_schema": true,
"res_body_is_json_schema": true,
"api_opened": false,
"index": 0,
"tag": [],
"_id": 135716,
"method": "POST",
"title": "数据推送接口",
"desc": "",
"path": "/api/dms/{dms_instance_code}/v1/message/push/{schema}/{version}",
"req_params": [
{
"_id": "67ff3dc5335acf6754926ab7",
"name": "dms_instance_code",
"desc": "注册实例code\n井筒中心 well_kd_wellbore_ideas01"
},
{
"_id": "67ff3dc5335acf0829926ab6",
"name": "schema",
"desc": ""
},
{
"_id": "67ff3dc5335acf485f926ab5",
"name": "version",
"desc": ""
}
],
"req_body_form": [],
"req_headers": [
{
"required": "1",
"_id": "67ff3dc5335acf11b4926aba",
"name": "Content-Type",
"value": "application/json"
},
{
"required": "1",
"_id": "67ff3dc5335acfae3f926ab9",
"name": "tenant-id",
"desc": "tenant-id (Only:undefined)"
},
{
"required": "1",
"_id": "67ff3dc5335acfad4f926ab8",
"name": "Authorization",
"desc": "Authorization (Only:undefined)"
}
],
"req_query": [],
"req_body_type": "json",
"res_body_type": "json",
"res_body": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"number\"},\"message\":{\"type\":\"string\"},\"data\":{\"type\":\"object\",\"properties\":{\"total\":{\"type\":\"number\"},\"list\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"dsid\":{\"type\":\"string\"},\"dataRegion\":{\"type\":\"string\"},\"gasReleaseMon\":{\"type\":\"null\"},\"gasReleaseYear\":{\"type\":\"null\"},\"releaseGasCum\":{\"type\":\"null\"}}}}}}}}",
"req_body_other": "{\"properties\":{\"isSearchCount\":{\"default\":true,\"description\":\"是否统计总条数\",\"type\":\"boolean\"},\"query\":{\"description\":\"查询条件\",\"properties\":{\"dataRegions\":{\"description\":\"数据域JD、DG、TL\",\"items\":{\"description\":\"数据域JD、DG、TL\",\"type\":\"string\"},\"type\":\"array\"},\"fields\":{\"description\":\"查询的字段\",\"items\":{\"description\":\"查询的字段\",\"type\":\"string\"},\"type\":\"array\"},\"filter\":{\"description\":\"筛选器\",\"properties\":{\"key\":{\"description\":\"条件项\",\"type\":\"string\"},\"logic\":{\"description\":\"逻辑操作符可选值为AND、OR\",\"type\":\"string\"},\"realValue\":{\"description\":\"条件值\",\"items\":{\"description\":\"条件值\",\"type\":\"object\",\"properties\":{}},\"type\":\"array\"},\"singleValue\":{\"type\":\"object\",\"writeOnly\":true,\"properties\":{}},\"subFilter\":{\"description\":\"子条件\",\"items\":{\"$ref\":\"#/components/schemas/FilterVO\",\"type\":\"string\"},\"type\":\"array\"},\"symbol\":{\"description\":\"运算符,可选值为:>、>=、<、<=、>、<、=、<>、!=、IN、NOTIN、LIKE、IS当运算符为 IS 时条件值只能为NULL或NOT NULL\",\"type\":\"string\"}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/FilterVO\"},\"groupFields\":{\"description\":\"分组字段group by\",\"items\":{\"description\":\"分组字段group by\",\"type\":\"string\"},\"type\":\"array\"},\"groupFilter\":{\"description\":\"筛选器\",\"properties\":{\"key\":{\"description\":\"条件项\",\"type\":\"string\"},\"logic\":{\"description\":\"逻辑操作符可选值为AND、OR\",\"type\":\"string\"},\"realValue\":{\"description\":\"条件值\",\"items\":{\"description\":\"条件值\",\"type\":\"object\",\"properties\":{}},\"type\":\"array\"},\"singleValue\":{\"type\":\"object\",\"writeOnly\":true,\"properties\":{}},\"subFilter\":{\"description\":\"子条件\",\"items\":{\"$ref\":\"#/components/schemas/FilterVO\",\"type\":\"string\"},\"type\":\"array\"},\"symbol\":{\"description\":\"运算符,可选值为:>、>=、<、<=、>、<、=、<>、!=、IN、NOTIN、LIKE、IS当运算符为 IS 时条件值只能为NULL或NOT NULL\",\"type\":\"string\"}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/FilterVO\"},\"sort\":{\"additionalProperties\":{\"description\":\"排序字段key=字段名value=排序方式ASC、DESC\",\"type\":\"string\"},\"description\":\"排序字段key=字段名value=排序方式ASC、DESC\",\"type\":\"object\",\"properties\":{}}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/QueryVO\"}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/RdbQueryPageInput\"}",
"project_id": 1193,
"catid": 17672,
"markdown": "",
"uid": 808,
"add_time": 1744780583,
"up_time": 1744780741,
"__v": 0
}
]
},
{
"index": 0,
"name": "地质单元",
"desc": null,
"add_time": 1745736888,
"up_time": 1745736888,
"list": [
{
"query_path": {
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit/{version}",
"params": []
},
"edit_uid": 0,
"status": "undone",
"type": "var",
"req_body_is_json_schema": true,
"res_body_is_json_schema": true,
"api_opened": false,
"index": 0,
"tag": [],
"_id": 135751,
"method": "POST",
"title": "地质单元列表查询",
"desc": "",
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit/{version}",
"req_params": [
{
"_id": "680dd55a335acff12e926d18",
"name": "dms_instance_code",
"desc": "注册实例code\n井筒中心 well_kd_wellbore_ideas01"
},
{
"_id": "680dd55a335acfc43d926d17",
"name": "version",
"example": "1.0.0",
"desc": "交换模型版本"
}
],
"req_body_form": [],
"req_headers": [
{
"required": "1",
"_id": "680dd55a335acfb51b926d1d",
"name": "Content-Type",
"value": "application/json"
},
{
"required": "1",
"_id": "680dd55a335acf6226926d1c",
"name": "tenant-id",
"desc": "tenant-id (Only:undefined)"
},
{
"required": "1",
"_id": "680dd55a335acf39a0926d1b",
"name": "Authorization",
"desc": "Authorization (Only:undefined)"
}
],
"req_query": [
{
"required": "0",
"_id": "680dd55a335acfabfa926d1a",
"name": "pageNo",
"desc": "页码(从1开始)"
},
{
"required": "0",
"_id": "680dd55a335acf831b926d19",
"name": "pageSize",
"desc": "分页大小(最大值200)"
}
],
"req_body_type": "json",
"res_body_type": "json",
"res_body": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"number\"},\"message\":{\"type\":\"string\"},\"data\":{\"type\":\"object\",\"properties\":{\"total\":{\"type\":\"number\"},\"list\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"dsid\":{\"type\":\"string\"},\"dataRegion\":{\"type\":\"string\"},\"gasReleaseMon\":{\"type\":\"null\"},\"gasReleaseYear\":{\"type\":\"null\"},\"releaseGasCum\":{\"type\":\"null\"}}}}}}}}",
"req_body_other": "{\"properties\":{\"isSearchCount\":{\"default\":true,\"description\":\"是否统计总条数\",\"type\":\"boolean\"},\"query\":{\"description\":\"查询条件\",\"properties\":{\"dataRegions\":{\"description\":\"数据域JD、DG、TL\",\"items\":{\"description\":\"数据域JD、DG、TL\",\"type\":\"string\"},\"type\":\"array\"},\"fields\":{\"description\":\"查询的字段\",\"items\":{\"description\":\"查询的字段\",\"type\":\"string\"},\"type\":\"array\"},\"filter\":{\"description\":\"筛选器\",\"properties\":{\"key\":{\"description\":\"条件项\",\"type\":\"string\"},\"logic\":{\"description\":\"逻辑操作符可选值为AND、OR\",\"type\":\"string\"},\"realValue\":{\"description\":\"条件值\",\"items\":{\"description\":\"条件值\",\"type\":\"object\",\"properties\":{}},\"type\":\"array\"},\"singleValue\":{\"type\":\"object\",\"writeOnly\":true,\"properties\":{}},\"subFilter\":{\"description\":\"子条件\",\"items\":{\"$ref\":\"#/components/schemas/FilterVO\",\"type\":\"string\"},\"type\":\"array\"},\"symbol\":{\"description\":\"运算符,可选值为:>、>=、<、<=、>、<、=、<>、!=、IN、NOTIN、LIKE、IS当运算符为 IS 时条件值只能为NULL或NOT NULL\",\"type\":\"string\"}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/FilterVO\"},\"groupFields\":{\"description\":\"分组字段group by\",\"items\":{\"description\":\"分组字段group by\",\"type\":\"string\"},\"type\":\"array\"},\"groupFilter\":{\"description\":\"筛选器\",\"properties\":{\"key\":{\"description\":\"条件项\",\"type\":\"string\"},\"logic\":{\"description\":\"逻辑操作符可选值为AND、OR\",\"type\":\"string\"},\"realValue\":{\"description\":\"条件值\",\"items\":{\"description\":\"条件值\",\"type\":\"object\",\"properties\":{}},\"type\":\"array\"},\"singleValue\":{\"type\":\"object\",\"writeOnly\":true,\"properties\":{}},\"subFilter\":{\"description\":\"子条件\",\"items\":{\"$ref\":\"#/components/schemas/FilterVO\",\"type\":\"string\"},\"type\":\"array\"},\"symbol\":{\"description\":\"运算符,可选值为:>、>=、<、<=、>、<、=、<>、!=、IN、NOTIN、LIKE、IS当运算符为 IS 时条件值只能为NULL或NOT NULL\",\"type\":\"string\"}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/FilterVO\"},\"sort\":{\"additionalProperties\":{\"description\":\"排序字段key=字段名value=排序方式ASC、DESC\",\"type\":\"string\"},\"description\":\"排序字段key=字段名value=排序方式ASC、DESC\",\"type\":\"object\",\"properties\":{}}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/QueryVO\"}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/RdbQueryPageInput\"}",
"project_id": 1193,
"catid": 18705,
"markdown": "",
"uid": 1103,
"add_time": 1745736910,
"up_time": 1745737050,
"__v": 0
},
{
"query_path": {
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit",
"params": []
},
"edit_uid": 0,
"status": "undone",
"type": "var",
"req_body_is_json_schema": true,
"res_body_is_json_schema": true,
"api_opened": false,
"index": 0,
"tag": [],
"_id": 135749,
"method": "PUT",
"title": "地质单元数据修改",
"desc": "",
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit",
"req_params": [
{
"_id": "680dd510335acf19c3926cec",
"name": "dms_instance_code",
"desc": "注册实例code\n井筒中心 well_kd_wellbore_ideas01"
}
],
"req_body_form": [],
"req_headers": [
{
"required": "1",
"_id": "680dd510335acf7bb3926cf0",
"name": "Content-Type",
"value": "application/json"
},
{
"required": "1",
"_id": "680dd510335acf6953926cef",
"name": "tenant-id",
"desc": "tenant-id (Only:undefined)"
},
{
"required": "1",
"_id": "680dd510335acfd86b926cee",
"name": "Authorization",
"desc": "Authorization (Only:undefined)"
}
],
"req_query": [
{
"required": "1",
"_id": "680dd510335acf1ed1926ced",
"name": "id",
"example": "dsid",
"desc": "主键id的key"
}
],
"req_body_type": "json",
"res_body_type": "json",
"res_body": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"number\"},\"message\":{\"type\":\"string\"},\"data\":{\"type\":\"boolean\"}}}",
"req_body_other": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"required\":true},\"version\":{\"type\":\"string\"}},\"required\":[\"id\",\"version\"]}",
"project_id": 1193,
"catid": 18705,
"markdown": "",
"uid": 1103,
"add_time": 1745736907,
"up_time": 1745736976,
"__v": 0
},
{
"query_path": {
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit",
"params": []
},
"edit_uid": 0,
"status": "undone",
"type": "var",
"req_body_is_json_schema": true,
"res_body_is_json_schema": true,
"api_opened": false,
"index": 0,
"tag": [],
"_id": 135750,
"method": "DELETE",
"title": "地质单元数据删除",
"desc": "",
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit",
"req_params": [
{
"_id": "680dd51b335acfe93a926cf1",
"name": "dms_instance_code",
"desc": "注册实例code\n井筒中心 well_kd_wellbore_ideas01"
}
],
"req_body_form": [],
"req_headers": [
{
"required": "1",
"_id": "680dd51b335acfb316926cf5",
"name": "Content-Type",
"value": "application/json"
},
{
"required": "1",
"_id": "680dd51b335acf45f4926cf4",
"name": "tenant-id",
"desc": "tenant-id (Only:undefined)"
},
{
"required": "1",
"_id": "680dd51b335acf0cfa926cf3",
"name": "Authorization",
"desc": "Authorization (Only:undefined)"
}
],
"req_query": [
{
"required": "1",
"_id": "680dd51b335acf7441926cf2",
"name": "id",
"example": "dsid",
"desc": "主键id的key"
}
],
"req_body_type": "json",
"res_body_type": "json",
"res_body": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"number\"},\"message\":{\"type\":\"string\"},\"data\":{\"type\":\"boolean\"}}}",
"req_body_other": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"version\":{\"type\":\"string\",\"title\":\"版本号\"},\"data\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"title\":\"主键id数据集\"}}}",
"project_id": 1193,
"catid": 18705,
"markdown": "",
"uid": 1103,
"add_time": 1745736908,
"up_time": 1745736987,
"__v": 0
},
{
"query_path": {
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit",
"params": []
},
"edit_uid": 0,
"status": "done",
"type": "var",
"req_body_is_json_schema": true,
"res_body_is_json_schema": true,
"api_opened": false,
"index": 0,
"tag": [],
"_id": 135748,
"method": "POST",
"title": "地质单元数据添加",
"desc": "",
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit",
"req_params": [
{
"_id": "680dd4ff335acf81b3926ce8",
"name": "dms_instance_code",
"desc": "注册实例code\n井筒中心 well_kd_wellbore_ideas01"
}
],
"req_body_form": [],
"req_headers": [
{
"required": "1",
"_id": "680dd4ff335acfc5c7926ceb",
"name": "Content-Type",
"value": "application/json"
},
{
"required": "1",
"_id": "680dd4ff335acff16f926cea",
"name": "tenant-id",
"desc": "tenant-id (Only:undefined)"
},
{
"required": "1",
"_id": "680dd4ff335acf1a5c926ce9",
"name": "Authorization",
"desc": "Authorization (Only:undefined)"
}
],
"req_query": [],
"req_body_type": "json",
"res_body_type": "json",
"res_body": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"number\"},\"message\":{\"type\":\"string\"},\"data\":{\"type\":\"boolean\"}}}",
"req_body_other": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"version\":{\"type\":\"string\",\"title\":\"交换模型版本号\"},\"data\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"bsflag\":{\"type\":\"number\",\"title\":\"必填字段删除标记\"},\"wellCommonName\":{\"type\":\"string\"},\"wellId\":{\"type\":\"string\"},\"dataRegion\":{\"type\":\"string\"}},\"required\":[\"bsflag\",\"wellCommonName\",\"wellId\",\"dataRegion\"]},\"title\":\"交换模型数据集\"}}}",
"project_id": 1193,
"catid": 18705,
"markdown": "",
"uid": 1103,
"add_time": 1745736907,
"up_time": 1745736959,
"__v": 0
},
{
"query_path": {
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit/{version}/{id}",
"params": []
},
"edit_uid": 0,
"status": "done",
"type": "var",
"req_body_is_json_schema": true,
"res_body_is_json_schema": true,
"api_opened": false,
"index": 0,
"tag": [],
"_id": 135752,
"method": "GET",
"title": "地质单元查询详情",
"desc": "",
"path": "/api/dms/{dms_instance_code}/v1/cd_geo_unit/{version}/{id}",
"req_params": [
{
"_id": "680dd53d335acf42db926d05",
"name": "dms_instance_code",
"desc": "注册实例code\n井筒中心 well_kd_wellbore_ideas01"
},
{
"_id": "680dd53d335acf2105926d04",
"name": "version",
"example": "1.0.0",
"desc": "交换模型版本"
},
{
"_id": "680dd53d335acf7970926d03",
"name": "id",
"desc": ""
}
],
"req_body_form": [],
"req_headers": [
{
"required": "1",
"_id": "680dd53d335acf68e4926d08",
"name": "Content-Type",
"value": "application/json"
},
{
"required": "1",
"_id": "680dd53d335acf9fb4926d07",
"name": "tenant-id",
"desc": "tenant-id (Only:undefined)"
},
{
"required": "1",
"_id": "680dd53d335acf7a8d926d06",
"name": "Authorization",
"desc": "Authorization (Only:undefined)"
}
],
"req_query": [],
"req_body_type": "json",
"res_body_type": "json",
"res_body": "{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"number\"},\"message\":{\"type\":\"string\"},\"data\":{\"type\":\"object\",\"properties\":{\"total\":{\"type\":\"number\"},\"list\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"dsid\":{\"type\":\"string\"},\"dataRegion\":{\"type\":\"string\"},\"gasReleaseMon\":{\"type\":\"null\"},\"gasReleaseYear\":{\"type\":\"null\"},\"releaseGasCum\":{\"type\":\"null\"}}}}}}}}",
"req_body_other": "{\"properties\":{\"isSearchCount\":{\"default\":true,\"description\":\"是否统计总条数\",\"type\":\"boolean\"},\"query\":{\"description\":\"查询条件\",\"properties\":{\"dataRegions\":{\"description\":\"数据域JD、DG、TL\",\"items\":{\"description\":\"数据域JD、DG、TL\",\"type\":\"string\"},\"type\":\"array\"},\"fields\":{\"description\":\"查询的字段\",\"items\":{\"description\":\"查询的字段\",\"type\":\"string\"},\"type\":\"array\"},\"filter\":{\"description\":\"筛选器\",\"properties\":{\"key\":{\"description\":\"条件项\",\"type\":\"string\"},\"logic\":{\"description\":\"逻辑操作符可选值为AND、OR\",\"type\":\"string\"},\"realValue\":{\"description\":\"条件值\",\"items\":{\"description\":\"条件值\",\"type\":\"object\",\"properties\":{}},\"type\":\"array\"},\"singleValue\":{\"type\":\"object\",\"writeOnly\":true,\"properties\":{}},\"subFilter\":{\"description\":\"子条件\",\"items\":{\"$ref\":\"#/components/schemas/FilterVO\",\"type\":\"string\"},\"type\":\"array\"},\"symbol\":{\"description\":\"运算符,可选值为:>、>=、<、<=、>、<、=、<>、!=、IN、NOTIN、LIKE、IS当运算符为 IS 时条件值只能为NULL或NOT NULL\",\"type\":\"string\"}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/FilterVO\"},\"groupFields\":{\"description\":\"分组字段group by\",\"items\":{\"description\":\"分组字段group by\",\"type\":\"string\"},\"type\":\"array\"},\"groupFilter\":{\"description\":\"筛选器\",\"properties\":{\"key\":{\"description\":\"条件项\",\"type\":\"string\"},\"logic\":{\"description\":\"逻辑操作符可选值为AND、OR\",\"type\":\"string\"},\"realValue\":{\"description\":\"条件值\",\"items\":{\"description\":\"条件值\",\"type\":\"object\",\"properties\":{}},\"type\":\"array\"},\"singleValue\":{\"type\":\"object\",\"writeOnly\":true,\"properties\":{}},\"subFilter\":{\"description\":\"子条件\",\"items\":{\"$ref\":\"#/components/schemas/FilterVO\",\"type\":\"string\"},\"type\":\"array\"},\"symbol\":{\"description\":\"运算符,可选值为:>、>=、<、<=、>、<、=、<>、!=、IN、NOTIN、LIKE、IS当运算符为 IS 时条件值只能为NULL或NOT NULL\",\"type\":\"string\"}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/FilterVO\"},\"sort\":{\"additionalProperties\":{\"description\":\"排序字段key=字段名value=排序方式ASC、DESC\",\"type\":\"string\"},\"description\":\"排序字段key=字段名value=排序方式ASC、DESC\",\"type\":\"object\",\"properties\":{}}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/QueryVO\"}},\"type\":\"object\",\"$$ref\":\"#/components/schemas/RdbQueryPageInput\"}",
"project_id": 1193,
"catid": 18705,
"markdown": "",
"uid": 1103,
"add_time": 1745736911,
"up_time": 1745737021,
"__v": 0
}
]
}
]