compliance/assets/doc/井筒API示例swagger_fixed_simple.json
gongwenxin 2b1afbf47e llm
2025-05-21 18:09:14 +08:00

1244 lines
38 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.

{
"swagger": "2.0",
"info": {
"title": "井筒DMS",
"version": "last"
},
"basePath": "/",
"tags": [
{
"name": "公共分类",
"description": "公共分类"
},
{
"name": "地质单元",
"description": null
},
{
"name": "钻井地质设计",
"description": null
},
{
"name": "井筒生产层段",
"description": null
},
{
"name": "压裂基础数据",
"description": null
},
{
"name": "压裂施工参数",
"description": null
},
{
"name": "射孔井段数据",
"description": null
},
{
"name": "射孔数据",
"description": null
},
{
"name": "管柱元件",
"description": null
},
{
"name": "试油成果数据",
"description": null
},
{
"name": "试油日报",
"description": null
},
{
"name": "井泵注程序数据",
"description": null
},
{
"name": "起下钻接单根数据",
"description": null
},
{
"name": "油气显示统计表",
"description": null
},
{
"name": "录井综合记录",
"description": null
},
{
"name": "试油基础数据",
"description": null
},
{
"name": "施工总结油管记录",
"description": null
},
{
"name": "酸化压裂分层作业",
"description": null
},
{
"name": "支撑剂数据",
"description": null
},
{
"name": "地层测试",
"description": null
},
{
"name": "水分析",
"description": null
},
{
"name": "测温测压数据",
"description": null
},
{
"name": "地层测试成果",
"description": null
},
{
"name": "试油成果统计数据",
"description": null
},
{
"name": "测温测压",
"description": null
},
{
"name": "排液求产动态数据",
"description": null
},
{
"name": "排液求产成果数据",
"description": null
},
{
"name": "施工总结",
"description": null
},
{
"name": "井下作业日报",
"description": null
},
{
"name": "施工总结管理信息",
"description": null
},
{
"name": "井壁取心统计",
"description": null
},
{
"name": "岩心图像扫描记录",
"description": null
},
{
"name": "气测迟到数据表",
"description": null
},
{
"name": "残余碳分析记录",
"description": null
},
{
"name": "井壁取心",
"description": null
},
{
"name": "气测录井基础信息",
"description": null
},
{
"name": "录井综合解释",
"description": null
},
{
"name": "录井日报",
"description": null
},
{
"name": "酸化基础数据",
"description": null
},
{
"name": "岩屑描述记录",
"description": null
},
{
"name": "录井解释成果表",
"description": null
},
{
"name": "钻井取心筒次数据",
"description": null
},
{
"name": "钻井取心描述记录",
"description": null
},
{
"name": "气测解释成果",
"description": null
},
{
"name": "取心描述",
"description": null
},
{
"name": "钻井取心",
"description": null
},
{
"name": "单井地质分层",
"description": null
},
{
"name": "地质分层数据",
"description": null
},
{
"name": "井基本信息",
"description": null
},
{
"name": "井作业阶段",
"description": null
},
{
"name": "组织机构",
"description": null
},
{
"name": "小层分层数据",
"description": null
},
{
"name": "高压物性取样",
"description": null
},
{
"name": "储集岩热解解释成果数据",
"description": null
},
{
"name": "井筒基本信息",
"description": null
},
{
"name": "高压物性分析",
"description": null
}
],
"schemes": [
"http"
],
"paths": {
"/api/dms/{dms_instance_code}/v1/message/push/{schema}/{version}": {
"post": {
"tags": [
"公共分类"
],
"summary": "数据推送接口",
"description": "",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "tenant-id",
"in": "header",
"description": "tenant-id (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"description": "Authorization (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "dms_instance_code",
"in": "path",
"description": "注册实例code\n井筒中心 well_kd_wellbore_ideas01",
"required": true,
"type": "string"
},
{
"name": "schema",
"in": "path",
"description": "",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "",
"required": true,
"type": "string"
},
{
"name": "root",
"in": "body",
"schema": {
"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"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"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"
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"/api/dms/{dms_instance_code}/v1/cd_geo_unit/{version}": {
"post": {
"tags": [
"地质单元"
],
"summary": "地质单元列表查询",
"description": "",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "tenant-id",
"in": "header",
"description": "tenant-id (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"description": "Authorization (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "dms_instance_code",
"in": "path",
"description": "注册实例code\n井筒中心 well_kd_wellbore_ideas01",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "交换模型版本",
"required": true,
"type": "string"
},
{
"name": "pageNo",
"in": "query",
"required": false,
"description": "页码(从1开始)",
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"description": "分页大小(最大值200)",
"type": "string"
},
{
"name": "root",
"in": "body",
"schema": {
"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"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"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"
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"/api/dms/{dms_instance_code}/v1/cd_geo_unit": {
"put": {
"tags": [
"地质单元"
],
"summary": "地质单元数据修改",
"description": "",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "tenant-id",
"in": "header",
"description": "tenant-id (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"description": "Authorization (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "dms_instance_code",
"in": "path",
"description": "注册实例code\n井筒中心 well_kd_wellbore_ideas01",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "query",
"required": true,
"description": "主键id的key",
"type": "string"
},
{
"name": "root",
"in": "body",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"version": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bsflag": {
"type": "number"
},
"wellCommonName": {
"type": "string"
},
"wellId": {
"type": "string"
},
"dataRegion": {
"type": "string"
}
},
"required": [
"bsflag",
"wellCommonName",
"wellId",
"dataRegion"
]
}
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {
"type": "boolean"
}
}
}
}
}
}
}
},
"delete": {
"tags": [
"地质单元"
],
"summary": "地质单元数据删除",
"description": "",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "tenant-id",
"in": "header",
"description": "tenant-id (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"description": "Authorization (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "dms_instance_code",
"in": "path",
"description": "注册实例code\n井筒中心 well_kd_wellbore_ideas01",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "query",
"required": true,
"description": "主键id的key",
"type": "string"
},
{
"name": "root",
"in": "body",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"version": {
"type": "string",
"title": "版本号"
},
"data": {
"type": "array",
"items": {
"type": "string"
},
"title": "主键id数据集"
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {
"type": "boolean"
}
}
}
}
}
}
}
},
"post": {
"tags": [
"地质单元"
],
"summary": "地质单元数据添加",
"description": "",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "tenant-id",
"in": "header",
"description": "tenant-id (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"description": "Authorization (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "dms_instance_code",
"in": "path",
"description": "注册实例code\n井筒中心 well_kd_wellbore_ideas01",
"required": true,
"type": "string"
},
{
"name": "root",
"in": "body",
"schema": {
"$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": "交换模型数据集"
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"/api/dms/{dms_instance_code}/v1/cd_geo_unit/{version}/{id}": {
"get": {
"tags": [
"地质单元"
],
"summary": "地质单元查询详情",
"description": "",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "tenant-id",
"in": "header",
"description": "tenant-id (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"description": "Authorization (Only:undefined)",
"required": true,
"type": "string"
},
{
"name": "dms_instance_code",
"in": "path",
"description": "注册实例code\n井筒中心 well_kd_wellbore_ideas01",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "交换模型版本",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "string"
},
{
"name": "root",
"in": "body",
"schema": {
"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"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"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"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}