web service接口—Net

BPMservice接口

1     启动H3 BPM流程,设置主键数据项的值

接口地址:/WebServices/BPMService.asmx

方法名称:StartWorkflowWithKey

输入参数描述:

参数名称

类型

说明

workflowCode

字符串

流程模板编码

userCode

字符串

用户编码

finishStart

逻辑

是否结束第一个活动

keyName

字符串

主键数据项名称

keyValue

字符串

主键数据项的值

 

输出参数描述:

参数名称

类型

说明

Success

逻辑

流程启动是否成功

InstanceID

字符串

启动的流程实例ID

Message

字符串

系统返回消息

WorkItemID

字符串

第一个节点的ItemID

WorkItemUrl

字符串

第一个节点的url

 

2     激活指定的活动节点

接口地址:/WebServices/BPMService.asmx

方法名称:ActiveToken

输入参数描述:

参数名称

类型

说明

示例

InstanceID

字符串

激活的流程实例ID


activityCode

字符串

活动节点


participants

字符串数组

活动参与者,可以指定参与者,如果为空那么取流程默认配置

String[]

输出数据描述:

属性名称

类型

说明

示例

是否激活成功

boolean

流程激活结果

True为激活,False为未激活

3     取消指定的活动节点

接口地址:/WebServices/BPMService.asmx

方法名称:CancelToken

输入参数描述:

参数名称

类型

说明

示例

InstanceID

字符串

流程实例ID


activityCode

字符串

活动节点


输出数据描述:

属性名称

类型

说明

示例

返回结果

boolean

取消指定的活动节点结果

True为取消,False为未取消

4     获取用户已任务总数

接口地址:/WebServices/BPMService.asmx

方法名称:GetUserFinishedWorkItemCount

输入参数描述:

参数名称

类型

说明

示例

userId

字符串

用户ID


输出数据描述:

属性名称

类型

说明

示例

返回值

int

已完成的任务总数

GetUserFinishedWorkItemCount()

5     获取用户未完成的任务总数

接口地址:/WebServices/BPMService.asmx

方法名称GetUserUnfinishedWorkItemCount

输入参数描述:

参数名称

类型

说明

示例

userId

字符串

用户ID


输出数据描述:

属性名称

类型

说明

示例

返回值

int

未完成的任务总数

GetUserUnfinishedWorkItemCount()

6     获取发起流程模板

接口地址:/WebServices/BPMService.asmx

方法名称:GetWorkfowNodeByUser

输入参数描述:

参数名称

类型

说明

示例

UserCode

字符串

系统编码


ShowFavorite

逻辑型

是否常用


IsMobile

逻辑型

是否移动端


ParentCode

字符串

父流程编码


SearchKey

字符串

搜索关键字


输出数据描述:

属性名称

类型

说明

示例

返回值

字符串

返回一个JSON格式的字符串,由List<WorkflowNode>转化的包含属性有IsLeaf(是否流程节点)

ObjectID(节点Id

Code(节点编码)

DisplayName(节点显示名称)PublishedTime(流程发布时间)

Version(流程版本号)

Frequent(是否常用流程)

IconFileName(图标文件名称)

Icon(图标字体)

List<WorkflowNode> children(子节点)


7     查询用户的待阅任务

接口地址:/WebServices/BPMService.asmx

方法名称:GetUnReadWorkItems

输入参数描述:

参数名称

类型

说明

示例

userCode

字符串

用户编码


startTime

Datetime

开始时间(可控)


endTime

Datetime

结束时间


startIndex

数字

开始索引


endIndex

数字

结束索引


workflowCode

字符串

流程模板编码


instanceName

字符串

流程实例名称


输出数据描述:GetUnReadWorkItemsResult.CirculateItemViewModel.XXX

属性名称

类型

说明

示例

Participant

字符串

参与者


Originator

字符串

流程发起人


OriginatorName

字符串

发起人姓名


OriginatorOUName

字符串

发起人所在OU名称


InstanceName

字符串

流程实例名称


DisplayName

字符串

活动名称


ReceiveTime

字符串

工作任务接收时间


PlanFinishTime

字符串

工作任务计划完成时间


FinishTime

字符串

工作任务完成时间


InstanceId

字符串

流程实例ID


WorkflowCode

字符串

流程模板编码WorkflowCode


WorkflowName

字符串

流程实例WorkflowName


ItemCount

字符串

流程模板的流程数(待办任务分组模式)


DisplayWorkflowCode

布尔值

表中表是否展示(待办任务分组模式)


Priority

字符串

工作任务紧急程度


State

数字

工作任务状态


Urged

布尔值

当前任务是否被催办


Assisted

布尔值

当前任务是否有协办


AssistantFinished

布尔值

当前任务是否协办已完成


Consulted

布尔值

当前任务是否有征询意见


ConsultantFinished

布尔值

当前任务是否征询已完成


CirculateCreator

字符串

传阅人ID


CirculateCreatorName

字符串

传阅人Name


StayTime

字符串

流程实例运行时长(滞留时间)


8     激活流程                

接口地址:/WebServices/BPMService.asmx

方法名称:ActiveInstance

输入参数描述:

参数名称

类型

说明

示例

instanceId

字符串

流程实例ID


输出数据描述:

属性名称

类型

说明

示例

返回结果

布尔值

True成功/false失败


9     获取用户已阅任务总数

接口地址:/WebServices/BPMService.asmx

方法名称:GetUserReadedWorkItemCount

输入参数描述:

参数名称

类型

说明

示例

userId

字符串

用户ID


输出数据描述:

属性名称

类型

说明

示例

返回值

整数

返回已阅任务的数量


10  获取用户未阅任务总数

接口地址:/WebServices/BPMService.asmx

方法名称:GetUserUnReadWorkItemCount

输入参数描述:

参数名称

类型

说明

示例

userId

字符串

用户ID


输出数据描述:

属性名称

类型

说明

示例

返回值

整数

返回未阅任务的数量


11  查询用户已阅任务

接口地址:/WebServices/BPMService.asmx

方法名称:GetReadWorkItems

输入参数描述:

参数名称

类型

说明

示例

userCode

字符串

用户编码


startTime

日期

开始时间


endTime

日期

截至时间


startIndex

整数

开始索引


endIndex

整数

结束索引


workflowCode

字符串

流程模板编码


instanceName

字符串

流程名称


输出数据描述:

属性名称

类型

说明

示例

ParticiPant

字符串

参与者


Originator

字符串

流程发起人


OriginatorName

字符串

发起人姓名


OriginatorOUName

字符串

发起人所在OU名称


InstanceName

字符串

流程实例名称


DisplayName

字符串

活动名称


ReceiveTime

字符串

工作任务接受时间


PlanFinishTime

字符串

工作任务计划完成时间


FinishTime

字符串

工作任务完成时间


InstanceId

字符串

流程实例ID


WorkflowCode

字符串

流程实例编码


WorkflowName

字符串

流程实例名称


ItemCount

字符串

流程模板的流程数(待办任务分组模式)


DisplayWorkflowCode

逻辑型

表中表是否显示(待办任务分组模式)


Priorty

字符串

工作任务紧急情况


State

整数

工作任务状态


Urged

逻辑型

当前任务是否被催办


Assisted

逻辑型

当前任务是否有协办


AssistantFinished

逻辑型

当前任务协办是否已完成


Consulted

逻辑型

当前任务是否有征询意见


ConsultantFinished

逻辑型

当前任务是否征询已完成


CirculateCreator

字符串

传阅人ID


CirculateCreatorName

字符串

传阅人Name


StayTime

时间戳

流程实例运行时长


12  查询用户的已办

接口地址:/WebServices/BPMService.asmx

方法名称:GetFinishWorkItems

输入参数描述:

参数名称

类型

说明

示例

userCode

整数

用户编码


startTime

日期

开始时间(可控)


endTime

日期

结束时间


startIndex

整数

开始索引


endIndex

整数

结束索引


workflowCode

字符串

流程模板编码


instanceName

字符串

流程实例名称


 

输出数据描述:

属性名称

类型

说明

备注

返回结果

List

返回一个JSON格式的字符串,由List< WorkItemViewModel>转化的,内容有

Participant(参与者),

ParticipantName(参与者姓名),

Originator(发起人),

OriginatorName(发起人姓名),

OriginatorOUName(发起人所在OU名称),

InstanceName(流程实例名称),

ActivityCode(活动编码),

DisplayName(活动名称),

ReceiveTime(工作任务接收时间),

PlanFinishTime(工作任务计划完成时间),

FinishTime(工作任务完成时间),

InstanceId(流程实例ID),

WorkflowCode流程模板编码WorkFlowCode),

WorkflowName(流程实例WorkFlowName),

ItemCount(流程模板的流程数),

DisplayWorkflowCode(表中表是否展示),

Priority(工作任务紧急程度),

State(工作任务状态),

Urged(当前任务是否被催办),

Assisted(当前任务是否有协办),

AssistantFinished(当前任务是否协办已完成),

Consulted(当前任务是否有征询意见),

ConsultantFinished(当前任务是否征询已完成),

CirculateCreator(传阅人ID),

CirculateCreatorName(传阅人姓名),

StayTime(流程实例运行时长),

ItemSummary(任务节点摘要信息)

Priority对应的状态有

-1-Unspecified,未指定的优先级,这个主要是为了方便查询;

0-Low,低优先级;

1-Normal,普通优先级;

2-High,高优先级;

 

 

State对应的状态有

-1-Unspecified,未指定的状态,这个主要是为了方便查询;

0- Waiting,处于等待的状态;

1-处于正在工作中的状态;

2-Finished,处于完成状态;

3-Canceled,已经被取消;

4-Unfinished,这个并不属于WorkItem本身的状态,只是为了方便进行查询,他指Waiting或者Working状态;

5-NotCanceled,这个并不属于WorkItem本身的状态,只是为了方便进行查询,未被取消的状态,指WaitingWorking或者Finished状态

13  发起流程

接口地址:/WebServices/BPMService.asmx

方法名称:StartWorkflow

输入参数描述:

参数名称

类型

说明

示例

workflowCode

字符串

流程模板编码


userCode

字符串

用户编码

用户唯一标识

finishStart

逻辑

是否结束第一个活动


paramValues

字符串

流程实例启动初始化数据项集合(JSON格式)

[{"ItemName":"Title","ItemValue":"主题"},{"ItemName":"Content","ItemValue":"内容"}]

输出数据描述:

属性名称

类型

说明

示例

Success

逻辑型

流程启动是否成功

"Success":true

InstanceID

字符串

启动的流程实例ID

"InstanceID":"557b05fb-cdf2-4f69-8e2d-27456e12860b"

Message

字符串

系统返回消息

"Message":"流程实例启动成功"

WorkItemID

字符串

第一个节点的ItemID

"WorkItemID":""

WorkItemUrl

字符串

第一个节点的url

"WorkItemUrl":""

 14  结束流程

接口地址:/WebServices/BPMService.asmx

方法名称:FinishInstance

输入参数描述:

参数名称

类型

说明

示例

InstanceID

字符串

流程实例ID


输出数据描述:

属性名称

类型

说明

示例

返回值

逻辑型

True为已结束,False为未结束


15  提交工作任务

接口地址:/WebServices/BPMService.asmx

方法名称:SubmitWorkItem

输入参数描述:

参数名称

类型

说明

示例

workItemId

string

工作任务节点的ItemID


commentText

string

提交的内容


输出数据描述:

属性名称

类型

说明

示例

返回值

逻辑型

True为已提交,False为未提交


16  获取未完成的任务

接口地址:/WebServices/BPMService.asmx

方法名称:GetUnFinishWorkItems

输入参数描述:

参数名称

类型

说明

示例

userCode

字符串

用户编码


startTime

日期

开始时间


endTime

日期

结束时间


startIndex

整数

开始索引


endIndex

整数

结束索引


workflowCode

字符串

流程模板编码


instanceName

字符串

流程实例名称


输出数据描述:

属性名称

类型

说明

示例

返回值

List

返回参数类型List<WorkItemViewModel> 包含字段有Participant(参与者id)

ParticipantName(参与者姓名) Originator(发起人id)

OriginatorName(发起人姓名)

OriginatorOUName(发起人所在OU名称)

InstanceName(流程实例名称)

ActivityCode(活动编码)

DisplayName(活动名称)

ReceiveTime(工作任务接收时间)

PlanFinishTime(计划完成时间)

FinishTime(工作任务完成时间)

InstanceId(流程实例ID

WorkflowCode流程模板编码WorkflowCode

WorkflowName(流程实例WorkflowName

ItemCount(流程模板的流程数)

DisplayWorkflowCode(表中表是否展示)

Priority(任务紧急程度)

State(任务状态)

Urged(任务是否被催办)

Assisted(是否有协办)

AssistantFinished(协办是否已完成)

Consulted(是否有征询意见)

ConsultantFinished(征询是否已完成)

CirculateCreator(传阅人id

CirculateCreatorName(传阅人名称)

StayTime(流程实例运行时长)

ItemSummary(任务节点摘要信息)


17  设置单个流程数据项的值

接口地址:/WebServices/BPMService.asmx

方法名称:SetItemValue

输入参数描述:

参数名称

类型

说明

示例

userId

字符串

用户ID


bizObjectSchemaCode

字符串

数据模型编码

demo

bizObjectId

字符串

数据实体ID

557b05fb-cdf2-4f69-8e2d-27456e12860b

keyName

字符串

数据项参数的名称

demo

keyValue

字符串

数据项参数的值

demo

输出数据描述:

属性名称

类型

说明

示例

返回值

逻辑型

是否更新成功

true为更新成功,false为更新不成功

 

18  设置批量流程数据项的值

接口地址:/WebServices/BPMService.asmx

方法名称:SetItemValues

输入参数描述:

参数名称

类型

说明

示例

userId

字符串

用户ID


bizObjectSchemaCode

字符串

数据模型编码

demo

bizObjectId

字符串

数据实体ID

557b05fb-cdf2-4f69-8e2d-27456e12860b

keyValues

字符串

数据项集合(JSON格式)List<DataItemParam>转化的,内容有ItemName(数据项名称)

ItemValue(数据项值)

[{"ItemName":"Title","ItemValue":"主题"},{"ItemName":"Content","ItemValue":"内容"}]

输出数据描述:

属性名称

类型

说明

示例

返回值

逻辑型

是否更新成功

true为更新成功,false为更新不成功 

19  取回工作任务

接口地址:/WebServices/BPMService.asmx

方法名称:RetrieveWorkItem

输入参数描述:

参数名称

类型

说明

示例

userId

字符串

用户ID


workItemId

字符串

工作任务ID

557b05fb-cdf2-4f69-8e2d-27456e12860b

输出数据描述:

属性名称

类型

说明

示例

返回值

逻辑型

取回结果

true为已取回,false为未取回

20  驳回工作任务

接口地址:/WebServices/BPMService.asmx

方法名称:ReturnWorkItem

输入参数描述:

参数名称

类型

说明

示例

userId

字符串

用户ID


workItemId

字符串

任务实例ID

administrator

commentText

字符串

意见文本

同意

输出数据描述:


属性名称

类型

说明

示例

返回值

逻辑型

驳回结果

true为已驳回,false为未驳回


SSO service接口

1  根据 Token 解密得到真实的用户信息

接口地址:/WebServices/SSOService

方法名称:GetAuthenticationUser

输入参数描述:

参数名称

类型

说明

示例

systemCode

字符串

系统编码,由SSO服务提供


secret

字符串

解密密钥


token

字符串

单点登录信息


输出数据描述:

属性名称

类型

说明

示例

返回值

字符串

userCode;当前已登录统一认证系统的登录账号


2  获取可以单点登录到其他系统的URL

接口地址:/WebServices/SSOService

方法名称:SSOSystemUrl

输入参数描述:

参数名称

类型

说明

示例

systemCode

字符串

当前系统编码


secret

字符串

系统秘钥


userCode

字符串

当前已认证的系统用户帐号


targetsystemCode

字符串

目标系统编码


targetUrl

字符串

目标url


输出数据描述:

属性名称

类型

说明

示例

返回结果

字符串

可以单点登录到其他系统的URL


3  更改解密秘钥

接口地址:/WebServices/SSOService

方法名称:Updatesecret

输入参数描述:

参数名称

类型

说明

示例

systemCode

字符串

系统编码,由SSO服务提供


secret

字符串

旧的解密密钥


Newsecret

字符串

新的解密密钥


输出数据描述:

属性名称

类型

说明

示例

返回值

逻辑型

是否更改secret值是否成功

true为更新成功,false为更新不成功

4  用户登陆验证

接口地址:/WebServices/SSOService

方法名称:ValidateUser       

输入参数描述:

参数名称

类型

说明

示例

SysytemCode

字符串

系统编码


secret

字符串

密钥


UserName

字符串

用户名


Password

字符串

用户密码


输出数据描述:

属性名称

类型

说明

示例

返回值

逻辑型

True 登陆成功

Flase 登陆失败