项目工点数据
接口说明
该接口用于获取项目工点数据
接口地址
/external/project-spot?startId=0&startVersion=0&limit=100&orgId=115447715247232
接口类型
Http
请求方式
GET
内容类型
application/json
鉴权策略
参见《Open-API鉴权协议》
请求参数
| 参数名称 | 说明 |
|---|---|
| startId | 本次请求所要获取的增量数据的id起始值,第一次调用初始值为0,客户端需要缓存接口返回的数据集合中最后一条数据的id值 |
| startVersion | 本次请求所要获取的增量数据的version起始值,第一次调用初始值为0,客户端需要缓存接口返回的数据集合中最后一条数据的version值 |
| limit | 返回指定的数据条数,上限为500条,0 <= limit <= 500。如果limit > 500, 则最多返回500条数据 |
| orgId | 组织机构Id |
请求头
响应报文
[
{
"id": 113346637493632,
"orgId": 115447715247232,
"projectUnitWorkId": 119737290540032,
"sectionId": 113337959982080,
"userId": "118030746502272,117550279910400",
"teamId": "19686949741696,119686691558528,119686691558537",
"name": "河畔大桥",
"startPileNo": 40443.511,
"endPileNo": 53000,
"pileNoPrefix": null,
"startPile": "K40+443.511",
"endPile": "K53+000",
"actualStartDate": "2018-05-10T09:22:14.000Z",
"planEndDate": "2018-09-12T08:47:02.000Z",
"actualEndDate": null,
"completeStatus": "doing",
"completePercent": 31.96,
"userName": "用户1,用户2",
"teamName": "朱昌峰劳务队,路基一队,路基二队",
"teamCaptainName": "李四,,张三",
"projectUnitWorkName": "路基工程",
"keyUnitWork": false,
"projectLineKey": "113439079757184",
"unitWorkId": 116547035968512,
"unitWorkName": "桥梁工程",
"unitWorkCategoryId": 144815008216704,
"unitWorkCategoryName": "桥梁工程",
"sectionName": "六工段",
"createdAt": "2018-05-10T09:22:14.000Z",
"updatedAt": "2018-09-12T08:47:02.000Z",
"removed": false,
"version": 171456266088539
}
]
响应状态码
| 字段名称 | 数据类型 |
|---|---|
| 200 | 成功 |
| 400 | 用户请求头中Authorization值的格式不对,错误码:InvalidArgument。 |
| 403 | AccessId不存在或被禁用 错误码:InvalidAccessId |
| 500 | 非法参数或接口执行异常 |
响应数据结构
| 字段名称 | 数据类型 | 是否可以为空 | 字段描述 |
|---|---|---|---|
| id | long | 否 | 工点Id |
| orgId | long | 否 | 组织机构Id |
| projectUnitWorkId | long | 否 | 项目形象单元Id |
| sectionId | long | 是 | 项目工段Id |
| userId | string | 是 | 项目工点负责人Id集合 |
| teamId | string | 是 | 作业队伍Id集合 |
| name | string | 否 | 名称 |
| startPileNo | double | 否 | 开始桩号 |
| endPileNo | double | 否 | 结束桩号 |
| pileNoPrefix | string | 否 | 桩号前缀 |
| startPile | string | 否 | 开始桩号显示值 |
| endPile | string | 否 | 结束桩号显示值 |
| actualStartDate | date | 否 | 开工日期, utc标准时间格式 |
| planEndDate | date | 否 | 计划完工日期, utc标准时间格式 |
| actualEndDate | date | 是 | 实际完工日期, utc标准时间格式 |
| completeStatus | string | 否 | 工点完成状态 见表2 |
| completePercent | double | 是 | 工点完成进度 |
| userName | string | 是 | 项目工点负责人集合 |
| teamName | string | 是 | 作业队伍名称集合 |
| teamCaptainName | string | 是 | 作业队伍队长姓名集合 |
| projectUnitWorkName | string | 是 | 形象单元名称 |
| keyUnitWork | boolean | 否 | 是否关键形象单元 见表3 |
| projectLineKey | string | 是 | 所属线路 |
| unitWorkId | long | 是 | wbs字典Id |
| unitWorkName | string | 是 | wbs字典名称 |
| unitWorkCategoryId | long | 是 | 单位工程类型Id |
| unitWorkCategoryName | string | 是 | 单位工程类型名称 |
| sectionName | string | 是 | 工段名称 |
| createdAt | date | 否 | 创建时间,utc标准时间格式 |
| updatedAt | date | 否 | 修改时间,utc标准时间格式 |
| removed | boolean | 否 | 是否逻辑删除 见表1 |
| version | long | 否 | 数据版本 |
表1 逻辑删除标志位枚举值定义
| removed | |
|---|---|
| false | 未删除 |
| true | 已删除 |
表2 工点完成状态枚举值定义
| completeStatus | |
|---|---|
| todo | 未开始 |
| doing | 进行中 |
| done | 已完工 |
| stop | 停工 |
表3 是否关键形象单元枚举值定义
| keyUnitWork | |
|---|---|
| false | 非关键形象单元 |
| true | 关键形象单元 |