描述

获取工作流模板。

请求

URL

https://api.dadayun.cn/v1/workflow/templates/$id
HTTP请求方式

GET
HTTP请求参数

名称	是否必需	类型	描述
id	是	String	工作流模板Id。
instanceId	否	String	筛选条工作流实例Id，如果传入此参数，表示获取此模板运行实例数据（模板+实例）。

响应

返回参数

返回工作流模板，列表数据项参数说明：

名称	类型	描述
Id	String	工作流模板Id。
Name	String	工作流模板名称。
InternationalName	String	本地化模板名称。
HasInstance	Boolean	是否有实例数据。
WorkflowType	Integer	工作流模板类型: - `1` 普通工作流 - `2` 自由工作流
Status	String	模板状态: - `1` 未提交 - `2` 测试 - `3` 已提交
Creator	String	模板创建者Id。
CreatorName	String	模板创建时间。
WFNodes	Object[]	流程节点。参考下文 WFNodes 参数说明
WFDataObjects	Object[]	模板携带数据对象。参考下文 WFDataObjects 参数说明

WFNodes 参数说明:

名称	类型	描述
Id	String	流程节点Id。
Name	String	节点名称。
InternationalName	String	本地化节点名称。
WFTplId	String	所属工作流模板Id。
NodeType	String	节点类型， - `1` 常规节点， - `2` 自动化节点， - `3` 结束节点
Status	String	节点状态，运行中的实例才有。
IsEndNode	Boolean	是否结束节点，即`NodeType`等于3。
IsStartNode	String	是否开始节点。
ActionType	Integer	节点任务类型， - `1` 审核/审批， - `2` 知会 - `3` 执行确认， - `4` 开始节点， - `5` 无效
ApproveText	String	节点通过按钮文字。
RejectText	String	节点驳回按钮文字。
InType	Integer	任务转入类型， - `1` 全部分支到达时 - `2` 任一分支到达时 - `3` 不小于指定数量的分支到达时
InThreshold	Integer	任务转入类型为3时的数量阀值。
OutType	String	任务转出类型， - `1` 允许任务转移至满足条件的所有分支 - `2` 允许任务转移至满足条件的第一分支
MultiActorOutType	String	多个执行者的任务转出规则， - `0` 任一执行者代表所有执行者执行完毕时转出（默认值） - `1`任一执行者执行完毕时转出 - `2` 所有执行者执行完毕时转出 - `3` 不小于指定数量的执行者执行完毕时转出
MultiActorOutThreshold	String	多个执行者转出阈值，`OutType`等于3的数量阀值。
CanSplitFormData	Boolean	允许分拆审批json字符串。
SplitFormDataConfig	String	分拆审批配置，json字符串。参考下文 SplitFormDataConfig 参数说明
WFNodeActors	Object[]	流程节点执行者，一个节点可以设置多个执行者。参考下文 WFNodeActors 参数说明
WFTransactionConditions	Object[]	流程节点流转到下一节点的条件，一个节点可以流转到一个或多个节点。参考下文 WFNodeActors 参数说明

SplitFormDataConfig 参数说明:

名称	类型	描述
FormTplId	String	表单模板Id。
FormItemListIds	String[]	表单拆分的依据字段。

WFNodeActors 参数说明:

名称	类型	描述
Id	String	流程节点执行者Id。
WFNodeId	String	所属流程节点Id。
ActorType	Integer	执行者类型， - `1` 创建者， - `2` 前一节点的直接上级， - `3` 前一节点的上下级， - `4` 前一节点部门内指定级别的岗位， - `5` 创建者上下级， - `6` 岗位， - `7` 角色， - `8` 根据单据内容动态选择执行者， - `9` 前一节点临时指定岗位或角色， - `10` 指定节点的实际执行者。
CompositeId	String	参与者Id。
CompositeName	String	参与者名称。
DynamicActorDatas	String	动态执行者配置。

WFTransactionConditions 参数说明:

名称	类型	描述
Id	String	流转条件Id。
WFNodeId	String	当前所在节点Id。
Condition	String	流转到指定节点的条件。
TargetNodeId	String	流转到的节点Id。
TargetNodeName	String	流转到的节点名称。

WFDataObjects 参数说明:

名称	类型	描述
Id	String	数据对象Id。
WFTplId	String	所属工作流模板Id。
ObjType	String	数据对象类型， - `1` 单据， - `2` 文档， - `3` 报表。
ObjId	String	数据对象模板Id（单据模板Id,文档模板Id,报表模板Id）。
MustBeNew	Boolean	主单据（在创建流程必须创建），一个流程模板只能设置一个主单据。
ObjName	String	数据对象名称。数据对象是单据，则表示单据模板名称；数据对象是文档，则表示文档模板名称；数据对象是报表，则表示报表模板名称。
NodeList	Object[]	数据对象在各节点的权限设置。参考下文 NodeList 参数说明

NodeList 参数说明:

名称	类型	描述
DataObjectId	String	所属数据对象Id。
NodeId	String	节点Id。
NodeName	String	节点名称。
R	String	数据对象在`NodeId`指向的节点的读取权限（可读）。
U	String	数据对象在`NodeId`指向的节点的编辑权限（可编辑）。

示例

请求示例

HTTP/1.1
GET  /v1/workflow/templates/8ac78f4c-a7eb-4d0c-ab8e-19930fa4ec6f
Host: api.dadayun.cn
Date: Thu, 30 Aug 2018 02:55:22 GMT

正常返回示例

HTTP/1.1 200 OK
Date: Thu, 30 Aug 2018 02:55:22 GMT
Content-Type: application/json; charset=utf-8

{
    "Id": "8ac78f4c-a7eb-4d0c-ab8e-19930fa4ec6f",
    "Name": "采购申请",
    "InternationalName": "采购申请",
    "HasInstance": true,
    "WorkflowType": 1,
    "Status": 3,
    "Creator": "d63f3678-5082-4c8a-9bd5-5aef58c2be08",
    "CreateTime": "2015-05-28T05:55:30.960Z",
    "WFNodes": [
        {
            "Id": "05d64126-d598-4e1c-a375-4ba1352b616c",
            "Name": "采购申请",
            "InternationalName": "采购申请",
            "WFTplId": "8ac78f4c-a7eb-4d0c-ab8e-19930fa4ec6f",
            "NodeType": 1,
            "Status": 4,
            "IsEndNode": false,
            "IsStartNode": true,
            "ActionType": 4,
            "ApproveText": "同意",
            "RejectText": "不同意",
            "InType": 2,
            "InThreshold": 0,
            "OutType": 1,
            "MultiActorOutType": 0,
            "MultiActorOutThreshold": 0,
            "CanSplitFormData": false,
            "WFNodeActors": [
                {
                    "Id": "b23bb26c-60e9-40bd-ae0c-82f5f15dfe24",
                    "WFNodeId": "05d64126-d598-4e1c-a375-4ba1352b616c",
                    "ActorType": 7,
                    "CompositeId": "9f98fba5-fe8f-468e-8209-4ba0718d5d84",
                    "CompositeName": "采购人员",
                    "DynamicActorDatas": ""
                }
            ],
            "WFTransactionConditions": [
                {
                    "Id": "82f747f9-0960-4a9f-944d-636a54543294",
                    "WFNodeId": "05d64126-d598-4e1c-a375-4ba1352b616c",
                    "Condition": "无条件",
                    "TargetNodeId": "f4d24690-07b2-4887-a2a1-2046d28b8ea0",
                    "TargetNodeName": "采购经理审批"
                }
            ]
        },
        {
            "Id": "f4d24690-07b2-4887-a2a1-2046d28b8ea0",
            "Name": "采购经理审批",
            "InternationalName": "采购经理审批",
            "WFTplId": "8ac78f4c-a7eb-4d0c-ab8e-19930fa4ec6f",
            "NodeType": 1,
            "Status": 4,
            "IsEndNode": false,
            "IsStartNode": false,
            "ActionType": 1,
            "ApproveText": "同意",
            "RejectText": "不同意",
            "InType": 2,
            "InThreshold": 0,
            "OutType": 1,
            "MultiActorOutType": 0,
            "MultiActorOutThreshold": 0,
            "CanSplitFormData": true,
            "SplitFormDataConfig": "{\"FormTplId\":\"240ed22e-b775-4c80-9050-f73b8843f7a4\",\"FormItemListIds\":[\"5cc8253c-*c8f1-4be9-9f92-3bef5026059c\"]}",
            "WFNodeActors": [
                {
                    "Action": "ignore",
                    "Id": "f03329b4-cda1-4119-9a78-d3d88f32c9d0",
                    "ActorType": 6,
                    "CompositeId": "3cd62504-62be-404a-a30f-2ff90f014292",
                    "WFNodeId": "f4d24690-07b2-4887-a2a1-2046d28b8ea0",
                    "DynamicActorDatas": "",
                    "CompositeName": "采购部:采购部经理",
                    "RankName": "部门经理",
                    "EmployeeName": "叶小玲",
                    "OUName": "采购部"
                }
            ],
            "WFTransactionConditions": [
                {
                    "Action": "ignore",
                    "Id": "3d86a652-deaf-4644-81de-d8e32d574979",
                    "Condition": "无条件",
                    "TargetNodeId": "ad777070-89c3-4e4c-b0f0-e1ef8c06d666",
                    "WFNodeId": "f4d24690-07b2-4887-a2a1-2046d28b8ea0",
                    "TargetNodeName": "财务经理审批"
                }
            ]
        },
        {
            "Id": "09382078-6904-4367-b1ec-bc6c2b385105",
            "Name": "结束",
            "InternationalName": "结束",
            "WFTplId": "8ac78f4c-a7eb-4d0c-ab8e-19930fa4ec6f",
            "NodeType": 3,
            "Status": 4,
            "IsEndNode": true,
            "IsStartNode": false,
            "ActionType": 1,
            "ApproveText": "同意",
            "RejectText": "不同意",
            "InType": 2,
            "InThreshold": 0,
            "OutType": 1,
            "MultiActorOutType": 0,
            "MultiActorOutThreshold": 0,
            "CanSplitFormData": false,
            "WFNodeActors": [],
            "WFTransactionConditions": []
        }
    ],
    "WFDataObjects": [
        {
            "Id": "ded38129-bca8-4c75-80bf-7efd068a9c70",
            "WFTplId": "8ac78f4c-a7eb-4d0c-ab8e-19930fa4ec6f",
            "ObjType": 1,
            "ObjId": "240ed22e-b775-4c80-9050-f73b8843f7a4",
            "MustBeNew": true,
            "ObjName": "采购申请单",
            "NodeList": [
                {
                    "DataObjectId": "ded38129-bca8-4c75-80bf-7efd068a9c70",
                    "NodeId": "f4d24690-07b2-4887-a2a1-2046d28b8ea0",
                    "NodeName": "采购经理审批",
                    "U": false,
                    "R": true
                }
            ]
        },
        {
            "Id": "56176458-bae3-497a-929f-7b5a0f03271e",
            "WFTplId": "8ac78f4c-a7eb-4d0c-ab8e-19930fa4ec6f",
            "ObjType": 1,
            "ObjId": "21bc6da1-648d-4571-b637-cbd1333f6dfb",
            "MustBeNew": false,
            "ObjName": "入库单",
            "NodeList": [
                {
                    "DataObjectId": "56176458-bae3-497a-929f-7b5a0f03271e",
                    "NodeId": "f4d24690-07b2-4887-a2a1-2046d28b8ea0",
                    "NodeName": "采购经理审批",
                    "U": false,
                    "R": true
                }
            ]
        }
    ]
}

异常返回示例

HTTP/1.1 500 Internal Server Error
Date: Thu, 30 Aug 2018 02:55:22 GMT
Content-Type: application/json; charset=utf-8

{
  "Code": "InternalError",
  "Message": "未知错误"
}

results matching ""

No results matching ""