title: myApps.5.0trunk v1.0.0
language_tabs:

shell: Shell
http: HTTP
javascript: JavaScript
ruby: Ruby
python: Python
php: PHP
java: Java
go: Go
toc_footers: []
includes: []
search: true
code_clipboard: true
highlight_theme: darkula
headingLevel: 2
generator: “@tarslib/widdershins v4.0.17”

myApps.5.0trunk

v1.0.0

Base URLs:

myApps运行时/文档（Documents）

GET 获取文档

GET /api/runtime/{applicationId}/documents/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	文档主键

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "value",
    "formid": "value",
    "applicationid": "value",
    "stateid": "value",
    "versions": 1,
    "parentid": "value",
    "authorDeptIndex": "value",
    "stateInt": 0,
    "istmp": false,
    "lastmodified": "value",
    "auditdate": "value",
    "created": "value",
    "authorId": "value",
    "initiator": "value",
    "audituser": "value",
    "lastFlowOperation": 80,
    "stateLabelInfo": "value",
    "auditorList": "value",
    "prevAuditNode": "value",
    "prevAuditUser": "value",
    "sign": "value",
    "items": [
      {
        "name": "value",
        "age": 0,
        "date": "2017-6-23"
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	none
» errmsg	string	true	none	none
» data	object	false	none	none
»» id	string	true	none	none
»» authorDeptIndex	string	false	none	none
»» authorDeptId	string	false	none	none
»» authorUserIndex	string	true	none	none
»» created	integer	true	none	none
»» lastmodified	integer	false	none	none
»» istmp	boolean	true	none	none
»» versions	integer	true	none	none
»» auditorList	string	true	none	none
»» coAuditorList	string	true	none	none
»» stateInt	integer	true	none	none
»» authorId	string	true	none	none
»» stateLabelInfo	string	true	none	none
»» formname	string	true	none	none
»» formid	string	true	none	none
»» edit	boolean	true	none	none
»» delete	boolean	true	none	none
»» editor	boolean	true	none	none
»» relateFlow	boolean	true	none	none

PATCH 局部更新文档

PATCH /api/runtime/{applicationId}/documents/{id}

Body 请求参数

{
  "id": "value",
  "items": [
    {
      "name": "demo"
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	none
body	body	object	否	none
» id	body	string	是	主键，文档对象的唯一标识
» items	body	[object]	是	字段信息，键值对形式（字段名：字段值
»» name	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "保存成功",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

PUT 更新文档（带校验）

PUT /api/runtime/{applicationId}/documents/{id}

Body 请求参数

{
  "id": "value",
  "formid": "value",
  "applicationid": "value",
  "stateid": "value",
  "versions": 0,
  "parentid": "value",
  "sign": "value",
  "items": [
    {
      "name": "demo",
      "age": 18,
      "date": "2017-6-23"
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	文档ID
body	body	object	否	none
» id	body	string	是	主键，文档对象的唯一标识
» formid	body	string	是	动态表单id
» applicationid	body	string	是	软件id
» stateid	body	string	是	流程实例id
» versions	body	integer	是	版本号
» parentid	body	string	是	父文档id
» sign	body	string	是	签名信息
» items	body	[object]	是	字段信息，键值对形式（字段名：字段值
»» name	body	string	否	none
»» age	body	integer	否	none
»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "保存成功",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		状态码对应的信息文本

DELETE 删除文档

DELETE /api/runtime/{applicationId}/documents/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	文档主键

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		状态码对应的信息文本

POST 创建文档

POST /api/runtime/{applicationId}/documents/withoutValid

Body 请求参数

{
  "id": "value",
  "formid": "value",
  "applicationid": "value",
  "stateid": "value",
  "versions": 0,
  "parentid": "value",
  "sign": "value",
  "items": [
    {
      "文档接口": "321321"
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
body	body	object	否	none
» id	body	string	是	主键，文档对象的唯一标识
» formid	body	string	是	动态表单id
» applicationid	body	string	是	软件id
» stateid	body	string	是	流程实例id
» versions	body	integer	是	版本号
» parentid	body	string	是	父文档id
» sign	body	string	是	签名信息
» items	body	[object]	是	字段信息，键值对形式（字段名：字段
»» 文档接口	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "保存成功"
}

返回结果

状态码	状态码含义	说明	数据模型
201	Created	成功	Inline

返回数据结构

状态码 201

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		none
» errmsg	string	true	none		none

POST 创建文档（带校验）

POST /api/runtime/{applicationId}/documents

Body 请求参数

{
  "id": "value",
  "formid": "value",
  "applicationid": "value",
  "stateid": "value",
  "versions": 0,
  "parentid": "value",
  "sign": "value",
  "items": [
    {
      "name": "demo",
      "age": 18,
      "date": "2017-6-23"
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
body	body	object	否	none
» id	body	string	是	主键，文档对象的唯一标识
» formid	body	string	是	动态表单id
» applicationid	body	string	是	软件id
» stateid	body	string	是	流程实例id
» versions	body	integer	是	版本号
» parentid	body	string	是	父文档id
» sign	body	string	是	签名信息
» items	body	[object]	是	字段信息，键值对形式（字段名：字段值
»» name	body	string	否	none
»» age	body	integer	否	none
»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "保存成功",
  "data": {
    "…": null
  }
}

返回结果

状态码	状态码含义	说明	数据模型
201	Created	成功	Inline

返回数据结构

状态码 201

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		状态码对应的信息文本

GET 获取文档集合

GET /api/runtime/{applicationId}/documents

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
parameter	query	string	否	参数名为过滤条件，参数值为过滤内容
_page	query	string	否	当前页码，参数为空时默认第一页
page_lines	query	string	否	每页行数，参数为空时默认最大值
sortCol	query	string	否	排序字段名，可为多个字段名。
orderby	query	string	否	特定排序类型的排序字段
_sortStatus	query	string	否	排序类型（升序asc、降序desc）
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [],
  "page": 1,
  "page_lines": 30,
  "size": 30,
  "row_count": 100
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errmsg	string	true	none		状态码对应的信息文本

DELETE 批量删除文档

DELETE /api/runtime/{applicationId}/documents

Body 请求参数

[
  "ID1",
  "ID2",
  "ID3"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		状态码对应的信息文本

PUT 更新文档

PUT /api/runtime/{applicationId}/documents/{id}/withoutValid

Body 请求参数

{
  "id": "value",
  "viewid": "value",
  "formid": "value",
  "applicationid": "value",
  "stateid": "value",
  "versions": 0,
  "parentid": "value",
  "sign": "value",
  "items": [
    {
      "name": "demo",
      "age": 18,
      "date": "2017-6-23"
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	文档ID
body	body	object	否	none
» id	body	string	是	主键，文档对象的唯一标识
» viewid	body	string	是	none
» formid	body	string	是	动态表单id
» applicationid	body	string	是	软件id
» stateid	body	string	是	流程实例id
» versions	body	integer	是	版本号
» parentid	body	string	是	父文档id
» sign	body	string	是	签名信息
» items	body	[object]	是	字段信息，键值对形式（字段名：字段值
»» name	body	string	否	none
»» age	body	integer	否	none
»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "保存成功",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		状态码对应的信息文本

PUT 更新缓存中子表数据（子表为网格视图时使用）

PUT /api/runtime/{applicationId}/documents/{id}/childs

Body 请求参数

{
  "id": "value",
  "formId": "value",
  "applicationId": "value",
  "stateId": "value",
  "versions": 0,
  "parentId": "value",
  "sign": "value",
  "items": [
    {
      "name": "demo",
      "age": 18,
      "date": "2017-6-23"
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	主表id
body	body	object	否	none
» id	body	string	是	主键，文档对象的唯一标识
» formId	body	string	是	动态表单id
» applicationId	body	string	是	软件id
» stateId	body	string	是	流程实例id
» versions	body	integer	是	流程实例id
» parentId	body	string	是	父文档id
» sign	body	string	是	签名信息
» items	body	[object]	是	字段信息，键值对形式（字段名：字段值
»» name	body	string	否	none
»» age	body	integer	否	none
»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	状态码对应的信息文本
» data	null	false	none	null

DELETE 删除缓存中子表数据（子表为网格视图时使用）

DELETE /api/runtime/{applicationId}/documents/{parentId}/childs/{childId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
parentId	path	string	是	主表id
childId	path	string	是	子表id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	状态码对应的信息文本
» data	null	false	none	null

POST 表单控件的校验

POST /api/runtime/{applicationId}/documents/validate

Body 请求参数

{
  "applicationId": "HdPeBqYwJyFyjHkhZu3",
  "id": "__dpcBPOMmeeFHNYTTkBm",
  "templateForm": "",
  "formId": "f4NDOEOVMi7vrgWjzz4",
  "sign": "",
  "parentId": "",
  "subDocuments": [],
  "items": {
    "备注": ""
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
body	body	object	否	none
» applicationId	body	string	是	软件id
» id	body	string	是	主键，文档对象的唯一标识
» templateForm	body	string	是	none
» formId	body	string	是	动态表单id
» sign	body	string	是	签名信息
» parentId	body	string	是	父文档id
» subDocuments	body	[string]	是	none
» items	body	object	是	字段信息，键值对形式（字段名：字段值）
»» 备注	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "errcode": 4001,
    "errmsg": "表单校验不通过",
    "errors": [
      {
        "errcode": 40001,
        "field": "备注",
        "errmsg": "'备注'必须填写！"
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	状态码对应的信息文本
» data	object	false	none	校验信息
»» errcode	integer	true	none	none
»» errmsg	string	true	none	none
»» errors	[object]	true	none	none
»»» errcode	integer	false	none	none
»»» field	string	false	none	none
»»» errmsg	string	false	none	none

POST 保存金格HTML电子签章

POST /api/runtime/{applicationId}/documents/{docId}/htmlsignature

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
docId	path	string	是	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取金格HTML电子签章

GET /api/runtime/{applicationId}/documents/{docId}/htmlsignature

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
docId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 更新金格HTML电子签章

PUT /api/runtime/{applicationId}/documents/{docId}/htmlsignature

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 批量更新文档(带校验)

POST /api/runtime/{applicationId}/documents/batch

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{
  "id": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» id	string	true	none		none
» data	string	true	none		none

GET 获取表单配置的签章按钮

GET /api/runtime/{applicationId}/documents/{docId}/signatureButtonFields

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
docId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 更新金格pdf电子签章

PUT /api/runtime/{applicationId}/documents/{docId}/pdfsignature

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
flowDocId	query	string	否	流程文档id
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

DELETE 删除金格pdf电子签章信息

DELETE /api/runtime/{applicationId}/documents/{docId}/pdfsignature

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取需要删除的金格pdf电子签章数量统计

GET /api/runtime/{applicationId}/documents/{docId}/deletedpdfsignature

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取PDF签章的相关信息，pdfUrl和按钮

GET /api/runtime/{applicationId}/documents/pdfsignatures

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	query	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 批量金格PDF电子签章

PUT /api/runtime/{applicationId}/documents/pdfsignatures/batch

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取金格pdf电子签章的版本号

GET /api/runtime/{applicationId}/documents/{docId}/pdfsignature/version

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/表单

GET 获取表单模板（已废弃）

GET /api/runtime/{applicationId}/forms/{formId}/documents/{docId}/template

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id
docId	path	string	是	文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "document": {
      "id": "value",
      "formid": "value",
      "applicationid": "value",
      "mappingId": "value",
      "stateid": "value",
      "versions": 1,
      "parentid": "value",
      "authorDeptIndex": "value",
      "stateInt": 0,
      "istmp": false,
      "lastmodified": "value",
      "auditdate": "value",
      "created": "value",
      "authorId": "value",
      "initiator": "value",
      "audituser": "value",
      "lastFlowOperation": 80,
      "stateLabelInfo": "value",
      "auditorList": "value",
      "prevAuditNode": "value",
      "prevAuditUser": "value",
      "sign": "value",
      "items": [
        {
          "name": "value",
          "age": 0,
          "date": "2017-6-23"
        }
      ]
    },
    "activitys": [
      {
        "id": "11e7-4c27-f0b88789-a441-734aa5158162",
        "name": "保存",
        "type": 4
      },
      {
        "id": "11e7-4c27-f0b88789-a441-734aa5158162",
        "name": "提交",
        "type": 8
      }
    ],
    "style": "value",
    "approvers": [
      [
        {
          "instanceId": "11e7-5c9e-f9e93dfc-b2d6-b959e8a4d585",
          "flowName": "测试流程",
          "flowId": "11e6-5fae-abde2740-b3ac-31493634e7af",
          "nodes": [
            {
              "nodeId": "1470911349645",
              "stateLabel": "节点二[标签]",
              "auditors": [
                {
                  "id": "11e6-6ab3-19bfcfc3-bcfe-1f3c25384deb",
                  "name": "happy"
                }
              ]
            }
          ]
        }
      ]
    ],
    "html": "htmlencode后的字符串",
    " formTemplate": {
      "template": "<input type=\"hidden\" id=\"dy_refreshObj\" formid=\"11de-a1ce-12978c3f-a188-7710f5ef0f5e\" docid=\"DQGsf7ngOAez51Jvm9u\" userid=\"11e7-7721-76f875ba-bacd-b744ea587d6a\" mapVal=\"申请单号;申请日期;所属部门;职务;加班类型;开始时间;结束时间;总小时数;加班内容;补偿方式;工资倍数;备注\" /><p style='text-align: right;'>&nbsp;</p><p style='text-align: right;'>申请单号：<o-input data-id=\"DQGsf7ngOAez51Jvm"
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	none
» errmsg	string	false	none	none
» data	object	false	none	none
»» document	object	true	none	none
»»» id	string	true	none	none
»»» formid	string	true	none	none
»»» applicationid	string	true	none	none
»»» mappingId	string	true	none	none
»»» stateid	string	true	none	none
»»» versions	integer	true	none	none
»»» parentid	string	true	none	none
»»» authorDeptIndex	string	true	none	none
»»» stateInt	integer	true	none	none
»»» istmp	boolean	true	none	none
»»» lastmodified	string	true	none	none
»»» auditdate	string	true	none	none
»»» created	string	true	none	none
»»» authorId	string	true	none	none
»»» initiator	string	true	none	none
»»» audituser	string	true	none	none
»»» lastFlowOperation	integer	true	none	none
»»» stateLabelInfo	string	true	none	none
»»» auditorList	string	true	none	none
»»» prevAuditNode	string	true	none	none
»»» prevAuditUser	string	true	none	none
»»» sign	string	true	none	none
»»» items	[object]	true	none	none
»»»» name	string	false	none	none
»»»» age	integer	false	none	none
»»»» date	string	false	none	none
»» activitys	[object]	true	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» type	integer	true	none	none
»» style	string	true	none	none
»» approvers	[array]	true	none	none
»»» instanceId	string	false	none	none
»»» flowName	string	false	none	none
»»» flowId	string	false	none	none
»»» nodes	[object]	false	none	none
»»»» nodeId	string	false	none	none
»»»» stateLabel	string	false	none	none
»»»» auditors	[object]	false	none	none
»»»»» id	string	false	none	none
»»»»» name	string	false	none	none
html	string	true	none	none
formTemplate	object	true	none	none
» template	string	true	none	none

GET 获取表单数据（已废弃）

GET /api/runtime/{applicationId}/forms/{formId}/documents/{docId}/data

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id
docId	path	string	是	文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "补偿方式": {
      "fieldtype": "VALUE_TYPE_VARCHAR",
      "module": "",
      "hiddenValue": "",
      "classname": "cn.myapps.runtime.dynaform.form.ejb.RadioField",
      "discript": "补偿方式(必填)",
      "id": "DQGsf7ngOAez51Jvm9u_补偿方式",
      "formField": "RadioField",
      "displayType": 2,
      "name": "补偿方式",
      "layout": "horizontal",
      "readOnlyShowValOnly": false,
      "value": "",
      "cssClass": "radio-cmd",
      "textType": "text",
      "refreshOnChanged": true,
      "options": [
        {
          "option": "补休假期",
          "value": "补休假期",
          "def": false
        },
        {
          "option": "支付加班工资",
          "value": "支付加班工资",
          "def": false
        }
      ],
      "divId": "11e5-8695-dc466ce2-b072-3b5a9cb7f21b",
      "layoutType": "horizontal"
    },
    "申请日期": {
      "limit": "false",
      "fieldtype": "VALUE_TYPE_DATE",
      "text": "2018-07-05",
      "hiddenValue": "",
      "classname": "cn.myapps.runtime.dynaform.form.ejb.DateField",
      "discript": "",
      "id": "DQGsf7ngOAez51Jvm9u_申请日期",
      "isdatefield": "true",
      "formField": "DateField",
      "displayType": 2,
      "readOnlyShowValOnly": true,
      "name": "申请日期",
      "value": "2018-07-05",
      "dateFormat": "yyyy-MM-dd",
      "cssClass": "Wdate",
      "textType": "readonly",
      "refreshOnChanged": false,
      "divId": "11e3-8a8e-04808f84-b7a0-251e54e1ec3d",
      "layoutType": "horizontal",
      "prev_Name": ""
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	none
» errmsg	string	false	none	none
» data	object	false	none	none
»» 补偿方式	object	true	none	none
»»» fieldtype	string	true	none	none
»»» module	string	true	none	none
»»» hiddenValue	string	true	none	none
»»» classname	string	true	none	none
»»» discript	string	true	none	none
»»» id	string	true	none	none
»»» formField	string	true	none	none
»»» displayType	integer	true	none	none
»»» name	string	true	none	none
»»» layout	string	true	none	none
»»» readOnlyShowValOnly	boolean	true	none	none
»»» value	string	true	none	none
»»» cssClass	string	true	none	none
»»» textType	string	true	none	none
»»» refreshOnChanged	boolean	true	none	none
»»» options	[object]	true	none	none
»»»» option	string	true	none	none
»»»» value	string	true	none	none
»»»» def	boolean	true	none	none
»»» divId	string	true	none	none
»»» layoutType	string	true	none	none
»» 申请日期	object	true	none	none
»»» limit	string	true	none	none
»»» fieldtype	string	true	none	none
»»» text	string	true	none	none
»»» hiddenValue	string	true	none	none
»»» classname	string	true	none	none
»»» discript	string	true	none	none
»»» id	string	true	none	none
»»» isdatefield	string	true	none	none
»»» formField	string	true	none	none
»»» displayType	integer	true	none	none
»»» readOnlyShowValOnly	boolean	true	none	none
»»» name	string	true	none	none
»»» value	string	true	none	none
»»» dateFormat	string	true	none	none
»»» cssClass	string	true	none	none
»»» textType	string	true	none	none
»»» refreshOnChanged	boolean	true	none	none
»»» divId	string	true	none	none
»»» layoutType	string	true	none	none
»»» prev_Name	string	true	none	none

GET 获取打印表单（已废弃）

GET /api/runtime/{applicationId}/forms/{formId}/documents/{docId}/print

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id
docId	path	string	是	文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "style": "value",
    "html": "htmlencode后的字符串"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» style	string	true	none	none
»» html	string	true	none	none

DELETE 删除文件

DELETE /api/runtime/files/delete

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	query	string	否	软件id
formId	query	string	否	表单id
docId	query	string	否	文档id
path	query	string	否	文件保存路径

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "删除成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» data	string	true	none		返回删除上传文件信息

GET 判断表单打开权限(脚本)

GET /api/runtime/{applicationId}/forms/{formId}/documents/{docId}/openable

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id
docId	path	string	是	文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回运算结果，true/false

GET 判断表单打开权限

GET /api/runtime/{applicationId}/forms/{formId}/openable

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回运算结果，true/false

POST 文件上传控件

POST /api/runtime/upload

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	query	string	否	软件id
allowedTypes	query	string	否	允许上传的类型
fieldId	query	string	否	表单字段
fileSaveMode	query	string	否	文件保存模式
path	query	string	否	上传文件保存的路径
actionType	query	string	否	类型

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "fileName": "1223.txt",
      "filePath": "/uploads/item/2017/6665753f-69db-4510-b0b1-69fd5001c24f.txt",
      "fileSize": 213,
      "fileType": ".txt"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回上传文件信息
»» fileName	string	false	none	none
»» filePath	string	false	none	none
»» fileSize	integer	false	none	none
»» fileType	string	false	none	none

POST 校验表单控件值的合法性(已废弃）

POST /api/runtime/{applicationId}/forms/{formid}/documents/{docid}/validateFieldValue

Body 请求参数

{
  "mapping": [
    {
      "asda": "asda123"
    }
  ],
  "document": {
    "id": "value",
    "formid": "value",
    "applicationid": "value",
    "stateid": "value",
    "versions": 0,
    "parentid": "value",
    "sign": "value",
    "items": [
      {
        "name": "demo",
        "age": 18,
        "date": "2017-6-23"
      }
    ]
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formid	path	string	是	表单id
docid	path	string	是	文档id
body	body	object	否	none
» mapping	body	[object]	是	视图选择框映射字段
»» asda	body	string	否	none
» document	body	object	是	none
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "刷新字段"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内
» data	string	false	none	刷新字段的消息

GET 获取空文档

GET /api/runtime/{applicationId}/forms/{formId}/empty

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "document"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	Document对象

POST 文件排序

POST /api/runtime/files/sort

Body 请求参数

{
  "applicationId": "",
  "formId": "",
  "docId": "",
  "itemName": "合同附件",
  "itemValue": "[{\"name\":\"任务 copy.png\",\"path\":\"/uploads/item/2017/66d379b9-88d5-4804-81ce-f766ba82e289.png\"},{\"name\":\"oa copy.png\",\"path\":\"/uploads/item/2017/41a6f08f-e832-4c9c-96ef-1f195b703bcd.png\"}]"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» applicationId	body	string	是	软件id
» formId	body	string	是	表单id
» docId	body	string	是	文档id
» itemName	body	string	是	字段名称
» itemValue	body	string	是	上传文件

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "name": "任务 copy.png",
      "path": "/uploads/item/2017/66d379b9-88d5-4804-81ce-f766ba82e289.png"
    },
    {
      "name": "oa copy.png",
      "path": "/uploads/item/2017/41a6f08f-e832-4c9c-96ef-1f195b703bcd.png"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回排序后上传文件信息
»» name	string	true	none	none
»» path	string	true	none	none

POST 刷新表单

POST /api/runtime/{applicationId}/forms/{formId}/documents/{docId}/refresh

Body 请求参数

{
  "actField": "QxCnJSF0f3MoICbdfcV--iHSd7YQSGee42GzX7iN_全局刷新",
  "tabId": "",
  "document": {
    "applicationId": "sOZu9kthmxyP8qQfq0e",
    "formId": "iHSd7YQSGee42GzX7iN",
    "id": "QxCnJSF0f3MoICbdfcV--iHSd7YQSGee42GzX7iN",
    "items": {
      "全局刷新": "d",
      "局部刷新": "",
      "全局刷新_计数": "1",
      "局部刷新_计数": "1",
      "手机可用": "",
      "手机不可用": "",
      "隐藏条件_false": "不隐藏",
      "隐藏条件_true": "",
      "打印时隐藏条件_false": "打印时不隐藏",
      "打印时隐藏条件_true": "打印时隐藏",
      "只读条件_false": "只读条件为false",
      "只读条件_true": "只读条件为true",
      "只读时仅显示值": "只读时仅显示值"
    },
    "parentId": "",
    "subDocuments": [],
    "versions": "0"
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id
docId	path	string	是	文档id
document	query	string	否	文档
body	body	object	否	none
» actField	body	string	是	none
» tabId	body	string	是	none
» document	body	object	是	none
»» applicationId	body	string	是	none
»» formId	body	string	是	none
»» id	body	string	是	none
»» items	body	object	是	none
»»» 全局刷新	body	string	是	none
»»» 局部刷新	body	string	是	none
»»» 全局刷新_计数	body	string	是	none
»»» 局部刷新_计数	body	string	是	none
»»» 手机可用	body	string	是	none
»»» 手机不可用	body	string	是	none
»»» 隐藏条件_false	body	string	是	none
»»» 隐藏条件_true	body	string	是	none
»»» 打印时隐藏条件_false	body	string	是	none
»»» 打印时隐藏条件_true	body	string	是	none
»»» 只读条件_false	body	string	是	none
»»» 只读条件_true	body	string	是	none
»»» 只读时仅显示值	body	string	是	none
»» parentId	body	string	是	none
»» subDocuments	body	[string]	是	none
»» versions	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "fieldName1": "encode后的html代码段1",
    "fieldName2": "encode后的html代码段2"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回状态发生变更的控件内容
»» fieldName1	string	false	none	none
»» fieldName2	string	false	none	none

GET Word控件-判断是否可编辑

GET /api/runtime/forms/wordfield/edit

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
wordid	query	string	否	Word文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "state": "true",
    "massage": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回word文档当前编辑人的对象信息
»» state	boolean	true	none	none
»» massage	string	false	none	none

PUT Word控件-退出编辑

PUT /api/runtime/forms/wordfield/exixtEdit

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
wordid	query	string	否	Word文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	Null

GET 视图选择框控件-执行确定回调脚本

GET /api/runtime/{applicationId}/forms/{formId}/documents/{docId}/view_dialog_field/FIELDID/callback_script

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id
docId	path	string	是	文档id

返回示例

200 Response

{
  "errcode": 0,
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6

POST 智能搜索提示框-查询

POST /api/runtime/{applicationId}/forms/{formid}/documents/{docid}/querySuggest

Body 请求参数

{
  "parentId": "",
  "formFieldId": "11e7-6791-c7a704f6-bb6a-ff15ffadffa1",
  "keyword": "ahah"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formid	path	string	是	表单id
docid	path	string	是	文档id
body	body	object	否	none
» parentId	body	string	是	父id
» formFieldId	body	string	是	表单字段id
» keyword	body	string	是	查询关键字

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "name": "选择框1",
      "id": "1"
    },
    {
      "name": "选择框2",
      "id": "2"
    },
    {
      "name": "选择框3",
      "id": "3"
    },
    {
      "name": "选择框4",
      "id": "4"
    },
    {
      "name": "选择框5",
      "id": "5"
    },
    {
      "name": "选择框6",
      "id": "6"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回的搜索出的提示信息
»» name	string	true	none	none
»» id	string	true	none	none

GET 判断是否配置预览环境(用于在线预览)

GET /api/runtime/files/preview/environment

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回是否配置了预览环境

GET 获取PDF文件

GET /api/runtime/file/{fileId}/pdf

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	path	string	是	文件id
path	query	string	否	文件路径

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "/uploads/item/2017/123456.pdf"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	none

GET 判断文件是否存在pdf文件

GET /api/runtime/files/hasPdf

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
path	query	string	否	文件路径
fileRealName	query	string	否	文件真实名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回是否存在pdf文件

POST 水印文件打印

POST /api/runtime/{applicationId}/documents/{docId}/files/watermark/print

Body 请求参数

{
  "path": "/uploads/item/2019/ef5bcd5e-909a-445-0cad14a7f0be.doc",
  "fileName": "abc.doc",
  "itemId": "vF6Kep6uOGQg0zEzM6U"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» path	body	string	是	文件路径
» fileName	body	string	是	文件名
» itemId	body	string	是	字段id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "\\uploads\\item\\2019\\swf\\ef-a7f0beWithWaterMark.pdf"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	返回pdf文件路径

GET 获取上传控件水印

GET /api/runtime/{applicationId}/getUploadFieldWaterMark

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
waterMarkSetting	query	string	否	none
docId	query	string	否	none
itemId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 返回水印文件路径

GET /api/runtime/{applicationId}/fileDownloadWithWaterMark

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
filename	query	string	否	none
filepath	query	string	否	none
waterMarkSetting	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/视图

POST 获取视图

POST /api/runtime/{applicationId}/views/{id}/documents

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	视图id
isRelate	query	string	否	isRelate
parentId	query	string	否	父id
startDate	query	string	否	日历视图开始时间
endDate	query	string	否	日历视图结束时间
sortCol	query	string	否	排序列字段
sortStatus	query	string	否	排序状态(升序DESC或降序ASC)
parentParam	query	string	否	折叠视图的上级参数
lines	query	string	否	每页显示数
isQueryButton	query	string	否	是否查询按钮

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "11e7-4c27-fa914816-a441-734aa5158162",
    "name": "测试视图",
    "applicationid": "11e7-473e-7c2149a7-b6ca-1d93db2e7698",
    "openType": 1,
    "pagination": true,
    "pagelines": 10,
    "editMode": "00",
    "showTotalRow": false,
    "relatedForm": "11e7-4c27-e9843316-a441-734aa5158162",
    "refresh": false,
    "readonly": false,
    "viewType": 1,
    "innerType": "FORM",
    "displayType": "relatedForm",
    "showWaterMark": false,
    "showWaterContent": "",
    "style": "",
    "permissionType": "public",
    "activitys": [],
    "columns": []
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回的视图对象，数据结构参考#4.3
»» id	string	false	none	none
»» name	string	false	none	none
»» applicationid	string	false	none	none
»» openType	integer	false	none	none
»» pagination	boolean	false	none	none
»» pagelines	integer	false	none	none
»» editMode	string	false	none	none
»» showTotalRow	boolean	false	none	none
»» relatedForm	string	false	none	none
»» refresh	boolean	false	none	none
»» readonly	boolean	false	none	none
»» viewType	integer	false	none	none
»» innerType	string	false	none	none
»» displayType	string	false	none	none
»» showWaterMark	boolean	false	none	none
»» showWaterContent	string	false	none	none
»» style	string	false	none	none
»» permissionType	string	false	none	none
»» activitys	[string]	false	none	none
»» columns	[string]	false	none	none

GET 获取视图查询表单模板

GET /api/runtime/{applicationId}/views/{id}/searchformtemplate

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	视图id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    " fields": [],
    " document": {},
    " template": ".."
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	返回的视图对象，数据结构参考#4.3
»» fields	[string]	false	none	none
»» document	object	false	none	none
»» template	string	false	none	none

POST 获取视图数据

POST /api/runtime/{applicationId}/views/{viewId}/documents

Body 请求参数

{
  "KEY": "VALUE"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
parentId	query	string	否	父id
sortCol	query	string	否	排序列字段
sortStatus	query	string	否	排序状态(升序DESC或降序ASC)
parentParam	query	string	否	折叠视图的上级参数
isMobile	query	string	否	是否移动端
searchWord	query	string	否	搜索关键字（移动端）
lines	query	string	否	每页显示数
endDate	query	string	否	日历结束开始时间
startDate	query	string	否	日历视图开始时间
body	body	object	否	none
» KEY	body	string	是	none
» content	body	string	是	Document里面的item

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": []
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	视图文档对象的数据列表

POST 获取视图列筛选数据

POST /api/runtime/{applicationId}/views/{id}/filterColumns

Body 请求参数

{
  "KEY": "VALUE"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	视图id
parentId	query	string	否	父级id
isRelate	query	string	否	是否父子关系
fieldName	query	string	否	排筛选字段名称
body	body	object	否	none
» KEY	body	string	是	none
» content	body	string	是	Document里面的item

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    "a",
    "aa"
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回视图列数据

POST 视图列的提交按钮

POST /api/runtime/{applicationId}/views/{viewId}/column/submit

Body 请求参数

{
  "docId": "14e7dwq091134ct9635fG",
  "approveLimit": "abc,abb,bbbc",
  "attitude": "222"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
body	body	object	否	none
» docId	body	string	是	文档id
» approveLimit	body	string	是	节点限制id
» attitude	body	string	是	提交意见

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "成功处理1条,失败0条"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	流程提交成功的消息

POST 执行视图选择框确定回调脚本

POST /api/runtime/views/selectbox/runViewDialogConfirmScript

Body 请求参数

{
  "_selects": "qweqwe",
  "callbackScript": "qweqwe",
  "fieldId": "asdas",
  "document": {
    "id": "12312",
    "formId": "ASDAS",
    "items": {
      "单行文本": "asdas"
    }
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» _selects	body	string	是	none
» callbackScript	body	string	是	none
» fieldId	body	string	是	none
» content	body	string	是	包体
» document	body	object	是	none
»» id	body	string	是	none
»» formId	body	string	是	none
»» items	body	object	是	none
»»» 单行文本	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "asdas"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	运算后得出的结果

POST 获取树形视图数据

POST /api/runtime/{applicationId}/treeviews/{viewId}/documents

Body 请求参数

{
  "KEY": "VALUE"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
parentId	query	string	否	父id（父级的docid）
name	query	string	否	节点名称
body	body	object	否	none
» KEY	body	string	是	none
» content	body	string	是	Document里面的item

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": []
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	视图文档对象的数据列表

GET 树形视图查询

GET /api/runtime/{applicationId}/views/{viewId}/tree/search

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
keyword	query	string	否	查询关键字

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    "#11e7-735a-8b7d3a04-966a-876161d2b77c"
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[string]	false	none	视图id集合

GET 判断视图打开权限

GET /api/runtime/{applicationId}/views/{viewId}/openable

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	false	none	返回运算结果，true/false

PUT 执行视图列操作按钮的脚本

PUT /api/runtime/{applicationId}/views/{viewId}/columns/{columnId}/runActionScript

Body 请求参数

{
  "docId": "asdasdasd",
  "columnName": "asdasdasd"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
columnId	path	string	是	视图列id
body	body	object	否	none
» docId	body	string	是	none
» columnName	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	运算后得出的结果

PUT 执行视图列操作按钮的执行前脚本

PUT /api/runtime/{applicationId}/views/{viewId}/columns/{columnId}/beforescript

Body 请求参数

{
  "docId": "asdasdasd",
  "columnName": "asdasdasd"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
columnId	path	string	是	视图列id
body	body	object	否	none
» docId	body	string	是	none
» columnName	body	string	是	none
» content	body	string	是	参数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	运算后得出的结果

PUT 执行视图列操作按钮的跳转脚本

PUT /api/runtime/{applicationId}/views/{viewId}/columns/{columnId}/runDispatcherUrlScript

Body 请求参数

{
  "docId": "asdasdasd",
  "columnName": "asdasdasd"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
columnId	path	string	是	视图列id
body	body	object	否	none
» docId	body	string	是	none
» columnName	body	string	是	none
» content	body	string	是	包体

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	运算后得出的结果

POST 执行视图列操作按钮的执行后脚本(已废弃)

POST /api/runtime/{applicationId}/views/{viewId}/columns/{columnId}/afterscript

Body 请求参数

{
  "docId": "asdasdasd",
  "columnName": "asdasdasd"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
columnId	path	string	是	视图列id
body	body	object	否	none
» docId	body	string	是	none
» columnName	body	string	是	none
» content	body	string	是	包体

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	运算后得出的结果

POST 网格视图中刷新一行表单数据

POST /api/runtime/{applicationId}/views/{viewid}/documents/{docid}/refresh

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewid	path	string	是	视图id
docid	path	string	是	文档Id
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "refresh": {
    "docid": "14e7dwq091134ct9635fG",
    "viewid": "11e7-66ae-756b2cc9-9cdb-af6bc8266ed2",
    "items": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» refresh	object	false	none	返回序列号
»» docid	string	false	none	none
»» viewid	string	false	none	none
»» items	string	false	none	none

GET 获取视图模板

GET /api/runtime/{applicationId}/views/{id}/template

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	视图id
parentId	query	string	否	父id
isRelate	query	string	否	isrelate

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/工作流

GET 获取流程状态

GET /api/runtime/{applicationId}/workflows/{instanceId}/states

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
instanceId	path	string	是	流程id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "instanceId": "11e7-5c9e-f9e93dfc-b2d6-b959e8a4d585",
    "flowName": "测试流程",
    "flowId": "11e6-5fae-abde2740-b3ac-31493634e7af",
    "nodes": [
      {
        "nodeId": "1470911349645",
        "stateLabel": "节点二[标签]",
        "auditors": [
          {
            "id": "11e6-6ab3-19bfcfc3-bcfe-1f3c25384deb",
            "name": "happy"
          }
        ]
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回文档的流程状态
»» instanceId	string	false	none	none
»» flowName	string	false	none	none
»» flowId	string	false	none	none
»» nodes	[object]	false	none	none
»»» nodeId	string	false	none	none
»»» stateLabel	string	false	none	none
»»» auditors	[object]	false	none	none
»»»» id	string	false	none	none
»»»» name	string	false	none	none

GET 获取文档的流程历史

GET /api/runtime/{applicationId}/documents/{docId}/workflows/flowhistorys

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
content	query	string	否	查询条件

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "startNodeName": "通过组织指定",
      "targetNodeName": "通过角色指定",
      "auditorName": "张强",
      "auditorId": "11e7-5f9a-cc4b2b49-917f-e799edecb417",
      "agentAuditorName": null,
      "attitude": "",
      "signature": "",
      "processtime": 1501608073000,
      "flowOperation": "80",
      "folowStateId": "11e7-76dd-cefc7139-aa03-c5c684d033ca",
      "historyId": "11e7-76dd-d184f0e0-aa03-c5c684d033ca",
      "startNodeId": "1499322276773",
      "targetNodeId": "1499322294264",
      "signatureImageDate": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回文档的流程历史对象的集合
»» startNodeName	string	false	none	none
»» targetNodeName	string	false	none	none
»» auditorName	string	false	none	none
»» auditorId	string	false	none	none
»» agentAuditorName	null	false	none	none
»» attitude	string	false	none	none
»» signature	string	false	none	none
»» processtime	integer	false	none	none
»» flowOperation	string	false	none	none
»» folowStateId	string	false	none	none
»» historyId	string	false	none	none
»» startNodeId	string	false	none	none
»» targetNodeId	string	false	none	none
»» signatureImageDate	string	false	none	none

GET 获取文档的流程图

GET /api/runtime/{applicationId}/documents/{docId}/workflows/{instanceId}/flowchart

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
instanceId	path	string	是	流程实例id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "currentFlowChart": "当前流程图",
    "parentFlowChart": "主流程图"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回文档的流程图对象
»» currentFlowChart	string	false	none	none
»» parentFlowChart	string	false	none	none

GET 获取文档的流程图数据（新流程图，前端渲染）(已废弃）

GET /api/runtime/{applicationId}/documents/{docId}/workflows/{instanceId}/newflowchart

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
instanceId	path	string	是	流程实例id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "flows": {
      "C4CW5DDwwOpwi4n87Pu--__KQK7Ww9WdmdrjFLNF1g-pMQlVUXSkihhIQMuO3X": "财务流程"
    },
    "element": [
      {
        "Type": "cn.myapps.runtime.workflow.element.StartNode",
        "x": 138,
        "y": 147
      },
      {
        "Type": "cn.myapps.runtime.workflow.element.ManualNode",
        "x": 302,
        "y": 172
      },
      {
        "Type": "cn.myapps.runtime.workflow.element.ManualNode",
        "isCurrNode": true,
        "x": 479,
        "y": 186
      },
      {
        "Type": "cn.myapps.runtime.workflow.element.ManualNode",
        "x": 649,
        "y": 230
      },
      {
        "Type": "cn.myapps.runtime.workflow.element.CompleteNode",
        "x": 822,
        "y": 270
      },
      {
        "start_x": 163,
        "Type": "cn.myapps.runtime.workflow.element.Relation",
        "end_x": 377,
        "start_y": 172,
        "end_y": 207
      },
      {
        "start_x": 377,
        "Type": "cn.myapps.runtime.workflow.element.Relation",
        "end_x": 554,
        "start_y": 207,
        "end_y": 221,
        "isRaletion": true
      },
      {
        "start_x": 554,
        "Type": "cn.myapps.runtime.workflow.element.Relation",
        "end_x": 724,
        "start_y": 221,
        "end_y": 265
      },
      {
        "start_x": 724,
        "Type": "cn.myapps.runtime.workflow.element.Relation",
        "end_x": 847,
        "start_y": 265,
        "end_y": 295
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	返回文档的流程图对象
»» flows	object	true	none	none
»»» C4CW5DDwwOpwi4n87Pu–__KQK7Ww9WdmdrjFLNF1g-pMQlVUXSkihhIQMuO3X	string	true	none	none
»» element	[object]	true	none	none
»»» Type	string	true	none	none
»»» x	integer	true	none	none
»»» y	integer	true	none	none
»»» isCurrNode	boolean	false	none	none
»»» start_x	integer	true	none	none
»»» end_x	integer	true	none	none
»»» start_y	integer	true	none	none
»»» end_y	integer	true	none	none
»»» isRaletion	boolean	false	none	none

GET 获取文档的流程催办历史

GET /api/runtime/{applicationId}/documents/{docId}/workflows/remind-historys

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-6f8f-98272c56-966a-876161d2b77c",
      "content": "aaaa",
      "userId": "11e7-5f9a-210f9112-917f-e799edecb417",
      "userName": "李玲",
      "nodeName": "审批人",
      "docId": "11e7-6947-93c5aeca-8a83-bf38d96990bd",
      "flowInstanceId": "11e7-6947-96178e0f-8a83-bf38d96990bd",
      "processTime": 1500804818000
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	流程提交面板信息
»» id	string	false	none	节点id
»» content	string	false	none	none
»» userId	string	false	none	none
»» userName	string	false	none	none
»» nodeName	string	false	none	none
»» docId	string	false	none	none
»» flowInstanceId	string	false	none	none
»» processTime	integer	false	none	none

POST 获取文档的流程发起面板

POST /api/runtime/{applicationId}/documents/{docid}/panels/initiate

Body 请求参数

{
  "id": "",
  "document": {}
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docid	path	string	是	文档id
body	body	object	否	none
» id	body	string	是	none
» document	body	object	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "1470911349645",
      "name": "请假流程1",
      "firstNodeList": [
        {
          "id": "id1",
          "name": "name1"
        },
        {
          "id": "id2",
          "name": "name2"
        }
      ]
    },
    {
      "id": "1470911349645",
      "name": "请假流程2",
      "firstNodeList": [
        {
          "id": "id3",
          "name": "name3"
        },
        {
          "id": "id4",
          "name": "name4"
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回流程发起面板信息
»» id	string	true	none	流程id
»» name	string	false	none	流程名称
»» firstNodeList	[object]	true	none	开始节点列表
»»» id	string	true	none	none
»»» name	string	true	none	none

POST 获取文档的流程回退面板

POST /api/runtime/{applicationId}/documents/{docId}/panels/back

{
document: {
“id”: “value”,
“formid”: “value”,
“applicationid”: “value”,
“stateid”: “value”,
“versions”: 0,
“parentid”: “value”,
“sign”: “value”,
“items”: [
{
“name”: “demo”,
“age”: 18,
“date”: “2017-6-23”
}
]
}
}

Body 请求参数

{
  "id": "",
  "document": {}
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» id	body	string	是	none
» document	body	object	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "currentNodeId": "1470911344557",
    "isSplit": false,
    "splitToken": "",
    "nextNodes": [
      {
        "id": "1470911349645",
        "name": "节点二",
        "type": "ManualNode"
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	返回流程回退面板信息
»» currentNodeId	string	true	none	none
»» isSplit	boolean	true	none	none
»» splitToken	string	true	none	none
»» nextNodes	[object]	true	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» type	string	false	none	none

POST 获取文档的流程提交面板

POST /api/runtime/{applicationId}/documents/{docId}/panels/submission

{
"document":{
        "id": "value",
        "formid": "value",
        "applicationid": "value",
        "stateid": "value",
        "versions": 0,
        "parentid": "value",
        "sign": "value",
        "items": [
            {
                "name": "demo",
                "age": 18,
                "date": "2017-6-23"
            }
        ]
    }
}

Body 请求参数

{
  "document": {
    "applicationId": "sOZu9kthmxyP8qQfq0e",
    "formId": "__YHiGZwn3wPaiCgcb4fP",
    "id": "K2u8ExAz54rbE50VU0F--__YHiGZwn3wPaiCgcb4fP",
    "items": [
      {
        "备注": "11",
        "开始时间": "2022-08-03 00:00",
        "结束时间": "2022-08-04 00:00",
        "请假天数": "1"
      }
    ]
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» document	body	object	是	none
»» applicationId	body	string	是	none
»» formId	body	string	是	none
»» id	body	string	是	none
»» items	body	[object]	是	none
»»» 备注	body	string	否	none
»»» 开始时间	body	string	否	none
»»» 结束时间	body	string	否	none
»»» 请假天数	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "currentNodeId": "1470911344557",
    "flowId": "11e7-6622-7ab2d220-9cdb-af6bc8266ed2",
    "isSplit": false,
    "splitToken": "",
    "nextNodes": [
      {
        "id": "1470911349645",
        "name": "节点二",
        "type": "ManualNode",
        "isToPerson": false,
        "isAppentCirculator": false,
        "checked": true,
        "locked": false
      },
      {
        "id": "1470911349645",
        "name": "子流程节点",
        "type": "SubNode",
        "isToPerson": false,
        "isAppentCirculator": false,
        "checked": true,
        "locked": false,
        "instanceSettingType": "01",
        "instanceTotal": 1
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	流程提交面板信息
»» currentNodeId	string	true	none	当前节点id
»» flowId	string	true	none	none
»» isSplit	boolean	true	none	当前节点是否为分散节点
»» splitToken	string	true	none	分散节点token信息（非分散节点值为空）
»» nextNodes	[object]	true	none	下一步节点的集合
»»» id	string	true	none	节点id
»»» name	string	true	none	节点名称
»»» type	string	true	none	节点类型（ManualNode、AutoNode、SubNode）
»»» isToPerson	boolean	false	none	是否指定审批人
»»» isAppentCirculator	boolean	false	none	是否抄送
»»» checked	boolean	true	none	是否默认选中
»»» locked	boolean	true	none	是否锁定节点选中状态（锁定时不能取消选中）
»»» instanceSettingType	string	false	none	none
»»» instanceTotal	integer	false	none	none

PUT 终止流程

PUT /api/runtime/{applicationId}/documents/{docId}/workflows/termination

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
attitude	query	string	否	none
signature	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "终止成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	终止流程返回的信息

POST 发起流程

POST /api/runtime/{applicationId}/documents/{docid}/workflows/initiate

Body 请求参数

"{\r\n    \"actid\":\"14e7dwq091134ct9635fG\",\r\n    \"flowId\":\"14e7dwq091134ct9635fG\",\r\n    \"nextId\":\"14e7dwq091134ct9635fG\",\r\n    \"flowType\":\"1\",\r\n    \"document\":{\r\n        \"id\": \"value\",\r\n        \"formid\": \"value\",\r\n        \"applicationid\": \"value\",\r\n        \"stateid\": \"value\",\r\n        \"versions\": 0,\r\n        \"parentid\": \"value\",\r\n        …//其他系统字段\r\n        \"sign\": \"value\",\r\n        \"items\": [\r\n            {\r\n                \"name\": \"demo\",\r\n                \"age\": 18,\r\n                \"date\": \"2017-6-23\"\r\n            }\r\n        ]\r\n    }\r\n}   "

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docid	path	string	是	文档id
body	body	object	否	none
» actid	body	string	是	流程发起的按钮id
» flowId	body	string	是	流程定义id
» nextId	body	string	是	none
» flowType	body	string	是	流程处理动作代码（1）
» document	body	object	是	文档对象，数据结构参考#2.8
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "启动成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	发起流程的成功消息

PUT 回退流程

PUT /api/runtime/{applicationId}/documents/{docId}/workflows/back

Body 请求参数

{
  "flowId": "14e7dwq091134ct9635fG",
  "flowType": "81",
  "currentNodeId": "1470911349635",
  "nextNodeIds": [
    "1470911349645"
  ],
  "attitude": "",
  "signature": "",
  "document": {
    "id": "value",
    "formid": "value",
    "applicationid": "value",
    "stateid": "value",
    "versions": 0,
    "parentid": "value",
    "sign": "value",
    "items": [
      {
        "name": "demo",
        "age": 18,
        "date": "2017-6-23"
      }
    ]
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» flowId	body	string	是	流程定义id
» flowType	body	string	是	流程处理动作代码(81)
» currentNodeId	body	string	是	当前节点id
» nextNodeIds	body	[string]	是	下一步节点id集合
» attitude	body	string	是	提交备注
» signature	body	string	是	手写签名
» document	body	object	是	文档对象，数据结构参考#2.8
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "回退成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	流程回退成功的消息

PUT 恢复流程

PUT /api/runtime/{applicationId}/documents/{docId}/workflows/recovery

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "恢复成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	流程恢复成功的消息

POST 自由流程发起

POST /api/runtime/{applicationId}/documents/{docid}/freeflows/initiate

Body 请求参数

"{\r\n    \"flowType\": \"1\",\r\n    \"nextUserId\": \"sf34sdsfKJg342\",\r\n    \"attitude\": \"提交备注\",\r\n    \"document\": {\r\n        \"id\": \"value\",\r\n        \"formid\": \"value\",\r\n        \"applicationid\": \"value\",\r\n        \"stateid\": \"value\",\r\n        \"versions\": 0,\r\n        \"parentid\": \"value\",\r\n        … //其他系统字段\r\n        \"sign\": \"value\",\r\n        \"items\": [\r\n            {\r\n                \"name\": \"demo\",\r\n                \"age\": 18,\r\n                \"date\": \"2017-6-23\"\r\n            }\r\n        ]\r\n    }\r\n}"

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docid	path	string	是	文档id
body	body	object	否	none
» flowType	body	string	是	提交动作代码
» nextUserId	body	string	是	下一步处理人id
» attitude	body	string	是	提交备注
» document	body	object	是	文档对象，数据结构参考#2.8
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "自由流程发起成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	自由流程发起返回的信息

PUT 撤回流程

PUT /api/runtime/{applicationId}/documents/{docId}/workflows/retracement

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "撤回成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	流程撤回成功的消息

PUT 挂起流程

PUT /api/runtime/{applicationId}/documents/{docid}/workflows/suspend

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docid	path	string	是	文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "挂起成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	流程挂起成功的消息

PUT 流程催办

PUT /api/runtime/{applicationId}/documents/{docId}/workflows/remind

Body 请求参数

{
  "reminderContent": "zz",
  "nodertIds": [
    "1470911349645",
    "1470911349644"
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» reminderContent	body	string	是	节点id集合
» nodertIds	body	[string]	是	文档对象，数据结构参考#2.8

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "催办成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	流程催办成功的消息

PUT 提交流程

PUT /api/runtime/{applicationId}/documents/{docId}/workflows/submit

Body 请求参数

{
  "flowId": "14e7dwq091134ct9635fG",
  "flowType": "80",
  "currentNodeId": "1470911349635",
  "nextNodeIds": [
    "1470911349645",
    "1470911349644"
  ],
  "attitude": "",
  "signature": "",
  "submitTo": "",
  "circulatorInfo": "",
  "subFlowApproverInfo": "",
  "subFlowApproverInfoAll": "",
  "document": {
    "id": "value",
    "formid": "value",
    "applicationid": "value",
    "stateid": "value",
    "versions": 0,
    "parentid": "value",
    "sign": "value",
    "items": [
      {
        "name": "demo",
        "age": 18,
        "date": "2017-6-23"
      }
    ]
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» flowId	body	string	是	流程定义id
» flowType	body	string	是	流程处理动作代码（80）
» currentNodeId	body	string	是	当前节点id
» nextNodeIds	body	[string]	是	下一步节点id集合
» attitude	body	string	是	提交备注
» signature	body	string	是	手写签名
» submitTo	body	string	是	指定审批人
» circulatorInfo	body	string	是	指定抄送人
» subFlowApproverInfo	body	string	是	指定子流程审批人
» subFlowApproverInfoAll	body	string	是	指定所有子流程节点审批人
» document	body	object	是	文档对象，数据结构参考#2.8
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "提交成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	流程提交成功的消息

PUT 自由流程结束

PUT /api/runtime/{applicationId}/documents/{docId}/freeflows/complete

Body 请求参数

{
  "flowType": "7",
  "attitude": "",
  "document": {
    "id": "value",
    "formid": "value",
    "applicationid": "value",
    "stateid": "value",
    "versions": 0,
    "parentid": "value",
    "sign": "value",
    "items": [
      {
        "name": "demo",
        "age": 18,
        "date": "2017-6-23"
      }
    ]
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» flowType	body	string	是	提交动作代码（7）
» attitude	body	string	是	提交备注
» document	body	object	是	文档对象，数据结构参考#2.8
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "自由流程结束成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	自由流程结束返回的信息

PUT 自由流程回退

PUT /api/runtime/{applicationId}/documents/{docId}/freeflows/back

Body 请求参数

{
  "applicationId": "sOZu9kthmxyP8qQfq0e",
  "docId": "Tau6y0XNGywfkKw0oHu--wD2JpspXZRpletfE6p6",
  "document": {
    "applicationId": "sOZu9kthmxyP8qQfq0e",
    "formId": "wD2JpspXZRpletfE6p6",
    "id": "Tau6y0XNGywfkKw0oHu--wD2JpspXZRpletfE6p6",
    "items": {
      "开始时间": "2022-08-16 15:57",
      "结束时间": "2022-08-16 15:57",
      "请假天数": "0",
      "备注": "aa"
    },
    "parentId": "",
    "subDocuments": [],
    "versions": "0",
    "stateId": "Tau6y0XNGywfkKw0oHu--wD2JpspXZRpletfE6p6-ygZq33nfCeMHIL8hnMA"
  },
  "formId": "wD2JpspXZRpletfE6p6",
  "id": "Tau6y0XNGywfkKw0oHu--wD2JpspXZRpletfE6p6",
  "nextUserId": "__oP0irhWXGA2oZRusW1d",
  "parentId": "",
  "templateForm": "",
  "viewId": "",
  "attitude": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» flowType	body	string	是	提交动作代码（81）
» nextUserId	body	string	是	下一步处理人id
» attitude	body	string	是	提交备注
» document	body	object	是	文档对象，数据结构参考#2.8
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "自由流程回退成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	自由流程回退返回的信息

PUT 自由流程提交

PUT /api/runtime/{applicationId}/documents/{docId}/freeflows/submit

Body 请求参数

{
  "applicationId": "sOZu9kthmxyP8qQfq0e",
  "docId": "fg72qVrFckvKoGMq3hd--wD2JpspXZRpletfE6p6",
  "document": {
    "applicationId": "sOZu9kthmxyP8qQfq0e",
    "formId": "wD2JpspXZRpletfE6p6",
    "id": "fg72qVrFckvKoGMq3hd--wD2JpspXZRpletfE6p6",
    "items": {
      "开始时间": "2022-08-09 00:00",
      "结束时间": "2022-08-16 15:45",
      "请假天数": "7",
      "备注": "ss"
    },
    "parentId": "",
    "subDocuments": [],
    "versions": "0",
    "exparams": {}
  },
  "formId": "wD2JpspXZRpletfE6p6",
  "id": "fg72qVrFckvKoGMq3hd--wD2JpspXZRpletfE6p6",
  "parentId": "",
  "templateForm": "",
  "viewId": "",
  "attitude": "",
  "subFlowApprover": [],
  "submitTo": [],
  "nextNodeIds": [],
  "nextUserId": "__y2nHhGskY9FQ6LYny8s"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» flowType	body	string	是	提交动作代码（80）
» nextUserId	body	string	是	下一步处理人id
» attitude	body	string	是	提交备注
» document	body	object	是	文档对象，数据结构参考#2.8
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "自由流程提交成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» data	string	false	none		自由流程提交返回的信息

PUT 更新流程节点审批人

PUT /api/runtime/{applicationId}/documents/{docId}/workflows/approvers

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "修改成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	编辑审批人成功返回的信息

GET 获取流程指定审批人用户选择框列表

GET /api/runtime/{applicationId}/documents/{docId}/workflows/{flowId}/selectApprovers

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
flowId	path	string	是	流程id
nodeId	query	string	是	节点id
type	query	string	是	类型
selectId	query	string	否	悬着id
pageNum	query	string	否	当前页
pageSize	query	string	否	每页显示数据数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "id": "11e4-63ff-5d9df2ad-9f19-57d7b83ae7be",
        "name": "admin",
        "type": 1,
        "mobile": "",
        "mobile2": null,
        "email": "",
        "avatar": "",
        "dept": "产品部",
        "deptId": "11e8-46a9-a3c6c4f2-94a7-9b60038597d7",
        "loginNo": "admin1",
        "domainId": "11e1-81e2-37f74759-9124-47aada6b7467",
        "pcmEnable": true,
        "domainAdmin": false
      }
    ],
    "pageCount": 1,
    "rowCount": 2,
    "pageNum": 1,
    "linesPerPage": 5
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	审批人用户列表
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» type	integer	false	none	none
»»» mobile	null	false	none	none
»»» mobile2	null	false	none	none
»»» email	null	false	none	none
»»» avatar	string	false	none	none
»»» dept	string	false	none	none
»»» deptId	string	false	none	none
»»» loginNo	string	false	none	none
»»» domainId	string	false	none	none
»»» pcmEnable	boolean	false	none	none
»»» domainAdmin	boolean	false	none	none
»» pageCount	integer	true	none	none
»» rowCount	integer	true	none	none
»» pageNum	integer	true	none	none
»» linesPerPage	integer	true	none	none

GET 自由流程模式回退获取历史处理人

GET /api/runtime/{applicationId}/workflows/{instanceId}/hisActorsFreeFlow

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
instanceId	path	string	是	流程实例id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e4-63ff-5d9df2ad-9f19-57d7b83ae7be",
      "name": "admin",
      "type": 1,
      "mobile": "",
      "mobile2": null,
      "email": "",
      "avatar": "",
      "dept": "产品部",
      "deptId": "11e8-46a9-a3c6c4f2-94a7-9b60038597d7",
      "loginNo": "admin1",
      "domainId": "11e1-81e2-37f74759-9124-47aada6b7467",
      "pcmEnable": true,
      "domainAdmin": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	可回退的用户列表
»» id	string	false	none	none
»» name	string	false	none	none
»» type	integer	false	none	none
»» mobile	null	false	none	none
»» mobile2	null	false	none	none
»» email	null	false	none	none
»» avatar	string	false	none	none
»» dept	string	false	none	none
»» deptId	string	false	none	none
»» loginNo	string	false	none	none
»» domainId	string	false	none	none
»» pcmEnable	boolean	false	none	none
»» domainAdmin	boolean	false	none	none

GET 获取流程指定抄送人用户选择框列表

GET /api/runtime/{applicationId}/documents/{docId}/workflows/{flowId}/selectCirculators

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
flowId	path	string	是	流程id
nodeId	query	string	是	节点id
type	query	string	是	类型（3:查询;2:角色;1:部门;）
selectId	query	string	否	点击角色或者部门时选中id
pageNum	query	string	否	当前页
pageSize	query	string	否	每页显示数据条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "id": "11e4-63ff-5d9df2ad-9f19-57d7b83ae7be",
        "name": "admin",
        "type": 1,
        "mobile": "",
        "mobile2": null,
        "email": "",
        "avatar": "",
        "dept": "产品部",
        "deptId": "11e8-46a9-a3c6c4f2-94a7-9b60038597d7",
        "loginNo": "admin1",
        "domainId": "11e1-81e2-37f74759-9124-47aada6b7467",
        "pcmEnable": true,
        "domainAdmin": false
      }
    ],
    "pageCount": 1,
    "rowCount": 2,
    "pageNum": 1,
    "linesPerPage": 5
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	审批人用户列表
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» type	integer	false	none	none
»»» mobile2	null	false	none	none
»»» email	null	false	none	none
»»» avatar	string	false	none	none
»»» dept	string	false	none	none
»»» deptId	string	false	none	none
»»» loginNo	string	false	none	none
»»» domainId	string	false	none	none
»»» pcmEnable	boolean	false	none	none
»»» domainAdmin	boolean	false	none	none
»» pageCount	integer	true	none	none
»» rowCount	integer	true	none	none
»» pageNum	integer	true	none	none
»» linesPerPage	integer	true	none	none

PUT 添加/补签意见

PUT /api/runtime/{applicationId}/workflows/{instanceId}/supplement

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
instanceId	path	string	是	流程实例id
comments	query	string	否	补签意见

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	补签成功信息

PUT 流程协办

PUT /api/runtime/{applicationId}/workflows/{instanceId}/assist

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
instanceId	path	string	是	流程实例id
attitude	query	string	否	补签意见

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	none
» errmsg	string	true	none	none
» data	string	false	none	none

PUT 流程协办加签

PUT /api/runtime/{applicationId}/documents/{docId}/workflows/assist/addition

Body 请求参数

[
  "id1",
  "id2",
  "id3"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	加签成功信息

PUT 流程主办加签

PUT /api/runtime/{applicationId}/documents/{docId}/workflows/approver/addition

Body 请求参数

[
  "id1",
  "id2",
  "id3"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	加签成功信息

PUT 回退流程历史节点指定历史用户

PUT /api/runtime/{applicationId}/documents/{docid}/workflows/jump

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docid	path	string	是	文档id
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取文档的流程跳转面板

POST /api/runtime/{applicationId}/documents/{docId}/panels/jump

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
docId	path	string	是	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 流程仪表查询

POST /api/runtime/{applicationId}/Consuming

Body 请求参数

{
  "select": "Status",
  "startdate": "startDate",
  "enddate": "endDate",
  "application": "applicationid",
  "showMode": "ShowMode",
  "dateRange": "DateRange"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
body	body	object	否	none
» select	body	string	是	none
» startdate	body	string	是	none
» enddate	body	string	是	none
» application	body	string	是	none
» showMode	body	string	是	none
» dateRange	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "echart": {
        "number": "2",
        "consuming": [
          "0.00",
          "0.00"
        ],
        "yAxis": [
          "0.00",
          "0.00"
        ],
        "xAxis": [
          "发文_并行选中",
          "并行聚合自动节点"
        ],
        "num": [
          2,
          5
        ]
      },
      "table": [
        {
          "core": "1",
          "consuming": "0.00",
          "number": "2",
          "consumingday": "0.00",
          "flowname": "发文_并行选中",
          "statelabel": "未完成"
        },
        {
          "core": "2",
          "consuming": "0.00",
          "number": "5",
          "consumingday": "0.00",
          "flowname": "并行聚合自动节点",
          "statelabel": "未完成"
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	流程仪表数据
»» echart	object	false	none	none
»»» number	string	true	none	none
»»» consuming	[string]	true	none	none
»»» yAxis	[string]	true	none	none
»»» xAxis	[string]	true	none	none
»»» num	[integer]	true	none	none
»» table	[object]	false	none	none
»»» core	string	true	none	none
»»» consuming	string	true	none	none
»»» number	string	true	none	none
»»» consumingday	string	true	none	none
»»» flowname	string	true	none	none
»»» statelabel	string	true	none	none

POST 流程走向（已废弃）

POST /api/runtime/{applicationId}/documents/{docId}/trail

Body 请求参数

{
  "applicationId": "sOZu9kthmxyP8qQfq0e",
  "formId": "__4UsYWRflfvwOxmCIbQQ",
  "id": "beAoevua9iHocnZcvgk--__4UsYWRflfvwOxmCIbQQ",
  "parentId": "",
  "sign": "",
  "subDocuments": [],
  "versions": "0",
  "docId": "beAoevua9iHocnZcvgk--__4UsYWRflfvwOxmCIbQQ",
  "document": {
    "applicationId": "sOZu9kthmxyP8qQfq0e",
    "formId": "__4UsYWRflfvwOxmCIbQQ",
    "id": "beAoevua9iHocnZcvgk--__4UsYWRflfvwOxmCIbQQ",
    "items": {
      "单行文本": "1",
      "日期": ""
    },
    "parentId": "",
    "sign": "",
    "subDocuments": [],
    "versions": "0",
    "exparams": {},
    "templateForm": ""
  },
  "viewId": "",
  "templateForm": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» applicationId	body	string	是	none
» formId	body	string	是	none
» id	body	string	是	none
» parentId	body	string	是	none
» sign	body	string	是	none
» subDocuments	body	[string]	是	none
» versions	body	string	是	none
» docId	body	string	是	none
» document	body	object	是	none
»» applicationId	body	string	是	none
»» formId	body	string	是	none
»» id	body	string	是	none
»» items	body	object	是	none
»»» 单行文本	body	string	是	none
»»» 日期	body	string	是	none
»» parentId	body	string	是	none
»» sign	body	string	是	none
»» subDocuments	body	[string]	是	none
»» versions	body	string	是	none
»» exparams	body	object	是	none
»» templateForm	body	string	是	none
» viewId	body	string	是	none
» templateForm	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "name": "申请人",
      "statelabel": "申请人",
      "nodeId": "1584946784147",
      "auditors": [
        {
          "dept": "我的公司",
          "station": "",
          "name": "超级管理员"
        }
      ],
      "type": null,
      "flowOperation": 80,
      "state": "history"
    },
    {
      "name": "人事",
      "statelabel": "人事",
      "nodeId": "1584946785482",
      "auditors": [
        {
          "dept": "我的公司",
          "station": "",
          "name": "超级管理员"
        },
        {
          "dept": "我的公司",
          "station": "",
          "name": "人事"
        }
      ],
      "type": null,
      "flowOperation": 0,
      "state": "now"
    },
    {
      "name": "总经理",
      "statelabel": "总经理",
      "nodeId": "1584946787018",
      "auditors": [
        {
          "dept": "我的公司",
          "station": "",
          "name": "超级管理员"
        }
      ],
      "type": null,
      "flowOperation": 0,
      "state": "future"
    },
    {
      "name": "结束",
      "statelabel": "结束",
      "nodeId": "1584946789169",
      "auditors": [
        {
          "dept": null,
          "station": null,
          "name": "结束"
        }
      ],
      "type": null,
      "flowOperation": 0,
      "state": "future"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	[object]	false	none	流程走向数据
»» name	string	true	none	节点名称
»» statelabel	string	true	none	节点状态标签
»» nodeId	string	true	none	节点id
»» auditors	[object]	true	none	审批人
»»» dept	string¦null	true	none	none
»»» station	string¦null	true	none	none
»»» name	string	true	none	节点名称
»» type	null	true	none	节点类型
»» flowOperation	integer	true	none	流转动作
»» state	string	true	none	节点状态

GET 获取流程列表

GET /api/runtime/{applicationId}/workflows/defi

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
type	query	string	否	type
pageSize	query	string	否	none
pageNum	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/操作（Activitys）

POST 运行动作执行前脚本

POST /api/runtime/{applicationId}/activities/{id}/runbeforeactionscript

Body 请求参数

{
  "applicationId": "sOZu9kthmxyP8qQfq0e",
  "formId": "6trTlUH15wgzniZA91J",
  "id": "LObKBMYy6d8b65H2DBz--6trTlUH15wgzniZA91J",
  "parentId": "",
  "subDocuments": [],
  "versions": "0",
  "docId": "LObKBMYy6d8b65H2DBz--6trTlUH15wgzniZA91J",
  "document": {
    "applicationId": "sOZu9kthmxyP8qQfq0e",
    "formId": "6trTlUH15wgzniZA91J",
    "id": "LObKBMYy6d8b65H2DBz--6trTlUH15wgzniZA91J",
    "items": {
      "全局刷新_A": "全局刷新A已刷新：<font color='red'>1</font>",
      "全局刷新_B": "     全局刷新B已刷新：<font color='red'>1</font>",
      "局部刷新_A": "局部刷新A已刷新：<font color='red'>1</font>",
      "显示控制": "显示"
    },
    "parentId": "",
    "subDocuments": [],
    "versions": "0",
    "exparams": {},
    "templateForm": ""
  },
  "viewId": "",
  "templateForm": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	按钮id
docId	query	string	否	none
viewId	query	string	否	none
formId	query	string	否	none
_templateForm	query	string	否	none
parentId	query	string	否	none
isRelate	query	string	否	none
actType	query	string	否	none
_flowType	query	string	否	none
body	body	object	否	none
» document	body	object	是	none
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none
» docId	body	string	是	none
» viewId	body	string	是	none
» formId	body	string	是	none
» templateForm	body	string	是	none
» parentId	body	string	是	none
» _selects	body	[string]	是	none
» isRelate	body	string	是	none

返回示例

200 Response

{
  "errcode": 0,
  "errmsg": "string",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6

POST 运算动作执行后脚本

POST /api/runtime/{applicationId}/activities/{id}/runafteractionscript

Body 请求参数

{
  "applicationId": "sOZu9kthmxyP8qQfq0e",
  "formId": "6trTlUH15wgzniZA91J",
  "id": "LObKBMYy6d8b65H2DBz--6trTlUH15wgzniZA91J",
  "parentId": "",
  "subDocuments": [],
  "versions": "0",
  "docId": "LObKBMYy6d8b65H2DBz--6trTlUH15wgzniZA91J",
  "document": {
    "applicationId": "sOZu9kthmxyP8qQfq0e",
    "formId": "6trTlUH15wgzniZA91J",
    "id": "LObKBMYy6d8b65H2DBz--6trTlUH15wgzniZA91J",
    "items": {
      "全局刷新_A": "全局刷新A已刷新：<font color='red'>1</font>",
      "全局刷新_B": "     全局刷新B已刷新：<font color='red'>1</font>",
      "局部刷新_A": "局部刷新A已刷新：<font color='red'>1</font>",
      "显示控制": "显示"
    },
    "parentId": "",
    "subDocuments": [],
    "versions": "0",
    "exparams": {},
    "templateForm": ""
  },
  "viewId": "",
  "templateForm": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	按钮id
docId	query	string	否	none
viewId	query	string	否	none
formId	query	string	否	none
_templateForm	query	string	否	none
parentId	query	string	否	none
_	query	string	否	none
actType	query	string	否	none
body	body	object	否	none
» document	body	object	是	none
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none
» docId	body	string	是	none
» viewId	body	string	是	none
» formId	body	string	是	none
» templateForm	body	string	是	none
» parentId	body	string	是	none
» _selects	body	[string]	是	none
» isRelate	body	string	是	none

返回示例

200 Response

{
  "errcode": 0,
  "errmsg": "string",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6

PUT 运算自定义动作脚本

PUT /api/runtime/{applicationId}/activities/{id}/execute

Body 请求参数

{
  "document": {
    "items": {
      "名称": "",
      "单价": "",
      "库存": "",
      "备注": ""
    },
    "applicationId": "sOZu9kthmxyP8qQfq0e",
    "id": "__N3YqDVkwiYykKyVnVks",
    "templateForm": "",
    "formId": "PlyzrsgHnCVr21PPKDQ",
    "sign": "",
    "parentId": "",
    "isRelate": "undefined",
    "subDocuments": [],
    "versions": "0"
  },
  "formId": "PlyzrsgHnCVr21PPKDQ",
  "docId": "__N3YqDVkwiYykKyVnVks",
  "parentId": "",
  "templateForm": "",
  "viewId": "",
  "applicationId": "sOZu9kthmxyP8qQfq0e",
  "id": "__N3YqDVkwiYykKyVnVks"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
id	path	string	是	none
docId	query	string	否	none
viewId	query	string	否	none
formId	query	string	否	none
parentId	query	string	否	none
body	body	object	否	none
» document	body	object	是	none
»» items	body	object	是	none
»»» 名称	body	string	是	none
»»» 单价	body	string	是	none
»»» 库存	body	string	是	none
»»» 备注	body	string	是	none
»» applicationId	body	string	是	none
»» id	body	string	是	none
»» templateForm	body	string	是	none
»» formId	body	string	是	none
»» sign	body	string	是	none
»» parentId	body	string	是	none
»» isRelate	body	string	是	none
»» subDocuments	body	[string]	是	none
»» versions	body	string	是	none
» formId	body	string	是	none
» docId	body	string	是	none
» parentId	body	string	是	none
» templateForm	body	string	是	none
» viewId	body	string	是	none
» applicationId	body	string	是	none
» id	body	string	是	none

返回示例

200 Response

{
  "errcode": 0,
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6

GET 运算操作某字段执行脚本

GET /api/runtime/{applicationId}/activities/{id}/runScript

Body 请求参数

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "https://www.baidu.com?sss=njhkjhj"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
id	path	string	是	none
docId	query	string	否	none
fieldName	query	string	否	none
body	body	object	否	none
» errcode	body	integer	是	none
» errmsg	body	string	是	none
» data	body	string	是	none

返回示例

200 Response

{
  "errcode": 0,
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6

POST 复制

POST /api/runtime/{applicationId}/documents/{docId}/activities/copy

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
docId	path	string	是	none
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "value",
    "formid": "value",
    "applicationid": "value",
    "stateid": "value",
    "versions": 1,
    "parentid": "value",
    "authorDeptIndex": "value",
    "stateInt": 0,
    "istmp": false,
    "lastmodified": "value",
    "auditdate": "value",
    "created": "value",
    "authorId": "value",
    "initiator": "value",
    "audituser": "value",
    "lastFlowOperation": 80,
    "stateLabelInfo": "value",
    "auditorList": "value",
    "prevAuditNode": "value",
    "prevAuditUser": "value",
    "sign": "value",
    "items": [
      {
        "name": "value",
        "age": 0,
        "date": "2017-6-23"
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» id	string	true	none	none
»» formid	string	true	none	none
»» applicationid	string	false	none	none
»» stateid	string	false	none	none
»» versions	integer	true	none	none
»» parentid	string	false	none	none
»» authorDeptIndex	string	true	none	none
»» stateInt	integer	true	none	none
»» istmp	boolean	true	none	none
»» lastmodified	number	true	none	none
»» auditdate	string	false	none	none
»» created	number	true	none	none
»» authorId	string	true	none	none
»» initiator	string	false	none	none
»» audituser	string	false	none	none
»» lastFlowOperation	integer	false	none	none
»» stateLabelInfo	string	true	none	none
»» auditorList	string	true	none	none
»» prevAuditNode	string	false	none	none
»» prevAuditUser	string	false	none	none
»» sign	string	false	none	none
»» items	object	true	none	none

GET 归档

GET /api/runtime/{applicationId}/documents/{docId}/activities/archive

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id

返回示例

200 Response

{
  "errcode": 0,
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	返回归档成功的信息

POST 保存并启动流程

POST /api/runtime/{applicationId}/documents/activities/saveStartWorkFlow

Body 请求参数

{
  "document": {
    "id": "value",
    "formid": "value",
    "applicationid": "value",
    "stateid": "value",
    "versions": 0,
    "parentid": "value",
    "sign": "value",
    "items": [
      {
        "name": "demo",
        "age": 18,
        "date": "2017-6-23"
      }
    ]
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
body	body	object	否	none
» document	body	object	否	文档对象，数据结构参考#2.8
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	null

DELETE 清除所有数据

DELETE /api/runtime/{applicationId}/forms/{formId}/activities/clear

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "清除成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	null

POST 通过邮件或手机短信分享

POST /api/runtime/{applicationId}/documents/{docId}/activities/share

Body 请求参数

{
  "transpond": "11e7-687f-062850be-8a83-bf38d96990bd",
  "handleUrl": "http://localhost:8080/obpm/..",
  "receiverid": "11e7-5f9a-74ef9518-917f-e799edecb417",
  "email": true,
  "msm": false
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» transpond	body	string	是	转载id
» handleUrl	body	string	是	处理的url
» receiverid	body	string	是	接受人id
» email	body	boolean	是	email分享（布尔）
» msm	body	boolean	是	短信分享（布尔

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "发送成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	null

POST 签章

POST /api/runtime/{applicationId}/documents/{docId}/activities/sign

Body 请求参数

{
  "document": {
    "id": "value",
    "formid": "value",
    "applicationid": "value",
    "stateid": "value",
    "versions": 0,
    "parentid": "value",
    "sign": "value",
    "items": [
      {
        "name": "demo",
        "age": 18,
        "date": "2017-6-23"
      }
    ]
  }
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
docId	path	string	是	文档id
body	body	object	否	none
» document	body	object	是	none
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "签章成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	null

POST 文件下载

POST /api/runtime/{applicationId}/activities/{id}/download

Body 请求参数

{
  "document": {
    "id": "value",
    "formid": "value",
    "applicationid": "value",
    "stateid": "value",
    "versions": 0,
    "parentid": "value",
    "sign": "value",
    "items": [
      {
        "name": "demo",
        "age": 18,
        "date": "2017-6-23"
      }
    ]
  },
  "docId": "",
  "viewId": "PeHAwXgRVH5kH657J8z",
  "formId": "51uwxPwK7QwxkiH5SYH",
  "templateForm": "",
  "parentId": "",
  "_selects": [],
  "isRelate": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	按钮id
docId	query	string	否	none
actType	query	string	否	none
parentId	query	string	否	none
isRelate	query	string	否	none
viewId	query	string	否	none
formId	query	string	否	none
_templateForm	query	string	否	none
body	body	object	否	none
» document	body	object	是	none
»» id	body	string	是	none
»» formid	body	string	是	none
»» applicationid	body	string	是	none
»» stateid	body	string	是	none
»» versions	body	integer	是	none
»» parentid	body	string	是	none
»» sign	body	string	是	none
»» items	body	[object]	是	none
»»» name	body	string	否	none
»»» age	body	integer	否	none
»»» date	body	string	否	none
» docId	body	string	是	none
» viewId	body	string	是	none
» formId	body	string	是	none
» templateForm	body	string	是	none
» parentId	body	string	是	none
» _selects	body	[string]	是	none
» isRelate	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "文件路径"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	文件路径

POST 批量审批

POST /api/runtime/{applicationId}/forms/activities/batchApprove

Body 请求参数

{
  "limistStrList": "",
  "docIds": [
    "1SpJQzWvwynv8aqWprb",
    "XTuIPs7RxseePzK6Qvs"
  ],
  "actId": "11e7-5f9a-74ef9518-917f-e799edecb417",
  "attitude": "提交意见",
  "remark": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
body	body	object	否	none
» limistStrList	body	string	是	下一个节点限制列表
» docIds	body	[string]	是	文档标识数组
» actId	body	string	是	按钮id
» attitude	body	string	是	提交意见
» remark	body	string	是	评论

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "处理成功信息"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

POST Pdf导出

POST /api/runtime/{applicationId}/forms/{formId}/documents/{docId}/activities/exportPdf

Body 请求参数

{
  "htmlBody": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id
docId	path	string	是	文档id
body	body	object	否	none
» htmlBody	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	Null

GET 打印

GET /api/runtime/{applicationId}/forms/{formId}/documents/{docId}/activities/print

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id
docId	path	string	是	文档id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

POST Excel导入

POST /api/runtime/{applicationId}/views/{viewId}/activities/importExcel

Body 请求参数

{
  "impmappingconfigid": "IynOn3U8buOnhRuKEgV",
  "path": "uploads/excel/2017/055ff797.xlsx",
  "actId": "11e7-5f9a-74ef9518-917f-e799edecb417"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
body	body	object	否	none
» impmappingconfigid	body	string	是	Excel导入模板id
» path	body	string	是	上传文件路径
» actId	body	string	是	按钮id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "成功导入.."
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	导入成功或者失败后返回信息

PUT 运算地址脚本

PUT /api/runtime/{applicationId}/activities/{actId}/executeAddress

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
actId	path	string	是	按钮
docId	query	string	否	文档id
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "content": "http://localhost:80/portal/dynaform/view/displayViewWithPermission.action?_viewid=11e7-687c-c592e0b0-8a83-bf38d96990bd&clearTemp=true&application=11e7-5f98-d7d66840-917f-e799edecb417&_backURL=../../../portal/H5/closeTab.jsp",
    "type": 16
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	none
»» content	string	true	none	运算后返回数据
»» type	integer	true	none	类型

POST Excel导出

POST /api/runtime/{applicationId}/views/{viewId}/activities/exportExcel

Body 请求参数

"{\r\n\"items\": [\r\n\"开始时间\": \"\",\r\n\"申请人\": \"\",\r\n\"结束时间\": \"\"]\r\n\"selectColumns\": \"申请人,开始时间,结束时间\"\r\n\"selectDocIds\": []\r\n}"

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
actId	query	string	否	按钮id
filename	query	string	否	文件名
body	body	object	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	Null

GET 读取导出excel进度

GET /api/runtime/exportExcel/readProcess

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
excelExportTime	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 读取批量提交进度

GET /api/runtime/batchApprove/readProcess

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 记录操作日志

POST /api/runtime/{applicationId}/activities/recordHandleLog

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
formId	query	string	否	表单id
viewId	query	string	否	视图id
actType	query	string	否	操作类型
menuId	query	string	否	菜单Id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 读取导入excel进度

GET /api/runtime/importExcel/readProcess

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
excelImportTime	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/菜单（Menus）

GET 获取菜单

GET /api/runtime/{applicationId}/menus

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
isMobile	query	string	否	是否移动端

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

myApps运行时/流程中心（FlowCenters）

GET 获取发起菜单

GET /api/runtime/{applicationId}/flowcenters/startmenus

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
isUsual	query	string	否	是否常用菜单
isMobile	query	string	否	是否移动端
isUsualList	query	string	否	是否常用添加列表

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "id",
      "url": "url",
      "description": "请假申请",
      "parent": "parentid",
      "level": "1",
      "ico": {
        "icon": "/portal/H5/resource/images/icon_menu_default.png",
        "icontype": "img"
      }
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	none
»» id	string	false	none	菜单id
»» url	string	false	none	打开表单的地址
»» description	string	false	none	描述
»» parent	string	false	none	父菜单id
»» level	string	false	none	菜单级别
»» ico	object	false	none	图标
»»» icon	string	true	none	none
»»» icontype	string	true	none	none

POST 添加常用发起菜单

POST /api/runtime/{applicationId}/flowcenters/startMenus/{id}/usual

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	发起菜单id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	新建成功信息

PUT 更新常用发起菜单(使用次数)

PUT /api/runtime/{applicationId}/flowcenters/startMenus/{id}/usual

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	发起菜单id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	更新成功信息

DELETE 移除常用发起菜单

DELETE /api/runtime/{applicationId}/flowcenters/startMenus/{id}/usual

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	发起菜单id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	删除成功信息

GET 获取经办导航

GET /api/runtime/flowcenters/navs/processeds

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	query	string	否	软件id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-5f98-d7d66840-917f-e799edecb417",
      "name": "自动化测试系统",
      "processedFlowList": [
        {
          "id": "freeFlow",
          "num": 4,
          "name": "流程基本信息_名称"
        },
        {
          "id": "freeFlow",
          "num": 2,
          "name": "设计时分秒"
        },
        {
          "id": "",
          "num": 69,
          "name": "全部"
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	none
»» id	string	false	none	软件id
»» name	string	false	none	软件名臣
»» processedFlowList	[object]	false	none	代办列表集合
»»» id	string	true	none	流程id
»»» num	integer	true	none	流程数量
»»» name	string	true	none	表单名称

GET 获取待办导航

GET /api/runtime/flowcenters/navs/pendings

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	query	string	否	软件id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-5f98-d7d66840-917f-e799edecb417",
      "pendingFlowList": [
        {
          "id": "freeFlow",
          "num": 1,
          "name": "流程基本信息_名称"
        },
        {
          "id": "11e7-64a2-865adaa0-9cdb-af6bc8266ed2",
          "num": 3,
          "name": "列表视图_case001"
        },
        {
          "id": "",
          "num": 33,
          "name": "全部"
        }
      ],
      "name": "自动化测试系统"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	none
»» id	string	false	none	软件id
»» pendingFlowList	[object]	false	none	none
»»» id	string	true	none	软件id
»»» num	integer	true	none	流程数量
»»» name	string	true	none	表单名称
»» name	string	false	none	软件名称

GET 获取抄送导航

GET /api/runtime/flowcenters/navs/carboncopy

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	query	string	否	软件id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-5f98-d7d66840-917f-e799edecb417",
      "name": "自动化测试系统",
      "processedFlowList": [
        {
          "id": "freeFlow",
          "num": 4,
          "name": "流程基本信息_名称"
        },
        {
          "id": "freeFlow",
          "num": 2,
          "name": "设计时分秒"
        },
        {
          "id": "",
          "num": 69,
          "name": "全部"
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	none
»» id	string	false	none	软件id
»» name	string	false	none	软件名臣
»» processedFlowList	[object]	false	none	办列表集
»»» id	string	true	none	流程id
»»» num	integer	true	none	流程数量
»»» name	string	true	none	表单名称

GET 获取待办事项

GET /api/runtime/{applicationId}/flowcenters/pendings

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
title	query	string	否	主题内容
flowId	query	string	否	流程id
initiatorId	query	string	否	发起人id
pageNo	query	string	否	当前页
linesPerPage	query	string	否	每页显示条数
isMobile	query	string	否	是否移动端

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "applicationId": "11e7-5f98-d7d66840-917f-e799edecb417",
        "auditorList": "[{\"instanceId\":\"cASVnFsg2mJ3BHZFHE9\",\"flowName\":\"基本信息_允许审批人终止流程\",\"flowId\":\"11e7-677e-ac9203c7-bb6a-ff15ffadffa1\",\"nodes\":[{\"nodeId\":\"1499778203280\",\"stateLabel\":\"起草\",\"auditors\":[{\"id\":\"11e7-5f9a-210f9112-917f-e799edecb417\",\"name\":\"李玲\"}]}]}]",
        "auditorNames": "李玲",
        "docId": "A5ZdTitYLFno5EExk3H",
        "firstProcessTime": "2017-11-01T17:39:28",
        "flowId": "11e7-677e-ac9203c7-bb6a-ff15ffadffa1",
        "flowName": "基本信息_允许审批人终止流程",
        "formId": "11e7-677f-c922602d-bb6a-ff15ffadffa1",
        "initiator": "李玲",
        "initiatorDept": "自动化测试组",
        "initiatorDeptId": "11e7-5f9a-0020047a-917f-e799edecb417",
        "initiatorId": "11e7-5f9a-210f9112-917f-e799edecb417",
        "lastFlowOperation": "1",
        "lastProcessTime": "2017-11-01T17:39:28",
        "read": true,
        "stateLabel": "起草",
        "subject": ""
      }
    ],
    "linesPerPage": 10,
    "pageCount": 4,
    "pageNo": 1,
    "rowCount": 33
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	待办列表集合
»» datas	[object]	true	none	none
»»» applicationId	string	false	none	软件id
»»» auditorList	string	false	none	处理人列表
»»» auditorNames	string	false	none	处理人名称
»»» docId	string	false	none	文档id
»»» firstProcessTime	string	false	none	第一处理时间
»»» flowId	string	false	none	流程id
»»» flowName	string	false	none	流程名称
»»» formId	string	false	none	表单id
»»» initiator	string	false	none	发起人
»»» initiatorDept	string	false	none	发起人部门
»»» initiatorDeptId	string	false	none	发起人部门id
»»» initiatorId	string	false	none	none
»»» lastFlowOperation	string	false	none	最后处理动作
»»» lastProcessTime	string	false	none	none
»»» read	boolean	false	none	是否已读
»»» stateLabel	string	false	none	状态描述
»»» subject	string	false	none	主题
»» linesPerPage	integer	true	none	每页显示数据条数
»» pageCount	integer	true	none	总页数
»» pageNo	integer	true	none	当前页
»» rowCount	integer	true	none	总条数

GET 获取经办事项

GET /api/runtime/{applicationId}/flowcenters/processeds

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
title	query	string	否	主题内容
flowId	query	string	否	流程id
initiatorId	query	string	否	发起人id
status	query	string	否	完成状态
isMyWorkFlow	query	string	否	是否是我处理的
pageNo	query	string	否	当前页
linesPerPage	query	string	否	每页显示条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "applicationId": "11e7-5f98-d7d66840-917f-e799edecb417",
        "auditorList": "[{\"instanceId\":\"kpXmp8VDO8kqRh6QqO6\",\"flowName\":\"基本信息_允许审批人终止流程\",\"flowId\":\"11e7-677e-ac9203c7-bb6a-ff15ffadffa1\",\"nodes\":[{\"nodeId\":\"11e7-5f9a-cc4b2b49-917f-e799edecb417\",\"stateLabel\":\"张强\",\"auditors\":[{\"id\":\"11e7-5f9a-cc4b2b49-917f-e799edecb417\",\"name\":\"张强\"}]}]}]",
        "auditorNames": "张强",
        "docId": "X4tcUzit3MiRuosmWIc",
        "firstProcessTime": "2017-11-01T17:36:44",
        "flowId": "11e7-677e-ac9203c7-bb6a-ff15ffadffa1",
        "flowName": "基本信息_允许审批人终止流程",
        "formId": "11e7-677f-c922602d-bb6a-ff15ffadffa1",
        "initiator": "李玲",
        "initiatorDept": "自动化测试组",
        "initiatorDeptId": "11e7-5f9a-0020047a-917f-e799edecb417",
        "initiatorId": "11e7-5f9a-210f9112-917f-e799edecb417",
        "lastFlowOperation": "80",
        "lastProcessTime": "2017-11-01T17:39:15",
        "stateLabel": "张强",
        "subject": ""
      }
    ],
    "linesPerPage": 10,
    "pageCount": 7,
    "pageNo": 1,
    "rowCount": 69
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	none
»» datas	[object]	true	none	经办列表集合
»»» applicationId	string	false	none	软件id
»»» auditorList	string	false	none	处理人列表
»»» auditorNames	string	false	none	处理人名称
»»» docId	string	false	none	文档id
»»» firstProcessTime	string	false	none	第一处理时间
»»» flowId	string	false	none	流程id
»»» flowName	string	false	none	流程名称
»»» formId	string	false	none	表单id
»»» initiator	string	false	none	发起人
»»» initiatorDept	string	false	none	发起人部门
»»» initiatorDeptId	string	false	none	发起人部门id
»»» initiatorId	string	false	none	发起人id
»»» lastFlowOperation	string	false	none	最后处理动作
»»» lastProcessTime	string	false	none	最后处理时间
»»» stateLabel	string	false	none	状态描述
»»» subject	string	false	none	主题
»» linesPerPage	integer	true	none	每页显示数据条数
»» pageCount	integer	true	none	总页数
»» pageNo	integer	true	none	当前页
»» rowCount	integer	true	none	总条数

GET 经办标记全部已读

GET /api/runtime/flowcenters/pendings/allRead

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "success"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	none

GET 获取抄送事项

GET /api/runtime/{applicationId}/flowcenters/carboncopy

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
title	query	string	否	主题内容
flowId	query	string	否	流程id
initiatorId	query	string	否	发起人id
isRead	query	string	否	是否已读
isMyWorkFlow	query	string	否	是否是我处理的
pageNo	query	string	否	当前页
linesPerPage	query	string	否	每页显示条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "applicationId": "11e7-5f98-d7d66840-917f-e799edecb417",
        "auditorList": "[{\"instanceId\":\"kpXmp8VDO8kqRh6QqO6\",\"flowName\":\"基本信息_允许审批人终止流程\",\"flowId\":\"11e7-677e-ac9203c7-bb6a-ff15ffadffa1\",\"nodes\":[{\"nodeId\":\"11e7-5f9a-cc4b2b49-917f-e799edecb417\",\"stateLabel\":\"张强\",\"auditors\":[{\"id\":\"11e7-5f9a-cc4b2b49-917f-e799edecb417\",\"name\":\"张强\"}]}]}]",
        "auditorNames": "张强",
        "docId": "X4tcUzit3MiRuosmWIc",
        "firstProcessTime": "2017-11-01T17:36:44",
        "flowId": "11e7-677e-ac9203c7-bb6a-ff15ffadffa1",
        "flowName": "基本信息_允许审批人终止流程",
        "formId": "11e7-677f-c922602d-bb6a-ff15ffadffa1",
        "initiator": "李玲",
        "initiatorDept": "自动化测试组",
        "initiatorDeptId": "11e7-5f9a-0020047a-917f-e799edecb417",
        "initiatorId": "11e7-5f9a-210f9112-917f-e799edecb417",
        "lastFlowOperation": "80",
        "lastProcessTime": "2017-11-01T17:39:15",
        "stateLabel": "张强",
        "subject": ""
      }
    ],
    "linesPerPage": 10,
    "pageCount": 7,
    "pageNo": 1,
    "rowCount": 69
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	none
»» datas	[object]	true	none	经办列表集合
»»» applicationId	string	false	none	软件i
»»» auditorList	string	false	none	处理人列表
»»» auditorNames	string	false	none	处理人名称
»»» docId	string	false	none	文档id
»»» firstProcessTime	string	false	none	第一处理时间
»»» flowId	string	false	none	流程id
»»» flowName	string	false	none	流程名称
»»» formId	string	false	none	表单id
»»» initiator	string	false	none	发起人
»»» initiatorDept	string	false	none	发起人部门
»»» initiatorDeptId	string	false	none	发起人部门id
»»» initiatorId	string	false	none	发起人id
»»» lastFlowOperation	string	false	none	最后处理动作
»»» lastProcessTime	string	false	none	最后处理时间
»»» stateLabel	string	false	none	状态描述
»»» subject	string	false	none	主题
»» linesPerPage	integer	true	none	每页显示数据条数
»» pageCount	integer	true	none	总页数
»» pageNo	integer	true	none	当前页
»» rowCount	integer	true	none	总条数

myApps运行时/小工具（Widgets）

GET 获取指定用户首页Widget配置

GET /api/runtime/homepage/config

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "widgets": {
      "11e7-679f-970641fb-bb6a-ff15ffadffa1": {
        "icontype": null,
        "titleBColor": "",
        "titleColor": "#000",
        "iconShow": false,
        "icon": {
          "icontype": "font",
          "icon": "if-lib icon-xinwenxinxi",
          "iconFontColor": "#000"
        },
        "description": null,
        "id": "11e7-679f-970641fb-bb6a-ff15ffadffa1",
        "applicationId": "11e7-5f98-d7d66840-917f-e799edecb417",
        "type": "summary",
        "height": ""
      }
    },
    "setting": {
      "appM": [
        "11e7-6c4a-66734702-966a-876161d2b77c",
        "system_knowledge"
      ],
      "appIcon": [
        "11e7-67cb-ab88f1ac-bb6a-ff15ffadffa1",
        "11e7-67cc-0304449e-bb6a-ff15ffadffa1"
      ],
      "appL": [
        "11e7-67a0-f2fd635a-bb6a-ff15ffadffa1",
        "system_empconbook"
      ],
      "layoutStyle": "1:1:1",
      "appR": []
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的表单对象，数据结构参考file:///D:\Document\IntelliJ\obpm_dev\docs\设计文档\myApps运行时RESTful%20API说明文档.docx#_表单数据结构说明
»» widgets	object	true	none	none
»» setting	object	true	none	none
»»» appM	[string]	true	none	none
»»» appIcon	[string]	true	none	none
»»» appL	[string]	true	none	none
»»» layoutStyle	string	true	none	none
»»» appR	[string]	true	none	none

POST 保存用户首页Widget配置

POST /api/runtime/homepage/config

Body 请求参数

{
  "appM": [
    "11e7-6c4a-66734702-966a-876161d2b77c",
    "11e7-6c4a-54176aed-966a-876161d2b77c"
  ],
  "appIcon": [
    "11e7-67cb-ab88f1ac-bb6a-ff15ffadffa1",
    "11e7-67cb-701bedca-bb6a-ff15ffadffa1"
  ],
  "appL": [
    "11e7-67a0-f2fd635a-bb6a-ff15ffadffa1",
    "system_empconbook"
  ],
  "layoutStyle": "1:1:1",
  "appR": []
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» appM	body	[string]	是	none
» appIcon	body	[string]	是	none
» appL	body	[string]	是	none
» layoutStyle	body	string	是	none
» appR	body	[string]	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 前台widget显示-我的经办(包含多个软件)

GET /api/runtime/widget/myProcessing

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	integer	否	现在的页数
linesPerPage	query	integer	否	每页的条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 15,
    "linesPerPage": 2,
    "pageNo": 1,
    "datas": [
      {
        "applicationId": "11e6-429d-dd7a3284-86a2-074015f7cc96",
        "docId": "FlEBA0NuTpVyWXUwpsZ",
        "formId": "O3sGG1gOo1FXPgVXcjn",
        "flowId": "rLPRrUTfTm7lSRwLqT3",
        "flowName": "流程1",
        "stateLabel": "2",
        "auditorNames": "...",
        "auditorList": "[...]",
        "subject": "",
        "initiator": "oliver2",
        "initiatorId": "zDdCgz9OiPj4hfjfLhR",
        "initiatorDept": "项目部",
        "initiatorDeptId": "11e6-292f-51466c29-9a78-9b801f3f5251",
        "firstProcessTime": "2018-02-27 17:59:28",
        "lastProcessTime": "2018-02-27 17:59:29",
        "lastFlowOperation": "80",
        "read": null
      },
      {
        "applicationId": "11e6-429d-dd7a3284-86a2-074015f7cc96",
        "docId": "hCW0aTPDIsDDN6iT34E",
        "formId": "KKn4dCrk67Pw3rw6tud",
        "flowId": "uiFFzqbxenvVwS5D3tP",
        "flowName": "新建测试流程2",
        "stateLabel": "2",
        "auditorNames": "管理员,karrman,we,钟总经理（总经理）",
        "auditorList": "[...]",
        "subject": "",
        "initiator": "oliver2",
        "initiatorId": "zDdCgz9OiPj4hfjfLhR",
        "initiatorDept": "项目部",
        "initiatorDeptId": "11e6-292f-51466c29-9a78-9b801f3f5251",
        "firstProcessTime": "2018-02-24 10:12:47",
        "lastProcessTime": "2018-02-24 10:12:48",
        "lastFlowOperation": "80",
        "read": null
      }
    ],
    "pageCount": 8
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	false	none		返回码
» errmsg	string	false	none		对返回码的文本描述内容

GET 前台widget显示-我的待办(包含多个软件)

GET /api/runtime/widget/myPending

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	integer	否	现在的页数
linesPerPage	query	integer	否	每页的条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 22,
    "linesPerPage": 2,
    "pageNo": 1,
    "datas": [
      {
        "applicationId": "VFwDvnIIvpDmwrPJ63s",
        "docId": "3d2tRitdjBeuoOb2W2y",
        "formId": "wTqxMMVbL9s1Ud4ikfq",
        "flowId": "aSXR0LQ5d8nbXhehyBP",
        "flowName": "lc1",
        "stateLabel": "2",
        "auditorNames": "oliver2,oliver3",
        "auditorList": "[...]",
        "subject": "QWERTY    mb1/bd1    ",
        "initiator": "oliver",
        "initiatorId": "cgOB9f2NXQyzuefSmKC",
        "initiatorDept": "客户服务部",
        "initiatorDeptId": "11e5-8ea0-79d39897-b6a8-8959966cbe66",
        "firstProcessTime": "2018-03-19 18:37:52",
        "lastProcessTime": "2018-03-19 18:37:53",
        "lastFlowOperation": "80",
        "read": false
      },
      {
        "applicationId": "VFwDvnIIvpDmwrPJ63s",
        "docId": "1izKwOXqnQvd0WbIKyM",
        "formId": "wTqxMMVbL9s1Ud4ikfq",
        "flowId": "aSXR0LQ5d8nbXhehyBP",
        "flowName": "lc1",
        "stateLabel": "2",
        "auditorNames": "oliver2,oliver3",
        "auditorList": "[...]",
        "subject": "",
        "initiator": "oliver",
        "initiatorId": "cgOB9f2NXQyzuefSmKC",
        "initiatorDept": "客户服务部",
        "initiatorDeptId": "11e5-8ea0-79d39897-b6a8-8959966cbe66",
        "firstProcessTime": "2018-03-19 15:45:29",
        "lastProcessTime": "2018-03-19 15:45:29",
        "lastFlowOperation": "80",
        "read": false
      }
    ],
    "pageCount": 11
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	返回的表单对象，数据结构参考file:///D:\Document\IntelliJ\obpm_dev\docs\设计文档\myApps运行时RESTful%20API说明文档.docx#_表单数据结构说明
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» applicationId	string	true	none	none
»»» docId	string	true	none	none
»»» formId	string	true	none	none
»»» flowId	string	true	none	none
»»» flowName	string	true	none	none
»»» stateLabel	string	true	none	none
»»» auditorNames	string	true	none	none
»»» auditorList	string	true	none	none
»»» subject	string	true	none	none
»»» initiator	string	true	none	none
»»» initiatorId	string	true	none	none
»»» initiatorDept	null	true	none	none
»»» initiatorDeptId	string	true	none	none
»»» firstProcessTime	null	true	none	none
»»» lastProcessTime	string	true	none	none
»»» lastFlowOperation	string	true	none	none
»»» read	boolean	true	none	none
»» pageCount	integer	true	none	none

GET 获取指定widget内容

GET /api/runtime/{applicationId}/widgets/{widgetId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
widgetId	path	string	是	小工具id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回的表单对象，数据结构参考file:///D:\Document\IntelliJ\obpm_dev\docs\设计文档\myApps运行时RESTful%20API说明文档.docx#_表单数据结构说明

POST 签到

POST /api/runtime/{applicationId}/widgets/{widgetId}/checkin

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
widgetId	path	string	是	widgetid

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "wQJ1AcOOLhT2gXH9VBJ",
    "widgetId": "xsadsacfvtrb",
    "userId": "Fyerrqyr53YShQ8KRya",
    "userName": "超级管理员",
    "checkinTime": 1632044956249
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	签到信息
»» id	string	true	none	主键
»» widgetId	string	true	none	widget主键
»» userId	string	true	none	用户主键
»» userName	string	true	none	用户名称
»» checkinTime	integer	true	none	签到时间

GET 是否签到

GET /api/runtime/{applicationId}/widgets/{widgetId}/checkin

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
widgetId	path	string	是	widgetid

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	是否签到（true

GET 前台widget显示-我的抄办(包含多个软件)

GET /api/runtime/widget/myCopy

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	integer	否	现在的页数
linesPerPage	query	integer	否	每页的条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 4,
    "linesPerPage": 2,
    "pageNo": 1,
    "datas": [
      {
        "id": "F3GWGBzFRzixcQRpc36",
        "name": "oliver2",
        "userId": "zDdCgz9OiPj4hfjfLhR",
        "docId": "3d2tRitdjBeuoOb2W2y",
        "nodertId": "jPi3oyWDUtfmbgDKjhE",
        "flowstatertId": "LD28oTtpstrtbWxim93",
        "ccTime": 1521455872000,
        "readTime": null,
        "deadline": null,
        "read": false,
        "summary": "QWERTY    mb1/bd1    ",
        "formId": "wTqxMMVbL9s1Ud4ikfq"
      },
      {
        "id": "cI009I7C3Yjin54oT85",
        "name": "oliver2",
        "userId": "zDdCgz9OiPj4hfjfLhR",
        "docId": "1izKwOXqnQvd0WbIKyM",
        "nodertId": "3cTJN94Frgq497C0hjg",
        "flowstatertId": "LxWIw9EIhKcaQFf5EV4",
        "ccTime": 1521445529000,
        "readTime": null,
        "deadline": null,
        "read": false,
        "summary": "QW",
        "formId": "wTqxMMVbL9s1Ud4ikfq"
      }
    ],
    "pageCount": 2
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的表单对象，数据结构参考file:///D:\Document\IntelliJ\obpm_dev\docs\设计文档\myApps运行时RESTful%20API说明文档.docx#_表单数据结构说明
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» userId	string	true	none	none
»»» docId	string	true	none	none
»»» nodertId	string	true	none	none
»»» flowstatertId	string	true	none	none
»»» ccTime	integer	true	none	none
»»» readTime	null	true	none	none
»»» deadline	null	true	none	none
»»» read	boolean	true	none	none
»»» summary	string	true	none	none
»»» formId	string	true	none	none
»» pageCount	integer	true	none	none

GET 签到统计

GET /api/runtime/{applicationId}/widgets/{widgetId}/checkins

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
widgetId	path	string	是	widgetid
countType	query	string	否	统计类型,none(无),month(月份),quarter(季度),year(

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": 5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	integer	true	none	签到次数

GET 获取手机端(微信)首页配置

GET /api/runtime/{applicationId}/homepage/phoneConfig

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	应用id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/自定义报表（CustomReports）

GET 获取自定义报表数据

GET /api/runtime/{applicationId}/customreports/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
id	path	string	是	自定义报表id（对应widget中actionContent）

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "xAxis": [
      "666",
      "777",
      "888",
      "999"
    ],
    "yAxis": [
      "21312.00",
      "777.00",
      "888.00",
      "999.00"
    ],
    "sign": "histogram",
    "name": "自定义报表"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	none
»» xAxis	[string]	true	none	none
»» yAxis	[string]	true	none	none
»» sign	string	true	none	报表类型（不同类型返回数据结构不同）
»» name	string	true	none	none

myApps运行时/交叉报表（CrossReports）

GET 获取

GET /api/runtime/{applicationId}/forms/{formId}/documents/{docId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
formId	path	string	是	表单id
docId	path	string	是	文档id

返回示例

200 Response

{
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» data	object	false	none		返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6

myApps运行时/报表模块

POST 获取报表显示路径

POST /api/runtime/report/showjrxml/{id}

Body 请求参数

{
  "appId": "HdPeBqYwJyFyjHkhZu3",
  "xx": "xxx"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	报表id
body	body	object	否	none
» appId	body	string	是	none
» xx	body	string	是	none

返回示例

成功

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	undefined

GET 获取报表的查询表单模板

GET /api/runtime/report/{id}/searchformtemplate/{applicationId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	报表id
applicationId	path	string	是	软件id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    " fields": [],
    " document": {},
    " template": ".."
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	查询表单数据
»» fields	[string]	false	none	none
»» document	object	false	none	none
»» template	string	false	none	none

GET 获取报表导出excel字段

GET /api/runtime/report/exportexcel/{id}/columns

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	报表id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    "单行",
    "多行"
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[string]	false	none	字段集合

POST 报表导出excel

POST /api/runtime/report/exportexcel/{id}

Body 请求参数

{
  "columns": [
    "单行",
    "多行"
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	报表id
body	body	object	否	none
» columns	body	[string]	是	none

返回示例

200 Response

<?xml version="1.0" encoding="UTF-8" ?>

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取当前报表册下的报表

GET /api/runtime/report/getReportsInGroup

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
reportGroupId	query	string	否	报表册id
reportIds	query	string	否	报表的id,用;分隔

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "data": {
      "qjPCp8J2dH7x41vyoZ2": "SQL数据源",
      "9M30I7ZscGZKSI1qIR2": "视图数据源"
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	none
» errmsg	string	true	none	none
» data	object	false	none	none
»» data	object	true	none	none
»»» qjPCp8J2dH7x41vyoZ2	string	true	none	none
»»» 9M30I7ZscGZKSI1qIR2	string	true	none	none

myApps运行时/用户（Users）

GET 获取以部门为树形结构的用户集合

GET /api/runtime/{applicationId}/users/selectbox/department

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
deptId	query	string	否	父级部门id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "avatar": "",
        "dept": "自动化测试用例系统企业域",
        "email": "",
        "id": "11e7-661d-31b9954a-8f1a-bfe936d3ae2a",
        "mobile": "13025478965",
        "mobile2": "",
        "name": "伟强",
        "type": 1
      },
      {
        "children": [],
        "id": "11e7-5f99-e70d1a49-917f-e799edecb417",
        "name": "测试部",
        "type": 2
      }
    ],
    "pageCount": 1,
    "rowCount": 2,
    "pageNum": 1,
    "linesPerPage": 5
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	none
»» datas	[object]	true	none	部门下用户
»»» avatar	string	false	none	none
»»» dept	string	false	none	none
»»» email	string	false	none	none
»»» id	string	true	none	none
»»» mobile	string	false	none	none
»»» mobile2	string	false	none	none
»»» name	string	true	none	none
»»» type	integer	true	none	none
»»» children	[string]	false	none	none
»» pageCount	integer	true	none	总页数
»» rowCount	integer	true	none	总行数
»» pageNum	integer	true	none	当前页
»» linesPerPage	integer	true	none	每页显示条数

GET 获取以角色为树形结构的用户集合

GET /api/runtime/{applicationId}/users/selectbox/role

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
roleId	query	string	否	角色id
pageSize	query	string	否	每页显示数据数（传入0时默认显示5条数据）
pageNum	query	string	否	当前页（传入0时默认显示第一页）
flowId	query	string	否	流程id
nodeId	query	string	否	节点id(指定抄送传的是当前节点id,指定审批人是下一节点id)
docId	query	string	否	文档id
type	query	string	否	类型(传1是指定下一节点审批人，传2指定抄送人，其他传

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "id": "11e7-5f9a-210f9112-917f-e799edecb417",
        "name": "李玲",
        "type": 1,
        "mobile": "",
        "mobile2": "",
        "email": "jack@teemlink.com",
        "avatar": null,
        "dept": "自动化测试组",
        "deptId": "11e7-5f9a-0020047a-917f-e799edecb417",
        "loginNo": "liling",
        "domainId": "11e7-5f99-cc5d96f1-917f-e799edecb417"
      }
    ],
    "pageCount": 1,
    "rowCount": 2,
    "pageNum": 1,
    "linesPerPage": 5
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	none
»» datas	[object]	true	none	角色下用户集合
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» type	integer	false	none	none
»»» mobile	string	false	none	none
»»» mobile2	string	false	none	none
»»» email	null	false	none	none
»»» avatar	string	false	none	none
»»» dept	string	false	none	none
»»» deptId	null	false	none	none
»»» loginNo	string	false	none	none
»»» domainId	string	false	none	none
»» pageCount	integer	true	none	总页数
»» rowCount	integer	true	none	总行数
»» pageNum	integer	true	none	当前页
»» linesPerPage	integer	true	none	每页显示条数

PUT 更新在线用户

PUT /api/runtime/updateOnlineUsers

Body 请求参数

[
  "id1",
  "id2"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

DELETE 移除在线用户

DELETE /api/runtime/removeOnlineUser

Body 请求参数

{
  "id": "__oP0irhWXGA2oZRusW1d"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取以通讯录为树形结构的用户集合

GET /api/runtime/users/selectbox/contacts

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
contactsId	query	string	否	通讯录分组id
pageSize	query	string	否	每页显示条数
pageNum	query	string	否	当前页

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "avatar": "",
        "dept": "自动化测试用例系统企业域",
        "email": "",
        "id": "11e7-661d-31b9954a-8f1a-bfe936d3ae2a",
        "mobile": "13025478965",
        "mobile2": "",
        "name": "伟强",
        "type": 1
      }
    ],
    "pageCount": 1,
    "rowCount": 2,
    "pageNum": 1,
    "linesPerPage": 5
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	none
»» datas	[object]	true	none	通讯录下用户集合
»»» avatar	string	false	none	none
»»» dept	string	false	none	none
»»» email	string	false	none	none
»»» id	string	false	none	none
»»» mobile	string	false	none	none
»»» mobile2	string	false	none	none
»»» name	string	false	none	none
»»» type	integer	false	none	none
»» pageCount	integer	true	none	总页数
»» rowCount	integer	true	none	总行数
»» pageNum	integer	true	none	当前页
»» linesPerPage	integer	true	none	每页显示条数

GET 根据联系人姓名,首字母,电话进行模糊查询（联系人）

GET /api/runtime/users/selectbox/search

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
keyWord	query	string	否	关键字
pageNum	query	string	否	当前页
pageSize	query	string	否	每页显示条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "datas": [
    {
      "avatar": "",
      "dept": "自动化测试用例系统企业域",
      "email": "",
      "id": "11e7-661d-31b9954a-8f1a-bfe936d3ae2a",
      "mobile": "13025478965",
      "mobile2": "",
      "name": "伟强",
      "type": 1
    }
  ],
  "pageCount": 1,
  "rowCount": 2,
  "pageNum": 1,
  "linesPerPage": 5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» datas	[object]	false	none	查询用户用户集合
»» avatar	string	false	none	none
»» dept	string	false	none	none
»» email	string	false	none	none
»» id	string	false	none	none
»» mobile	string	false	none	none
»» mobile2	string	false	none	none
»» name	string	false	none	none
»» type	integer	false	none	none
» pageCount	integer	false	none	总页数
» rowCount	integer	false	none	总行数
» pageNum	integer	false	none	当前页
» linesPerPage	integer	false	none	每页显示条数

GET 获取离职用户集合

GET /api/runtime/users/selectbox/dimissions

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNum	query	string	否	当前页
pageSize	query	string	否	每页显示条数
domainId	query	string	否	domainId

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "datas": [
    {
      "id": "anmilDhBJWtHg2Pn2Fy",
      "name": "啊萍",
      "type": 1,
      "orderByNo": 0,
      "mobile": null,
      "mobile2": null,
      "email": null,
      "avatar": null,
      "dept": null,
      "deptId": null,
      "loginNo": null,
      "domainId": null,
      "pcmEnable": false,
      "domainAdmin": false,
      "log": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» datas	[object]	false	none	离职用户集合
»» id	string	false	none	none
»» name	string	false	none	none
»» type	integer	false	none	none
»» orderByNo	integer	false	none	none
»» mobile	null	false	none	none
»» mobile2	null	false	none	none
»» email	null	false	none	none
»» avatar	null	false	none	none
»» dept	null	false	none	none
»» deptId	null	false	none	none
»» loginNo	null	false	none	none
»» domainId	null	false	none	none
»» pcmEnable	boolean	false	none	none
»» domainAdmin	boolean	false	none	none
»» log	boolean	false	none	none

GET 获取在线用户集合

GET /api/runtime/users/selectbox/onlines

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNum	query	string	否	当前页
pageSize	query	string	否	每页显示条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "datas": [
    {
      "avatar": "",
      "dept": "自动化测试用例系统企业域",
      "email": "",
      "id": "11e7-661d-31b9954a-8f1a-bfe936d3ae2a",
      "mobile": "13025478965",
      "mobile2": "",
      "name": "伟强",
      "type": 1
    }
  ],
  "pageCount": 1,
  "rowCount": 2,
  "pageNum": 1,
  "linesPerPage": 5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» datas	[object]	false	none	在线用户用户集合
»» avatar	string	false	none	none
»» dept	string	false	none	none
»» email	string	false	none	none
»» id	string	false	none	none
»» mobile	string	false	none	none
»» mobile2	string	false	none	none
»» name	string	false	none	none
»» type	integer	false	none	none
» pageCount	integer	false	none	总页数
» rowCount	integer	false	none	总行数
» pageNum	integer	false	none	当前页
» linesPerPage	integer	false	none	每页显示条数

GET 获取部门树

GET /api/runtime/users/selectbox/dept-tree

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
parentId	query	string	否	父级id

返回示例

200 Response

"string"

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	string

GET 获取通讯录分组

GET /api/runtime/users/selectbox/contacts/group

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 0,
    "linesPerPage": 0,
    "pageNo": 0,
    "datas": [
      {
        "id": "1XUQawEPVQ6Qyk5TqEY",
        "name": "分组1",
        "ownerId": "MyTiy4G4bDOq6iALQyr"
      }
    ],
    "pageCount": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	通讯录分组集合
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	每页显示条数
»» pageNo	integer	true	none	当前页
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» ownerId	string	false	none	none
»» pageCount	integer	true	none	总页数

POST 新建通讯录分组

POST /api/runtime/users/contacts/groups

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
name	query	string	否	分组名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "1XUQawEPVQ6Qyk5TqEY",
    "name": "分组1",
    "ownerId": "MyTiy4G4bDOq6iALQyr"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	通讯录分组信息
»» id	string	true	none	none
»» name	string	true	none	none
»» ownerId	string	true	none	none

DELETE 删除通讯录分组

DELETE /api/runtime/users/contacts/groups/{groupId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
groupId	path	string	是	分组id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "删除成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	删除成功

POST 保存通讯录分组

POST /api/runtime/users/contacts/groups/{groupId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
groupId	path	string	是	分组id
name	query	string	否	分组名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "1XUQawEPVQ6Qyk5TqEY",
    "name": "分组1",
    "ownerId": "MyTiy4G4bDOq6iALQyr"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	对返回码的文本描述内容
»» id	string	true	none	none
»» name	string	true	none	none
»» ownerId	string	true	none	none

POST 添加用户到通讯录分组

POST /api/runtime/users/contacts/groups/{groupId}/users

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
groupId	path	string	是	分组id
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "添加成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	添加成功

DELETE 移除用户到通讯录分组

DELETE /api/runtime/users/contacts/groups/{groupId}/users

Body 请求参数

[
  "id1",
  "id2",
  "id3"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
groupId	path	string	是	分组id
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "移除成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	移除成功

GET 获取当前登陆用户信息

GET /api/runtime/users/myprofile

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "avatar": "",
    "dept": "自动化测试用例系统企业域",
    "email": "",
    "id": "11e7-661d-31b9954a-8f1a-bfe936d3ae2a",
    "mobile": "13025478965",
    "mobile2": "",
    "name": "伟强",
    "type": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回用户信息
»» avatar	string	true	none	none
»» dept	string	true	none	none
»» email	string	true	none	none
»» id	string	true	none	none
»» mobile	string	true	none	none
»» mobile2	string	true	none	none
»» name	string	true	none	none
»» type	integer	true	none	none

GET 获取用户信息

GET /api/runtime/users/profile

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	query	string	否	用户id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "avatar": "",
    "dept": "自动化测试用例系统企业域",
    "email": "",
    "id": "11e7-661d-31b9954a-8f1a-bfe936d3ae2a",
    "mobile": "13025478965",
    "mobile2": "",
    "name": "伟强",
    "type": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回用户信息
»» avatar	string	true	none	none
»» dept	string	true	none	none
»» id	string	true	none	none
»» name	string	true	none	none
»» type	integer	true	none	none

GET 获取登录用户签章列表

GET /api/runtime/users/signs

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "iUGOhkCPX2QueqG5iUp",
      "name": "123",
      "password": "0d04ee6e708c0136eb0156ef71251544",
      "img": "iUGOhkCPX2QueqG5iUp.jpg",
      "desc": "123",
      "date": "2018-09-05"
    },
    {
      "id": "XdUeahX5pMWYxjzdUVg",
      "name": "1111",
      "password": "423d853ec9aac368af3a1f6cf2edcb51",
      "img": "XdUeahX5pMWYxjzdUVg.jpg",
      "desc": "3333",
      "date": "2018-09-05"
    },
    {
      "id": "XdUeahX5pMWYxjzdUVg",
      "name": "1111",
      "password": "2d060d2ee17163955e099c5374da93f4",
      "img": "XdUeahX5pMWYxjzdUVg.jpg",
      "desc": "3333",
      "date": "2018-09-05"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回签章列表
»» id	string	true	none	none
»» name	string	true	none	none
»» password	string	true	none	none
»» img	string	true	none	none
»» desc	string	true	none	none
»» date	string	true	none	none

POST 新建签章

POST /api/runtime/users/signs

Body 请求参数

{
  "id": "XdUeahX5pMWYxjzdUVg",
  "name": "1111",
  "password": "2d060d2ee17163955e099c5374da93f4",
  "img": "XdUeahX5pMWYxjzdUVg.jpg",
  "desc": "3333",
  "date": "2018-09-05"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	签章id
» name	body	string	是	签章名字
» password	body	string	是	签章密码
» img	body	string	是	签章图片
» desc	body	string	是	签章备注
» date	body	string	是	签章时间

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "新建成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	新建成功

DELETE 批量删除签章

DELETE /api/runtime/users/signs

Body 请求参数

[
  "id1",
  "id2",
  "id3"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "删除成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	删除成功

GET 根据id获取登录用户签章

GET /api/runtime/users/signs/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	签章id
password	query	string	否	密码

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "iUGOhkCPX2QueqG5iUp",
    "name": "123",
    "password": "0d04ee6e708c0136eb0156ef71251544",
    "img": "iUGOhkCPX2QueqG5iUp.jpg",
    "desc": "123",
    "date": "2018-09-05"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回签章
»» id	string	true	none	none
»» name	string	true	none	none
»» password	string	true	none	none
»» img	string	true	none	none
»» desc	string	true	none	none
»» date	string	true	none	none

DELETE 删除签章

DELETE /api/runtime/users/signs/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "删除成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	删除成功

POST 保存个人视图配置(已废弃）

POST /api/runtime/users/views/settings

Body 请求参数

{
  "hiddenColumns": [],
  "fixedColumns": []
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» hiddenColumns	body	[string]	是	none
» fixedColumns	body	[string]	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	false	none		返回码
» errmsg	string	false	none		对返回码的文本描述内容

GET 获取用户头像

GET /api/runtime/{applicationId}/users/{id}/avatar

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/ 部门（Departments）

GET 获取树形结构的部门集合

GET /api/runtime/{applicationId}/departments/selectbox/department

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
deptId	query	string	否	父级部门id
level	query	string	否	显示部门级别(-1:所有,0:一级,1:二级,2:三级…)
belong	query	string	否	是否只显示当前用户及下属部门(true

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-654a-2b182ffe-9cdb-af6bc8266ed2",
      "name": "产品部",
      "type": 2,
      "code": "",
      "level": "1",
      "parent": "自动化测试用例系统企业域",
      "children": []
    },
    {
      "id": "11e7-5f99-e70d1a49-917f-e799edecb417",
      "name": "测试部",
      "type": 2,
      "code": "001",
      "level": "1",
      "parent": "自动化测试用例系统企业域",
      "children": []
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» id	string	true	none	none
»» name	string	true	none	none
»» type	integer	true	none	none
»» code	string	true	none	none
»» level	string	true	none	none
»» parent	string	true	none	none
»» children	[string]	true	none	none

GET 搜索功能

GET /api/runtime/{applicationId}/departments/selectbox/search

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
keyword	query	string	否	部门名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-654a-2b182ffe-9cdb-af6bc8266ed2",
      "name": "产品部",
      "type": 2,
      "code": "",
      "level": "1",
      "parent": "自动化测试用例系统企业域",
      "children": []
    },
    {
      "id": "11e7-5f99-e70d1a49-917f-e799edecb417",
      "name": "测试部",
      "type": 2,
      "code": "001",
      "level": "1",
      "parent": "自动化测试用例系统企业域",
      "children": []
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» id	string	true	none	none
»» name	string	true	none	none
»» type	integer	true	none	none
»» code	string	true	none	none
»» level	number	false	none	none
»» parent	string	false	none	none
»» children	[string]	true	none	none

GET 获取部门集合或部门下用户集合

GET /api/runtime/{applicationId}/departments/selectbox/user

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
deptId	query	string	否	父级部门id
pageSize	query	string	否	每页显示数据数（传入0时默认显示5条数据
pageNum	query	string	否	当前页（传入0时默认显示第一页）
ifFromMail	query	string	否	是否邮件调用

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "id": "11e7-5f9a-210f9112-917f-e799edecb417",
        "name": "李玲",
        "type": 1,
        "mobile": "",
        "mobile2": "",
        "email": "jack@teemlink.com",
        "avatar": null,
        "dept": "自动化测试组",
        "deptId": "11e7-5f9a-0020047a-917f-e799edecb417",
        "loginNo": "liling",
        "domainId": "11e7-5f99-cc5d96f1-917f-e799edecb417"
      }
    ],
    "pageCount": 1,
    "rowCount": 2,
    "pageNum": 1,
    "linesPerPage": 5
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	none
»» datas	[object]	true	none	部门下用户集合
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» type	integer	false	none	none
»»» mobile	string	false	none	none
»»» mobile2	string	false	none	none
»»» email	string	false	none	none
»»» avatar	null	false	none	none
»»» dept	string	false	none	none
»»» deptId	string	false	none	none
»»» loginNo	string	false	none	none
»»» domainId	string	false	none	none
»» pageCount	integer	true	none	总页数
»» rowCount	integer	true	none	总行数
»» pageNum	integer	true	none	当前页
»» linesPerPage	integer	true	none	每页显示条数

GET 根据企业域获取部门集合

GET /api/runtime/department/list

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 根据父级获取部门集合

GET /api/runtime/{applicationId}/departments/selectbox/childs

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
parentId	query	string	否	部门id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-654a-2b182ffe-9cdb-af6bc8266ed2",
      "name": "产品部",
      "count": 2,
      "child": false
    },
    {
      "id": "11e7-654a-2b182ffe-9cdb-af6bc8266ed2",
      "name": "产品部",
      "count": 2,
      "child": true
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回部门数据
»» id	string	false	none	none
»» name	string	false	none	none
»» count	integer	false	none	none
»» child	boolean	false	none	none

POST 新增部门

POST /rest/bpm/department/save

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 更新部门信息

POST /rest/bpm/department/update

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 通过部门ID查找部门信息

POST /rest/bpm/department/find

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

DELETE 删除部门

DELETE /api/authtime/department

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
ids	query	string	否	部门id·数组

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取部门信息（多个）

POST /rest/bpm/department/get

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/个人设置（UserSetups）

POST 更新个人信息

POST /api/runtime/usersetups/detail

Body 请求参数

{
  "name": "1111",
  "email": "1111",
  "telephone": "1111"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» name	body	string	是	用户名称
» email	body	string	是	用户邮箱
» telephone	body	string	是	用户电话

返回示例

200 Response

{
  "errcode": 0,
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	number	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6

POST 更新密码

POST /api/runtime/usersetups/password

Body 请求参数

{
  "oldPassword": "1111",
  "newpassword": "1111",
  "confirmPassword": "1111"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» oldPassword	body	string	是	原密码
» newpassword	body	string	是	新密码
» confirmPassword	body	string	是	确认密码

返回示例

200 Response

{
  "errcode": 0,
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	number	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6

GET 系统设置

GET /api/runtime/{userid}/detail

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userid	path	string	是	用户id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "url"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	返回的url

POST 更新皮肤

POST /api/runtime/users/skin

Body 请求参数

{
  "skin": "1111"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» skin	body	string	是	皮肤

返回示例

200 Response

{
  "errcode": 0,
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	number	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6

myApps运行时/个人设置（UserSetups）/组织切换

GET 获取用户所属企业域

GET /api/runtime/usersetups/domains

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "__4SG7IKUoZuZ4tq9K7hT",
      "sendHost": "smtp.exmail.qq.com",
      "sendAddress": "quan@weioa365.com",
      "sendAccount": "quan@weioa365.com",
      "sendPassword": "VXrZaxVAoDAjZLtf",
      "ccAddress": null,
      "isUseClient": "true",
      "functionDomain": "qq.com",
      "trash": "Junk E-mail",
      "sender": "Sent Items",
      "draft": "Drafts",
      "removed": "removed",
      "fetchServer": "imap.exmail.qq.com",
      "fetchServerPort": "993",
      "fetchProtocol": "imap",
      "fetchssl": null,
      "smtpServer": "smtp.exmail.qq.com",
      "smtpServerPort": "465",
      "smtpAuthenticated": null,
      "smtpssl": null,
      "name": "我的公司",
      "systemName": "",
      "logoUrl": ""
    },
    {
      "id": "__bB4fGzch9L4op1STXR0",
      "sendHost": null,
      "sendAddress": null,
      "sendAccount": null,
      "sendPassword": null,
      "ccAddress": null,
      "isUseClient": null,
      "functionDomain": null,
      "trash": null,
      "sender": null,
      "draft": null,
      "removed": null,
      "fetchServer": null,
      "fetchServerPort": null,
      "fetchProtocol": null,
      "fetchssl": null,
      "smtpServer": null,
      "smtpServerPort": null,
      "smtpAuthenticated": null,
      "smtpssl": null,
      "name": "测试企业域",
      "systemName": "",
      "logoUrl": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	返回企业域列表
»» id	string	true	none	none
»» sendHost	string¦null	true	none	none
»» sendAddress	string¦null	true	none	none
»» sendAccount	string¦null	true	none	none
»» sendPassword	string¦null	true	none	none
»» ccAddress	string	true	none	none
»» isUseClient	string¦null	true	none	none
»» functionDomain	string¦null	true	none	none
»» trash	string¦null	true	none	none
»» sender	string¦null	true	none	none
»» draft	string¦null	true	none	none
»» removed	string¦null	true	none	none
»» fetchServer	string¦null	true	none	none
»» fetchServerPort	string¦null	true	none	none
»» fetchProtocol	string¦null	true	none	none
»» fetchssl	string	true	none	none
»» smtpServer	string¦null	true	none	none
»» smtpServerPort	string¦null	true	none	none
»» smtpAuthenticated	string	true	none	none
»» smtpssl	string	true	none	none
»» name	string	true	none	none
»» systemName	string	true	none	none
»» logoUrl	string	true	none	none

PUT 切换企业域

PUT /api/runtime/usersetups/domains/switch

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
domain	query	string	否	企业域名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

myApps运行时/个人设置（UserSetups）/代理设置

GET 获取代理列表

GET /api/runtime/{applicationId}/usersetups/proxys

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
flowName	query	string	否	流程名称
pageNo	query	string	否	当前页
linesPerPage	query	string	否	每页显示数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 10,
    "pageNo": 1,
    "datas": [
      {
        "id": "GBE1IwQSPyGUeklduFq",
        "flowName": "KPI审批流程",
        "flowId": "11e5-73d7-4a37291b-93d0-b7ec49f28add",
        "description": "123",
        "state": "1",
        "agents": "11e4-63ff-5d9df2ad-9f19-57d7b83ae7be",
        "agentsName": "方映春",
        "owner": "11e7-7721-76f875ba-bacd-b744ea587d6a",
        "startProxyTime": 1514217600000,
        "endProxyTime": 1514304000000,
        "proxyMode": 0
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» flowName	string	false	none	none
»»» flowId	string	false	none	none
»»» description	string	false	none	none
»»» state	string	false	none	none
»»» agents	string	false	none	none
»»» agentsName	string	false	none	none
»»» owner	string	false	none	none
»»» startProxyTime	integer	false	none	none
»»» endProxyTime	integer	false	none	none
»»» proxyMode	integer	false	none	none
»» pageCount	integer	true	none	none

DELETE 删除代理

DELETE /api/runtime/{applicationId}/usersetups/proxys

Body 请求参数

[
  "ID1",
  "ID2",
  "ID3"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 10,
    "pageNo": 1,
    "datas": [
      {
        "id": "GBE1IwQSPyGUeklduFq",
        "flowName": "KPI审批流程",
        "flowId": "11e5-73d7-4a37291b-93d0-b7ec49f28add",
        "description": "123",
        "state": "1",
        "agents": "11e4-63ff-5d9df2ad-9f19-57d7b83ae7be",
        "agentsName": "方映春",
        "owner": "11e7-7721-76f875ba-bacd-b744ea587d6a",
        "startProxyTime": 1514217600000,
        "endProxyTime": 1514304000000,
        "proxyMode": 0
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» flowName	string	false	none	none
»»» flowId	string	false	none	none
»»» description	string	false	none	none
»»» state	string	false	none	none
»»» agents	string	false	none	none
»»» agentsName	string	false	none	none
»»» owner	string	false	none	none
»»» startProxyTime	integer	false	none	none
»»» endProxyTime	integer	false	none	none
»»» proxyMode	integer	false	none	none
»» pageCount	integer	true	none	none

GET 获取代理

GET /api/runtime/{applicationId}/usersetups/proxys/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
id	path	string	是	代理id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 10,
    "pageNo": 1,
    "datas": {
      "id": "GBE1IwQSPyGUeklduFq",
      "flowName": "KPI审批流程",
      "flowId": "11e5-73d7-4a37291b-93d0-b7ec49f28add",
      "description": "123",
      "state": "1",
      "agents": "11e4-63ff-5d9df2ad-9f19-57d7b83ae7be",
      "agentsName": "方映春",
      "owner": "11e7-7721-76f875ba-bacd-b744ea587d6a",
      "startProxyTime": 1514217600000,
      "endProxyTime": 1514304000000,
      "proxyMode": 0
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	object	true	none	none
»»» id	string	true	none	none
»»» flowName	string	true	none	none
»»» flowId	string	true	none	none
»»» description	string	true	none	none
»»» state	string	true	none	none
»»» agents	string	true	none	none
»»» agentsName	string	true	none	none
»»» owner	string	true	none	none
»»» startProxyTime	integer	true	none	none
»»» endProxyTime	integer	true	none	none
»»» proxyMode	integer	true	none	none

POST 保存代理

POST /api/runtime/{applicationId}/usersetups/proxys/save

Body 请求参数

{
  "flowName": "KPI审批流程;啊哈哈哈",
  "flowId": "11e5-73d7-4f28add;11e5-73d7-4a3729128add",
  "description": "123",
  "state": "1",
  "agents": "11e4-63ff-5d9df2ad-9f19-57d7b83ae7be",
  "agentsName": "方映春",
  "owner": "11e7-7721-76f875ba-bacd-b744ea587d6a",
  "startProxyTime": 1514217600000,
  "endProxyTime": 1514304000000,
  "proxyMode": 0
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
Id	query	string	否	代理id
body	body	object	否	none
» flowName	body	string	是	none
» flowId	body	string	是	none
» description	body	string	是	none
» state	body	string	是	none
» agents	body	string	是	none
» agentsName	body	string	是	none
» owner	body	string	是	none
» startProxyTime	body	integer	是	none
» endProxyTime	body	integer	是	none
» proxyMode	body	integer	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 获取流程列表

GET /api/runtime/{applicationId}/usersetups/proxys/flows

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "": "",
    "11e5-73d7-4a37291b-93d0-b7ec49f28add": "KPI审批流程",
    "11e6-539e-f439b6cc-81f5-679a826556ce": "人才推荐",
    "11e6-5302-c8cd341d-a13d-c75d0a89256c": "离职申请",
    "11e6-52dd-ef4a426c-a13d-c75d0a89256c": "调岗申请"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» anonymous	string	false	none	none
»» 11e5-73d7-4a37291b-93d0-b7ec49f28add	string	false	none	none
»» 11e6-539e-f439b6cc-81f5-679a826556ce	string	false	none	none
»» 11e6-5302-c8cd341d-a13d-c75d0a89256c	string	false	none	none
»» 11e6-52dd-ef4a426c-a13d-c75d0a89256c	string	false	none	none

myApps运行时/个人设置（UserSetups）/常用意见设置

GET 获取常用意见配置

GET /api/runtime/users/{userId}/commonOpinions

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前登录用户id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "79efe485-f704-448f-8c49-bf7bc42a1214",
      "content": "同意"
    },
    {
      "id": "3eedf5d5-9d05-4921-bf61-45351241b15b",
      "content": "批准"
    },
    {
      "id": "6169402c-7915-4393-818c-4cdec6d255dc",
      "content": "OK"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	常用意见数据
»» id	string	true	none	none
»» content	string	true	none	none

POST 添加常用意见

POST /api/runtime/users/{userId}/commonOpinions

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前登录用户id
opinion	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "79efe485-f704-448f-8c49-bf7bc42a1214",
    "content": "同意"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	常用意见数据
»» id	string	true	none	none
»» content	string	true	none	none

PUT 修改常用意见

PUT /api/runtime/users/{userId}/commonOpinions/{opId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前登录用户id
opId	path	string	是	意见id
opinion	query	string	否	意见

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "79efe485-f704-448f-8c49-bf7bc42a1214",
    "content": "同意"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	常用意见数据
»» id	string	true	none	none
»» content	string	true	none	none

DELETE 删除常用意见

DELETE /api/runtime/users/{userId}/commonOpinions/{opId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前登录用户id
opId	path	string	是	意见id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "79efe485-f704-448f-8c49-bf7bc42a1214",
    "content": "同意"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	常用意见数据
»» id	string	true	none	none
»» content	string	true	none	none

myApps运行时/企业域管理

GET 获取企业域列表

GET /api/runtime/domains

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "pendingFlowList": [
        {
          "num": 1,
          "name": "请假申请_串行",
          "id": "5EWSM5Bm0UOk3cYj4T0"
        },
        {
          "num": 2,
          "name": "请假申请",
          "id": "FPnfiZrQktvBKa5thBd"
        },
        {
          "num": 1,
          "name": "简单流程",
          "id": "UrO2BNuusq43eZj9rW6"
        },
        {
          "num": 1,
          "name": "简单流程",
          "id": "__4D0nLZheR3L616RwbGL"
        },
        {
          "num": 5,
          "name": "全部",
          "id": ""
        }
      ],
      "name": "2.0功能示例",
      "id": "HdPeBqYwJyFyjHkhZu3"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	返回的企业域信息
»» pendingFlowList	[object]	false	none	none
»»» num	integer	true	none	none
»»» name	string	true	none	none
»»» id	string	true	none	none
»» name	string	false	none	none
»» id	string	false	none	none

GET 获取km的团队和专委会是否点击打开

GET /api/runtime/domains/realmAndTeam

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 根据企业域id获取企业域信息

GET /api/portal/domain/{domainId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
domainId	path	string	是	企业域id

返回示例

成功

{
  "id": "11e1-81e2-37f74759-9124-47aada6b7467",
  "sendHost": null,
  "sendAddress": null,
  "sendAccount": null,
  "sendPassword": null,
  "ccAddress": null,
  "isUseClient": null,
  "functionDomain": null,
  "trash": null,
  "sender": null,
  "draft": null,
  "removed": null,
  "fetchServer": null,
  "fetchServerPort": null,
  "fetchProtocol": null,
  "fetchssl": null,
  "smtpServer": null,
  "smtpServerPort": null,
  "smtpAuthenticated": null,
  "smtpssl": null,
  "name": "我的公司1",
  "systemName": "qqqqq",
  "logoUrl": "/accept.png"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» id	string	true	none	none
» sendHost	string	true	none	none
» sendAddress	string	true	none	none
» sendAccount	string	true	none	none
» sendPassword	string	true	none	none
» ccAddress	string	true	none	none
» isUseClient	string	true	none	none
» functionDomain	string	true	none	none
» trash	string	true	none	none
» sender	string	true	none	none
» draft	string	true	none	none
» removed	string	true	none	none
» fetchServer	string	true	none	none
» fetchServerPort	string	true	none	none
» fetchProtocol	string	true	none	none
» fetchssl	string	true	none	none
» smtpServer	string	true	none	none
» smtpServerPort	string	true	none	none
» smtpAuthenticated	string	true	none	none
» smtpssl	string	true	none	none
» name	string	true	none	none
» systemName	string	true	none	none
» logoUrl	string	true	none	none

myApps运行时/软件（Applications）

GET 获取软件列表

GET /api/runtime/applications

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "flowCenter": false,
    "applications": [
      {
        "id": "HdPeBqYwJyFyjHkhZu3",
        "name": "2.0功能示例",
        "activated": true
      },
      {
        "id": "pm",
        "name": "任务",
        "activated": true
      },
      {
        "id": "km",
        "name": "知识文档管理",
        "activated": false
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» flowCenter	boolean	true	none	none
»» applications	[object]	true	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» activated	boolean	true	none	none

GET 获取系统软件列表（已废弃）

GET /api/runtime/applications/{applicationId}/sysapplications

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "pm",
      "name": "任务"
    },
    {
      "id": "km",
      "name": "知识文档管理"
    },
    {
      "id": "qm",
      "name": "调查问卷"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» id	string	true	none	none
»» name	string	true	none	none

myApps运行时/消息中心（Messages）获取通知

GET 获取通知

GET /api/runtime/app/{applicationId}/notice/list.action

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
pageNo	query	string	否	当前页
linesPerPage	query	string	否	每页显示条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "datas": [
      {
        "createTime": "2017-11-01T15:22:30",
        "domainid": "11e7-5f99-cc5d96f1-917f-e799edecb417",
        "id": "tgkd9RyPi5FBLY3HBQL",
        "lazyLoad": true,
        "linkParams": "{\"_docid\":\"3fwTGoaSiF1Y5A4173f\",\"_formid\":\"11e7-66a6-784b8971-8f1a-bfe936d3ae2a\",\"application\":\"11e7-5f98-d7d66840-917f-e799edecb417\",\"mode\":\"personalMessageMode\"}",
        "module": "审批时限设置",
        "read": false,
        "subjectType": 3,
        "summary": "<span class='notice_type' type='3'></span><span class='notice_actor'>李玲</span><span class='notice_flowType'>创建</span><span class='notice_flow'>审批单</span><span class='notice_summary'>设计时分秒-</span>",
        "toUserId": "11e7-5f9a-210f9112-917f-e799edecb417",
        "version": 0
      }
    ],
    "linesPerPage": 30,
    "pageCount": 1,
    "pageNo": 1,
    "rowCount": 10
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	返回的表单对象，数据结构参考http://#%E8%8E%B7%E5%8F%96pdf%E6%96%87%E4%BB%B6
»» datas	[object]	true	none	none
»»» createTime	string	false	none	none
»»» domainid	string	false	none	none
»»» id	string	false	none	none
»»» lazyLoad	boolean	false	none	none
»»» linkParams	string	false	none	none
»»» module	string	false	none	none
»»» read	boolean	false	none	none
»»» subjectType	integer	false	none	none
»»» summary	string	false	none	none
»»» toUserId	string	false	none	none
»»» version	integer	false	none	none
»» linesPerPage	integer	true	none	none
»» pageCount	integer	true	none	none
»» pageNo	integer	true	none	none
»» rowCount	integer	true	none	none

PUT 标记已读

PUT /api/runtime/app/{applicationId}/notice/read.action

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
access_token	query	string	否	访问凭据
ids	query	string	否	联系人主键

返回示例

200 Response

{
  "errcode": "string",
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	string	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	null

PUT 全部标记已读

PUT /api//runtime/app/{applicationId}/notice/read

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none

返回示例

200 Response

{
  "errcode": "string",
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	string	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	null

DELETE 删除通知

DELETE /api/runtime/app/{applicationId}/notice/delete.action

Body 请求参数

[
  "id1",
  "id2",
  "id3"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
id	query	string	否	用户id
body	body	array[string]	否	none

返回示例

200 Response

{
  "errcode": "string",
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	string	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	null

myApps运行时/登录模块

POST 注销登录

POST /api/authtime/logout

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "url"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	返回的表单对象，数据结构参考

GET 调试登录-获取用户列表

GET //api/debuglogin/getDomainList

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
domainName	query	string	是	企业域名称
username	query	string	否	用户名

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "userlist"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	返回的用户列表

POST 调试登录-登陆

POST /api/debuglogin/loginWithCiphertext2

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
domainName	query	string	否	企业域名称
username	query	string	否	用户名

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "url"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	返回的url

POST 获取登陆页面所需的多语言字段

POST /api/runtime/login/getMultiLangWordList

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
language	query	string	否	语言
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "MultiLangWordList"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	string	false	none	返回的多语言列表

GET 钉钉免密登录

GET //api/runtime/dingding/authlogin

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
code	query	string	是	钉钉免登授权码
domainId	query	string	是	企业域id
appId	query	string	是	软件id
formId	query	string	是	表单id
docid	query	string	是	文档id

返回示例

成功

{
  "resultCode": 0,
  "msg": "ok",
  "returnUrl": "url"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» resultCode	integer	false	none	返回码
» msg	string	false	none	对返回码的文本描述内容
» returnUrl	string	false	none	返回的url

PUT 前台解锁

PUT /api/runtime/users/unlock

前台解锁

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	false	none	返回是否解锁成信息

POST 登录

POST /api/runtime/login/loginWithCiphertext2

Body 请求参数

{
  "username": "{{user1}}",
  "password": "{{userPwd}}",
  "remember": "0",
  "debug": "false",
  "domainName": "公司域管理",
  "checkcode": "",
  "language": "CN"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» username	body	string	是	none
» password	body	string	是	none
» remember	body	string	是	none
» debug	body	string	是	none
» domainName	body	string	是	none
» checkcode	body	string	是	none
» language	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 改变验证码

POST /api/runtime/login/changeCheckcodeImg

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 飞书免登录

POST //api/runtime/login/feisuhAuthLogin/domain/{domainId}/code/{code}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
domainId	path	string	是	none
code	path	string	是	免登授权码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取可代理登录用户

GET /api/runtime/login/getProxyUsers/{userid}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userid	path	string	是	用户id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 代理登录

GET /api/runtime/login/loginProxy/{userid}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userid	path	string	是	用户id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取企业域列表

POST /api/runtime/login/getDomainList

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 调试登录-获取登陆页面所需的多语言字段

GET /api/debuglogin/getMultiLangWordList

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
language	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 发送短信验证码

POST /api/runtime/login/smsSend

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 退出登录

POST /api/runtime/logout

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/公用

PUT 下载文件

PUT /api/runtime/{applicationId}/file/download

前台解锁

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
filename	query	string	是	文件名
filepath	query	string	是	文件相对路径

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回是否解锁成信息

GET 获取序列号

GET /api/runtime/sequence

服务器返回随机的序列号。

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "abcdefgshfhx"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	none
» errmsg	string	true	none	none
» data	string	true	none	none

GET gps定位纠偏

GET /api/runtime/gps/convert

gps定位纠偏

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
x	query	string	否	进度
y	query	string	否	纬度
from	query	string	否	from

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "x": "123123123.123",
    "y": "2221111.32"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回是否解锁成信息
»» x	string	true	none	none
»» y	string	true	none	none

POST 同步表数据

POST /api/runtime/{applicationId}/sync/data

同步表数据

Body 请求参数

{
  "action": "create",
  "applicationId": "sOZu9kthmxyP8qQfq0e",
  "dataObject": {
    "columnValues": [
      {
        "name": "id",
        "type": "text",
        "value": "Z42xU8LmniRouZ93E7s"
      },
      {
        "name": "name",
        "type": "text",
        "value": "总部"
      },
      {
        "name": "domain_id",
        "type": "text",
        "value": "3CffNlgt9B9StIjIUPB"
      },
      {
        "name": "levels",
        "type": "integer",
        "value": "0"
      },
      {
        "name": "indexcode",
        "type": "text",
        "value": "5fbaLCe8DIbIP2BdQoc_Z42xU8LmniRouZ93E7s"
      },
      {
        "name": "code",
        "type": "text",
        "value": "1"
      },
      {
        "name": "sortid",
        "type": "text",
        "value": ""
      },
      {
        "name": "valid",
        "type": "integer",
        "value": "1"
      },
      {
        "name": "orderbyno",
        "type": "integer",
        "value": "0"
      },
      {
        "name": "weixin_dept_id",
        "type": "text",
        "value": "1"
      },
      {
        "name": "lanxin_dept_id",
        "type": "text",
        "value": ""
      },
      {
        "name": "field1",
        "type": "text",
        "value": ""
      },
      {
        "name": "field2",
        "type": "text",
        "value": ""
      },
      {
        "name": "field3",
        "type": "text",
        "value": ""
      },
      {
        "name": "field4",
        "type": "text",
        "value": ""
      },
      {
        "name": "field5",
        "type": "text",
        "value": ""
      },
      {
        "name": "field6",
        "type": "text",
        "value": ""
      },
      {
        "name": "field7",
        "type": "text",
        "value": ""
      },
      {
        "name": "field8",
        "type": "text",
        "value": ""
      },
      {
        "name": "field9",
        "type": "text",
        "value": ""
      },
      {
        "name": "field10",
        "type": "text",
        "value": ""
      },
      {
        "name": "field11",
        "type": "text",
        "value": ""
      },
      {
        "name": "field12",
        "type": "text",
        "value": ""
      },
      {
        "name": "field13",
        "type": "text",
        "value": ""
      },
      {
        "name": "field14",
        "type": "text",
        "value": ""
      },
      {
        "name": "field15",
        "type": "text",
        "value": ""
      },
      {
        "name": "field16",
        "type": "text",
        "value": ""
      },
      {
        "name": "field17",
        "type": "text",
        "value": ""
      },
      {
        "name": "field18",
        "type": "text",
        "value": ""
      },
      {
        "name": "field19",
        "type": "text",
        "value": ""
      },
      {
        "name": "field20",
        "type": "text",
        "value": ""
      },
      {
        "name": "dingding_dept_id",
        "type": "text",
        "value": ""
      }
    ],
    "id": "Z42xU8LmniRouZ93E7s",
    "tableName": "t_department"
  },
  "dataSourceName": "测试连接"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
body	body	object	否	none
» action	body	string	是	动作类型（create新建，update更新，save新建或保存，delete删除）
» applicationId	body	string	是	软件id
» dataObject	body	object	是	数据对象
»» columnValues	body	[object]	是	字段对象
»»» name	body	string	是	字段名称
»»» type	body	string	是	字段类型
»»» value	body	string	是	字段值
»» id	body	string	是	数据id
»» tableName	body	string	是	表名
» dataSourceName	body	string	是	数据源名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	false	none		返回码
» errmsg	string	false	none		对返回码的文本描述内容

POST 同步文件

POST /api/runtime/{applicationId}/sync/file

同步表数据

Body 请求参数

{
  "downloadUrl": "http://localhost:8083/obpm/uploads/item/2021/a29bbf24-fb23-4413-b8eb-38512a22d666.docx?accessToken=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJhdXRoMCIsImV4cCI6MTYyMDcxMjE2NSwidXNlcm5hbWUiOiJfXzdNM1RyWXdtYTJqYzFaY0ZySHEifQ.AnSAvhVk3Y4KZ1jpd0VCSnqW4gyVms5QS6L0oHimHgA",
  "pathOnTargetServer": "D:/obpm-demo/uploads/item/2021/a29bbf24-fb23-4413-b8eb-38512a22d666.docx"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
body	body	object	否	none
» downloadUrl	body	string	是	文件下载地址
» pathOnTargetServer	body	string	是	文件目标存储地址

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	false	none		返回码
» errmsg	string	false	none		对返回码的文本描述内容

GET 获取前台用户accessToken

GET /api/runtime/secrets/{secret}/accessToken

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
secret	path	string	是	密钥
loginNo	query	string	是	用户账号

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJhdXRoMCIsImV4cCI6MTYyNjg2Mzk4OCwidXNlcm5hbWUiOiJEUzZaMWwyT0NPVU9LOWxUNzR6In0.4RpAY67dFKVYJ4oLFO7TsTrsMfeAGqijFDQz0DjelWY"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	用户token

GET 生成accessToken Restful接口

GET /api/rest/accessToken

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
secret	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

myApps运行时/同步软件的数据表单

GET 同步软件的数据表单

GET /api/runtimes/{applicationId}/synchronization/forms

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
applicationId	query	string	是	软件id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 获取同步表单状态

GET /api/runtimes/{applicationId}/synchronization/forms/status

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none

返回示例

200 Response

{
  "data": {},
  "errcode": 0,
  "errmsg": "string",
  "errors": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» data	object	true	none	none
» errcode	integer	true	none	none
» errmsg	string	true	none	none
» errors	object	true	none	none

myApps运行时/统计图模块

POST 获取统计图的数据内容

POST /api/runtime/{application}/charts/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
application	path	string	是	none
id	path	string	是	统计图id
id	query	string	否	none
appId	query	string	否	none
linkType	query	string	否	none
active	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "result": "option",
    "view": "view",
    "appId": "HdPeBqYwJyFyjHkhZu3"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回数据包
»» result	string	true	none	none
»» view	null	false	none	none
»» appId	string	true	none	none

GET 获取统计图的查询表单模板

GET /api/runtime/{applicationId}/charts/{id}/searchformtemplate

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	none
id	path	string	是	统计图id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    " fields": [],
    " document": {},
    " template": ".."
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	查询表单数据
»» fields	[string]	false	none	none
»» document	object	false	none	none
»» template	string	false	none	none

myApps运行时/评论模块

GET 获取评论统计

GET /api/runtime/{applicationId}/flags/{flag}/comments/count

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
flag	path	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "commentNum": 3,
    "likeNum": 0,
    "id": "cOBQIpCvBqUt55LC7Fi"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	false	none	返回码
» errmsg	string	false	none	对返回码的文本描述内容
» data	object	false	none	返回数据包
»» commentNum	integer	true	none	评论条数
»» likeNum	integer	true	none	点赞次数
»» id	string	true	none	主键

GET 获取回复列表

GET /api/runtime/{applicationId}/comments/{commentId}/answers

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
commentId	path	string	是	评论id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "i5amKH9m4leqrXMu5RP",
      "comment": "我是评论呢",
      "flag": "4KSca72zzVtijBmNN0r",
      "userId": "Fyerrqyr53YShQ8KRya",
      "userName": "超级管理员",
      "likeNum": 3,
      "unlikeNum": 1,
      "createDate": 1628611200000,
      "parentId": "",
      "avatar": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回数据包
»» id	string	false	none	主键
»» comment	string	false	none	评论内容
»» flag	string	false	none	评论标识
»» userId	string	false	none	用户id
»» userName	string	false	none	用户名称
»» likeNum	integer	false	none	点赞次数
»» unlikeNum	integer	false	none	觉得不行次数
»» createDate	integer	false	none	创建时间
»» parentId	string	false	none	父级id
»» avatar	string	false	none	头像

GET 获取评论列表

GET /api/runtime/{applicationId}/flags/{flag}/comments

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
flag	path	string	是	评论标识

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "i5amKH9m4leqrXMu5RP",
      "comment": "我是评论呢",
      "flag": "4KSca72zzVtijBmNN0",
      "userId": "Fyerrqyr53YShQ8KRya",
      "userName": "超级管理员",
      "likeNum": 3,
      "unlikeNum": 1,
      "createDate": 1628611200000,
      "parentId": "",
      "avatar": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	false	none	返回数据包
»» id	string	false	none	主键
»» comment	string	false	none	评论内容
»» flag	string	false	none	评论标识
»» userId	string	false	none	用户id
»» userName	string	false	none	用户名称
»» likeNum	integer	false	none	点赞次数
»» unlikeNum	integer	false	none	觉得不行次数
»» createDate	integer	false	none	创建时间
»» parentId	string	false	none	父级id
»» avatar	string	false	none	头像

POST 新建评论（回复）

POST /api/runtime/{applicationId}/flags/{flag}/comments

Body 请求参数

{
  "comment": "我是回复呢",
  "parentId": "i5amKH9m4leqrXMu5RP"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
flag	path	string	是	评论标识
body	body	object	否	none
» comment	body	string	是	评论内容
» parentId	body	string	是	回复的评论id(创建评论时为空)

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "i5amKH9m4leqrXMu5RP",
    "comment": "我是评论呢",
    "flag": "4KSca72zzVtijBmNN0r",
    "userId": "Fyerrqyr53YShQ8KRya",
    "userName": "超级管理员",
    "likeNum": 3,
    "unlikeNum": 1,
    "createDate": 1628611200000,
    "parentId": "i5amKH9m4leqrXMu5RP"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回数据包
»» id	string	true	none	主键
»» comment	string	true	none	评论内容
»» flag	string	true	none	评论标识
»» userId	string	true	none	用户id
»» userName	string	true	none	用户名称
»» likeNum	integer	true	none	点赞次数
»» unlikeNum	integer	true	none	觉得不行次数
»» createDate	integer	true	none	创建时间
»» parentId	string	true	none	父级id

PUT 觉得不行

PUT /api/runtime/{applicationId}/comments/{commentId}/unlike

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
commentId	path	string	是	评论id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": 1
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	integer	false	none	返回觉得不行次数

PUT 点赞

PUT /api/runtime/{applicationId}/comments/{commentId}/like

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
commentId	path	string	是	评论id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": 1
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	integer	false	none	返回点赞次数

myApps运行时/ebug调试（macro）

GET 是否开启调式模式

GET /api/runtime/macro/isdebug

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回是否开启（true/false）

PUT 设置是否开启调式模式

PUT /api/runtime/macro/debug

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
isDebug	query	string	否	是否开启

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回是否开启（true/false）

PUT 刷新操作

PUT /api/runtime/macro/refresh

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回是否开启（true/false

GET 宏脚本输出日志文件

GET /api/runtime/macro/log

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 执行操作

PUT /api/runtime/macro/conduct

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
action	query	string	否	动作类型

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回是否开启（true/false）

PUT 运行脚本

PUT /api/runtime/macro/evalexpr

Body 请求参数

"asdasfdfhfhjyhjkhuiuurgdf"

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "sssss"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	返回执行后的结果

myApps运行时/下载模块

GET 判断文件是否存在

GET /api/runtime/file/isFileExisted

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
filename	query	string	否	none
filepath	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 文件下载

GET /api/runtime/file/download

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
filename	query	string	否	文件名
filepath	query	string	否	文件相对路径
watermarkStr	query	string	否	水印名

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

数据模型

文档更新时间: 2023-09-12 11:51 作者：admin