wbs字典数据
接口说明
该接口用于获取wbs字典数据
接口地址
/external/unit-work?startId=0&startVersion=0&limit=200
接口类型
Http
请求方式
GET
内容类型
application/json
鉴权策略
参见《Open-API鉴权协议》
请求参数
| 参数名称 | 说明 |
|---|---|
| startId | 本次请求所要获取的增量数据的id起始值,第一次调用初始值为0,客户端需要缓存接口返回的数据集合中最后一条数据的id值 |
| startVersion | 本次请求所要获取的增量数据的version起始值,第一次调用初始值为0,客户端需要缓存接口返回的数据集合中最后一条数据的version值 |
| limit | 返回指定的数据条数,上限为500条,0 <= limit <= 500。如果limit > 500, 则最多返回500条数据 |
请求头
响应报文
[
{
"id": 116547035968512,
"name": "桥梁工程",
"code": "01",
"projectCategoryName": "公路工程",
"unitWorkCategoryName": " 桥梁工程",
"disabled": false,
"originalId": "42ab65b3bc8d453a808ba00d4b70140d",
"originalSystemKey": "data-platform",
"createdAt": "2018-05-07T06:31:21.000Z",
"updatedAt": "2018-08-20T07:11:18.000Z",
"removed": false,
"version": 171068015112196
}
]
响应状态码
| 字段名称 | 数据类型 |
|---|---|
| 200 | 成功 |
| 400 | 用户请求头中Authorization值的格式不对,错误码:InvalidArgument。 |
| 403 | AccessId不存在或被禁用 错误码:InvalidAccessId |
| 500 | 非法参数或接口执行异常 |
响应数据结构
| 字段名称 | 数据类型 | 是否可以为空 | 字段描述 |
|---|---|---|---|
| id | long | 否 | wbs字典Id |
| name | string | 否 | 模板名称 |
| code | string | 是 | 模板编码 |
| projectCategoryName | string | 是 | 工程类别 |
| unitWorkCategoryName | string | 是 | 模板类别 |
| disabled | boolean | 否 | 是否禁用 见表2 |
| originalId | string | 是 | 原始Id |
| originalSystemKey | string | 是 | 数据来源 |
| createdAt | date | 否 | 创建时间,utc标准时间格式 |
| updatedAt | date | 否 | 修改时间,utc标准时间格式 |
| removed | boolean | 否 | 是否逻辑删除 见表1 |
| version | long | 否 | 数据版本 |
表1 逻辑删除标志位枚举值定义
| removed | |
|---|---|
| false | 未删除 |
| true | 已删除 |
表2 禁用标志位枚举值定义
| disabled | |
|---|---|
| false | 启用 |
| true | 禁用 |