1. 导出变更分析报告

导出变更分析报告。

请求方式:POST

请求地址:/bosdesignservice/{appKey}/tags/{key}/changeReport

1.1. 请求参数:

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea access_token

PathParas:

参数名 类型 示例 是否必填 参数含义
Key string xb05cd3a35614caa85c0f8f86c58fcc1 构件 Key

SearchParas:

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

Body:

application/json:

Body (application/json)
{

    "relationships": ["irTagTag","irTagDocument","irTagWbs"], //  需要导出的关系类列表
    "direction": "up", //查询上游还是下游,up-上游,down-下游,both-全部,默认全部
    "level": 2, //向上或向下查几层, 默认查询10层
    "wbses": {
        "type": "", //任务类型(不传则查询全部):
        "normal": "", //已完成且未逾期的任务
        "notTyping": "", //未键入实际进度的任务
        "overdueStart": "", //逾期开始的任务
        "overdueEnd": "", //逾期结束的任务
        "name": "", //任务名,支持模糊查询
        "startTime": "", //开始计划时间
        "endTime": "" //结束计划时间
    }
}

1.2. 参数说明:

参数名 类型 示例 是否必填 参数含义
relationships object ["irTagTag","irTagDocument","irTagWbs"] 需要导出的关系类列表
direction string 查询上游还是下游,up-上游,down-下游,both-全部,默认全部
level string 向上或向下查几层, 默认查询 10 层
type string normal(已完成且未逾期的任务),
notTyping(未键入实际进度的任务),
overdueStart(逾期开始的任务),
overdueEnd(逾期结束的任务)
任务类型(不传则查询全部)

1.3. 正确返回:

Http Status Code:200
Excel文件

1.4. 状态码:

状态码 code message data 原因
200 ENTITY_NOTFOUND Key 为{key}的 tags 实体对象不存在 NULL 当 key 为{key}的 tags 不存在时

1.5. 注意事项:

1、 relationships:指定需要导出的关联关系列表。如指定,则以指定的范围为准;如不指定,则导出物项的以下关联关系: ① 物项上下游关系(irTagTag 及其子类) ② 物项与 WBS 关联关系 ③ 物项与文档的所有关联关系

2、 当导出范围包括物项上下游关系时,relationships 应包含 irTagTag(其子类自动包括)

3、 当导出范围包括物项上下游关系时,根据 direction 判断取上游或下游构件,up-只取上游,down-只取下游,both 或不传-全部,当出现闭环时,停止继续向上或向下搜索,给当前节点增加属性 "closedLoop": true,level 参数指定上下游层级,默认 10 层。

4、 当导出范围包括 WBS 时,wbses 参数定义构件关联进度任务信息的过滤条件。

5、当前导出构件上下游的数据依赖于接口根据物项 key 查询上下游物项。

1.6. 兼容性:

为了兼容历史版本的接口参数,当接口参数不含 relationships,但包含 customizedTagRels 或 customizedDocumentsRels 时,导出范围包括:

1、物项上下游关系(irTagTag 及其子类)

2、物项与 WBS 的关联关系(irTagWbs)

3、物项与文档的默认关联关系(irTagDocument)

4、customizedTagRels 参数定物项与物项的其他关联关系列表(不包括 irTagTag 及其子类)。默认查找物项关联(irTagTag 及其子类除外)的所有物项

5、customizedDocumentsRels 参数定义除 irTagDocument 外,物项与文档的其他关联关系列表。默认查找物项关联的所有文档

版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""