没有合适的资源?快使用搜索试试~ 我知道了~
首页ActivitiBPM-restful-API
ActivitiBPM-restful-API
需积分: 24 152 浏览量
更新于2023-05-26
评论
收藏 89KB DOCX 举报
ActivitiBPM-restful-API,详细描述Activiti的所有API和属性
资源详情
资源评论
资源推荐

1 接口约定
1.1 方法和返回值
Table15.1.HTTP 方法和对应操作
方法 操作
获得一个资源或获得多个资源
创建一个新资源。当请求结果太复杂,无法放到 请求的 中,也用来查询资
源。
更新已有资源的属性。也用来调用现存资源的功能。
删除现存资源。
Table15.2.HTTP 方法响应代码
响应 描述
操作成功,响应返回( 和 请求)。
操作成功,实体已创建,并返回到响应体中( 请求)。
操作成功,实体已删除,不会返回响应体( 请求)。
操作失败。操作要求设置 头部。如果请求中已经设置了头部,
对应的凭证是无效的或者用户不允许执行这个操作。
!"#
禁止操作,不要重试。这不是认证和授权的问题,这是禁止操作。比如:删除
一个执行中流程的任务是不允许的,无论用户或流程任务的状态。
$
操作失败。找不到请求的资源。
%&
''(
操作失败。使用的资源方法不允许调用。比如:想更新()已部署的资源会
返回 % 结果。
)*
操作失败。更新其他操作应更新的资源,会导致更新不合法。也可以表示一个
结合中新创建的资源的 已经存在了。
%+,,
&-,
操作失败。请求体包含了不支持的媒体类型。当请求体的 . 中包含未知的属
性或值时,也会返回这个响应,一般是因为无法处理的错误格式或类型。
%/'+0
操作失败。执行操作时出现了预期外的异常。响应体中包含错误的细节。

响应 描述
1-, 和 2 响应永远都是 ,,'34+,除非需要使用二进制内容(比如:发布资源数
据),会使用内容的 1-,。
1.2 错误响应体
当发生错误时(包括客户端和服务端,55 和 %55 状态码),响应体会包含描述发生的错误的描述。 下
面是任务不存在时出现的 状态:
6
78++89:
78&++;898'<+(==>8
?
1.3 请求参数
1.3.1 URL 片段
' 上的参数(比如 ,933+30+3+03,+-3,'-1+36,'-1/?上
的 ,'-1/) 都需要转义(参考
编码或百分号编码 来解决特殊字符问题)。 大多数框架都有
这种内置功能,但我们也要把这个问题考虑在内。特别是对于可能包含前斜线(比如,部署资源)的情况,
这就是必须的。
1.3.2 Rest URL 查询参数
设置在 中的查询参数(比如,,933+30+3+03,'-1+@
1A,'-1 中的 1 参数) 可以使用以下类型,它们对应着以下 / 文档:
Table15.3.URL 查询参数类型
类型 格式
;
纯文本参数。可以包含任何 允许的合法的字符。对于 555 参数,字符串应该包含通
配符B(还要通过 ' 编码)。这可以指定模糊搜索的意图。比如=+B=匹配所有以=+=开头

类型 格式
的值。
/;
整数参数。只能包含非小数的整数值,在>C>D!>ED 与 >C>D!>EC 之间。
;
长 整 形 参 数 。 只 能 包 含 非 小 树 的 长 整 形 值 , 在 )>!>!C>!E>D%>CC%>DD 与
)>!>!C>!E>D%>CC%>DC 之间。
F'
布尔类型参数。可以是 或 $'+。如果使用了其他值,会返回=%FG+=响
应。
日期类型。使用 /DE 日期格式(参考维基百科上的
/DE ), 用于时间和日期组件
(比如 !!!9%H)。
1.3.3 JSON 内容参数
Table15.4.JSON 参数类型
类型 格式
;
纯文本参数。可以包含任何 允许的合法的字符。对于 555 参数,字符串应该包含通
配符B(还要通过 ' 编码)。这可以指定模糊搜索的意图。比如=+B=匹配所有以=+=开头
的值。
/;
整数参数,. 数字。只能包含非小数的整数值,在>C>D!>ED 与 >C>D!>EC 之
间。
;
长整形参数,. 数字。只能包含非小树的长整形值,在 )>!>!C>!E>D%>CC%>DD 与
)>!>!C>!E>D%>CC%>DC 之间。
F'
布尔类型参数,. 布尔。可以是 或 $'+。如果使用了其他值,会返回=%F
G+=响应。
日期类型,. 文本。使用 /DE 日期格式(参考维基百科上的
/DE ), 用于时
间和日期组件(比如 !!!9%H)。
1.3.4 分页与排序
分页与排序参数可以添加到 的 G-+; 中(比如 ,933+30+3+03
,'-1+@+A1 中的 1 参数)。
Table15.5.查询 JSON 参数
参数 默认值 描述
+
根据查询实现而不同 查询的名称,对于不同的查询实现,默认值也不同。

参数 默认值 描述
+
排序的方式,可以为=+=或=+=。
+
分页查询开始的值,默认从 开始。
+
分页查询每页显示的记录数。默认为 。
1.3.5 JSON 查询变量格式
6
7818980#'18:
780'8980#'I'8:
78,898G'+8:
78-,898+;8
?
Table15.6.查询 JSON 参数
参数
是否
必须
描述
1
否
查询包含的变量名称。在一些查询中使用=G'+=查询对应资源的所有值时,可以为
空。
0'
是 查询包含的变量值,要包含给定类型的正确格式。
,
是
查 询 使 用 的 参 数 , 可 以 是 以 下 值 : G'+:G'+:G'+/;+:
G'+/;+: '++: ;: '++G'+:
;G'+ 和 '。
-,
否
使用的变量的类型。如果省略,类型会根据 0' 参数决定。所以 . 文本值都会
认为是 +; 类型,. 布尔对应 #',. 数字根据数字的长度对应 ';
或 ;。在不确定时,建议使用精确的类型。下面列出了不稳定支持的其他类型。
Table15.7.默认查询 JSON 类型
类型名称 描述
+;
对应 40>';>;>
+
对应 40>';>/;>
;
对应 40>';>/;>
';
对应 40>';>;>

类型名称 描述
#'
对应 40>';>#'>
#'
对应 40>';>F'>
对应 40>'>。. 字符串会使用 /DE 格式进行转
换。
1.3.6 变量格式
在使用变量时(执行,流程和任务),, 使用一些通用原则和 . 格式实现读写。 变量的
. 格式看起来如下所示:
6
7818980#'18:
780'8980#'I'8:
780''898,933>>>8:
78+,898''8:
78-,898+;8
?
Table15.8.变量 JSON 属性
参数
是否
必须
描述
1
是 变量名称。
0'
否 变量值。写入变量时,如果没有设置 0',会认为值是 ''。
0'
'
否
当读取变量的类型为 #- 或 +'#' 时,这个属性会指向获取原始二进制数据的
。
+,
否
变量的范围。如果为=''=,变量会对应到请求的资源。如果为=;'#'=,变量会定义到
请求资源的上级(或上级树的任何上级)。当写入变量,没有设置 +, 时,假设使用
;'#'。
-,
否
变量类型。参考下面的表格对类型的描述。当写入变量,没有设置类型时,会根据请求
的 . 属性来推断它的类型,限制为 +;,#',; 和 #'。如果不
确定会用到的类型,建议还是要设置一个类型。
Table15.9.变量类型
剩余34页未读,继续阅读

















安全验证
文档复制为VIP权益,开通VIP直接复制

评论0