15.REST API

通用Activiti REST原则

安装与认证

activiti 包含了一个activiti引擎的REST API，把activiti-rest.war部署到像Apache Tomcat这样的servlet容器就可以使用。不过，它也可以使用在其他web应用中，把activiti-rest的依赖都加入 classpath，添加servlet，并映射到你的应用中。

默认情况下，activiti引擎会连接内存数据库H2。你可以修改 WEB-INF/classes目录下的db.properties来修改数据库设置。REST API使用JSON格式（http://www.json.org），它是基于Restlet（http://www.restlet.org）开发的。

默认所有REST资源都需要先使用有效的activiti用户认证后才能使用。会使用Basic HTTP认证，所以你要一直在请求的HTTP头中包含一个Authorization: Basic ...==属性，或在请求url中包含用户名和密码（比如： http://username:password@localhost...）。

建议把Basic认证与HTTPS一起使用。

可以从删除对应资源的认证，或添加额外的授权给一个认证的用户（比如，把用户加入一个组，让它可以执行URL Y）。 可以使用org.activiti.rest.common.filter.RestAuthenticator的实现，它有两个方法：

• boolean requestRequiresAuthentication(Request request)：在请求认证检查之前调用（通过头部传递合法的账号和密码）。如果方法返回true，这个方法就需要认证才能访问。如果返回false，无论请求是否认证都可以访问。如果返回false，就不会为这个方法调用isRequestAuthorized。

• boolean isRequestAuthorized(Request request)：在用户已经通过activiti账号管理认证后，但是再请求实际之前调用。可以用来检查认证用户是否可以访问对应请求。如果返回true，会允许请求执行。如果返回true，请求不会执行，客户端会收到对应的错误。

自定义的RestAuthenticator应该设置到RestletServlet的org.activiti.rest.service.application.ActivitiRestServicesApplication中。 最简单的方法是创建ActivitiRestServicesApplication的子类，并在servlet-mapping中设置自定义的类名：

   <!-- Restlet adapter -->
  <servlet>
    <servlet-name>RestletServlet</servlet-name>
    <servlet-class>org.restlet.ext.servlet.ServerServlet</servlet-class>
    <init-param>
      <!-- Application class name -->
      <param-name>org.restlet.application</param-name>
      <param-value>com.my.company.CustomActivitiRestServicesApplication</param-value>
    </init-param>
  </servlet>

使用Tomcat

根据Tomcat的默认安全配置，默认转码的前斜线（%2F和%5C）都不允许使用（返回400）。 这可能对部署资源和它们的数据URL造成影响，URL可能会包含转移的前斜线。 当出现预期外的400问题，设置下面这个系统参数：-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true.

方法和返回值

Table 15.1.HTTP方法和对应操作

Table 15.2.HTTP方法响应代码

media-type和HTTP响应永远都是application/json，除非需要使用二进制内容（比如：发布资源数据），会使用内容的media-type。

错误响应体

当发生错误时（包括客户端和服务端，4XX和5XX状态码），响应体会包含描述发生的错误的描述。 下面是任务不存在时出现的404状态：

{
  "statusCode" : 404,
  "errorMessage" : "Could not find a task with id '444'."
}

请求参数

URL片段

url上的参数（比如http://host/actviti-rest/service/repository/deployments/{deploymentId}上的deploymentId） 都需要转义（参考URL编码或百分号编码来解决特殊字符问题）。 大多数框架都有这种内置功能，但我们也要把这个问题考虑在内。特别是对于可能包含前斜线（比如，部署资源）的情况，这就是必须的。

Rest URL查询参数

设置在URL中的查询参数（比如，http://host/activiti-rest/service/deployments?name=Deployment中的name参数） 可以使用以下类型，它们对应着以下REST-API文档：

Table 15.3.URL查询参数类型

JSON内容参数

Table 15.4.JSON参数类型

分页与排序

分页与排序参数可以添加到URL的query-string中（比如http://host/activiti-rest/service/deployments?sort=name中的name参数）。

Table 15.5.查询JSON参数

JSON查询变量格式

{
  "name" : "variableName",
  "value" : "variableValue",
  "operation" : "equals",
  "type" : "string"
}

Table 15.6.查询JSON参数

Table 15.7.默认查询JSON类型

变量格式

在使用变量时（执行，流程和任务），REST-api使用一些通用原则和JSON格式实现读写。 变量的JSON格式看起来如下所示：

{
  "name" : "variableName",
  "value" : "variableValue",
  "valueUrl" : "http://...",
  "scope" : "local",
  "type" : "string"
}

Table 15.8.变量JSON属性

Table 15.9.变量类型

可以通过自定义JSON格式来支持更多变量类型（无论是简单数值或复杂/内嵌JSON对象）。 扩展org.activiti.rest.api.RestResponseFactory的initializeVariableConverters()方法， 你可以添加自定义的org.activiti.rest.api.service.engine.variable.RestVariableConverter类来支持POJO与对应REST数据的相互转换。实际的JSON转换是通过Jackson实现的。

部署

如果使用tomcat，请参考tomcat用法。

部署列表

GET repository/deployments

Table 15.10.URL查询参数

Table 15.11.REST响应码

成功响应体：

{
  "data": [
    {
      "id": "10",
      "name": "activiti-examples.bar",
      "deploymentTime": "2010-10-13T14:54:26.750+02:00",
      "category": "examples",
      "url": "http://localhost:8081/service/repository/deployments/10",
          "tenantId": null
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "id",
  "order": "asc",
  "size": 1
}

获得一个部署

GET repository/deployments/{deploymentId}

Table 15.12.获得一个部署 - URL参数

Table 15.13.获得一个部署 - 响应码

成功响应体：

{
  "id": "10",
  "name": "activiti-examples.bar",
  "deploymentTime": "2010-10-13T14:54:26.750+02:00",
  "category": "examples",
  "url": "http://localhost:8081/service/repository/deployments/10",
  "tenantId" : null
}

创建新部署

POST repository/deployments

请求体：

请求体包含的数据类型应该是multipart/form-data。请求里应该只包含一个文件，其他额外的任务都会被忽略。 部署的名称就是文件域的名称。如果需要在一个部署中包含多个资源，把这些文件压缩成zip包，并要确认文件名是以.bar或.zip结尾。

可以在请求体中传递一个额外的参数（表单域） tenantId。字段的值会用来设置部署的租户id。

Table 15.14.创建新部署 - 响应码

成功响应体：

{
  "id": "10",
  "name": "activiti-examples.bar",
  "deploymentTime": "2010-10-13T14:54:26.750+02:00",
  "category": null,
  "url": "http://localhost:8081/service/repository/deployments/10",
  "tenantId" : "myTenant"
}

删除部署

DELETE repository/deployments/{deploymentId}

Table 15.15.删除部署 - URL参数

Table 15.16.删除部署 - 响应码

列出部署内的资源

GET repository/deployments/{deploymentId}/resources

Table 15.17.列出部署内的资源 - URL参数

Table 15.18.列出部署内的资源 - 响应码

成功响应体：

[
  {
    "id": "diagrams/my-process.bpmn20.xml",
    "url": "http://localhost:8081/activiti-rest/service/repository/deployments/10/resources/diagrams%2Fmy-process.bpmn20.xml",
    "dataUrl": "http://localhost:8081/activiti-rest/service/repository/deployments/10/resourcedata/diagrams%2Fmy-process.bpmn20.xml",
    "mediaType": "text/xml",
    "type": "processDefinition"
  },
  {
    "id": "image.png",
    "url": "http://localhost:8081/activiti-rest/service/repository/deployments/10/resources/image.png",
    "dataUrl": "http://localhost:8081/activiti-rest/service/repository/deployments/10/resourcedata/image.png",
    "mediaType": "image/png",
    "type": "resource"
  }
]

• mediaType：包含资源的media-type。这是使用（可插拔的）MediaTypeResolver处理的，默认已经支持了一些有限的mime-type映射。

• type：资源类型，可能值为：

  • resource：原始资源。

  • processDefinition：包含一个或多个流程定义的资源。它会被发布器处理。

  • processImage：展示一个已发布流程定义的图形布局。

结果json中的dataUrl属性包含了用来获取二进制资源的真实URL。

获取部署资源

GET repository/deployments/{deploymentId}/resources/{resourceId}

Table 15.19.获取部署资源 - URL参数

Table 15.20.获取部署资源 - 响应码

成功响应体：

{
  "id": "diagrams/my-process.bpmn20.xml",
  "url": "http://localhost:8081/activiti-rest/service/repository/deployments/10/resources/diagrams%2Fmy-process.bpmn20.xml",
  "dataUrl": "http://localhost:8081/activiti-rest/service/repository/deployments/10/resourcedata/diagrams%2Fmy-process.bpmn20.xml",
  "mediaType": "text/xml",
  "type": "processDefinition"
}

• mediaType：包含资源的media-type。这是使用（可插拔的）MediaTypeResolver处理的，默认已经支持了一些有限的mime-type映射。

• type: 资源类型，可能的值

  • resource: 原始资源.

  • processDefinition: 包含一个或多个流程定义的资源。它会被发布器处理。

  • processImage: 展示一个已发布流程定义的图形布局。

获取部署资源的内容

GET repository/deployments/{deploymentId}/resourcedata/{resourceId}

Table 15.21.获取部署资源的内容 - URL参数

Table 15.22.获取部署资源的内容 - 响应码

成功响应体：

根据请求的资源响应体将包含二进制的资源内容。响应体的content-type的'mimeType'属性将会和资源的返回类型相同。同样，响应头设置content-disposition，允许浏览器下载该文件而不是去显示它。

流程定义

流程定义列表

GET repository/process-definitions

Table 15.23.流程定义列表 - URL参数

Table 15.24.流程定义列表 - 响应码

成功响应体：

{
  "data": [
    {
      "id" : "oneTaskProcess:1:4",
      "url" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "version" : 1,
      "key" : "oneTaskProcess",
      "category" : "Examples",
      "suspended" : false,
      "name" : "The One Task Process",
      "description" : "This is a process for testing purposes",
      "deploymentId" : "2",
      "deploymentUrl" : "http://localhost:8081/repository/deployments/2",
      "graphicalNotationDefined" : true,
      "resource" : "http://localhost:8182/repository/deployments/2/resources/testProcess.xml",
      "diagramResource" : "http://localhost:8182/repository/deployments/2/resources/testProcess.png",
      "startFormDefined" : false
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

• graphicalNotationDefined：表示流程定义包含图形信息（BPMN DI）。

• resource：包含实际部署的BPMN 2.0 xml。

• diagramResource：包含流程的图形内容，如果没有图形就返回null。

获得一个流程定义

GET repository/process-definitions/{processDefinitionId}

Table 15.25.获得一个流程定义 - URL参数

Table 15.26.获得一个流程定义 - 响应码

成功响应体：

{
  "id" : "oneTaskProcess:1:4",
  "url" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
  "version" : 1,
  "key" : "oneTaskProcess",
  "category" : "Examples",
  "suspended" : false,
  "name" : "The One Task Process",
  "description" : "This is a process for testing purposes",
  "deploymentId" : "2",
  "deploymentUrl" : "http://localhost:8081/repository/deployments/2",
  "graphicalNotationDefined" : true,
  "resource" : "http://localhost:8182/repository/deployments/2/resources/testProcess.xml",
  "diagramResource" : "http://localhost:8182/repository/deployments/2/resources/testProcess.png",
  "startFormDefined" : false
}

• graphicalNotationDefined：表示流程定义包含图形信息（BPMN DI）。

• resource：包含实际部署的BPMN 2.0 xml。

• diagramResource：包含流程的图形内容，如果没有图形就返回null。

更新流程定义的分类

PUT repository/process-definitions/{processDefinitionId}

请求的JSON：

{
  "category" : "updatedcategory"
}

Table 15.27.更新流程定义的分类 - 响应码

成功响应体：参考repository/process-definitions/{processDefinitionId}.

获得一个流程定义的资源内容

GET repository/process-definitions/{processDefinitionId}/resourcedata

Table 15.28.获得一个流程定义的资源内容 - URL参数

响应：

与 GET repository/deployment/{deploymentId}/resourcedata/{resourceId}的响应码和响应体完全一致。

获得流程定义的BPMN模型

GET repository/process-definitions/{processDefinitionId}/model

Table 15.29.获得流程定义的BPMN模型 - URL参数

Table 15.30.获得流程定义的BPMN模型 - 响应码

响应体： 响应体是一个转换为JSON格式的org.activiti.bpmn.model.BpmnModel，包含整个流程定义模型。

{
   "processes":[
      {
         "id":"oneTaskProcess",
         "xmlRowNumber":7,
         "xmlColumnNumber":60,
         "extensionElements":{

         },
         "name":"The One Task Process",
         "executable":true,
         "documentation":"One task process description",

         ...
    ],

    ...
}

暂停流程定义

PUT repository/process-definitions/{processDefinitionId}

请求JSON体：

{
  "action" : "suspend",
  "includeProcessInstances" : "false",
  "date" : "2013-04-15T00:42:12Z"
}

Table 15.31.暂停流程定义 - 请求的JSON参数

Table 15.32.暂停流程定义 - 响应码

成功响应体： 参考 repository/process-definitions/{processDefinitionId}的响应。

激活流程定义

PUT repository/process-definitions/{processDefinitionId}

请求JSON体：

{
  "action" : "activate",
  "includeProcessInstances" : "true",
  "date" : "2013-04-15T00:42:12Z"
}

参考暂停流程定义的 JSON参数。

Table 15.33.激活流程定义 - 响应码

成功响应体： 参考 repository/process-definitions/{processDefinitionId}的响应。

获得流程定义的所有候选启动者

GET repository/process-definitions/{processDefinitionId}/identitylinks

Table 15.34.获得流程定义的所有候选启动者 - URL参数

Table 15.35.获得流程定义的所有候选启动者 - 响应码

成功响应体：

[
   {
      "url":"http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4/identitylinks/groups/admin",
      "user":null,
      "group":"admin",
      "type":"candidate"
   },
   {
      "url":"http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4/identitylinks/users/kermit",
      "user":"kermit",
      "group":null,
      "type":"candidate"
   }
]

为流程定义添加一个候选启动者

POST repository/process-definitions/{processDefinitionId}/identitylinks

Table 15.36.为流程定义添加一个候选启动者 - URL参数

请求体（用户）：

{
  "user" : "kermit"
}

请求体（组）：

{
  "groupId" : "sales"
}

Table 15.37.为流程定义添加一个候选启动者 - 响应码

成功响应体：

{
  "url":"http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4/identitylinks/users/kermit",
  "user":"kermit",
  "group":null,
  "type":"candidate"
}

删除流程定义的候选启动者

DELETE repository/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}

Table 15.38.删除流程定义的候选启动者 - URL参数

Table 15.39.删除流程定义的候选启动者 - 响应码

成功响应体：

{
  "url":"http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4/identitylinks/users/kermit",
  "user":"kermit",
  "group":null,
  "type":"candidate"
}

获得流程定义的一个候选启动者

GET repository/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}

Table 15.40.获得流程定义的一个候选启动者 - URL参数

Table 15.41.获得流程定义的一个候选启动者 - 响应码

成功响应体：

{
  "url":"http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4/identitylinks/users/kermit",
  "user":"kermit",
  "group":null,
  "type":"candidate"
}

模型

获得模型列表

GET repository/models

Table 15.42.获得模型列表 - URL参数

Table 15.43.获得模型列表 - 响应码

成功响应体：

{
   "data":[
      {
         "name":"Model name",
         "key":"Model key",
         "category":"Model category",
         "version":2,
         "metaInfo":"Model metainfo",
         "deploymentId":"7",
         "id":"10",
         "url":"http://localhost:8182/repository/models/10",
         "createTime":"2013-06-12T14:31:08.612+0000",
         "lastUpdateTime":"2013-06-12T14:31:08.612+0000",
         "deploymentUrl":"http://localhost:8182/repository/deployments/7",
                 "tenantId":null
      },

      ...

   ],
   "total":2,
   "start":0,
   "sort":"id",
   "order":"asc",
   "size":2
}

获得一个模型

GET repository/models/{modelId}

Table 15.44.获得一个模型 - URL参数

Table 15.45.获得一个模型 - 响应码

成功响应体：

{
   "id":"5",
   "url":"http://localhost:8182/repository/models/5",
   "name":"Model name",
   "key":"Model key",
   "category":"Model category",
   "version":2,
   "metaInfo":"Model metainfo",
   "deploymentId":"2",
   "deploymentUrl":"http://localhost:8182/repository/deployments/2",
   "createTime":"2013-06-12T12:31:19.861+0000",
   "lastUpdateTime":"2013-06-12T12:31:19.861+0000",
   "tenantId":null
}

更新模型

PUT repository/models/{modelId}

请求体：

{
   "name":"Model name",
   "key":"Model key",
   "category":"Model category",
   "version":2,
   "metaInfo":"Model metainfo",
   "deploymentId":"2",
   "tenantId":"updatedTenant"
}

所有请求参数都是可选的。比如，你可以只在请求体的JSON对象中包含'name'属性，只更新模型的名称，这样其他的字段都不会受到影响。如果显示包含了一个属性，并设置为null，模型值会被更新为null。比如：{"metaInfo" : null}会清空模型的metaInfo。

Table 15.46.更新模型 - 响应码

成功响应体：

{
   "id":"5",
   "url":"http://localhost:8182/repository/models/5",
   "name":"Model name",
   "key":"Model key",
   "category":"Model category",
   "version":2,
   "metaInfo":"Model metainfo",
   "deploymentId":"2",
   "deploymentUrl":"http://localhost:8182/repository/deployments/2",
   "createTime":"2013-06-12T12:31:19.861+0000",
   "lastUpdateTime":"2013-06-12T12:31:19.861+0000",
   "tenantId":""updatedTenant"
}

新建模型

POST repository/models

请求体：

{
   "name":"Model name",
   "key":"Model key",
   "category":"Model category",
   "version":1,
   "metaInfo":"Model metainfo",
   "deploymentId":"2",
   "tenantId":"tenant"
}

All request values are optional. For example, you can only include the 'name' attribute in the request body JSON-object, only setting the name of the model, leaving all other fields null.

Table 15.47.新建模型 - 响应码

成功响应体：

{
   "id":"5",
   "url":"http://localhost:8182/repository/models/5",
   "name":"Model name",
   "key":"Model key",
   "category":"Model category",
   "version":1,
   "metaInfo":"Model metainfo",
   "deploymentId":"2",
   "deploymentUrl":"http://localhost:8182/repository/deployments/2",
   "createTime":"2013-06-12T12:31:19.861+0000",
   "lastUpdateTime":"2013-06-12T12:31:19.861+0000",
   "tenantId":"tenant"
}

删除模型

DELETE repository/models/{modelId}

Table 15.48.删除模型 - URL参数

Table 15.49.删除模型 - 响应码

获得模型的可编译源码

GET repository/models/{modelId}/source

Table 15.50.获得模型的可编译源码 - URL参数

Table 15.51.获得模型的可编译源码 - 响应码

成功响应体： 响应体包含了模型的原始可编译源码。无论源码的内容是什么，响应的content-type都设置为application/octet-stream。

设置模型的可编辑源码

PUT repository/models/{modelId}/source

Table 15.52.设置模型的可编辑源码 - URL参数

请求体： 请求应该是multipart/form-data类型。应该只有一个文件区域，包含源码的二进制内容。

Table 15.53.设置模型的可编辑源码 - 响应码

成功响应体： 响应体包含了模型的原始可编译源码。无论源码的内容是什么，响应的content-type都设置为application/octet-stream。

获得模型的附加可编辑源码

GET repository/models/{modelId}/source-extra

Table 15.54.获得模型的附加可编辑源码 - URL参数

Table 15.55.获得模型的附加可编辑源码 - 响应码

成功响应体： 响应体包含了模型的原始可编译源码。无论附加源码的内容是什么，响应的content-type都设置为application/octet-stream。

设置模型的附加可编辑源码

PUT repository/models/{modelId}/source-extra

Table 15.56.设置模型的附加可编辑源码 - URL参数

请求体： 请求应该是multipart/form-data类型。应该只有一个文件区域，包含源码的二进制内容

Table 15.57.设置模型的附加可编辑源码 - 响应码

成功响应体： 响应体包含了模型的原始可编译源码。无论附加源码的内容是什么，响应的content-type都设置为application/octet-stream。

流程实例

获得流程实例

GET runtime/process-instances/{processInstanceId}

Table 15.58.获得流程实例 - URL参数

Table 15.59.获得流程实例 - 响应码

成功响应体：

{
   "id":"7",
   "url":"http://localhost:8182/runtime/process-instances/7",
   "businessKey":"myBusinessKey",
   "suspended":false,
   "processDefinitionUrl":"http://localhost:8182/repository/process-definitions/processOne%3A1%3A4",
   "activityId":"processTask",
   "tenantId": null
}

删除流程实例

DELETE runtime/process-instances/{processInstanceId}

Table 15.60.删除流程实例 - URL参数

Table 15.61.删除流程实例 - 响应码

激活或挂起流程实例

PUT runtime/process-instances/{processInstanceId}

Table 15.62.激活或挂起流程实例 - URL参数

请求响应体（挂起）：

{
   "action":"suspend"
}

请求响应体（激活）：

{
   "action":"activate"
}

Table 15.63.激活或挂起流程实例 - 响应码

启动流程实例

POST runtime/process-instances

请求体（使用流程定义id启动）：

{
   "processDefinitionId":"oneTaskProcess:1:158",
   "businessKey":"myBusinessKey",
   "variables": [
      {
        "name":"myVar",
        "value":"This is a variable",
      },

      ...
   ]
}

请求体（使用流程定义key启动）：

{
   "processDefinitionKey":"oneTaskProcess",
   "businessKey":"myBusinessKey",
   "tenantId": "tenant1",
   "variables": [
      {
        "name":"myVar",
        "value":"This is a variable",
      },

      ...
   ]
}

请求体（使用message启动）：

{
   "message":"newOrderMessage",
   "businessKey":"myBusinessKey",
   "tenantId": "tenant1",
   "variables": [
      {
        "name":"myVar",
        "value":"This is a variable",
      },

      ...
   ]
}

请求体中只能使用processDefinitionId，processDefinitionKey或message三者之一。参数businessKey，variables和tenantId都是可选的。 可以在REST变量章节了解更多关于变量格式的信息。注意忽略变量作用域，流程变量总是local。

Table 15.64.启动流程实例 - 响应码

成功响应体：

{
   "id":"7",
   "url":"http://localhost:8182/runtime/process-instances/7",
   "businessKey":"myBusinessKey",
   "suspended":false,
   "processDefinitionUrl":"http://localhost:8182/repository/process-definitions/processOne%3A1%3A4",
   "activityId":"processTask",
   "tenantId" : null
}

显示流程实例列表

GET runtime/process-instances

Table 15.65.显示流程实例列表 - URL参数

Table 15.66.显示流程实例列表 - 响应码

成功响应体：

{
   "data":[
      {
         "id":"7",
         "url":"http://localhost:8182/runtime/process-instances/7",
         "businessKey":"myBusinessKey",
         "suspended":false,
         "processDefinitionUrl":"http://localhost:8182/repository/process-definitions/processOne%3A1%3A4",
         "activityId":"processTask",
                 "tenantId" : null
      },

      ...
   ],
   "total":2,
   "start":0,
   "sort":"id",
   "order":"asc",
   "size":2
}

查询流程实例

POST query/process-instances

请求体：

{
  "processDefinitionKey":"oneTaskProcess",
  "variables":
  [
    {
        "name" : "myVariable",
        "value" : 1234,
        "operation" : "equals",
        "type" : "long"
    },
    ...
  ],
  ...
}

请求体可以包含所有用于显示流程实例列表中的查询参数。除此之外，查询条件中也可以使用变量列表，格式在此。

可以使用通用的 分页和排序查询参数。

Table 15.67.查询流程实例 - 响应码

成功响应体：

{
   "data":[
      {
         "id":"7",
         "url":"http://localhost:8182/runtime/process-instances/7",
         "businessKey":"myBusinessKey",
         "suspended":false,
         "processDefinitionUrl":"http://localhost:8182/repository/process-definitions/processOne%3A1%3A4",
         "activityId":"processTask",
                 "tenantId" : null
      },

      ...
   ],
   "total":2,
   "start":0,
   "sort":"id",
   "order":"asc",
   "size":2
}

获得流程实例的流程图

GET runtime/process-instances/{processInstanceId}

Table 15.68.获得流程实例的流程图 - URL参数

Table 15.69.获得流程实例的流程图 - 响应码

成功响应体：

{
   "id":"7",
   "url":"http://localhost:8182/runtime/process-instances/7",
   "businessKey":"myBusinessKey",
   "suspended":false,
   "processDefinitionUrl":"http://localhost:8182/repository/process-definitions/processOne%3A1%3A4",
   "activityId":"processTask"
}

获得流程实例的参与者

GET runtime/process-instances/{processInstanceId}/identitylinks

Table 15.70.获得流程实例的参与者 - URL参数

Table 15.71.获得流程实例的参与者 - 响应码

成功响应体：

[
   {
      "url":"http://localhost:8182/runtime/process-instances/5/identitylinks/users/john/customType",
      "user":"john",
      "group":null,
      "type":"customType"
   },
   {
      "url":"http://localhost:8182/runtime/process-instances/5/identitylinks/users/paul/candidate",
      "user":"paul",
      "group":null,
      "type":"candidate"
   }
]

注意groupId总是null，因为只有用户才能实际参与到流程实例中。

为流程实例添加一个参与者

POST runtime/process-instances/{processInstanceId}/identitylinks

Table 15.72.为流程实例添加一个参与者 - URL参数

请求体：

{
  "userId":"kermit",
  "type":"participant"
}

userId 和 type 都是必填项。

Table 15.73.为流程实例添加一个参与者 - 响应码

成功响应体：

{
   "url":"http://localhost:8182/runtime/process-instances/5/identitylinks/users/john/customType",
   "user":"john",
   "group":null,
   "type":"customType"
}

注意groupId总是null，因为只有用户才能实际参与到流程实例中。

删除一个流程实例的参与者

DELETE runtime/process-instances/{processInstanceId}/identitylinks/users/{userId}/{type}

Table 15.74.删除一个流程实例的参与者 - URL参数

Table 15.75.删除一个流程实例的参与者 - 响应码

成功响应体：

{
   "url":"http://localhost:8182/runtime/process-instances/5/identitylinks/users/john/customType",
   "user":"john",
   "group":null,
   "type":"customType"
}

注意groupId总是null，因为只有用户才能实际参与到流程实例中。

列出流程实例的变量

GET runtime/process-instances/{processInstanceId}/variables

Table 15.76.列出流程实例的变量 - URL参数

Table 15.77.列出流程实例的变量 - 响应码

成功响应体：

[
   {
      "name":"intProcVar",
      "type":"integer",
      "value":123,
      "scope":"local"
   },
   {
      "name":"byteArrayProcVar",
      "type":"binary",
      "value":null,
      "valueUrl":"http://localhost:8182/runtime/process-instances/5/variables/byteArrayProcVar/data",
      "scope":"local"
   },

   ...
]

当变量为二进制或序列化类型时，valueUrl给出了获得原始数据的URL。如果是普通变量，变量值就会直接包含在响应中。 注意只会返回local作用域的变量，因为流程实例变量没有global作用域。

获得流程实例的一个变量

GET runtime/process-instances/{processInstanceId}/variables/{variableName}

Table 15.78.获得流程实例的一个变量 - URL参数

Table 15.79.获得流程实例的一个变量 - 响应码

成功响应体：

   {
      "name":"intProcVar",
      "type":"integer",
      "value":123,
      "scope":"local"
   }

当变量为二进制或序列化类型时，valueUrl给出了获得原始数据的URL。如果是普通变量，变量值就会直接包含在响应中。 注意只会返回local作用域的变量，因为流程实例变量没有global作用域。

创建（或更新）流程实例变量

POST runtime/process-instances/{processInstanceId}/variables

PUT runtime/process-instances/{processInstanceId}/variables

使用POST时，会创建所有传递的变量。如果流程实例中已经存在了其中一个变量，就会返回一个错误（409 - CONFLICT）。使用PUT时， 流程实例中不存在的变量会被创建，已存在的变量会被更新，不会有任何错误。

Table 15.80.创建（或更新）流程实例变量 - URL参数

请求体：

[
   {
      "name":"intProcVar"
      "type":"integer"
      "value":123
   },

   ...
]

请求体的数组中可以包含任意多个变量。关于变量格式的更多信息可以参考REST变量章节。注意此处忽略作用域，流程实例只能设置local作用域。

Table 15.81.创建（或更新）流程实例变量 - 响应码

成功响应体：

[
   {
      "name":"intProcVar",
      "type":"integer",
      "value":123,
      "scope":"local"
   },

   ...

]

更新一个流程实例变量

PUT runtime/process-instances/{processInstanceId}/variables/{variableName}

Table 15.82.更新一个流程实例变量 - URL参数

请求体：

 {
    "name":"intProcVar"
    "type":"integer"
    "value":123
 }

请求体的数组中可以包含任意多个变量。关于变量格式的更多信息可以参考REST变量章节。注意此处忽略作用域，流程实例只能设置local作用域。

Table 15.83.更新一个流程实例变量 - 响应码

成功响应体：

   {
      "name":"intProcVar",
      "type":"integer",
      "value":123,
      "scope":"local"
   }

当变量为二进制或序列化类型时，valueUrl给出了获得原始数据的URL。如果是普通变量，变量值就会直接包含在响应中。 注意只会返回local作用域的变量，因为流程实例变量没有global作用域。

创建一个新的二进制流程变量

POST runtime/process-instances/{processInstanceId}/variables

Table 15.84.创建一个新的二进制流程变量 - URL参数

请求体： 请求应该是multipart/form-data类型。应该只有一个文件区域，包含源码的二进制内容。除此之外，需要提供以下表单域：

• name：必须的变量名称。

• type：创建的变量类型。如果忽略，会假设使用binary，请求的二进制数据会当做二进制数组保存起来。

成功响应体：

{
  "name" : "binaryVariable",
  "scope" : "local",
  "type" : "binary",
  "value" : null,
  "valueUrl" : "http://.../runtime/process-instances/123/variables/binaryVariable/data"
}

Table 15.85.创建一个新的二进制流程变量 - 响应码

更新一个二进制的流程实例变量

PUT runtime/process-instances/{processInstanceId}/variables

Table 15.86.更新一个二进制的流程实例变量 - URL参数

请求体： 请求应该是multipart/form-data类型。应该只有一个文件区域，包含源码的二进制内容。除此之外，需要提供以下表单域：

• name：必须的变量名称。

• type：创建的变量类型。如果忽略，会假设使用binary，请求的二进制数据会当做二进制数组保存起来。

成功响应体：

{
  "name" : "binaryVariable",
  "scope" : "local",
  "type" : "binary",
  "value" : null,
  "valueUrl" : "http://.../runtime/process-instances/123/variables/binaryVariable/data"
}

Table 15.87.更新一个二进制的流程实例变量 - 响应码

分支

获取一个分支

GET runtime/executions/{executionId}

Table 15.88.获取一个分支 - URL参数

Table 15.89.获取一个分支 - 响应码

成功响应体：

{
   "id":"5",
   "url":"http://localhost:8182/runtime/executions/5",
   "parentId":null,
   "parentUrl":null,
   "processInstanceId":"5",
   "processInstanceUrl":"http://localhost:8182/runtime/process-instances/5",
   "suspended":false,
   "activityId":null,
   "tenantId": null
}

对分支执行操作

PUT runtime/executions/{executionId}

Table 15.90.对分支执行操作 - URL参数

请求体（继续执行分支）：

{
  "action":"signal"
}

请求体（分支接收了信号事件）：

{
  "action":"signalEventReceived",
  "signalName":"mySignal"
  "variables": [ ... ]
}

提醒分支接收了一个信号事件，要使用一个signalName参数。还可以传递variables参数，它会在执行操作之前设置到分支中。

请求体（分支接收了消息事件）：

{
  "action":"messageEventReceived",
  "messageName":"myMessage"
  "variables": [ ... ]
}

提醒分支接收了一个消息事件，要使用一个messageName参数。还可以传递variables参数，它会在执行操作之前设置到分支中。

Table 15.91.对分支执行操作 - 响应码

成功响应体（当操作没有导致分支结束的情况）：

{
   "id":"5",
   "url":"http://localhost:8182/runtime/executions/5",
   "parentId":null,
   "parentUrl":null,
   "processInstanceId":"5",
   "processInstanceUrl":"http://localhost:8182/runtime/process-instances/5",
   "suspended":false,
   "activityId":null,
   "tenantId" : null
}

获得一个分支的所有活动节点

GET runtime/executions/{executionId}/activities

返回分支以及子分支当前所有活动的节点（递归所有下级）。

Table 15.92.获得一个分支的所有活动节点 - URL参数

Table 15.93.获得一个分支的所有活动节点 - 响应码

成功响应体：

[
  "userTaskForManager",
  "receiveTask"
]

获取分支列表

GET repository/executions

Table 15.94.获取分支列表 - URL参数

Table 15.95.获取分支列表 - 响应码

成功响应体：

{
   "data":[
      {
         "id":"5",
         "url":"http://localhost:8182/runtime/executions/5",
         "parentId":null,
         "parentUrl":null,
         "processInstanceId":"5",
         "processInstanceUrl":"http://localhost:8182/runtime/process-instances/5",
         "suspended":false,
         "activityId":null,
                 "tenantId":null
      },
      {
         "id":"7",
         "url":"http://localhost:8182/runtime/executions/7",
         "parentId":"5",
         "parentUrl":"http://localhost:8182/runtime/executions/5",
         "processInstanceId":"5",
         "processInstanceUrl":"http://localhost:8182/runtime/process-instances/5",
         "suspended":false,
         "activityId":"processTask",
                 "tenantId":null
      }
   ],
   "total":2,
   "start":0,
   "sort":"processInstanceId",
   "order":"asc",
   "size":2
}

查询分支

POST query/executions

请求体：

{
  "processDefinitionKey":"oneTaskProcess",
  "variables":
  [
    {
        "name" : "myVariable",
        "value" : 1234,
        "operation" : "equals",
        "type" : "long"
    },
    ...
  ],
  "processInstanceVariables":
  [
    {
        "name" : "processVariable",
        "value" : "some string",
        "operation" : "equals",
        "type" : "string"
    },
    ...
  ],
  ...
}

请求体可以包含在获取分支列表中可以使用的查询条件。除此之外，也可以在查询中提供variables和processInstanceVariables列表，关于变量的格式可以参考此处。

可以使用通用的 分页和排序查询参数 。

Table 15.96.查询分支 - 响应码

成功响应体：

{
   "data":[
      {
         "id":"5",
         "url":"http://localhost:8182/runtime/executions/5",
         "parentId":null,
         "parentUrl":null,
         "processInstanceId":"5",
         "processInstanceUrl":"http://localhost:8182/runtime/process-instances/5",
         "suspended":false,
         "activityId":null,
                 "tenantId":null
      },
      {
         "id":"7",
         "url":"http://localhost:8182/runtime/executions/7",
         "parentId":"5",
         "parentUrl":"http://localhost:8182/runtime/executions/5",
         "processInstanceId":"5",
         "processInstanceUrl":"http://localhost:8182/runtime/process-instances/5",
         "suspended":false,
         "activityId":"processTask",
                 "tenantId":null
      }
   ],
   "total":2,
   "start":0,
   "sort":"processInstanceId",
   "order":"asc",
   "size":2
}

获取分支的变量列表

GET runtime/executions/{executionId}/variables?scope={scope}

Table 15.97.获取分支的变量列表 - URL参数

Table 15.98.获取分支的变量列表 - 响应码

成功响应体：

[
   {
      "name":"intProcVar",
      "type":"integer",
      "value":123,
      "scope":"global"
   },
   {
      "name":"byteArrayProcVar",
      "type":"binary",
      "value":null,
      "valueUrl":"http://localhost:8182/runtime/process-instances/5/variables/byteArrayProcVar/data",
      "scope":"local"
   },

   ...
]

当变量为二进制或序列化类型时，valueUrl给出了获得原始数据的URL。如果是普通变量，变量值就会直接包含在响应中。

获得分支的一个变量

GET runtime/executions/{executionId}/variables/{variableName}?scope={scope}

Table 15.99.获得分支的一个变量 - URL参数

Table 15.100.获得分支的一个变量 - 响应码

成功响应体：

   {
      "name":"intProcVar",
      "type":"integer",
      "value":123,
      "scope":"local"
   }

当变量为二进制或序列化类型时，valueUrl给出了获得原始数据的URL。如果是普通变量，变量值就会直接包含在响应中。

新建（或更新）分支变量

POST runtime/executions/{executionId}/variables

PUT runtime/executions/{executionId}/variables

使用POST时，会创建所有传递的变量。如果流程实例中已经存在了其中一个变量，就会返回一个错误（409 - CONFLICT）。使用PUT时， 流程实例中不存在的变量会被创建，已存在的变量会被更新，不会有任何错误。

Table 15.101.新建（或更新）分支变量 - URL参数

请求体：

[
   {
      "name":"intProcVar"
      "type":"integer"
      "value":123,
      "scope":"local"
   },

   ...
]

注意你只能提供作用域相同的变量。如果请求体数组中包含了不同作用域的变量，请求会返回一个错误（400 - BAD REQUEST）。请求体数据中可以传递任意个数的变量。关于变量格式的详细信息可以参考REST变量章节。注意，如果忽略了作用域，只有local作用域的比那两可以设置到流程实例中。

Table 15.102.新建（或更新）分支变量 - 响应码

成功响应体：

[
   {
      "name":"intProcVar",
      "type":"integer",
      "value":123,
      "scope":"local"
   },

   ...

]

更新分支变量

PUT runtime/executions/{executionId}/variables/{variableName}

Table 15.103.更新分支变量 - URL参数

请求体：

 {
    "name":"intProcVar"
    "type":"integer"
    "value":123,
    "scope":"global"
 }

关于变量格式的详细信息可以参考REST变量章节。

Table 15.104.更新分支变量 - 响应码

成功响应体：

   {
      "name":"intProcVar",
      "type":"integer",
      "value":123,
      "scope":"global"
   }

当变量为二进制或序列化类型时，valueUrl给出了获得原始数据的URL。如果是普通变量，变量值就会直接包含在响应中。

创建一个二进制变量

POST runtime/executions/{executionId}/variables

Table 15.105.创建一个二进制变量 - URL参数

请求体： 请求应该是multipart/form-data类型。应该只有一个文件区域，包含源码的二进制内容。除此之外，需要提供以下表单域：

• name：必须的变量名称。

• type：创建的变量类型。如果忽略，会假设使用binary，请求的二进制数据会当做二进制数组保存起来。

成功响应体：

{
  "name" : "binaryVariable",
  "scope" : "local",
  "type" : "binary",
  "value" : null,
  "valueUrl" : "http://.../runtime/executions/123/variables/binaryVariable/data"
}

Table 15.106.创建一个二进制变量 - 响应码

更新已经已存在的二进制分支变量

PUT runtime/executions/{executionId}/variables/{variableName}

Table 15.107.更新已经已存在的二进制分支变量 - URL参数

请求体： 请求应该是multipart/form-data类型。应该只有一个文件区域，包含源码的二进制内容。除此之外，需要提供以下表单域：

• name：必须的变量名称。

• type：创建的变量类型。如果忽略，会假设使用binary，请求的二进制数据会当做二进制数组保存起来。

• scope：创建的变量作用于。如果忽略，假设是local。

成功响应体：

{
  "name" : "binaryVariable",
  "scope" : "local",
  "type" : "binary",
  "value" : null,
  "valueUrl" : "http://.../runtime/executions/123/variables/binaryVariable/data"
}

Table 15.108.更新已经已存在的二进制分支变量 - 响应码

任务

获取任务

GET runtime/tasks/{taskId}

Table 15.109.获取任务 - URL参数

Table 15.110.获取任务 - 响应码

成功响应体：

{
  "assignee" : "kermit",
  "createTime" : "2013-04-17T10:17:43.902+0000",
  "delegationState" : "pending",
  "description" : "Task description",
  "dueDate" : "2013-04-17T10:17:43.902+0000",
  "execution" : "http://localhost:8182/runtime/executions/5",
  "id" : "8",
  "name" : "My task",
  "owner" : "owner",
  "parentTask" : "http://localhost:8182/runtime/tasks/9",
  "priority" : 50,
  "processDefinition" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
  "processInstance" : "http://localhost:8182/runtime/process-instances/5",
  "suspended" : false,
  "taskDefinitionKey" : "theTask",
  "url" : "http://localhost:8182/runtime/tasks/8",
  "tenantId" : null
}

• delegationState：任务的代理状态。可以为null，"pending" 或 "resolved"。

任务列表

GET runtime/tasks

Table 15.111.任务列表 - URL参数

Table 15.112.任务列表 - 响应码

成功响应体：

{
  "data": [
    {
      "assignee" : "kermit",
      "createTime" : "2013-04-17T10:17:43.902+0000",
      "delegationState" : "pending",
      "description" : "Task description",
      "dueDate" : "2013-04-17T10:17:43.902+0000",
      "execution" : "http://localhost:8182/runtime/executions/5",
      "id" : "8",
      "name" : "My task",
      "owner" : "owner",
      "parentTask" : "http://localhost:8182/runtime/tasks/9",
      "priority" : 50,
      "processDefinition" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "processInstance" : "http://localhost:8182/runtime/process-instances/5",
      "suspended" : false,
      "taskDefinitionKey" : "theTask",
      "url" : "http://localhost:8182/runtime/tasks/8",
          "tenantId" : null
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

查询任务

POST query/tasks

请求体：

{
  "name" : "My task",
  "description" : "The task description",

  ...

  "taskVariables" : [
    {
      "name" : "myVariable",
      "value" : 1234,
      "operation" : "equals",
      "type" : "long"
    }
  ],

    "processInstanceVariables" : [
      {
         ...
      }
    ]
  ]
}

此处所有被支持的JSON参数都和获得任务集合完全一样，只是使用JSON体参数的方式替代URL参数，这样就可以使用更加高级的查询方式，并能预防请求uri过长导致的问题。除此之外，可以基于任务和流程变量进行查询。taskVariables 和 processInstanceVariables 都可以包含 此处描述的json数组。

Table 15.113.查询任务 - 响应码

成功响应体：

{
  "data": [
    {
      "assignee" : "kermit",
      "createTime" : "2013-04-17T10:17:43.902+0000",
      "delegationState" : "pending",
      "description" : "Task description",
      "dueDate" : "2013-04-17T10:17:43.902+0000",
      "execution" : "http://localhost:8182/runtime/executions/5",
      "id" : "8",
      "name" : "My task",
      "owner" : "owner",
      "parentTask" : "http://localhost:8182/runtime/tasks/9",
      "priority" : 50,
      "processDefinition" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "processInstance" : "http://localhost:8182/runtime/process-instances/5",
      "suspended" : false,
      "taskDefinitionKey" : "theTask",
      "url" : "http://localhost:8182/runtime/tasks/8",
          "tenantId" : null
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

更新任务

PUT runtime/tasks/{taskId}

请求JSON体：

{
  "assignee" : "assignee",
  "delegationState" : "resolved",
  "description" : "New task description",
  "dueDate" : "2013-04-17T13:06:02.438+02:00",
  "name" : "New task name",
  "owner" : "owner",
  "parentTaskId" : "3",
  "priority" : 20
}

所有请求参数都是可选的。比如，你可以在请求体的JSON对象中只包含'assignee'属性，只更新任务的负责人，其他字段都不填。当包含的字段值为null时，任务的对应属性会被更新为null。比如：{"dueDate" : null}会清空任务的持续时间。

Table 15.114.更新任务 - 响应码

成功响应体： 参考runtime/tasks/{taskId}的响应。

操作任务

POST runtime/tasks/{taskId}

完成任务 - JSON体：

{
  "action" : "complete",
  "variables" : ...
}

完成任务。可以使用variables参数传递可选的variable数组。关于变量格式的详细信息可以参考REST变量章节。注意，此处忽略变量作用域，变量会设置到上级作用域，除非本地作用域应包含了同名变量。这与TaskService.completeTask(taskId, variables) 的行为是相同的。

认领任务 - JSON体：

{
  "action" : "claim",
  "assignee" : "userWhoClaims"
}

根据指定的assignee认领任务。如果assignee为null，任务的执行人会变成空，又可以重新认领了。

代理任务 - JSON体：

{
  "action" : "delegate",
  "assignee" : "userToDelegateTo"
}

指定assignee代理任务。assignee是必填项。

处理任务 - JSON体：

{
  "action" : "resolve"
}

处理任务代理。任务会返回给任务的原负责人（如果存在）。

Table 15.115.操作任务 - 响应码

成功响应体： 参考runtime/tasks/{taskId}的响应。

删除任务

DELETE runtime/tasks/{taskId}?cascadeHistory={cascadeHistory}&deleteReason={deleteReason}

Table 15.116.>删除任务 - URL参数

Table 15.117.>删除任务 - 响应码

获得任务的变量

GET runtime/tasks/{taskId}/variables?scope={scope}

Table 15.118.获得任务的变量 - URL参数

Table 15.119.获得任务的变量 - 响应码

成功响应体：

[
  {
    "name" : "doubleTaskVar",
    "scope" : "local",
    "type" : "double",
    "value" : 99.99
  },
  {
    "name" : "stringProcVar",
    "scope" : "global",
    "type" : "string",
    "value" : "This is a ProcVariable"
  },

  ...

]

返回JSON数组型的变量。对响应的详细介绍可以参考REST变量章节。

获取任务的一个变量

GET runtime/tasks/{taskId}/variables/{variableName}?scope={scope}

Table 15.120.获取任务的一个变量 - URL参数

Table 15.121.获取任务的一个变量 - 响应码

成功响应体：

{
  "name" : "myTaskVariable",
  "scope" : "local",
  "type" : "string",
  "value" : "Hello my friend"
}

对响应的详细介绍可以参考REST变量章节。

获取变量的二进制数据

GET runtime/tasks/{taskId}/variables/{variableName}/data?scope={scope}

Table 15.122.获取变量的二进制数据 - URL参数

Table 15.123.获取变量的二进制数据 - 响应码

成功响应体： 响应体包含了变量的二进制值。当类型为 binary时，无论请求的accept-type头部设置了什么值，响应的content-type都为application/octet-stream。当类型为 serializable时， content-type为application/x-java-serialized-object。

创建任务变量

POST runtime/tasks/{taskId}/variables

Table 15.124.创建任务变量 - URL参数

创建简单（非二进制）变量的请求体：

[
  {
    "name" : "myTaskVariable",
    "scope" : "local",
    "type" : "string",
    "value" : "Hello my friend"
  },
  {
    ...
  }
]

请求体应该是包含一个或多个JSON对象的数组，对应应该创建的变量。

• name：必须的变量名称。

• scope:创建的变量的作用域。如果忽略，假设为local。

• type：创建的变量的类型。如果忽略，转换为对应的JSON的类型 (string, boolean, integer 或 double)。

• value：变量值。

关于变量格式的详细信息可以参考REST变量章节。

成功响应体：

[
  {
    "name" : "myTaskVariable",
    "scope" : "local",
    "type" : "string",
    "value" : "Hello my friend"
  },
  {
    ...
  }
]

Table 15.125.创建任务变量 - 响应码

创建二进制任务变量

POST runtime/tasks/{taskId}/variables

Table 15.126.创建二进制任务变量 - URL参数

请求体： 请求应该是multipart/form-data类型。应该只有一个文件区域，包含源码的二进制内容。除此之外，需要提供以下表单域：

• name：必须的变量名称。

• scope：创建的变量的作用域。如果忽略，假设使用 local。

• type：创建的变量类型。如果忽略，会假设使用binary，请求的二进制数据会当做二进制数组保存起来。

成功响应体：

{
  "name" : "binaryVariable",
  "scope" : "local",
  "type" : "binary",
  "value" : null,
  "valueUrl" : "http://.../runtime/tasks/123/variables/binaryVariable/data"
}

Table 15.127.创建二进制任务变量 - 响应码

更新任务的一个已有变量

PUT runtime/tasks/{taskId}/variables/{variableName}

Table 15.128.更新任务的一个已有变量 - URL参数

更新简单（非二进制）变量的请求体：

{
  "name" : "myTaskVariable",
  "scope" : "local",
  "type" : "string",
  "value" : "Hello my friend"
}

• name：必须的变量名称。

• scope：更新的变量的作用域。如果忽略，假设为local。

• type：更新的变量的类型。如果忽略，转换为对应的JSON的类型 (string, boolean, integer 或 double)。

• value：变量值。

关于变量格式的详细信息可以参考REST变量章节。

成功响应体：

{
  "name" : "myTaskVariable",
  "scope" : "local",
  "type" : "string",
  "value" : "Hello my friend"
}

Table 15.129.更新任务的一个已有变量 - 响应码

更新一个二进制任务变量

PUT runtime/tasks/{taskId}/variables/{variableName}

Table 15.130.更新一个二进制任务变量 - URL参数

请求体： 请求应该是multipart/form-data类型。应该只有一个文件区域，包含源码的二进制内容。除此之外，需要提供以下表单域：

• name：必须的变量名称。

• scope：创建的变量的作用域。如果忽略，假设使用 local。

• type：创建的变量类型。如果忽略，会假设使用binary，请求的二进制数据会当做二进制数组保存起来。

成功响应体：

{
  "name" : "binaryVariable",
  "scope" : "local",
  "type" : "binary",
  "value" : null,
  "valueUrl" : "http://.../runtime/tasks/123/variables/binaryVariable/data"
}

Table 15.131.更新一个二进制任务变量 - 响应码

删除任务变量

DELETE runtime/tasks/{taskId}/variables/{variableName}?scope={scope}

Table 15.132.删除任务变量 - URL参数

Table 15.133.删除任务变量 - 响应码

删除任务的所有局部变量

DELETE runtime/tasks/{taskId}/variables

Table 15.134.删除任务的所有局部变量 - URL参数

Table 15.135.删除任务的所有局部变量 - 响应码

获得任务的所有IdentityLink

GET runtime/tasks/{taskId}/identitylinks

Table 15.136.获得任务的所有IdentityLink - URL参数

Table 15.137.获得任务的所有IdentityLink - 响应码

成功响应体：

[
  {
    "userId" : "kermit",
    "groupId" : null,
    "type" : "candidate",
    "url" : "http://localhost:8081/activiti-rest/service/runtime/tasks/100/identitylinks/users/kermit/candidate"
  },
  {
    "userId" : null,
    "groupId" : "sales",
    "type" : "candidate",
    "url" : "http://localhost:8081/activiti-rest/service/runtime/tasks/100/identitylinks/groups/sales/candidate"
  },

  ...
]

获得一个任务的所有组或用户的IdentityLink

GET runtime/tasks/{taskId}/identitylinks/users
GET runtime/tasks/{taskId}/identitylinks/groups

返回对应于用户或组的IdentityLink。响应体与状态码与获得一个任务的所有IdentityLink完全一样。

获得一个任务的一个IdentityLink

GET runtime/tasks/{taskId}/identitylinks/{family}/{identityId}/{type}

Table 15.138.获得一个任务的所有组或用户的IdentityLink - URL参数

Table 15.139.获得一个任务的所有组或用户的IdentityLink - 响应码

成功响应体：

{
  "userId" : null,
  "groupId" : "sales",
  "type" : "candidate",
  "url" : "http://localhost:8081/activiti-rest/service/runtime/tasks/100/identitylinks/groups/sales/candidate"
}

为任务创建一个IdentityLink

POST runtime/tasks/{taskId}/identitylinks

Table 15.140.为任务创建一个IdentityLink - URL参数

请求体（用户）：

{
  "userId" : "kermit",
  "type" : "candidate",
}

请求体（组）：

{
  "groupId" : "sales",
  "type" : "candidate",
}

Table 15.141.为任务创建一个IdentityLink - 响应码

成功响应体：

{
  "userId" : null,
  "groupId" : "sales",
  "type" : "candidate",
  "url" : "http://localhost:8081/activiti-rest/service/runtime/tasks/100/identitylinks/groups/sales/candidate"
}

删除任务的一个IdentityLink

DELETE runtime/tasks/{taskId}/identitylinks/{family}/{identityId}/{type}

Table 15.142.删除任务的一个IdentityLink - URL参数

Table 15.143.删除任务的一个IdentityLink - 响应码

为任务创建评论

POST runtime/tasks/{taskId}/comments

Table 15.144.为任务创建评论 - URL参数

请求体：

{
  "message" : "This is a comment on the task."
}

成功响应体：

{
  "id" : "123",
  "url" : "http://localhost:8081/activiti-rest/service/runtime/tasks/100/comments/123",
  "message" : "This is a comment on the task.",
  "author" : "kermit"
}

Table 15.145.为任务创建评论 - 响应码

获得任务的所有评论

GET runtime/tasks/{taskId}/comments

Table 15.146.获得任务的所有评论 - URL参数

成功响应体：

[
  {
    "id" : "123",
    "url" : "http://localhost:8081/activiti-rest/service/runtime/tasks/100/comments/123",
    "message" : "This is a comment on the task.",
    "author" : "kermit"
  },
  {
    "id" : "456",
    "url" : "http://localhost:8081/activiti-rest/service/runtime/tasks/100/comments/456",
    "message" : "This is another comment on the task.",
    "author" : "gonzo"
  }
]

Table 15.147.获得任务的所有评论 - 响应码

获得任务的一个评论

GET runtime/tasks/{taskId}/comments/{commentId}

Table 15.148.获得任务的一个评论 - URL参数

成功响应体：

{
  "id" : "123",
  "url" : "http://localhost:8081/activiti-rest/service/runtime/tasks/100/comments/123",
  "message" : "This is a comment on the task.",
  "author" : "kermit"
}

Table 15.149.获得任务的一个评论 - 响应码

删除任务的一条评论

DELETE runtime/tasks/{taskId}/comments/{commentId}

Table 15.150.删除任务的一条评论 - URL参数

Table 15.151.删除任务的一条评论 - 响应码

获得任务的所有事件

GET runtime/tasks/{taskId}/events

Table 15.152.获得任务的所有事件 - URL参数

成功响应体：

[
  {
    "action" : "AddUserLink",
    "id" : "4",
    "message" : [ "gonzo", "contributor" ],
    "taskUrl" : "http://localhost:8182/runtime/tasks/2",
    "time" : "2013-05-17T11:50:50.000+0000",
    "url" : "http://localhost:8182/runtime/tasks/2/events/4",
    "userId" : null
  },

  ...

]

Table 15.153.获得任务的所有事件 - 响应码

获得任务的一个事件

GET runtime/tasks/{taskId}/events/{eventId}

Table 15.154.获得任务的一个事件 - URL参数

成功响应体：

{
  "action" : "AddUserLink",
  "id" : "4",
  "message" : [ "gonzo", "contributor" ],
  "taskUrl" : "http://localhost:8182/runtime/tasks/2",
  "time" : "2013-05-17T11:50:50.000+0000",
  "url" : "http://localhost:8182/runtime/tasks/2/events/4",
  "userId" : null
}

Table 15.155.获得任务的一个事件 - 响应码

为任务创建一个附件，包含外部资源的链接

POST runtime/tasks/{taskId}/attachments

Table 15.156.为任务创建一个附件，包含外部资源的链接 - URL参数

请求体：

{
  "name":"Simple attachment",
  "description":"Simple attachment description",
  "type":"simpleType",
  "externalUrl":"http://activiti.org"
}

创建附件只有name是必填的。

成功响应体：

{
  "id":"3",
  "url":"http://localhost:8182/runtime/tasks/2/attachments/3",
  "name":"Simple attachment",
  "description":"Simple attachment description",
  "type":"simpleType",
  "taskUrl":"http://localhost:8182/runtime/tasks/2",
  "processInstanceUrl":null,
  "externalUrl":"http://activiti.org",
  "contentUrl":null
}

Table 15.157.为任务创建一个附件，包含外部资源的链接 - 响应码

为任务创建一个附件，包含附件文件

POST runtime/tasks/{taskId}/attachments

Table 15.158.为任务创建一个附件，包含附件文件 - URL参数

请求体： 请求应该是multipart/form-data类型。应该只有一个文件区域，包含源码的二进制内容。除此之外，需要提供以下表单域：

• name：必须的变量名称。

• description：附件的描述，可选。

• type：创建的变量类型。如果忽略，会假设使用binary，请求的二进制数据会当做二进制数组保存起来。

成功响应体：

{
      "id":"5",
      "url":"http://localhost:8182/runtime/tasks/2/attachments/5",
      "name":"Binary attachment",
      "description":"Binary attachment description",
      "type":"binaryType",
      "taskUrl":"http://localhost:8182/runtime/tasks/2",
      "processInstanceUrl":null,
      "externalUrl":null,
      "contentUrl":"http://localhost:8182/runtime/tasks/2/attachments/5/content"
   }

Table 15.159.为任务创建一个附件，包含附件文件 - 响应码

获得任务的所有附件

GET runtime/tasks/{taskId}/attachments

Table 15.160.获得任务的所有附件 - URL参数

成功响应体：

[
  {
    "id":"3",
    "url":"http://localhost:8182/runtime/tasks/2/attachments/3",
    "name":"Simple attachment",
    "description":"Simple attachment description",
    "type":"simpleType",
    "taskUrl":"http://localhost:8182/runtime/tasks/2",
    "processInstanceUrl":null,
    "externalUrl":"http://activiti.org",
    "contentUrl":null
  },
  {
    "id":"5",
    "url":"http://localhost:8182/runtime/tasks/2/attachments/5",
    "name":"Binary attachment",
    "description":"Binary attachment description",
    "type":"binaryType",
    "taskUrl":"http://localhost:8182/runtime/tasks/2",
    "processInstanceUrl":null,
    "externalUrl":null,
    "contentUrl":"http://localhost:8182/runtime/tasks/2/attachments/5/content"
  }
]

Table 15.161.获得任务的所有附件 - 响应码

获得任务的一个附件

GET runtime/tasks/{taskId}/attachments/{attachmentId}

Table 15.162.获得任务的一个附件 - URL参数

成功响应体：

  {
    "id":"5",
    "url":"http://localhost:8182/runtime/tasks/2/attachments/5",
    "name":"Binary attachment",
    "description":"Binary attachment description",
    "type":"binaryType",
    "taskUrl":"http://localhost:8182/runtime/tasks/2",
    "processInstanceUrl":null,
    "externalUrl":null,
    "contentUrl":"http://localhost:8182/runtime/tasks/2/attachments/5/content"
  }

• externalUrl - contentUrl：如果附件是一个外部资源链接，externalUrl包含外部内容的URL。如果附件内容保存在Activiti引擎中，contentUrl会包含获取二进制流内容的URL。

• type：可以是任何有效值。包含一个格式合法的media-type时（比如application/xml, text/plain），二进制HTTP响应的content-type会被设置为对应值。

Table 15.163.获得任务的一个附件 - 响应码

获取附件的内容

GET runtime/tasks/{taskId}/attachment/{attachmentId}/content

Table 15.164.获取附件的内容 - URL参数

Table 15.165.获取附件的内容 - 响应码

成功响应体： 响应体包含了二进制内容。默认，响应的content-type设置为application/octet-stream，除非附件类型包含了合法的Content-Type。

删除任务的一个附件

DELETE runtime/tasks/{taskId}/attachments/{attachmentId}

Table 15.166.删除任务的一个附件 - URL参数

Table 15.167.删除任务的一个附件 - 响应码

历史

获得历史流程实例

GET history/historic-process-instances/{processInstanceId}

Table 15.168.获得历史流程实例 - 响应码

成功响应体：

{
  "data": [
    {
      "id" : "5",
      "businessKey" : "myKey",
      "processDefinitionId" : "oneTaskProcess%3A1%3A4",
      "processDefinitionUrl" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "startTime" : "2013-04-17T10:17:43.902+0000",
      "endTime" : "2013-04-18T14:06:32.715+0000",
      "durationInMillis" : 86400056,
      "startUserId" : "kermit",
      "startActivityId" : "startEvent",
      "endActivityId" : "endEvent",
      "deleteReason" : null,
      "superProcessInstanceId" : "3",
      "url" : "http://localhost:8182/history/historic-process-instances/5",
      "variables": null,
          "tenantId":null
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

历史流程实例列表

GET history/historic-process-instances

Table 15.169.历史流程实例列表 - URL参数

Table 15.170.历史流程实例列表 - 响应码

成功响应体：

{
  "data": [
    {
      "id" : "5",
      "businessKey" : "myKey",
      "processDefinitionId" : "oneTaskProcess%3A1%3A4",
      "processDefinitionUrl" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "startTime" : "2013-04-17T10:17:43.902+0000",
      "endTime" : "2013-04-18T14:06:32.715+0000",
      "durationInMillis" : 86400056,
      "startUserId" : "kermit",
      "startActivityId" : "startEvent",
      "endActivityId" : "endEvent",
      "deleteReason" : null,
      "superProcessInstanceId" : "3",
      "url" : "http://localhost:8182/history/historic-process-instances/5",
      "variables": [
        {
          "name": "test",
          "variableScope": "local",
          "value": "myTest"
        }
      ],
          "tenantId":null
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

查询历史流程实例

POST query/historic-process-instances

请求体：

{
  "processDefinitionId" : "oneTaskProcess%3A1%3A4",
  ...

  "variables" : [
    {
      "name" : "myVariable",
      "value" : 1234,
      "operation" : "equals",
      "type" : "long"
    }
  ]
}

所有支持的JSON参数字段和获得历史流程实例集合完全一样，但是传递的是JSON参数，而不是URL参数，这样可以支持更高级的参数，同时避免请求uri过长。除此之外，查询支持基于流程变量查询。 variables属性是一个json数组，包含此处描述的格式。

Table 15.171.查询历史流程实例 - 响应码

成功响应体：

{
  "data": [
    {
      "id" : "5",
      "businessKey" : "myKey",
      "processDefinitionId" : "oneTaskProcess%3A1%3A4",
      "processDefinitionUrl" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "startTime" : "2013-04-17T10:17:43.902+0000",
      "endTime" : "2013-04-18T14:06:32.715+0000",
      "durationInMillis" : 86400056,
      "startUserId" : "kermit",
      "startActivityId" : "startEvent",
      "endActivityId" : "endEvent",
      "deleteReason" : null,
      "superProcessInstanceId" : "3",
      "url" : "http://localhost:8182/history/historic-process-instances/5",
      "variables": [
        {
          "name": "test",
          "variableScope": "local",
          "value": "myTest"
        }
      ],
          "tenantId":null
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

删除历史流程实例

DELETE history/historic-process-instances/{processInstanceId}

Table 15.172.响应码

获取历史流程实例的IdentityLink

GET history/historic-process-instance/{processInstanceId}/identitylinks

Table 15.173.响应码

成功响应体：

[
 {
  "type" : "participant",
  "userId" : "kermit",
  "groupId" : null,
  "taskId" : null,
  "taskUrl" : null,
  "processInstanceId" : "5",
  "processInstanceUrl" : "http://localhost:8182/history/historic-process-instances/5"
 }
]

获取历史流程实例变量的二进制数据

GET history/historic-process-instances/{processInstanceId}/variables/{variableName}/data

Table 15.174.获取历史流程实例变量的二进制数据 - 响应码

成功响应体： 响应体包含了变量的二进制值。当类型为 binary时，无论请求的accept-type头部设置了什么值，响应的content-type都为application/octet-stream。当类型为 serializable时， content-type为application/x-java-serialized-object。

为历史流程实例创建一条新评论

POST history/historic-process-instances/{processInstanceId}/comments

Table 15.175.为历史流程实例创建一条新评论 - URL参数

请求体：

{
  "message" : "This is a comment."
}

成功响应体：

{
  "id" : "123",
  "url" : "http://localhost:8081/activiti-rest/history/historic-process-instances/100/comments/123",
  "message" : "This is a comment.",
  "author" : "kermit"
}

Table 15.176.为历史流程实例创建一条新评论 - 响应码

获得一个历史流程实例的所有评论

GET history/historic-process-instances/{processInstanceId}/comments

Table 15.177.获得流程实例的所有评论 - URL参数

成功响应体：

[
  {
    "id" : "123",
    "url" : "http://localhost:8081/activiti-rest/service/history/historic-process-instances/100/comments/123",
    "message" : "This is a comment",
    "author" : "kermit"
  },
  {
    "id" : "456",
    "url" : "http://localhost:8081/activiti-rest/service/history/historic-process-instances/100/comments/456",
    "message" : "This is a否ther comment.",
    "author" : "gonzo"
  }
]

Table 15.178.获得流程实例的所有评论 - 响应码

获得历史流程实例的一条评论

GET history/historic-process-instances/{processInstanceId}/comments/{commentId}

Table 15.179.获得历史流程的一条评论 - URL参数

成功响应体：

{
  "id" : "123",
  "url" : "http://localhost:8081/activiti-rest/history/historic-process-instances/100/comments/123",
  "message" : "This is a comment.",
  "author" : "kermit"
}

Table 15.180.获得历史流程的一条评论 - 响应码

删除历史流程实例的一条评论

DELETE history/historic-process-instances/{processInstanceId}/comments/{commentId}

Table 15.181.删除历史流程实例的一条评论 - URL参数

Table 15.182.删除历史流程实例的一条评论 - 响应码

获得单独历史任务实例

GET history/historic-task-instances/{taskId}

Table 15.183.获得单独历史任务实例 - 响应码

成功响应体：

{
  "id" : "5",
  "processDefinitionId" : "oneTaskProcess%3A1%3A4",
  "processDefinitionUrl" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
  "processInstanceId" : "3",
  "processInstanceUrl" : "http://localhost:8182/history/historic-process-instances/3",
  "executionId" : "4",
  "name" : "My task name",
  "description" : "My task description",
  "deleteReason" : null,
  "owner" : "kermit",
  "assignee" : "fozzie",
  "startTime" : "2013-04-17T10:17:43.902+0000",
  "endTime" : "2013-04-18T14:06:32.715+0000",
  "durationInMillis" : 86400056,
  "workTimeInMillis" : 234890,
  "claimTime" : "2013-04-18T11:01:54.715+0000",
  "taskDefinitionKey" : "taskKey",
  "formKey" : null,
  "priority" : 50,
  "dueDate" : "2013-04-20T12:11:13.134+0000",
  "parentTaskId" : null,
  "url" : "http://localhost:8182/history/historic-task-instances/5",
  "variables": null,
  "tenantId":null
}

获取历史任务实例

GET history/historic-task-instances

Table 15.184.获取历史任务实例 - URL参数

Table 15.185.获取历史任务实例 - 响应码

成功响应体：

{
  "data": [
    {
      "id" : "5",
      "processDefinitionId" : "oneTaskProcess%3A1%3A4",
      "processDefinitionUrl" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "processInstanceId" : "3",
      "processInstanceUrl" : "http://localhost:8182/history/historic-process-instances/3",
      "executionId" : "4",
      "name" : "My task name",
      "description" : "My task description",
      "deleteReason" : null,
      "owner" : "kermit",
      "assignee" : "fozzie",
      "startTime" : "2013-04-17T10:17:43.902+0000",
      "endTime" : "2013-04-18T14:06:32.715+0000",
      "durationInMillis" : 86400056,
      "workTimeInMillis" : 234890,
      "claimTime" : "2013-04-18T11:01:54.715+0000",
      "taskDefinitionKey" : "taskKey",
      "formKey" : null,
      "priority" : 50,
      "dueDate" : "2013-04-20T12:11:13.134+0000",
      "parentTaskId" : null,
      "url" : "http://localhost:8182/history/historic-task-instances/5",
      "taskVariables": [
        {
          "name": "test",
          "variableScope": "local",
          "value": "myTest"
        }
      ],
      "processVariables": [
        {
          "name": "processTest",
          "variableScope": "global",
          "value": "myProcessTest"
        }
      ],
          "tenantId":null
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

查询历史任务实例

POST query/historic-task-instances

查询历史任务实例 - 请求体：

{
  "processDefinitionId" : "oneTaskProcess%3A1%3A4",
  ...

  "variables" : [
    {
      "name" : "myVariable",
      "value" : 1234,
      "operation" : "equals",
      "type" : "long"
    }
  ]
}

所有支持的JSON参数字段和获得历史任务实例集合完全一样，但是传递的是JSON参数，而不是URL参数，这样可以支持更高级的参数，同时避免请求uri过长。除此之外，查询支持基于流程变量查询。 taskVariables和processVariables属性是一个json数组，包含此处描述的格式。

Table 15.186.查询历史任务实例 - 响应码

成功响应体：

{
  "data": [
    {
      "id" : "5",
      "processDefinitionId" : "oneTaskProcess%3A1%3A4",
      "processDefinitionUrl" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "processInstanceId" : "3",
      "processInstanceUrl" : "http://localhost:8182/history/historic-process-instances/3",
      "executionId" : "4",
      "name" : "My task name",
      "description" : "My task description",
      "deleteReason" : null,
      "owner" : "kermit",
      "assignee" : "fozzie",
      "startTime" : "2013-04-17T10:17:43.902+0000",
      "endTime" : "2013-04-18T14:06:32.715+0000",
      "durationInMillis" : 86400056,
      "workTimeInMillis" : 234890,
      "claimTime" : "2013-04-18T11:01:54.715+0000",
      "taskDefinitionKey" : "taskKey",
      "formKey" : null,
      "priority" : 50,
      "dueDate" : "2013-04-20T12:11:13.134+0000",
      "parentTaskId" : null,
      "url" : "http://localhost:8182/history/historic-task-instances/5",
      "taskVariables": [
        {
          "name": "test",
          "variableScope": "local",
          "value": "myTest"
        }
      ],
      "processVariables": [
        {
          "name": "processTest",
          "variableScope": "global",
          "value": "myProcessTest"
        }
      ]
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

删除历史任务实例

DELETE history/historic-task-instances/{taskId}

Table 15.187.响应码

获得历史任务实例的IdentityLink

GET history/historic-task-instance/{taskId}/identitylinks

Table 15.188.响应码

成功响应体：

[
 {
  "type" : "assignee",
  "userId" : "kermit",
  "groupId" : null,
  "taskId" : "6",
  "taskUrl" : "http://localhost:8182/history/historic-task-instances/5",
  "processInstanceId" : null,
  "processInstanceUrl" : null
 }
]

获取历史任务实例变量的二进制值

GET history/historic-task-instances/{taskId}/variables/{variableName}/data

Table 15.189.获取历史任务实例变量的二进制值 - 响应码

成功响应体： 响应体包含了变量的二进制值。当类型为 binary时，无论请求的accept-type头部设置了什么值，响应的content-type都为application/octet-stream。当类型为 serializable时， content-type为application/x-java-serialized-object。

获取历史活动实例

GET history/historic-activity-instances

Table 15.190.获取历史活动实例 - URL参数

Table 15.191.获取历史活动实例 - 响应码

成功响应体：

{
  "data": [
    {
      "id" : "5",
      "activityId" : "4",
      "activityName" : "My user task",
      "activityType" : "userTask",
      "processDefinitionId" : "oneTaskProcess%3A1%3A4",
      "processDefinitionUrl" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "processInstanceId" : "3",
      "processInstanceUrl" : "http://localhost:8182/history/historic-process-instances/3",
      "executionId" : "4",
      "taskId" : "4",
      "calledProcessInstanceId" : null,
      "assignee" : "fozzie",
      "startTime" : "2013-04-17T10:17:43.902+0000",
      "endTime" : "2013-04-18T14:06:32.715+0000",
      "durationInMillis" : 86400056,
          "tenantId":null
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}

查询历史活动实例

POST query/historic-activity-instances

请求体：

{
  "processDefinitionId" : "oneTaskProcess%3A1%3A4"
}

所有支持的JSON参数字段和获得历史任务实例集合完全一样，但是传递的是JSON参数，而不是URL参数，这样可以支持更高级的参数，同时避免请求uri过长。

Table 15.192.查询历史活动实例 - 响应码

成功响应体：

{
  "data": [
    {
      "id" : "5",
      "activityId" : "4",
      "activityName" : "My user task",
      "activityType" : "userTask",
      "processDefinitionId" : "oneTaskProcess%3A1%3A4",
      "processDefinitionUrl" : "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4",
      "processInstanceId" : "3",
      "processInstanceUrl" : "http://localhost:8182/history/historic-process-instances/3",
      "executionId" : "4",
      "taskId" : "4",
      "calledProcessInstanceId" : null,
      "assignee" : "fozzie",
      "startTime" : "2013-04-17T10:17:43.902+0000",
      "endTime" : "2013-04-18T14:06:32.715+0000",
      "durationInMillis" : 86400056,
          "tenantId":null
    }
  ],
  "total": 1,
  "start": 0,
  "sort": "name",
  "order": "asc",
  "size": 1
}