获取流程实例

说明

调用本接口获取流程实例。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	宜搭流程数据读权限	API Explorer
第三方企业应用	支持	宜搭流程数据读权限	API Explorer
第三方个人应用	暂不支持	宜搭流程数据读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidParameter.methodInputs.invalidFormat	数据格式错误:%s	数据格式错误
400	invalidParameter.number.exceed	数字超过限制:%s	数字超过限制
400	invalidParameter.methodInputs.invalid	入参校验失败:%s	入参校验失败
400	dataNotExist.form.notExists	表单不存在:%s	表单不存在
500	dataModified.form.formAlreadyModified	实例数据已修改, 请刷新当前页面:%s	实例数据已经修改
500	unclassifiedError	异常:%s	通用异常信息

请求参数

Query 参数

pageNumber

string

分页页码。

可选

pageSize

string

分页大小。

可选

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

appType

string

应用ID。

必需

systemToken

string

应用秘钥。

必需

userId

string

必需

用户的userid。

language

string

语言，取值：

可选

formUuid

string

表单ID。

必需

searchFieldJson

string

可选

根据表单内组件值查询。

originatorId

string

可选

根据流程发起人工号查询。

createFromTimeGMT

string

创建时间起始值。

可选

createToTimeGMT

string

创建时间终止值。

可选

modifiedFromTimeGMT

string

修改时间起始值。

可选

modifiedToTimeGMT

string

修改时间终止值。

可选

taskId

string

任务ID。

可选

instanceStatus

string

实例状态。

可选

approvedResult

string

流程审批结果。

可选

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

totalCount

integer

总数量。

可选

pageNumber

integer

当前第几页。

可选

data

array [object {12}]

流程实例。

可选

createTimeGMT

string

创建时间。

可选

processInstanceId

string

流程实例ID。

可选

actionExecutor

array [object {4}]

多个执行人。

可选

approvedResult

string

流程审批结果。

可选

formUuid

string

表单ID。

可选

data

object

数据。

可选

processCode

string

流程编码。

可选

modifiedTimeGMT

string

修改时间。

可选

originator

object

发起人。

可选

title

string

标题。

可选

instanceStatus

string

实例状态。

可选

version

integer

版本。

可选

示例

{
  "totalCount": 0,
  "pageNumber": 0,
  "data": [
    {
      "createTimeGMT": "string",
      "processInstanceId": "string",
      "actionExecutor": [
        {
          "name": {
            "nameInEnglish": "string",
            "type": "string",
            "nameInChinese": "string"
          },
          "deptName": "string",
          "userId": "string",
          "email": "string"
        }
      ],
      "approvedResult": "string",
      "formUuid": "string",
      "data": {},
      "processCode": "string",
      "modifiedTimeGMT": "string",
      "originator": {
        "name": {
          "nameInEnglish": "string",
          "type": "string",
          "nameInChinese": "string"
        },
        "deptName": "string",
        "userId": "string",
        "email": "string"
      },
      "title": "string",
      "instanceStatus": "string",
      "version": 0
    }
  ]
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码