获取工程生产文件接口API | 接口文档
获取工程生产文件接口API
接口说明
用于获取特定工程的生产文件信息,支持分页和排序功能。
请求方式
GET
请求URL
/projects/{project_id}/production_files
请求参数
| 参数名称 | 参数类型 | 是否必填 | 说明 | 示例 | 备注 |
|---|---|---|---|---|---|
| project_id | 路径参数 | 是 | 工程ID,用于指定要获取生产文件的工程 | 123 | |
| page | 查询参数 | 否 | 页码,用于分页,默认为1 | 1 | |
| limit | 查询参数 | 否 | 每页返回的数据条数,默认为10 | 10 | |
| sort | 查询参数 | 否 | 排序方式,用于指定返回数据的顺序,默认按照文件创建时间降序排序 | desc | 可选值:asc(升序),desc(降序) |
响应参数
| 参数名称 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| status | string | 请求状态,表示接口调用成功或失败 | 'success' |
| message | string | 响应信息,包含接口调用的结果描述 | '获取生产文件成功' |
| data | array | 返回的生产文件信息列表 | [
{
'file_id': '1',
'file_name': 'file1.pdf',
'file_type': '生产报告',
'create_time': '2022-01-01 09:00:00',
'size': '2MB'
},
{
'file_id': '2',
'file_name': 'file2.docx',
'file_type': '工程计划',
'create_time': '2022-01-02 14:30:00',
'size': '1.5MB'
},
...
] |
数据结构
生产文件信息
| 参数名称 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| file_id | string | 文件ID,用于唯一标识文件 | '1' |
| file_name | string | 文件名称,描述文件的名称及格式 | 'file1.pdf' |
| file_type | string | 文件类型,表示文件的分类或用途 | '生产报告' |
| create_time | string | 文件创建时间,表示文件的创建日期和时间 | '2022-01-01 09:00:00' |
| size | string | 文件大小,表示文件的大小信息 | '2MB' |
示例
请求URL
/projects/123/production_files?page=1&limit=10&sort=desc
响应
{
'status': 'success',
'message': '获取生产文件成功',
'data': [
{
'file_id': '1',
'file_name': 'file1.pdf',
'file_type': '生产报告',
'create_time': '2022-01-01 09:00:00',
'size': '2MB'
},
{
'file_id': '2',
'file_name': 'file2.docx',
'file_type': '工程计划',
'create_time': '2022-01-02 14:30:00',
'size': '1.5MB'
},
...
]
}
原文地址: https://www.cveoy.top/t/topic/p0EP 著作权归作者所有。请勿转载和采集!