feat:调整

张含笑

2026-02-02 0d77f210713a54fe5a4718aa4e6a241dbce2b2e5

feat:调整

 applications/task-work-order/src/views/orderView/appConfiguration/materials/接口文档.txt

@@ -0,0 +1,321 @@


## 分页


**接口地址**:`/implement/gdMaterial/page`


**请求方式**:`GET`


**请求数据类型**:`application/x-www-form-urlencoded`


**响应数据类型**:`*/*`


**接口描述**:<p>传入gdMaterial</p>



**请求参数**:


**请求参数**:


| 参数名称 | 参数说明 | 请求类型    | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|areaCode|区域编码|query|false|string||
|current|当前页|query|false|integer(int32)||
|id|主键id|query|false|integer(int64)||
|isAllScenario|是否适用全部情形：1是 0否|query|false|integer(int32)||
|materialDesc|材料说明|query|false|string||
|materialName|材料名称（列表展示字段）|query|false|string||
|necessity|必要性：必填/可选/容缺|query|false|string||
|size|每页的数量|query|false|integer(int32)||


**响应状态**:


| 状态码 | 说明 | schema |
| -------- | -------- | ----- | 
|200|OK|R«IPage«GdMaterialVO»»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||


**响应参数**:


| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- | 
|code|状态码|integer(int32)|integer(int32)|
|data|承载数据|IPage«GdMaterialVO»|IPage«GdMaterialVO»|
|&emsp;&emsp;current||integer(int64)||
|&emsp;&emsp;pages||integer(int64)||
|&emsp;&emsp;records||array|GdMaterialVO|
|&emsp;&emsp;&emsp;&emsp;areaCode|区域编码|string||
|&emsp;&emsp;&emsp;&emsp;id|主键id|integer||
|&emsp;&emsp;&emsp;&emsp;isAllScenario|是否适用全部情形：1是 0否|integer||
|&emsp;&emsp;&emsp;&emsp;materialDesc|材料说明|string||
|&emsp;&emsp;&emsp;&emsp;materialName|材料名称（列表展示字段）|string||
|&emsp;&emsp;&emsp;&emsp;necessity|必要性：必填/可选/容缺|string||
|&emsp;&emsp;size||integer(int64)||
|&emsp;&emsp;total||integer(int64)||
|msg|返回消息|string||
|success|是否成功|boolean||


**响应示例**:
```javascript
{
    "code": 0,
    "data": {
        "current": 0,
        "pages": 0,
        "records": [
            {
                "areaCode": "",
                "id": 0,
                "isAllScenario": 0,
                "materialDesc": "",
                "materialName": "",
                "necessity": ""
            }
        ],
        "size": 0,
        "total": 0
    },
    "msg": "",
    "success": true
}
```


## 详情


**接口地址**:`/implement/gdMaterial/detail`


**请求方式**:`GET`


**请求数据类型**:`application/x-www-form-urlencoded`


**响应数据类型**:`*/*`


**接口描述**:<p>传入gdMaterial</p>



**请求参数**:


**请求参数**:


| 参数名称 | 参数说明 | 请求类型    | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|id|主键|query|true|integer(int64)||


**响应状态**:


| 状态码 | 说明 | schema |
| -------- | -------- | ----- | 
|200|OK|R«GdMaterialVO»|
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||


**响应参数**:


| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- | 
|code|状态码|integer(int32)|integer(int32)|
|data|承载数据|GdMaterialVO|GdMaterialVO|
|&emsp;&emsp;areaCode|区域编码|string||
|&emsp;&emsp;id|主键id|integer(int64)||
|&emsp;&emsp;isAllScenario|是否适用全部情形：1是 0否|integer(int32)||
|&emsp;&emsp;materialDesc|材料说明|string||
|&emsp;&emsp;materialName|材料名称（列表展示字段）|string||
|&emsp;&emsp;necessity|必要性：必填/可选/容缺|string||
|msg|返回消息|string||
|success|是否成功|boolean||


**响应示例**:
```javascript
{
    "code": 0,
    "data": {
        "areaCode": "",
        "id": 0,
        "isAllScenario": 0,
        "materialDesc": "",
        "materialName": "",
        "necessity": ""
    },
    "msg": "",
    "success": true
}
```


## 新增或修改


**接口地址**:`/implement/gdMaterial/submit`


**请求方式**:`POST`


**请求数据类型**:`application/json`


**响应数据类型**:`*/*`


**接口描述**:<p>传入gdMaterial</p>



**请求示例**:


```javascript
{
  "areaCode": "",
  "id": 0,
  "isAllScenario": 0,
  "materialDesc": "",
  "materialName": "",
  "necessity": ""
}
```


**请求参数**:


**请求参数**:


| 参数名称 | 参数说明 | 请求类型    | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|gdMaterial|gdMaterial|body|true|GdMaterialDTO|GdMaterialDTO|
|&emsp;&emsp;areaCode|区域编码||false|string||
|&emsp;&emsp;id|主键id||false|integer(int64)||
|&emsp;&emsp;isAllScenario|是否适用全部情形：1是 0否||false|integer(int32)||
|&emsp;&emsp;materialDesc|材料说明||false|string||
|&emsp;&emsp;materialName|材料名称（列表展示字段）||false|string||
|&emsp;&emsp;necessity|必要性：必填/可选/容缺||false|string||


**响应状态**:


| 状态码 | 说明 | schema |
| -------- | -------- | ----- | 
|200|OK|R|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||


**响应参数**:


| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- | 
|code|状态码|integer(int32)|integer(int32)|
|data|承载数据|object||
|msg|返回消息|string||
|success|是否成功|boolean||


**响应示例**:
```javascript
{
    "code": 0,
    "data": {},
    "msg": "",
    "success": true
}
```


## 逻辑删除


**接口地址**:`/implement/gdMaterial/remove`


**请求方式**:`POST`


**请求数据类型**:`application/json`


**响应数据类型**:`*/*`


**接口描述**:<p>传入ids</p>



**请求参数**:


**请求参数**:


| 参数名称 | 参数说明 | 请求类型    | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|ids|主键集合|query|true|string||


**响应状态**:


| 状态码 | 说明 | schema |
| -------- | -------- | ----- | 
|200|OK|R|
|201|Created||
|401|Unauthorized||
|403|Forbidden||
|404|Not Found||


**响应参数**:


| 参数名称 | 参数说明 | 类型 | schema |
| -------- | -------- | ----- |----- | 
|code|状态码|integer(int32)|integer(int32)|
|data|承载数据|object||
|msg|返回消息|string||
|success|是否成功|boolean||


**响应示例**:
```javascript
{
    "code": 0,
    "data": {},
    "msg": "",
    "success": true
}
```