云扩控制台API文档

1 文档概述

本文档描述了控制台产品对外提供的API接口的详细描述，包括接口用途、请求格式、返回格式和请求实例等。

2 面向对象

本文档主要面向以下对象：

● 二次开发工程师

3 调用方式

3.1 构造请求

3.1.1 服务端点

本文档主要涉及ApiGateway和SSO两个服务端点。ApiGateway为后台接口提供统一的调用入口，SSO负责提供统一的认证鉴权服务。对于需要认证的接口，均需要在Authorization请求头中带上SSO签发的token信息，格式为Authorization: Bearer <token>。

说明： Bearer和<token>之间需留一个空格。

● SaaS服务端点：

SSO: auth.encoo.com

ApiGateway: api.encoo.com

● 私有化服务端点： 默认情况下，非https部署，SSO端口为81，ApiGateway端口为8080。 https部署情况下，为对应域名

SSO: 控制台IP:81或SSO域名

ApiGateway: 控制台IP:8080或ApiGateway域名

3.1.2 请求URI

请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

参数 描述
--
URI-scheme 表示用于传输请求的协议，当前API接口采用HTTPS协议或HTTP协议。
Endpoint 指定承载API服务的服务器域名或IP地址加端口号，即调用API服务的接入地址。
resource-path 资源路径，也即API的请求路径。从具体API的URI模块获取。
query-string 公共请求参数，请求参数前面需要携带“?”，形式为“参数名=参数取值”，例如“AccessKey=d0742694e5784074af7b2c5ecff21455”，参数之间由“&”连接。

3.1.3 请求方法

方法说明
--
GET 请求服务器返回指定资源。
PUT 请求服务器更新指定资源。
POST 请求服务器新增资源或执行特殊操作。
DELETE 请求服务器删除指定资源，如删除对象等。
HEAD 请求服务器资源头部。
PATCH 请求服务器更新资源的部分内容。

3.1.4 请求消息头

公共请求消息头是所有API请求都必需的参数。为减少内容重复，公共请求将不在各API详情中列出。

名称描述示例
---
Content-type 指定请求消息体中的MIME类型 application/json。本系中若未特殊说明通常为application/json,上传文件时通常为application/octet-stream
Content-Length 指定请求消息体的长度 3456。通常可省略，因为HttpClient，PostMan等会自动添加
Authorization 指定用户的认证令牌token Bearer eyJhbGciOiJSUzI1Ni…(后略)即Bearer 拼接通过端口获取到的3.2.2获取到的令牌
CompanyId 需要调用接口获取的信息所在公司Id 40143948-f359-4b9f-949f-ad179bcf1397
DepartmentId 需要调用接口获取的信息所在部门Id 1c3464c8-6939-4b13-ba5d-45f44ed8b671

3.1.5 请求消息体

该部分可选。请求消息体通常以结构化格式（如JSON）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。 若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。

3.2 返回结果

3.2.1 响应消息头

响应消息头包含如下两部分：

● 一个HTTP状态代码，从2xx成功代码到4xx或5xx错误代码，或者可以返回服务定义的状态码。

● 附加响应头字段，如Content-Type响应消息头。 详细的公共响应消息头字段请参考下表

名称 描述 示例
---
Content-Length 服务端返回的消息实体的传输长度，以字节为单位 3456
Content-type 消息体的MIME类型 application/json

3.2.2 响应消息体

该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 以下是通用HTTP状态码说明

HTTP状态码 状态描述 语义
---
200 OK 请求成功
204 NoContent 没有返回信息
400 BadRequest 1．请求参数错误 2．因资源被引用而无法删除
401 Unauthorized 未提供令牌或令牌失效，此令牌为Header中的Authorization字段
404 NotFound 资源未找到
415 Unsupported Media Type 服务端未实现此请求方法，或要传递一个空的Json作为Body，即，”{}”
500 InternalServerError 服务器内部异常

3.3 认证鉴权

认证接口请求目标服务器为SSO，参见【服务端点】

3.3.1 获取令牌

获取用户访问令牌，用于接口调用。

Path： /v2/connect/token

Method： POST

请求参考示例：

{
  "username": "<your_email>",    // 用户名
  "password": "<your_password>"    // 用户密码
}

响应参考示例：

{
  "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVEND...",    // 访问令牌
  "expires_in": 3600,    // 令牌过期时间，单位秒
  "token_type": "Bearer",    // 令牌类型
  "refresh_token": "AFUc6Z7ube1lY4ihUCx...",    // 刷新令牌
  "scope": "this is a string",    // 令牌作用域
  "error": "invalid_grant",    // 错误
  "error_description": "error detail..."    // 错误描述
}


3.3.2 刷新令牌

由于访问令牌生命周期有限，当访问令牌过期时，可使用刷新令牌请求新的访问令牌

说明：刷新令牌仅能使用一次

Path： /v2/connect/refreshtoken

Method： POST

请求参考示例：

{
  "refreshToken": "this is a string"    // 刷新令牌
}

响应参考示例：

{
  "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVEND...",    // 访问令牌
  "expires_in": 3600,    // 令牌过期时间，单位秒
  "token_type": "Bearer",    // 令牌类型
  "refresh_token": "AFUc6Z7ube1lY4ihUCx...",    // 刷新令牌
  "scope": "this is a string",    // 令牌作用域
  "error": "invalid_grant",    // 错误
  "error_description": "error detail..."    // 错误描述
}


3.4 业务接口

● 业务接口请求目标服务器为ApiGateway，参见【服务端点】

● 业务接口请求应使用公共请求消息头，若未特殊说明Content-Type为application/json

4 RPA中心接口

4.1 任务记录

4.1.1 获取任务详情

根据JobId获取任务详情

Path： /openapi/jobs/{id}

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "id": "ad3e31ac-8980-43a0-9266-bdecfb022f3f",    // 唯一标识
  "workflowId": "148eeb2b-9938-4029-ae93-009a265df2d0",    // 流程部署id
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "packageId": "af65447f-8a68-4f65-8526-da6246ea39d5",    // 流程包id
  "packageName": "this is a string",    // 流程包名称
  "packageVersion": "1.0.9",    // 流程包版本号
  "packageVersionId": "bcd6c134-1eca-493e-b69f-c3d2c060cd3d",    // 流程包版本id
  "arguments": [// 参数
    {
      "name": "this is a string",    // 名称
      "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
      "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
      "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
      "assetContent": {// 使用的资产，若未使用资产，则不传此字段
        "name": "this is a string",    // 名称
        "description": "this is a string",    // 备注
        "isRequiredEncryption": false    // 是否加密
      }    
    }
    //,{ 更多元素略 }
  ],    
  "containingQueueId": "b19e7d10-d65a-4ea7-af99-1e6efeb8f423",    // 运行目标机器人组id
  "priority": 2000,    // 优先级，范围:0-5000
  "displayState": "Queued",    // 显示状态:Queued-等待中;Running-运行中;Failed-失败;Cancelled-已取消;Succeeded-成功;Paused-已暂停
  "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
  "message": "this is a string",    // 内容/说明
  "lastRunInstaceId": "6f5991aa-f2a2-429b-855c-87082f4876fc",    // 最近运行实例id
  "lastRobotName": "this is a string",    // 最近运行的机器人名称
  "startedAt": "2022-07-29T12:13:49.790Z",    // 开始运行时间
  "finishedAt": "2022-07-29T12:13:49.790Z",    // 结束运行时间
  "retriedCount": 2,    // 重试计数
  "maxRetryCount": 1,    // 最大重试次数,范围:0-10
  "departmentId": "9a4f049f-fa1e-479d-890e-7b012b590321",    // 部门id
  "companyId": "e20bce36-c239-4251-95ed-3cdf0c0f42bf",    // 公司id
  "cronTriggerId": "4048caea-1fc6-4716-8262-7e2f359f107b",    // 触发的定时器id,非定时器触发时为null
  "jobExecutionPolicy": "AnyTime",    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
  "createdAt": "2022-07-29T12:13:49.790Z",    // 创建时间
  "createdBy": "534d71f9-38fa-4813-b93b-b7c2ab8e812f",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-07-29T12:13:49.790Z",    // 更新时间
  "modifiedBy": "ac6dc477-6aab-4fe8-9f23-0745e2de563b",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "jobStartupType": "Manually",    // 启动方式:Manually-手动;Trigger-定时任务;TaskQueue-任务队列
  "jobStartupId": "75baaaff-04d0-41f9-b524-c1b0f35eedd6",    // 启动方式id，例如定时器id，或任务队列id
  "jobStartupName": "this is a string",    // 启动方式名称,例如定时器名称，或任务队列名称
  "jobGroupId": "2ef33453-9763-4587-b264-9f21e1db3830",    // 所属任务组id
  "seqNum": 78,    // 执行序号
  "step": "this is a string",    // 步骤编号，用于展示
  "jobSubjectId": "4493488f-6e50-4ecd-92e8-1c25fddf8411",    // Job关联体id，默认使用WorkflowId，可指定为自定义Id，用于业务统计
  "jobSubjectName": "this is a string",    // Job关联体名称，默认使用Workflow名称,可指定为自定义内容，用于业务统计
  "jobSubjectType": "this is a string"    // Job关联体类型，默认使用Workflow，可指定为自定义类型，用于业务统计
}


4.1.2 调整任务优先级

根据JobId调整任务优先级，仅适用于等待中的任务

Path： /openapi/jobs/{jobId}/priority

Method： PATCH

请求参考示例：

无内容

响应参考示例：

无内容


4.1.3 取消任务

根据JobId取消等待中或正在运行的任务

Path： /openapi/jobs/{jobId}/requestedstop

Method： PATCH

请求参考示例：

无内容

响应参考示例：

无内容


4.1.4 获取任务执行实例列表

根据JobId获取执行实例列表。
运行实例定义：一个任务（Job）可能运行一次，如果执行失败且设置了重试次数大于0，则可能执行多次，直到成功或用完重试次数，每一次执行我们称之为运行实例(RunInstance)。

Path： /openapi/jobs/{jobId}/runinstances

Method： GET

Query string：

参数名称参数类型描述
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 42,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "departmentId": "f3814598-32cc-42ba-9814-e9c4f8823578",    // 部门id
      "companyId": "badb5789-a018-451a-8098-484ac31facc3",    // 公司id
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "startedAt": "2023-08-28T02:39:13.243Z",    // 开始运行时间
      "finishedAt": "2023-08-28T02:39:13.244Z",    // 结束运行时间
      "workflowId": "ece8edee-3a75-42d7-99a6-98f4c68b2de4",    // 流程部署id
      "queueId": "02ae7422-afc3-4646-ba38-181219a6e2e3",    // 
      "jobId": "a213e173-95da-4309-b144-695317a95285",    // JobId
      "retryCount": 32,    // 重试次数
      "robotId": "435889cd-d846-438c-ae83-912fe23c510e",    // 机器人Id
      "robotName": "this is a string",    // 机器人名称
      "robotCreatedAt": "2023-08-28T02:39:13.244Z",    // 机器人创建时间
      "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
      "displayState": "Running",    // 显示状态:Running-运行中;Failed-失败;Cancelled-已取消;Succeeded-成功;Paused-已暂停
      "message": "this is a string",    // 内容/说明
      "packageId": "d2cca86a-7c7b-4667-b2d3-0026f5859141",    // 流程包id
      "packageName": "this is a string",    // 流程包名称
      "arguments": [// 参数
        {
          "name": "this is a string",    // 名称
          "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
          "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
          "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
          "assetContent": {// 使用的资产，若未使用资产，则不传此字段
            "name": "this is a string",    // 名称
            "description": "this is a string",    // 备注
            "isRequiredEncryption": false    // 是否加密
          }    
        }
        //,{ 更多元素略 }
      ],    
      "packageVersionId": "0036e263-7eee-4017-8ed7-cf5b8f85d76e",    // 流程包版本id
      "packageVersion": "1.0.9",    // 流程包版本号
      "executionTimeout": UInt32,    // 执行超时时间
      "runAsAdministrator": false,    // 是否以管理员权限运行
      "robotSdkVersion": "this is a string",    // RobotSdk版本
      "logFiled": false,    // 日志是否存档
      "createdAt": "2023-08-28T02:39:13.245Z",    // 创建时间
      "createdBy": "b21b660d-f4a7-4543-bc00-16d2795077dc",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedAt": "2023-08-28T02:39:13.245Z",    // 更新时间
      "modifiedBy": "47869c30-3ca1-40c4-ae4e-35789d2116b5",    // 更新人id
      "modifiedByName": "administrator"    // 更新人名称
    }
    //,{ 更多元素略 }
  ]    
}


4.1.5 获取流程运行日志

根据RuninstanceId获取流程执行日志

Path： /openapi/runinstances/{id}/logs

Method： GET

Query string：

参数名称参数类型描述
limitInt获取数量限制
lastPartitionKeyString上次查询返回的PartitionKey,首次查询时不传
lastRowKeyString上次查询返回的RowKey，首次查询时不传
logTypeString日志类型(1.System-系统日志;2.LogActivity-业务日志)
logLevelString日志级别(1.Debug-调试;2.Info-信息;3.Error-错误)

请求参考示例：

无内容

响应参考示例：

{
  "nextPage": {// 基准项，基于前次结果向后分页查询
    "partitionKey": "this is a string",    // 下次查询基准分区
    "rowKey": "this is a string"    // 下次查询基准行
  },    
  "data": [// 数据内容
    {
      "runInstanceId": "a7f62ea9-eefb-4e6d-9a51-f972ba55f376",    // 执行实例Id
      "message": "this is a string",    // 内容/说明
      "fileName": "this is a string",    // 错误截图地址,当前步骤出错时才有值
      "logLevel": "Info",    // 日志级别(1.Debug-调试;2.Info-信息;3.Error-错误)
      "logType": "LogActivity"    // 日志类型(1.System-系统日志;2.LogActivity-业务日志)
    }
    //,{ 更多元素略 }
  ]    
}


4.2 流程包管理

4.2.1 查询流程包列表

根据参数查询对应的流程包列表

Path： /openapi/packages

Method： GET

Query string：

参数名称参数类型描述
includeVersionsBoolean是否包含所有版本
searchStringString关键字，模糊匹配名称、备注、标签
nameString名称
isDescBoolean是否按创建时间降序排序，默认true,说明:true-降序；false-升序
startTimeDateTime开始时间，格式:"2022-07-29T12:13:49.780Z"
endTimeDateTime结束时间，格式:"2022-07-29T12:13:49.780Z"
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 58,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "ee190999-9a73-423b-9fc8-6dde2d91d9f0",    // 唯一标识
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "totalDownloads": 64,    // 下载计数
      "lastVersion": "1.0.9",    // 最新版本号
      "lastVersionId": "06e19272-2b7d-470e-8227-f27418517f13",    // 最高版本id
      "createdAt": "2022-07-29T12:13:49.781Z",    // 创建时间
      "modifiedAt": "2022-07-29T12:13:49.781Z",    // 更新时间
      "createdBy": "7aa3d616-b6ea-470e-8205-e50dc886b033",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedBy": "6146fed5-e624-4e2e-8e59-8e4a94af1932",    // 更新人id
      "modifiedByName": "administrator",    // 更新人名称
      "tags": ["this is a string","this is a string"],    // 标签
      "companyId": "dc120332-1f02-40b3-af01-3de313c51331",    // 公司id
      "departmentId": "6e75d6af-4bed-4c31-bd33-51861e9e4792",    // 部门id
      "iconUrl": "this is a string",    // 图标存放地址
      "fullDescription": "this is a string",    // 备注详情
      "versions": [// 版本列表
        {
          "id": "2326bcbc-ebb9-48ad-8f23-338f9307994d",    // 唯一标识
          "packageId": "35282205-087c-4968-8d84-1c2af5eb37fb",    // 流程包id
          "version": "this is a string",    // 版本
          "description": "this is a string",    // 备注
          "arguments": [// 参数
            {
              "name": "this is a string",    // 名称
              "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
              "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
              "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
              "assetContent": {// 使用的资产，若未使用资产，则不传此字段
                "name": "this is a string",    // 名称
                "description": "this is a string",    // 备注
                "isRequiredEncryption": false    // 是否加密
              }    
            }
            //,{ 更多元素略 }
          ],    
          "eTag": "this is a string",    // 版本控制标记
          "uploadTime": "2022-07-29T12:13:49.781Z",    // 上传时间
          "totalDownloads": 75,    // 下载计数
          "createdAt": "2022-07-29T12:13:49.781Z",    // 创建时间
          "modifiedAt": "2022-07-29T12:13:49.781Z",    // 更新时间
          "createdBy": "4b973f0c-b298-4062-9ef4-695c58ff42b4",    // 创建人id
          "createdByName": "administrator",    // 创建人名称
          "modifiedBy": "b743f25f-2d81-4c5c-a503-8b8cc92573bb",    // 更新人id
          "modifiedByName": "administrator",    // 更新人名称
          "companyId": "892c2bcb-6619-442a-8e79-7e5e6465bea2",    // 公司id
          "departmentId": "1c23661f-724c-461a-b945-372446f4314e",    // 部门id
          "fullDescription": "this is a string"    // 备注详情
        }
        //,{ 更多元素略 }
      ]    
    }
    //,{ 更多元素略 }
  ]    
}


4.2.2 获取流程包详情

根据packageId获取一个流程包具体的详细信息

Path： /openapi/packages/{packageId}

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "id": "ee190999-9a73-423b-9fc8-6dde2d91d9f0",    // 唯一标识
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "totalDownloads": 64,    // 下载计数
  "lastVersion": "1.0.9",    // 最新版本号
  "lastVersionId": "06e19272-2b7d-470e-8227-f27418517f13",    // 最高版本id
  "createdAt": "2022-07-29T12:13:49.781Z",    // 创建时间
  "modifiedAt": "2022-07-29T12:13:49.781Z",    // 更新时间
  "createdBy": "7aa3d616-b6ea-470e-8205-e50dc886b033",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedBy": "6146fed5-e624-4e2e-8e59-8e4a94af1932",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "tags": ["this is a string","this is a string"],    // 标签
  "companyId": "dc120332-1f02-40b3-af01-3de313c51331",    // 公司id
  "departmentId": "6e75d6af-4bed-4c31-bd33-51861e9e4792",    // 部门id
  "iconUrl": "this is a string",    // 图标存放地址
  "fullDescription": "this is a string",    // 备注详情
  "versions": [// 版本列表
    {
      "id": "2326bcbc-ebb9-48ad-8f23-338f9307994d",    // 唯一标识
      "packageId": "35282205-087c-4968-8d84-1c2af5eb37fb",    // 流程包id
      "version": "this is a string",    // 版本
      "description": "this is a string",    // 备注
      "arguments": [// 参数
        {
          "name": "this is a string",    // 名称
          "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
          "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
          "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
          "assetContent": {// 使用的资产，若未使用资产，则不传此字段
            "name": "this is a string",    // 名称
            "description": "this is a string",    // 备注
            "isRequiredEncryption": false    // 是否加密
          }    
        }
        //,{ 更多元素略 }
      ],    
      "eTag": "this is a string",    // 版本控制标记
      "uploadTime": "2022-07-29T12:13:49.781Z",    // 上传时间
      "totalDownloads": 75,    // 下载计数
      "createdAt": "2022-07-29T12:13:49.781Z",    // 创建时间
      "modifiedAt": "2022-07-29T12:13:49.781Z",    // 更新时间
      "createdBy": "4b973f0c-b298-4062-9ef4-695c58ff42b4",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedBy": "b743f25f-2d81-4c5c-a503-8b8cc92573bb",    // 更新人id
      "modifiedByName": "administrator",    // 更新人名称
      "companyId": "892c2bcb-6619-442a-8e79-7e5e6465bea2",    // 公司id
      "departmentId": "1c23661f-724c-461a-b945-372446f4314e",    // 部门id
      "fullDescription": "this is a string"    // 备注详情
    }
    //,{ 更多元素略 }
  ]    
}


4.2.3 更新流程包

根据流程包packageId更新流程包描述和标签

Path： /openapi/packages/{packageId}

Method： PATCH

请求参考示例：

{
  "eTag": "this is a string",    // 版本控制标记
  "tags": ["this is a string","this is a string"]    // 标签
}

响应参考示例：

{
  "id": "ee190999-9a73-423b-9fc8-6dde2d91d9f0",    // 唯一标识
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "totalDownloads": 64,    // 下载计数
  "lastVersion": "1.0.9",    // 最新版本号
  "lastVersionId": "06e19272-2b7d-470e-8227-f27418517f13",    // 最高版本id
  "createdAt": "2022-07-29T12:13:49.781Z",    // 创建时间
  "modifiedAt": "2022-07-29T12:13:49.781Z",    // 更新时间
  "createdBy": "7aa3d616-b6ea-470e-8205-e50dc886b033",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedBy": "6146fed5-e624-4e2e-8e59-8e4a94af1932",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "tags": ["this is a string","this is a string"],    // 标签
  "companyId": "dc120332-1f02-40b3-af01-3de313c51331",    // 公司id
  "departmentId": "6e75d6af-4bed-4c31-bd33-51861e9e4792",    // 部门id
  "iconUrl": "this is a string",    // 图标存放地址
  "fullDescription": "this is a string",    // 备注详情
  "versions": [// 版本列表
    {
      "id": "2326bcbc-ebb9-48ad-8f23-338f9307994d",    // 唯一标识
      "packageId": "35282205-087c-4968-8d84-1c2af5eb37fb",    // 流程包id
      "version": "this is a string",    // 版本
      "description": "this is a string",    // 备注
      "arguments": [// 参数
        {
          "name": "this is a string",    // 名称
          "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
          "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
          "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
          "assetContent": {// 使用的资产，若未使用资产，则不传此字段
            "name": "this is a string",    // 名称
            "description": "this is a string",    // 备注
            "isRequiredEncryption": false    // 是否加密
          }    
        }
        //,{ 更多元素略 }
      ],    
      "eTag": "this is a string",    // 版本控制标记
      "uploadTime": "2022-07-29T12:13:49.781Z",    // 上传时间
      "totalDownloads": 75,    // 下载计数
      "createdAt": "2022-07-29T12:13:49.781Z",    // 创建时间
      "modifiedAt": "2022-07-29T12:13:49.781Z",    // 更新时间
      "createdBy": "4b973f0c-b298-4062-9ef4-695c58ff42b4",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedBy": "b743f25f-2d81-4c5c-a503-8b8cc92573bb",    // 更新人id
      "modifiedByName": "administrator",    // 更新人名称
      "companyId": "892c2bcb-6619-442a-8e79-7e5e6465bea2",    // 公司id
      "departmentId": "1c23661f-724c-461a-b945-372446f4314e",    // 部门id
      "fullDescription": "this is a string"    // 备注详情
    }
    //,{ 更多元素略 }
  ]    
}


4.2.4 删除流程包

根据packageId删除流程包

Path： /openapi/packages/{packageId}

Method： DELETE

请求参考示例：

无内容

响应参考示例：

无内容


4.2.5 上传流程包并创建信息

上传流程包文件并生成流程包版本信息。 注意：当流程包（.dgs 文件）大于 200M 时，创建流程包应按如下步骤实施：

  1. 获取上传通道/地址，参见【生成流程包上传地址】

  2. 上传流程包 dgs 文件，参见【通用上传文件流地址】

  3. 通知完成上传，参见【通知流程包上传完成】

Path： /openapi/packages

Method： PUT

请求参考示例：

注意：请求头信息Content-Type应设置application/octet-stream

[二进制文件流数据]

响应参考示例：

{
  "packageId": "842e892d-dc3b-48ce-ab50-1c9be3fb0721",    // 流程包id
  "packageVersionId": "58975958-4289-4c0e-a800-14311c0444d9",    // 流程包版本id
  "packageName": "this is a string",    // 流程包名称
  "lastVersion": "1.0.9"    // 最新版本号
}


4.2.6 生成流程包上传地址

在不知道 dgs 信息的情况下创建上传通道

Path： /openapi/preloadedVersionFiles

Method： POST

请求参考示例：

无内容

响应参考示例：

{
  "id": "1b528e05-69bd-4ccc-91bd-1b4a07bc7e63",    // 唯一标识
  "channel": {// 上传通道
    "uri": "this is a string",    // Url地址
    "headers": {"Content-Type":"application/octet-stream"}    // 请求Headers
  },    
  "createdAt": "2022-07-29T12:13:49.782Z",    // 创建时间
  "companyId": "5ed1a0ed-b1e3-41a4-b875-f5432af4f606",    // 公司id
  "departmentId": "cec896b0-c7ac-4532-8197-e94fa637927e"    // 部门id
}


4.2.7 通用上传文件流地址

通过获取上传地址后将文件通过该接口上传至控制台

Path： 通过【生成流程包上传地址】获取到的uri地址

Method： PUT

请求参考示例：

注意：需将【生成流程包上传地址】返回的headers数据以键值对方式填写在该接口的HTTP Headers中

[二进制文件流数据]

响应参考示例：

无内容


4.2.8 通知流程包上传完成

通过上传地址完成上传文件后调用该接口, 路径中id为【生成流程包上传地址】返回的Id

Path： /openapi/preloadedVersionFiles/{id}

Method： PATCH

请求参考示例：

无内容

响应参考示例：

{
  "packageId": "842e892d-dc3b-48ce-ab50-1c9be3fb0721",    // 流程包id
  "packageVersionId": "58975958-4289-4c0e-a800-14311c0444d9",    // 流程包版本id
  "packageName": "this is a string",    // 流程包名称
  "lastVersion": "1.0.9"    // 最新版本号
}


4.3 机器人组管理

4.3.1 查询机器人组列表

根据指定条件查询机器人组列表

Path： /openapi/queues

Method： GET

Query string：

参数名称参数类型描述
includeRobotCountBoolean包含机器人数量
tagsString标签
startTimeDateTime开始时间，格式:"2024-04-09T06:04:38.129Z"
endTimeDateTime结束时间，格式:"2024-04-09T06:04:38.133Z"
searchStringString关键字，模糊匹配名称、备注、标签
isDescBoolean是否按创建时间降序排序，默认true,说明:true-降序；false-升序
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 22,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "0dc930eb-2e40-446f-93b1-c93c019fb914",    // 唯一标识
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "tags": ["this is a string","this is a string"],    // 标签
      "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
      "createdAt": "2022-07-29T12:13:49.783Z",    // 创建时间
      "createdBy": "948e1573-2dbc-4c42-81e3-495e41f6aaba",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedAt": "2022-07-29T12:13:49.783Z",    // 更新时间
      "modifiedBy": "4540b03c-814d-4d48-ab2e-0ced36bb9e0c",    // 更新人id
      "modifiedByName": "administrator",    // 更新人名称
      "robotCount": 76,    // 包含机器人数量
      "companyId": "5170669b-fb34-4af2-bc79-51dd05241da0",    // 公司id
      "departmentId": "ac87d0c2-3db0-4c50-9a0f-d4bdadb55542"    // 部门id
    }
    //,{ 更多元素略 }
  ]    
}


4.3.2 根据id获取机器人组信息

根据Id获取机器人组

Path： /openapi/queues/{queueId}

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "id": "0dc930eb-2e40-446f-93b1-c93c019fb914",    // 唯一标识
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "createdAt": "2022-07-29T12:13:49.783Z",    // 创建时间
  "createdBy": "948e1573-2dbc-4c42-81e3-495e41f6aaba",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-07-29T12:13:49.783Z",    // 更新时间
  "modifiedBy": "4540b03c-814d-4d48-ab2e-0ced36bb9e0c",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "robotCount": 76,    // 包含机器人数量
  "companyId": "5170669b-fb34-4af2-bc79-51dd05241da0",    // 公司id
  "departmentId": "ac87d0c2-3db0-4c50-9a0f-d4bdadb55542"    // 部门id
}


4.3.3 删除机器人组

根据Id删除机器人组

Path： /openapi/queues/{queueId}

Method： DELETE

请求参考示例：

无内容

响应参考示例：

无内容


4.3.4 更新机器人组信息

根据Id更新机器人组信息

Path： /openapi/queues/{queueId}

Method： PATCH

请求参考示例：

{
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"]    // 标签
}

响应参考示例：

{
  "id": "0dc930eb-2e40-446f-93b1-c93c019fb914",    // 唯一标识
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "createdAt": "2022-07-29T12:13:49.783Z",    // 创建时间
  "createdBy": "948e1573-2dbc-4c42-81e3-495e41f6aaba",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-07-29T12:13:49.783Z",    // 更新时间
  "modifiedBy": "4540b03c-814d-4d48-ab2e-0ced36bb9e0c",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "robotCount": 76,    // 包含机器人数量
  "companyId": "5170669b-fb34-4af2-bc79-51dd05241da0",    // 公司id
  "departmentId": "ac87d0c2-3db0-4c50-9a0f-d4bdadb55542"    // 部门id
}


4.3.5 创建机器人组

创建机器人组

Path： /openapi/queues/{queueId}

Method： POST

请求参考示例：

{
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "companyId": "f0f31fa4-a85b-413e-a9d5-d6c2b650eb41",    // 公司id
  "departmentId": "5c353854-3640-4c1e-8275-0375ac7a49ad",    // 部门id
  "createBy": "25540342-ac36-4003-a665-14793a005078",    // 创建人id
  "createByName": "this is a string"    // 创建人名称
}

响应参考示例：

{
  "id": "0dc930eb-2e40-446f-93b1-c93c019fb914",    // 唯一标识
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "createdAt": "2022-07-29T12:13:49.783Z",    // 创建时间
  "createdBy": "948e1573-2dbc-4c42-81e3-495e41f6aaba",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-07-29T12:13:49.783Z",    // 更新时间
  "modifiedBy": "4540b03c-814d-4d48-ab2e-0ced36bb9e0c",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "robotCount": 76,    // 包含机器人数量
  "companyId": "5170669b-fb34-4af2-bc79-51dd05241da0",    // 公司id
  "departmentId": "ac87d0c2-3db0-4c50-9a0f-d4bdadb55542"    // 部门id
}


4.3.6 查询机器人组包含的机器人

根据机器人组id查询包含的机器人

Path： /openapi/queues/{queueId}/robots

Method： GET

Query string：

参数名称参数类型描述
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 41,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "545b37c3-286a-4296-9b40-e89b974a3b93",    // 唯一标识
      "currentDeviceId": "7ab942da-9e6f-43db-8149-46472a639b08",    // 当前所在设备的id
      "lastHeartbeatTime": "2022-07-29T12:13:49.788Z",    // 最近心跳时间
      "companyId": "d572ed1f-c4e8-4335-bbb7-4f882199cf7f",    // 公司id
      "departmentId": "fea0120a-eafa-49d1-b2ab-521e8db183b5",    // 部门id
      "sdkVersion": "this is a string",    // 机器人sdk版本
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "canUpgrade": false,    // 是否可升级
      "licenseStatus": "Unlicensed",    // 许可状态:Unlicensed-未许可;ClientLicensed-本地许可;ServerLicensed-控制台许可;PoolLicensed-浮动许可
      "clientSku": "this is a string",    // 机器人许可类型
      "version": "this is a string",    // 版本
      "status": "Disconnected"    // 状态:Disconnected-已断开;Ready-空闲;Busy-忙碌
    }
    //,{ 更多元素略 }
  ]    
}


4.3.7 更新机器人组包含的机器人

根据机器人组id更新包含的机器人

Path： /openapi/queues/{queueId}/robots

Method： PATCH

请求参考示例：

{
  "robotIds": ["71629409-bef1-486d-ad04-b45856de9ea8","71629409-bef1-486d-ad04-b45856de9ea8"]    // 机器人id列表
}

响应参考示例：

无内容


4.4 机器人管理

4.4.1 查询机器人列表

根据指定查询条件，获取机器人列表

Path： /openapi/robots

Method： GET

Query string：

参数名称参数类型描述
nameString名称
tagsString标签
searchStringString关键字，模糊匹配名称、备注、标签
isDescBoolean是否按创建时间降序排序，默认true,说明:true-降序；false-升序
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 41,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "545b37c3-286a-4296-9b40-e89b974a3b93",    // 唯一标识
      "currentDeviceId": "7ab942da-9e6f-43db-8149-46472a639b08",    // 当前所在设备的id
      "lastHeartbeatTime": "2022-07-29T12:13:49.788Z",    // 最近心跳时间
      "companyId": "d572ed1f-c4e8-4335-bbb7-4f882199cf7f",    // 公司id
      "departmentId": "fea0120a-eafa-49d1-b2ab-521e8db183b5",    // 部门id
      "sdkVersion": "this is a string",    // 机器人sdk版本
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "canUpgrade": false,    // 是否可升级
      "licenseStatus": "Unlicensed",    // 许可状态:Unlicensed-未许可;ClientLicensed-本地许可;ServerLicensed-控制台许可;PoolLicensed-浮动许可
      "clientSku": "this is a string",    // 机器人许可类型
      "version": "this is a string",    // 版本
      "status": "Disconnected"    // 状态:Disconnected-已断开;Ready-空闲;Busy-忙碌
    }
    //,{ 更多元素略 }
  ]    
}


4.4.2 获取机器人详情

根据id获取机器人详情

Path： /openapi/robots/{robotId}

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "id": "545b37c3-286a-4296-9b40-e89b974a3b93",    // 唯一标识
  "currentDeviceId": "7ab942da-9e6f-43db-8149-46472a639b08",    // 当前所在设备的id
  "lastHeartbeatTime": "2022-07-29T12:13:49.788Z",    // 最近心跳时间
  "companyId": "d572ed1f-c4e8-4335-bbb7-4f882199cf7f",    // 公司id
  "departmentId": "fea0120a-eafa-49d1-b2ab-521e8db183b5",    // 部门id
  "sdkVersion": "this is a string",    // 机器人sdk版本
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "canUpgrade": false,    // 是否可升级
  "licenseStatus": "Unlicensed",    // 许可状态:Unlicensed-未许可;ClientLicensed-本地许可;ServerLicensed-控制台许可;PoolLicensed-浮动许可
  "clientSku": "this is a string",    // 机器人许可类型
  "version": "this is a string",    // 版本
  "status": "Disconnected"    // 状态:Disconnected-已断开;Ready-空闲;Busy-忙碌
}


4.5 任务队列

任务队列 主要用于监听业务数据并触发给相应的流程部署或机器人运行

您可以通过接口对消息进行处理，但无法改变任务队列本身-若要创建、配置、删除任务队列，请在控制台页面进行操作

4.5.1 新增消息

根据消息名称增加消息

Path： /openapi/taskqueues/{queueName}/messages

queueNameString不是显示名称，应使用页面上“队列标识”

Method： POST

Query string：

参数名称参数类型描述
visibilitytimeoutInt可见超时时间，单位：秒；默认值：0
messagettlInt消息有效时间，单位：秒；默认值：604800

请求参考示例：

{
  "messageText": "this is a string"    // 消息文本
}

响应参考示例：

{
  "id": "this is a string",    // 唯一标识
  "messageText": "this is a string",    // 消息文本
  "nextVisibleTime": "2022-09-19T07:32:15.057Z",    // 下次可见时间,UTC时间
  "expirationTime": "2022-09-19T07:32:15.063Z",    // 消息有效时间,UTC时间
  "insertionTime": "2022-09-19T07:32:15.069Z",    // 消息入队时间,UTC时间
  "popReceipt": "this is a string",    // 当设置query参数的visibilitytimeout时，操作消息的附加凭据，主凭据为消息Id
  "dequeueCount": 31    // 出队次数
}


4.5.2 查看消息记录

查看消息记录

Path： /openapi/taskqueues/{queueName}/messages

queueNameString不是显示名称，应使用页面上“队列标识”

Method： GET

Query string：

参数名称参数类型描述
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 24,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "5cb8844d-0a56-428f-acbc-78735ff594f2",    // 唯一标识
      "status": "Reserved",    // 状态:Reserved;ToDo;Done;Deleted
      "taskQueueId": "daae5e5a-b10d-43a4-83b7-700c1115ba49",    // 所属任务队列ID
      "messageText": "this is a string",    // 消息文本
      "nextVisibleTime": "2022-09-23T11:20:20.338Z",    // 下次可见时间,UTC时间
      "expirationTime": "2022-09-23T11:20:20.340Z",    // 消息有效时间,UTC时间
      "insertionTime": "2022-09-23T11:20:20.340Z",    // 消息入队时间,UTC时间
      "popReceipt": "this is a string",    // 弹出凭证
      "workflowId": "2b6a73d8-e6b1-4006-aaf8-889165a6dd1d",    // 流程部署id
      "jobIdList": ["9554e3c5-2f8b-4c19-8b68-24928c426df6","9554e3c5-2f8b-4c19-8b68-24928c426df6"]    // 任务记录ID列表
    }
    //,{ 更多元素略 }
  ]    
}


4.5.3 根据消息Id和附加凭据删除消息

根据消息Id和附加凭据删除消息

Path： /openapi/taskqueues/{queueName}/messages/{messageId}

queueNameString不是显示名称，应使用页面上“队列标识”
messageIdString消息Id

Method： DELETE

Query string：

参数名称参数类型描述
popReceiptString消息的附加凭据

请求参考示例：

无内容

响应参考示例：

无内容


4.5.4 清除指定队列中所有消息

清除指定队列中所有消息，如果数量较大可能会超时并返回服务器内部错误，客户端需要重试

Path： /openapi/taskqueues/{queueName}/messages

queueNameString不是显示名称，应使用页面上“队列标识”

Method： DELETE

请求参考示例：

无内容

响应参考示例：

无内容


4.6 流程部署管理

4.6.1 查询流程部署列表

根据指定查询条件，获取流程部署列表

Path： /openapi/workflows

Method： GET

Query string：

参数名称参数类型描述
nameString名称
searchStringString关键字，模糊匹配
isDescBoolean是否按创建时间降序排序，默认true,说明:true-降序；false-升序
associatedQueueIdString（执行目标）机器人组id，格式:guid/uuid
packageIdString流程包id，格式:guid/uuid
packageVersionIdString流程包版本id，格式:guid/uuid
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 17,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "ac87fd69-af43-4378-984a-ca806f826e50",    // 唯一标识
      "departmentId": "01b6ca01-0e54-45a5-8a11-533157f16599",    // 部门id
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "arguments": [// 参数
        {
          "name": "this is a string",    // 名称
          "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
          "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
          "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
          "assetContent": {// 使用的资产，若未使用资产，则不传此字段
            "name": "this is a string",    // 名称
            "description": "this is a string",    // 备注
            "isRequiredEncryption": false    // 是否加密
          }    
        }
        //,{ 更多元素略 }
      ],    
      "tags": ["this is a string","this is a string"],    // 标签
      "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
      "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
      "jobStateNotification": {// 运行状态通知
        "switchOn": false,    // 通知功能是否启用
        "conditions": ["Failed"],    // 通知条件:Failed-失败;Cancelled-已取消;Succeeded-成功;Finished-完成
        "recipients": ["test111@qq.com","test222@qq.com"]    // 接收人列表
      },    
      "packageName": "this is a string",    // 流程包名称
      "packageId": "9e34c367-9d32-4890-afb9-235e06490c92",    // 流程包id
      "packageVersionId": "bf6a36a7-0fe5-4174-a80e-e86d578585d9",    // 流程包版本id
      "packageVersion": "1.0.9",    // 流程包版本号
      "associatedQueueId": "7a69bce7-f6b4-40c8-86a9-57529cb3c890",    // （执行目标）机器人组id
      "priority": 2000,    // 优先级，范围:0-5000
      "maxRetryCount": 1,    // 最大重试次数,范围:0-10
      "triggerPolicy": "AnyTime",    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
      "lastTriggeredAt": "2022-07-29T12:13:49.787Z",    // 最后触发时间
      "triggeredCount": 80,    // 触发计数
      "createdAt": "2022-07-29T12:13:49.787Z",    // 创建时间
      "createdBy": "86f58195-c889-4bd2-ae4f-d23f9aead58a",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedAt": "2022-07-29T12:13:49.787Z",    // 更新时间
      "modifiedBy": "d8a954e6-d40c-456b-a569-d2126741068f",    // 更新人id
      "modifiedByName": "administrator",    // 更新人名称
      "companyId": "48c412a1-2940-4100-80e2-046faf7f958e"    // 公司id
    }
    //,{ 更多元素略 }
  ]    
}


4.6.2 获取流程部署详情

根据id获取流程部署详情

Path： /openapi/workflows/{workflowId}

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "id": "ac87fd69-af43-4378-984a-ca806f826e50",    // 唯一标识
  "departmentId": "01b6ca01-0e54-45a5-8a11-533157f16599",    // 部门id
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "arguments": [// 参数
    {
      "name": "this is a string",    // 名称
      "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
      "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
      "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
      "assetContent": {// 使用的资产，若未使用资产，则不传此字段
        "name": "this is a string",    // 名称
        "description": "this is a string",    // 备注
        "isRequiredEncryption": false    // 是否加密
      }    
    }
    //,{ 更多元素略 }
  ],    
  "tags": ["this is a string","this is a string"],    // 标签
  "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "jobStateNotification": {// 运行状态通知
    "switchOn": false,    // 通知功能是否启用
    "conditions": ["Failed"],    // 通知条件:Failed-失败;Cancelled-已取消;Succeeded-成功;Finished-完成
    "recipients": ["test111@qq.com","test222@qq.com"]    // 接收人列表
  },    
  "packageName": "this is a string",    // 流程包名称
  "packageId": "9e34c367-9d32-4890-afb9-235e06490c92",    // 流程包id
  "packageVersionId": "bf6a36a7-0fe5-4174-a80e-e86d578585d9",    // 流程包版本id
  "packageVersion": "1.0.9",    // 流程包版本号
  "associatedQueueId": "7a69bce7-f6b4-40c8-86a9-57529cb3c890",    // （执行目标）机器人组id
  "priority": 2000,    // 优先级，范围:0-5000
  "maxRetryCount": 1,    // 最大重试次数,范围:0-10
  "triggerPolicy": "AnyTime",    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
  "lastTriggeredAt": "2022-07-29T12:13:49.787Z",    // 最后触发时间
  "triggeredCount": 80,    // 触发计数
  "createdAt": "2022-07-29T12:13:49.787Z",    // 创建时间
  "createdBy": "86f58195-c889-4bd2-ae4f-d23f9aead58a",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-07-29T12:13:49.787Z",    // 更新时间
  "modifiedBy": "d8a954e6-d40c-456b-a569-d2126741068f",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "companyId": "48c412a1-2940-4100-80e2-046faf7f958e"    // 公司id
}


4.6.3 创建流程部署

创建流程部署

Path： /openapi/workflows

Method： POST

请求参考示例：

{
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "arguments": [// 参数
    {
      "name": "this is a string",    // 名称
      "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
      "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
      "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
      "assetContent": {// 使用的资产，若未使用资产，则不传此字段
        "name": "this is a string",    // 名称
        "description": "this is a string",    // 备注
        "isRequiredEncryption": false    // 是否加密
      }    
    }
    //,{ 更多元素略 }
  ],    
  "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
  "jobStateNotification": {// 运行状态通知
    "switchOn": false,    // 通知功能是否启用
    "conditions": ["Failed"],    // 通知条件:Failed-失败;Cancelled-已取消;Succeeded-成功;Finished-完成
    "recipients": ["test111@qq.com","test222@qq.com"]    // 接收人列表
  },    
  "packageName": "this is a string",    // 流程包名称
  "packageId": "b0adccf0-97a7-4d27-9dc5-ede4096c3ffb",    // 流程包id
  "packageVersionId": "b544c811-2cc7-4b5a-8b98-fd724a2331e2",    // 流程包版本id
  "packageVersion": "1.0.9",    // 流程包版本号
  "associatedQueueId": "d677ae87-8274-485a-a918-76ee9e9fb772",    // （执行目标）机器人组id
  "priority": 2000,    // 优先级，范围:0-5000
  "maxRetryCount": 1,    // 最大重试次数,范围:0-10
  "triggerPolicy": "AnyTime"    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
}

响应参考示例：

{
  "id": "ac87fd69-af43-4378-984a-ca806f826e50",    // 唯一标识
  "departmentId": "01b6ca01-0e54-45a5-8a11-533157f16599",    // 部门id
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "arguments": [// 参数
    {
      "name": "this is a string",    // 名称
      "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
      "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
      "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
      "assetContent": {// 使用的资产，若未使用资产，则不传此字段
        "name": "this is a string",    // 名称
        "description": "this is a string",    // 备注
        "isRequiredEncryption": false    // 是否加密
      }    
    }
    //,{ 更多元素略 }
  ],    
  "tags": ["this is a string","this is a string"],    // 标签
  "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "jobStateNotification": {// 运行状态通知
    "switchOn": false,    // 通知功能是否启用
    "conditions": ["Failed"],    // 通知条件:Failed-失败;Cancelled-已取消;Succeeded-成功;Finished-完成
    "recipients": ["test111@qq.com","test222@qq.com"]    // 接收人列表
  },    
  "packageName": "this is a string",    // 流程包名称
  "packageId": "9e34c367-9d32-4890-afb9-235e06490c92",    // 流程包id
  "packageVersionId": "bf6a36a7-0fe5-4174-a80e-e86d578585d9",    // 流程包版本id
  "packageVersion": "1.0.9",    // 流程包版本号
  "associatedQueueId": "7a69bce7-f6b4-40c8-86a9-57529cb3c890",    // （执行目标）机器人组id
  "priority": 2000,    // 优先级，范围:0-5000
  "maxRetryCount": 1,    // 最大重试次数,范围:0-10
  "triggerPolicy": "AnyTime",    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
  "lastTriggeredAt": "2022-07-29T12:13:49.787Z",    // 最后触发时间
  "triggeredCount": 80,    // 触发计数
  "createdAt": "2022-07-29T12:13:49.787Z",    // 创建时间
  "createdBy": "86f58195-c889-4bd2-ae4f-d23f9aead58a",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-07-29T12:13:49.787Z",    // 更新时间
  "modifiedBy": "d8a954e6-d40c-456b-a569-d2126741068f",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "companyId": "48c412a1-2940-4100-80e2-046faf7f958e"    // 公司id
}


4.6.4 更新流程部署

根据id更新流程部署详情

Path： /openapi/workflows/{workflowId}

Method： PATCH

请求参考示例：

{
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "arguments": [// 参数
    {
      "name": "this is a string",    // 名称
      "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
      "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
      "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
      "assetContent": {// 使用的资产，若未使用资产，则不传此字段
        "name": "this is a string",    // 名称
        "description": "this is a string",    // 备注
        "isRequiredEncryption": false    // 是否加密
      }    
    }
    //,{ 更多元素略 }
  ],    
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
  "jobStateNotification": {// 运行状态通知
    "switchOn": false,    // 通知功能是否启用
    "conditions": ["Failed"],    // 通知条件:Failed-失败;Cancelled-已取消;Succeeded-成功;Finished-完成
    "recipients": ["test111@qq.com","test222@qq.com"]    // 接收人列表
  },    
  "triggerPolicy": "AnyTime",    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
  "packageName": "this is a string",    // 流程包名称
  "packageVersionId": "afcb66b1-b7e5-4e7d-9ee7-5d7672118e4f",    // 流程包版本id
  "packageVersion": "1.0.9",    // 流程包版本号
  "associatedQueueId": "560f9708-164a-4336-80bf-9b81e49aa2b1",    // （执行目标）机器人组id
  "priority": 2000,    // 优先级，范围:0-5000
  "maxRetryCount": 1    // 最大重试次数,范围:0-10
}

响应参考示例：

{
  "id": "ac87fd69-af43-4378-984a-ca806f826e50",    // 唯一标识
  "departmentId": "01b6ca01-0e54-45a5-8a11-533157f16599",    // 部门id
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "arguments": [// 参数
    {
      "name": "this is a string",    // 名称
      "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
      "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
      "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
      "assetContent": {// 使用的资产，若未使用资产，则不传此字段
        "name": "this is a string",    // 名称
        "description": "this is a string",    // 备注
        "isRequiredEncryption": false    // 是否加密
      }    
    }
    //,{ 更多元素略 }
  ],    
  "tags": ["this is a string","this is a string"],    // 标签
  "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "jobStateNotification": {// 运行状态通知
    "switchOn": false,    // 通知功能是否启用
    "conditions": ["Failed"],    // 通知条件:Failed-失败;Cancelled-已取消;Succeeded-成功;Finished-完成
    "recipients": ["test111@qq.com","test222@qq.com"]    // 接收人列表
  },    
  "packageName": "this is a string",    // 流程包名称
  "packageId": "9e34c367-9d32-4890-afb9-235e06490c92",    // 流程包id
  "packageVersionId": "bf6a36a7-0fe5-4174-a80e-e86d578585d9",    // 流程包版本id
  "packageVersion": "1.0.9",    // 流程包版本号
  "associatedQueueId": "7a69bce7-f6b4-40c8-86a9-57529cb3c890",    // （执行目标）机器人组id
  "priority": 2000,    // 优先级，范围:0-5000
  "maxRetryCount": 1,    // 最大重试次数,范围:0-10
  "triggerPolicy": "AnyTime",    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
  "lastTriggeredAt": "2022-07-29T12:13:49.787Z",    // 最后触发时间
  "triggeredCount": 80,    // 触发计数
  "createdAt": "2022-07-29T12:13:49.787Z",    // 创建时间
  "createdBy": "86f58195-c889-4bd2-ae4f-d23f9aead58a",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-07-29T12:13:49.787Z",    // 更新时间
  "modifiedBy": "d8a954e6-d40c-456b-a569-d2126741068f",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "companyId": "48c412a1-2940-4100-80e2-046faf7f958e"    // 公司id
}


4.6.5 删除流程部署

根据id删除流程部署

Path： /openapi/workflows/{workflowId}

Method： DELETE

请求参考示例：

无内容

响应参考示例：

无内容


4.6.6 执行流程部署

根据id执行流程部署

Path： /openapi/workflows/{workflowId}/execute

Method： POST

请求参考示例：

{
  "arguments": [// 参数,不传时使用流程部署已配置的参数
    {
      "name": "this is a string",    // 名称
      "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
      "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
      "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
      "assetContent": {// 使用的资产，若未使用资产，则不传此字段
        "name": "this is a string",    // 名称
        "description": "this is a string",    // 备注
        "isRequiredEncryption": false    // 是否加密
      }    
    }
    //,{ 更多元素略 }
  ],    
  "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
  "priority": 2000,    // 优先级，范围:0-5000
  "maxRetryCount": 1    // 最大重试次数,范围:0-10
}

响应参考示例：

[
  {
    "id": "ad3e31ac-8980-43a0-9266-bdecfb022f3f",    // 唯一标识
    "workflowId": "148eeb2b-9938-4029-ae93-009a265df2d0",    // 流程部署id
    "name": "this is a string",    // 名称
    "description": "this is a string",    // 备注
    "packageId": "af65447f-8a68-4f65-8526-da6246ea39d5",    // 流程包id
    "packageName": "this is a string",    // 流程包名称
    "packageVersion": "1.0.9",    // 流程包版本号
    "packageVersionId": "bcd6c134-1eca-493e-b69f-c3d2c060cd3d",    // 流程包版本id
    "arguments": [// 参数
      {
        "name": "this is a string",    // 名称
        "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
        "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
        "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
        "assetContent": {// 使用的资产，若未使用资产，则不传此字段
          "name": "this is a string",    // 名称
          "description": "this is a string",    // 备注
          "isRequiredEncryption": false    // 是否加密
        }    
      }
      //,{ 更多元素略 }
    ],    
    "containingQueueId": "b19e7d10-d65a-4ea7-af99-1e6efeb8f423",    // 运行目标机器人组id
    "priority": 2000,    // 优先级，范围:0-5000
    "displayState": "Queued",    // 显示状态:Queued-等待中;Running-运行中;Failed-失败;Cancelled-已取消;Succeeded-成功;Paused-已暂停
    "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
    "message": "this is a string",    // 内容/说明
    "lastRunInstaceId": "6f5991aa-f2a2-429b-855c-87082f4876fc",    // 最近运行实例id
    "lastRobotName": "this is a string",    // 最近运行的机器人名称
    "startedAt": "2022-07-29T12:13:49.790Z",    // 开始运行时间
    "finishedAt": "2022-07-29T12:13:49.790Z",    // 结束运行时间
    "retriedCount": 2,    // 重试计数
    "maxRetryCount": 1,    // 最大重试次数,范围:0-10
    "departmentId": "9a4f049f-fa1e-479d-890e-7b012b590321",    // 部门id
    "companyId": "e20bce36-c239-4251-95ed-3cdf0c0f42bf",    // 公司id
    "cronTriggerId": "4048caea-1fc6-4716-8262-7e2f359f107b",    // 触发的定时器id,非定时器触发时为null
    "jobExecutionPolicy": "AnyTime",    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
    "createdAt": "2022-07-29T12:13:49.790Z",    // 创建时间
    "createdBy": "534d71f9-38fa-4813-b93b-b7c2ab8e812f",    // 创建人id
    "createdByName": "administrator",    // 创建人名称
    "modifiedAt": "2022-07-29T12:13:49.790Z",    // 更新时间
    "modifiedBy": "ac6dc477-6aab-4fe8-9f23-0745e2de563b",    // 更新人id
    "modifiedByName": "administrator",    // 更新人名称
    "jobStartupType": "Manually",    // 启动方式:Manually-手动;Trigger-定时任务;TaskQueue-任务队列
    "jobStartupId": "75baaaff-04d0-41f9-b524-c1b0f35eedd6",    // 启动方式id，例如定时器id，或任务队列id
    "jobStartupName": "this is a string",    // 启动方式名称,例如定时器名称，或任务队列名称
    "jobGroupId": "2ef33453-9763-4587-b264-9f21e1db3830",    // 所属任务组id
    "seqNum": 78,    // 执行序号
    "step": "this is a string",    // 步骤编号，用于展示
    "jobSubjectId": "4493488f-6e50-4ecd-92e8-1c25fddf8411",    // Job关联体id，默认使用WorkflowId，可指定为自定义Id，用于业务统计
    "jobSubjectName": "this is a string",    // Job关联体名称，默认使用Workflow名称,可指定为自定义内容，用于业务统计
    "jobSubjectType": "this is a string"    // Job关联体类型，默认使用Workflow，可指定为自定义类型，用于业务统计
  }
  //,{ 更多元素略 }
]


4.6.7 获取流程部署关联机器人列表

根据指定流程部署Id，获取流程部署关联的机器人列表

Path： /openapi/workflows/{workflowId}/robots

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "count": 41,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "545b37c3-286a-4296-9b40-e89b974a3b93",    // 唯一标识
      "currentDeviceId": "7ab942da-9e6f-43db-8149-46472a639b08",    // 当前所在设备的id
      "lastHeartbeatTime": "2022-07-29T12:13:49.788Z",    // 最近心跳时间
      "companyId": "d572ed1f-c4e8-4335-bbb7-4f882199cf7f",    // 公司id
      "departmentId": "fea0120a-eafa-49d1-b2ab-521e8db183b5",    // 部门id
      "sdkVersion": "this is a string",    // 机器人sdk版本
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "canUpgrade": false,    // 是否可升级
      "licenseStatus": "Unlicensed",    // 许可状态:Unlicensed-未许可;ClientLicensed-本地许可;ServerLicensed-控制台许可;PoolLicensed-浮动许可
      "clientSku": "this is a string",    // 机器人许可类型
      "version": "this is a string",    // 版本
      "status": "Disconnected"    // 状态:Disconnected-已断开;Ready-空闲;Busy-忙碌
    }
    //,{ 更多元素略 }
  ]    
}


4.6.8 批量增加流程部署关联机器人

根据指定流程部署Id，为流程部署关联执行使用的机器人

Path： /openapi/workflows/{workflowId}/robots

Method： POST

请求参考示例：

{
  "robotIds": ["8a11ba8f-66b3-44ec-a8c2-fd10fca58c9a","8a11ba8f-66b3-44ec-a8c2-fd10fca58c9a"]    // 机器人id列表
}

响应参考示例：

[
  {
    "workflowId": "ba41bc8e-d636-4c01-9d7c-e4027799eb57",    // 流程部署id
    "robotId": "4f8065b9-5569-42d3-a2cc-920abea214de",    // 机器人Id
    "errorMessage": "this is a string"    // 关联失败原因
  }
  //,{ 更多元素略 }
]


4.6.9 删除流程部署执行目标机器人

根据指定流程部署Id，为流程部署移除关联的机器人

Path： /openapi/workflows/{workflowId}/robots/{robotId}

Method： DELETE

请求参考示例：

无内容

响应参考示例：

无内容


4.6.10 批量更新关联的流程包到最新版本

批量更新流程部署，使其使用最新版本流程包

Path： /openapi/workflows/batch/upgrade

Method： POST

请求参考示例：

{
  "workflowIds": ["970d4d24-81db-4ca4-8509-153195d10e83","970d4d24-81db-4ca4-8509-153195d10e83"]    // 流程部署id列表
}

响应参考示例：

{
  "total": 20,    // 批量操作总数目
  "successCount": 18,    // 成功数量
  "failureCount": 1,    // 失败数量
  "missingCount": 1,    // 缺失（未找到记录）数量
  "failedList": [// 失败详情
    {
      "id": "this is a string",    // 唯一标识
      "name": "this is a string",    // 名称
      "message": "this is a string"    // 内容/说明
    }
    //,{ 更多元素略 }
  ],    
  "warningList": [// 告警详情
    {
      "id": "this is a string",    // 唯一标识
      "name": "this is a string",    // 名称
      "message": "this is a string"    // 内容/说明
    }
    //,{ 更多元素略 }
  ]    
}


4.7 流程编排管理

4.7.1 获取流程编排列表

根据指定查询条件，获取流程编排列表

Path： /openapi/workflowlayouts

Method： GET

Query string：

参数名称参数类型描述
nameString名称
searchStringString关键字，模糊匹配名称、备注、标签
isDescBoolean是否按创建时间降序排序，默认true,说明:true-降序；false-升序
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 60,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "7affc8af-b6c9-45a1-b5f1-c3482e16d4ae",    // 唯一标识
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "tags": ["this is a string","this is a string"],    // 标签
      "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
      "nodes": [// 子任务列表
        {
          "id": "87cf506e-211d-4c5d-a5e2-b3264a109083",    // 唯一标识
          "index": 6,    // 索引
          "name": "this is a string",    // 名称
          "workflowId": "c2b72aa1-5ea6-498d-add5-b13d68954d12",    // 流程部署id
          "description": "this is a string",    // 备注
          "tags": ["this is a string","this is a string"],    // 标签
          "arguments": [// 参数
            {
              "name": "this is a string",    // 名称
              "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
              "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
              "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
              "assetContent": {// 使用的资产，若未使用资产，则不传此字段
                "name": "this is a string",    // 名称
                "description": "this is a string",    // 备注
                "isRequiredEncryption": false    // 是否加密
              }    
            }
            //,{ 更多元素略 }
          ],    
          "createdAt": "2022-07-29T12:13:49.789Z",    // 创建时间
          "createdBy": "4a4ca8b8-4ac5-4593-9f8d-c8c7861a7ecf",    // 创建人id
          "createdByName": "administrator",    // 创建人名称
          "modifiedAt": "2022-07-29T12:13:49.789Z",    // 更新时间
          "modifiedBy": "05c219d7-ae72-4fa6-97a3-183e746e9def",    // 更新人id
          "modifiedByName": "administrator"    // 更新人名称
        }
        //,{ 更多元素略 }
      ],    
      "lastTriggeredAt": "2022-07-29T12:13:49.789Z",    // 最后触发时间
      "triggeredCount": 38,    // 触发计数
      "companyId": "9f2e097d-77af-4361-8edd-d8434bf5d52c",    // 公司id
      "departmentId": "2f4c17fc-16ef-400f-bc86-da5e5252958c",    // 部门id
      "createdAt": "2022-07-29T12:13:49.789Z",    // 创建时间
      "createdBy": "91480078-dc08-4a60-b228-1ce19eb11aca",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedAt": "2022-07-29T12:13:49.789Z",    // 更新时间
      "modifiedBy": "b6a860cd-30d9-4d41-a4ab-af3b234250b5",    // 更新人id
      "modifiedByName": "administrator"    // 更新人名称
    }
    //,{ 更多元素略 }
  ]    
}


4.7.2 根据id获取流程编排

根据id获取流程编排详情

Path： /openapi/workflowlayouts/{workflowlayoutId}

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "count": 60,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "7affc8af-b6c9-45a1-b5f1-c3482e16d4ae",    // 唯一标识
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "tags": ["this is a string","this is a string"],    // 标签
      "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
      "nodes": [// 子任务列表
        {
          "id": "87cf506e-211d-4c5d-a5e2-b3264a109083",    // 唯一标识
          "index": 6,    // 索引
          "name": "this is a string",    // 名称
          "workflowId": "c2b72aa1-5ea6-498d-add5-b13d68954d12",    // 流程部署id
          "description": "this is a string",    // 备注
          "tags": ["this is a string","this is a string"],    // 标签
          "arguments": [// 参数
            {
              "name": "this is a string",    // 名称
              "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
              "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
              "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
              "assetContent": {// 使用的资产，若未使用资产，则不传此字段
                "name": "this is a string",    // 名称
                "description": "this is a string",    // 备注
                "isRequiredEncryption": false    // 是否加密
              }    
            }
            //,{ 更多元素略 }
          ],    
          "createdAt": "2022-07-29T12:13:49.789Z",    // 创建时间
          "createdBy": "4a4ca8b8-4ac5-4593-9f8d-c8c7861a7ecf",    // 创建人id
          "createdByName": "administrator",    // 创建人名称
          "modifiedAt": "2022-07-29T12:13:49.789Z",    // 更新时间
          "modifiedBy": "05c219d7-ae72-4fa6-97a3-183e746e9def",    // 更新人id
          "modifiedByName": "administrator"    // 更新人名称
        }
        //,{ 更多元素略 }
      ],    
      "lastTriggeredAt": "2022-07-29T12:13:49.789Z",    // 最后触发时间
      "triggeredCount": 38,    // 触发计数
      "companyId": "9f2e097d-77af-4361-8edd-d8434bf5d52c",    // 公司id
      "departmentId": "2f4c17fc-16ef-400f-bc86-da5e5252958c",    // 部门id
      "createdAt": "2022-07-29T12:13:49.789Z",    // 创建时间
      "createdBy": "91480078-dc08-4a60-b228-1ce19eb11aca",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedAt": "2022-07-29T12:13:49.789Z",    // 更新时间
      "modifiedBy": "b6a860cd-30d9-4d41-a4ab-af3b234250b5",    // 更新人id
      "modifiedByName": "administrator"    // 更新人名称
    }
    //,{ 更多元素略 }
  ]    
}


4.7.3 执行流程编排

根据id执行流程编排

Path： /openapi/workflowlayouts/{workflowlayoutId}/execute

Method： POST

请求参考示例：

无内容

响应参考示例：

{
  "id": "95b1af59-67e6-4e99-8113-65cb603b9721",    // 唯一标识
  "name": "this is a string",    // 名称
  "startedAt": "2022-07-29T12:13:49.789Z",    // 开始运行时间
  "finishedAt": "2022-07-29T12:13:49.789Z",    // 结束运行时间
  "departmentId": "bc2779c4-a655-42a8-ae7b-f9f5b7a5ed35",    // 部门id
  "companyId": "f626412f-dfc0-4a11-bc40-9e53bb02a601",    // 公司id
  "createdAt": "2022-07-29T12:13:49.789Z",    // 创建时间
  "createdBy": "a3be2e74-37e4-4d65-a931-1427555a9e78",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-07-29T12:13:49.789Z",    // 更新时间
  "modifiedBy": "a66eaada-d7b2-4077-9ec1-2406d0eba099",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "jobStartupType": "Manually",    // 启动方式:Manually-手动;Trigger-定时任务;TaskQueue-任务队列
  "jobStartupId": "cecade63-9369-4428-9ce9-748096bf4660",    // 启动方式id，例如定时器id，或任务队列id
  "jobStartupName": "this is a string",    // 启动方式名称,例如定时器名称，或任务队列名称
  "ownerId": "0fb16b20-18b7-4a37-bdf3-b24df1adca42",    // 记录所属对象id，例如流程部署Id
  "jobs": [// 任务列表
    {
      "id": "ad3e31ac-8980-43a0-9266-bdecfb022f3f",    // 唯一标识
      "workflowId": "148eeb2b-9938-4029-ae93-009a265df2d0",    // 流程部署id
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "packageId": "af65447f-8a68-4f65-8526-da6246ea39d5",    // 流程包id
      "packageName": "this is a string",    // 流程包名称
      "packageVersion": "1.0.9",    // 流程包版本号
      "packageVersionId": "bcd6c134-1eca-493e-b69f-c3d2c060cd3d",    // 流程包版本id
      "arguments": [// 参数
        {
          "name": "this is a string",    // 名称
          "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
          "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
          "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
          "assetContent": {// 使用的资产，若未使用资产，则不传此字段
            "name": "this is a string",    // 名称
            "description": "this is a string",    // 备注
            "isRequiredEncryption": false    // 是否加密
          }    
        }
        //,{ 更多元素略 }
      ],    
      "containingQueueId": "b19e7d10-d65a-4ea7-af99-1e6efeb8f423",    // 运行目标机器人组id
      "priority": 2000,    // 优先级，范围:0-5000
      "displayState": "Queued",    // 显示状态:Queued-等待中;Running-运行中;Failed-失败;Cancelled-已取消;Succeeded-成功;Paused-已暂停
      "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
      "message": "this is a string",    // 内容/说明
      "lastRunInstaceId": "6f5991aa-f2a2-429b-855c-87082f4876fc",    // 最近运行实例id
      "lastRobotName": "this is a string",    // 最近运行的机器人名称
      "startedAt": "2022-07-29T12:13:49.790Z",    // 开始运行时间
      "finishedAt": "2022-07-29T12:13:49.790Z",    // 结束运行时间
      "retriedCount": 2,    // 重试计数
      "maxRetryCount": 1,    // 最大重试次数,范围:0-10
      "departmentId": "9a4f049f-fa1e-479d-890e-7b012b590321",    // 部门id
      "companyId": "e20bce36-c239-4251-95ed-3cdf0c0f42bf",    // 公司id
      "cronTriggerId": "4048caea-1fc6-4716-8262-7e2f359f107b",    // 触发的定时器id,非定时器触发时为null
      "jobExecutionPolicy": "AnyTime",    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
      "createdAt": "2022-07-29T12:13:49.790Z",    // 创建时间
      "createdBy": "534d71f9-38fa-4813-b93b-b7c2ab8e812f",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedAt": "2022-07-29T12:13:49.790Z",    // 更新时间
      "modifiedBy": "ac6dc477-6aab-4fe8-9f23-0745e2de563b",    // 更新人id
      "modifiedByName": "administrator",    // 更新人名称
      "jobStartupType": "Manually",    // 启动方式:Manually-手动;Trigger-定时任务;TaskQueue-任务队列
      "jobStartupId": "75baaaff-04d0-41f9-b524-c1b0f35eedd6",    // 启动方式id，例如定时器id，或任务队列id
      "jobStartupName": "this is a string",    // 启动方式名称,例如定时器名称，或任务队列名称
      "jobGroupId": "2ef33453-9763-4587-b264-9f21e1db3830",    // 所属任务组id
      "seqNum": 78,    // 执行序号
      "step": "this is a string",    // 步骤编号，用于展示
      "jobSubjectId": "4493488f-6e50-4ecd-92e8-1c25fddf8411",    // Job关联体id，默认使用WorkflowId，可指定为自定义Id，用于业务统计
      "jobSubjectName": "this is a string",    // Job关联体名称，默认使用Workflow名称,可指定为自定义内容，用于业务统计
      "jobSubjectType": "this is a string"    // Job关联体类型，默认使用Workflow，可指定为自定义类型，用于业务统计
    }
    //,{ 更多元素略 }
  ]    
}


4.7.4 获取流程编排执行记录详情

根据Id获取流程编排执行记录，其中Id是"执行流程编排"接口返回的字段"Id"。

Path： /openapi/jobgroups/{id}

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "id": "95b1af59-67e6-4e99-8113-65cb603b9721",    // 唯一标识
  "name": "this is a string",    // 名称
  "startedAt": "2022-07-29T12:13:49.789Z",    // 开始运行时间
  "finishedAt": "2022-07-29T12:13:49.789Z",    // 结束运行时间
  "departmentId": "bc2779c4-a655-42a8-ae7b-f9f5b7a5ed35",    // 部门id
  "companyId": "f626412f-dfc0-4a11-bc40-9e53bb02a601",    // 公司id
  "createdAt": "2022-07-29T12:13:49.789Z",    // 创建时间
  "createdBy": "a3be2e74-37e4-4d65-a931-1427555a9e78",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-07-29T12:13:49.789Z",    // 更新时间
  "modifiedBy": "a66eaada-d7b2-4077-9ec1-2406d0eba099",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "jobStartupType": "Manually",    // 启动方式:Manually-手动;Trigger-定时任务;TaskQueue-任务队列
  "jobStartupId": "cecade63-9369-4428-9ce9-748096bf4660",    // 启动方式id，例如定时器id，或任务队列id
  "jobStartupName": "this is a string",    // 启动方式名称,例如定时器名称，或任务队列名称
  "ownerId": "0fb16b20-18b7-4a37-bdf3-b24df1adca42",    // 记录所属对象id，例如流程部署Id
  "jobs": [// 任务列表
    {
      "id": "ad3e31ac-8980-43a0-9266-bdecfb022f3f",    // 唯一标识
      "workflowId": "148eeb2b-9938-4029-ae93-009a265df2d0",    // 流程部署id
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "packageId": "af65447f-8a68-4f65-8526-da6246ea39d5",    // 流程包id
      "packageName": "this is a string",    // 流程包名称
      "packageVersion": "1.0.9",    // 流程包版本号
      "packageVersionId": "bcd6c134-1eca-493e-b69f-c3d2c060cd3d",    // 流程包版本id
      "arguments": [// 参数
        {
          "name": "this is a string",    // 名称
          "type": "System.Int32",    // 参数类型，常见类型：System.Int16、System.Int32、System.UInt32、System.Int64、System.Double、System.Decimal、System.Boolean、System.Char、System.String、System.DateTime
          "direction": "In",    // 参数方向:In-入参;Out-出参;InOut-出入参
          "defaultValue": "this is a string",    // 参数默认值; 当使用资产（即AssetContent不为null）时，这里为资产id，若DefaultValue为空，AssetContent作null处理
          "assetContent": {// 使用的资产，若未使用资产，则不传此字段
            "name": "this is a string",    // 名称
            "description": "this is a string",    // 备注
            "isRequiredEncryption": false    // 是否加密
          }    
        }
        //,{ 更多元素略 }
      ],    
      "containingQueueId": "b19e7d10-d65a-4ea7-af99-1e6efeb8f423",    // 运行目标机器人组id
      "priority": 2000,    // 优先级，范围:0-5000
      "displayState": "Queued",    // 显示状态:Queued-等待中;Running-运行中;Failed-失败;Cancelled-已取消;Succeeded-成功;Paused-已暂停
      "videoRecordMode": "NeverRecord",    // 视频录制模式:NeverRecord-从不录制;ReportOnlyWhenSucceeded-仅成功时上传;ReportOnlyWhenFailed-仅失败时上传;AlwaysRecord-总是录制;AlwaysReport-总是上传
      "message": "this is a string",    // 内容/说明
      "lastRunInstaceId": "6f5991aa-f2a2-429b-855c-87082f4876fc",    // 最近运行实例id
      "lastRobotName": "this is a string",    // 最近运行的机器人名称
      "startedAt": "2022-07-29T12:13:49.790Z",    // 开始运行时间
      "finishedAt": "2022-07-29T12:13:49.790Z",    // 结束运行时间
      "retriedCount": 2,    // 重试计数
      "maxRetryCount": 1,    // 最大重试次数,范围:0-10
      "departmentId": "9a4f049f-fa1e-479d-890e-7b012b590321",    // 部门id
      "companyId": "e20bce36-c239-4251-95ed-3cdf0c0f42bf",    // 公司id
      "cronTriggerId": "4048caea-1fc6-4716-8262-7e2f359f107b",    // 触发的定时器id,非定时器触发时为null
      "jobExecutionPolicy": "AnyTime",    // 执行策略:SkipWhenNoResource-无可用机器人时取消任务;AnyTime-无可用机器人时等待
      "createdAt": "2022-07-29T12:13:49.790Z",    // 创建时间
      "createdBy": "534d71f9-38fa-4813-b93b-b7c2ab8e812f",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedAt": "2022-07-29T12:13:49.790Z",    // 更新时间
      "modifiedBy": "ac6dc477-6aab-4fe8-9f23-0745e2de563b",    // 更新人id
      "modifiedByName": "administrator",    // 更新人名称
      "jobStartupType": "Manually",    // 启动方式:Manually-手动;Trigger-定时任务;TaskQueue-任务队列
      "jobStartupId": "75baaaff-04d0-41f9-b524-c1b0f35eedd6",    // 启动方式id，例如定时器id，或任务队列id
      "jobStartupName": "this is a string",    // 启动方式名称,例如定时器名称，或任务队列名称
      "jobGroupId": "2ef33453-9763-4587-b264-9f21e1db3830",    // 所属任务组id
      "seqNum": 78,    // 执行序号
      "step": "this is a string",    // 步骤编号，用于展示
      "jobSubjectId": "4493488f-6e50-4ecd-92e8-1c25fddf8411",    // Job关联体id，默认使用WorkflowId，可指定为自定义Id，用于业务统计
      "jobSubjectName": "this is a string",    // Job关联体名称，默认使用Workflow名称,可指定为自定义内容，用于业务统计
      "jobSubjectType": "this is a string"    // Job关联体类型，默认使用Workflow，可指定为自定义类型，用于业务统计
    }
    //,{ 更多元素略 }
  ]    
}


5 数据中心接口

5.1 资产管理

5.1.1 查询资产列表

根据指定查询条件，查询资产列表

Path： /openapi/assets

Method： GET

Query string：

参数名称参数类型描述
nameString名称
valueTypeString资产类型
isRequiredEncryptionBoolean是否加密

请求参考示例：

无内容

响应参考示例：

{
  "count": 7,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "valueType": "String",    // 资产类型
      "isRequiredEncryption": false,    // 是否加密
      "credentialUserName": "TestPassword",    // 账户密码
      "credentialPassword": "TestAccount",    // 账户用户名称
      "integerValue": 51,    // 整数类型值
      "stringValue": "this is a string",    // 字符串类型值
      "floatValue": 2.2,    // 浮点数类型值
      "boolValue": false,    // Bool类型值
      "departmentId": "c9c20e29-490c-4e2f-a9a1-392e77e89d14",    // 部门id
      "companyId": "22b69f07-a4dc-4b95-948e-cf9d614b15ea",    // 公司id
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "createdAt": "2022-08-25T06:21:22.346Z",    // 创建时间
      "createdBy": "9e8c19e7-0e99-4f36-bb80-9441cdf17809",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedAt": "2022-08-25T06:21:22.354Z",    // 更新时间
      "modifiedBy": "dafe1d8f-c102-46e7-bb21-3e19678bd4b1",    // 更新人id
      "modifiedByName": "administrator"    // 更新人名称
    }
    //,{ 更多元素略 }
  ]    
}


5.1.2 根据id获取资产

根据id获取资产详情

Path： /openapi/assets/{assetId}

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "valueType": "String",    // 资产类型
  "isRequiredEncryption": false,    // 是否加密
  "credentialUserName": "TestPassword",    // 账户密码
  "credentialPassword": "TestAccount",    // 账户用户名称
  "integerValue": 51,    // 整数类型值
  "stringValue": "this is a string",    // 字符串类型值
  "floatValue": 2.2,    // 浮点数类型值
  "boolValue": false,    // Bool类型值
  "departmentId": "c9c20e29-490c-4e2f-a9a1-392e77e89d14",    // 部门id
  "companyId": "22b69f07-a4dc-4b95-948e-cf9d614b15ea",    // 公司id
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "createdAt": "2022-08-25T06:21:22.346Z",    // 创建时间
  "createdBy": "9e8c19e7-0e99-4f36-bb80-9441cdf17809",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-08-25T06:21:22.354Z",    // 更新时间
  "modifiedBy": "dafe1d8f-c102-46e7-bb21-3e19678bd4b1",    // 更新人id
  "modifiedByName": "administrator"    // 更新人名称
}


5.1.3 新增资产信息

新增资产信息

Path： /openapi/assets

Method： POST

请求参考示例：

{
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "valueType": "String",    // 资产类型
  "isRequiredEncryption": false,    // 是否加密
  "credentialUserName": "TestPassword",    // 账户密码
  "credentialPassword": "TestAccount",    // 账户用户名称
  "integerValue": 81,    // 整数类型值
  "stringValue": "this is a string",    // 字符串类型值
  "floatValue": 8.2,    // 浮点数类型值
  "boolValue": false    // Bool类型值
}

响应参考示例：

{
  "valueType": "String",    // 资产类型
  "isRequiredEncryption": false,    // 是否加密
  "credentialUserName": "TestPassword",    // 账户密码
  "credentialPassword": "TestAccount",    // 账户用户名称
  "integerValue": 51,    // 整数类型值
  "stringValue": "this is a string",    // 字符串类型值
  "floatValue": 2.2,    // 浮点数类型值
  "boolValue": false,    // Bool类型值
  "departmentId": "c9c20e29-490c-4e2f-a9a1-392e77e89d14",    // 部门id
  "companyId": "22b69f07-a4dc-4b95-948e-cf9d614b15ea",    // 公司id
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "createdAt": "2022-08-25T06:21:22.346Z",    // 创建时间
  "createdBy": "9e8c19e7-0e99-4f36-bb80-9441cdf17809",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-08-25T06:21:22.354Z",    // 更新时间
  "modifiedBy": "dafe1d8f-c102-46e7-bb21-3e19678bd4b1",    // 更新人id
  "modifiedByName": "administrator"    // 更新人名称
}


5.1.4 更新资产信息

根据id更新资产信息

Path： /openapi/assets/{assetId}

Method： PATCH

请求参考示例：

{
  "name": "this is a string",    // 名称
  "valueType": "String",    // 资产类型
  "description": "this is a string",    // 备注
  "isRequiredEncryption": false,    // 是否加密
  "credentialUserName": "TestPassword",    // 账户密码
  "credentialPassword": "TestAccount",    // 账户用户名称
  "integerValue": 43,    // 整数类型值
  "stringValue": "this is a string",    // 字符串类型值
  "floatValue": 0.4,    // 浮点数类型值
  "boolValue": false    // Bool类型值
}

响应参考示例：

{
  "valueType": "String",    // 资产类型
  "isRequiredEncryption": false,    // 是否加密
  "credentialUserName": "TestPassword",    // 账户密码
  "credentialPassword": "TestAccount",    // 账户用户名称
  "integerValue": 51,    // 整数类型值
  "stringValue": "this is a string",    // 字符串类型值
  "floatValue": 2.2,    // 浮点数类型值
  "boolValue": false,    // Bool类型值
  "departmentId": "c9c20e29-490c-4e2f-a9a1-392e77e89d14",    // 部门id
  "companyId": "22b69f07-a4dc-4b95-948e-cf9d614b15ea",    // 公司id
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "createdAt": "2022-08-25T06:21:22.346Z",    // 创建时间
  "createdBy": "9e8c19e7-0e99-4f36-bb80-9441cdf17809",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedAt": "2022-08-25T06:21:22.354Z",    // 更新时间
  "modifiedBy": "dafe1d8f-c102-46e7-bb21-3e19678bd4b1",    // 更新人id
  "modifiedByName": "administrator"    // 更新人名称
}


5.1.5 删除资产

根据id删除资产

Path： /openapi/assets/{assetId}

Method： DELETE

请求参考示例：

无内容

响应参考示例：

无内容


5.2 数据队列

5.2.1 查询数据队列列表

根据指定查询条件，获取数据队列列表，在Saas版本中仅支持前缀查询

Path： /openapi/dataqueues

Method： GET

Query string：

参数名称参数类型描述
searchStringString搜索字符串, 可搜索 Name,Tags,Description字段
limitInt获取数量限制
isDescBoolean是否按创建时间降序排序，默认true,说明:true-降序；false-升序
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 75,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "id": "c8b0d03c-88e6-467a-9706-25d24bcaa82a",    // 唯一标识
      "queueName": "this is a string",    // 队列名字
      "description": "this is a string",    // 备注
      "companyId": "de551b5d-64bd-42dd-ba07-739492e975a8",    // 公司id
      "departmentId": "bcfa8088-c899-4142-99f3-923b2b8edab9",    // 部门id
      "createdAt": "2022-09-19T07:32:14.380Z",    // 创建时间
      "modifiedAt": "2022-09-19T07:32:14.397Z",    // 更新时间
      "createdBy": "13ba2c2f-84f4-476c-be85-52fd568ae3b8",    // 创建人id
      "modifiedBy": "2a340f0c-bddb-492f-bc14-ef52b30c21c9",    // 更新人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedByName": "administrator",    // 更新人名称
      "tags": ["this is a string","this is a string"],    // 标签
      "version": 74,    // 版本
      "underlyingName": "this is a string"    // 底层名称，系统中唯一
    }
    //,{ 更多元素略 }
  ]    
}


5.2.2 创建数据队列

创建数据队列

Path： /openapi/dataqueues

Method： POST

请求参考示例：

{
  "queueName": "this is a string",    // 队列名字
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"]    // 标签
}

响应参考示例：

{
  "id": "c8b0d03c-88e6-467a-9706-25d24bcaa82a",    // 唯一标识
  "queueName": "this is a string",    // 队列名字
  "description": "this is a string",    // 备注
  "companyId": "de551b5d-64bd-42dd-ba07-739492e975a8",    // 公司id
  "departmentId": "bcfa8088-c899-4142-99f3-923b2b8edab9",    // 部门id
  "createdAt": "2022-09-19T07:32:14.380Z",    // 创建时间
  "modifiedAt": "2022-09-19T07:32:14.397Z",    // 更新时间
  "createdBy": "13ba2c2f-84f4-476c-be85-52fd568ae3b8",    // 创建人id
  "modifiedBy": "2a340f0c-bddb-492f-bc14-ef52b30c21c9",    // 更新人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedByName": "administrator",    // 更新人名称
  "tags": ["this is a string","this is a string"],    // 标签
  "version": 74,    // 版本
  "underlyingName": "this is a string"    // 底层名称，系统中唯一
}


5.2.3 修改队列备注和标签

修改队列备注和标签

Path： /openapi/dataqueues/{queueName}

queueNameString队列名字

Method： PATCH

请求参考示例：

{
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"]    // 标签
}

响应参考示例：

{
  "id": "c8b0d03c-88e6-467a-9706-25d24bcaa82a",    // 唯一标识
  "queueName": "this is a string",    // 队列名字
  "description": "this is a string",    // 备注
  "companyId": "de551b5d-64bd-42dd-ba07-739492e975a8",    // 公司id
  "departmentId": "bcfa8088-c899-4142-99f3-923b2b8edab9",    // 部门id
  "createdAt": "2022-09-19T07:32:14.380Z",    // 创建时间
  "modifiedAt": "2022-09-19T07:32:14.397Z",    // 更新时间
  "createdBy": "13ba2c2f-84f4-476c-be85-52fd568ae3b8",    // 创建人id
  "modifiedBy": "2a340f0c-bddb-492f-bc14-ef52b30c21c9",    // 更新人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedByName": "administrator",    // 更新人名称
  "tags": ["this is a string","this is a string"],    // 标签
  "version": 74,    // 版本
  "underlyingName": "this is a string"    // 底层名称，系统中唯一
}


5.2.4 获取队列详情

获取队列详情

Path： /openapi/dataqueues/{queueName}

queueNameString队列名字

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "id": "c8b0d03c-88e6-467a-9706-25d24bcaa82a",    // 唯一标识
  "queueName": "this is a string",    // 队列名字
  "description": "this is a string",    // 备注
  "companyId": "de551b5d-64bd-42dd-ba07-739492e975a8",    // 公司id
  "departmentId": "bcfa8088-c899-4142-99f3-923b2b8edab9",    // 部门id
  "createdAt": "2022-09-19T07:32:14.380Z",    // 创建时间
  "modifiedAt": "2022-09-19T07:32:14.397Z",    // 更新时间
  "createdBy": "13ba2c2f-84f4-476c-be85-52fd568ae3b8",    // 创建人id
  "modifiedBy": "2a340f0c-bddb-492f-bc14-ef52b30c21c9",    // 更新人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedByName": "administrator",    // 更新人名称
  "tags": ["this is a string","this is a string"],    // 标签
  "version": 74,    // 版本
  "underlyingName": "this is a string"    // 底层名称，系统中唯一
}


5.2.5 删除指定数据队列

删除数据队列

Path： /openapi/dataqueues/{queueName}

queueNameString队列名字

Method： DELETE

请求参考示例：

无内容

响应参考示例：

无内容


5.2.6 增加单条消息到指定名字队列

增加单条消息到指定名字队列

Path： /openapi/dataqueues/{queueName}/messages

queueNameString队列名字

Method： POST

Query string：

参数名称参数类型描述
visibilitytimeoutInt可见超时时间，单位：秒；默认值：0
messagettlInt消息有效时间，单位：秒；默认值：604800

请求参考示例：

{
  "messageText": "this is a string"    // 消息文本
}

响应参考示例：

无内容


5.2.7 查看或获取指定队列的多个消息

查看或获取指定名字队列的多个消息

Path： /openapi/dataqueues/{queueName}/messages

queueNameString队列名字

Method： GET

Query string：

参数名称参数类型描述
peekonlyBooleanpeekonly=true时执行查看行为，没有该query参数时或值为false时执行获取行为
visibilitytimeoutInt获取时设置可见超时时间，即保留消息的不可见时间；默认值：30
numOfMessagesInt查看或获取消息的数量，范围1到32，默认1

请求参考示例：

无内容

响应参考示例：

{
  "nextPage": {// 基准项，基于前次结果向后分页查询
    "partitionKey": "this is a string",    // 下次查询基准分区
    "rowKey": "this is a string"    // 下次查询基准行
  },    
  "data": [// 数据内容
    {
      "id": "this is a string",    // 唯一标识
      "messageText": "this is a string",    // 消息文本
      "nextVisibleTime": "2022-09-19T07:32:15.057Z",    // 下次可见时间,UTC时间
      "expirationTime": "2022-09-19T07:32:15.063Z",    // 消息有效时间,UTC时间
      "insertionTime": "2022-09-19T07:32:15.069Z",    // 消息入队时间,UTC时间
      "popReceipt": "this is a string",    // 当设置query参数的visibilitytimeout时，操作消息的附加凭据，主凭据为消息Id
      "dequeueCount": 31    // 出队次数
    }
    //,{ 更多元素略 }
  ]    
}


5.2.8 更新消息

根据消息Id和附加凭据更新消息

Path： /openapi/dataqueues/{queueName}/messages/{messageId}

queueNameString队列名字
messageIdString消息Id

Method： PUT

Query string：

参数名称参数类型描述
popReceiptString消息的附加凭据
visibilitytimeoutInt获取时设置可见超时时间，即保留消息的不可见时间

请求参考示例：

{
  "messageText": "this is a string"    // 消息文本
}

响应参考示例：

{
  "id": "this is a string",    // 唯一标识
  "messageText": "this is a string",    // 消息文本
  "nextVisibleTime": "2022-09-19T07:32:15.057Z",    // 下次可见时间,UTC时间
  "expirationTime": "2022-09-19T07:32:15.063Z",    // 消息有效时间,UTC时间
  "insertionTime": "2022-09-19T07:32:15.069Z",    // 消息入队时间,UTC时间
  "popReceipt": "this is a string",    // 当设置query参数的visibilitytimeout时，操作消息的附加凭据，主凭据为消息Id
  "dequeueCount": 31    // 出队次数
}


5.2.9 删除消息

根据消息Id和附加凭据删除消息

Path： /openapi/dataqueues/{queueName}/messages/{messageId}

queueNameString队列名字
messageIdString消息Id

Method： DELETE

Query string：

参数名称参数类型描述
popReceiptString消息的附加凭据

请求参考示例：

无内容

响应参考示例：

无内容


5.2.10 清除指定队列中所有消息

清除指定队列中所有消息，如果数量较大可能会超时并返回服务器内部错误，客户端需要重试

Path： /openapi/dataqueues/{queueName}/messages

queueNameString队列名字

Method： DELETE

请求参考示例：

无内容

响应参考示例：

无内容


5.2.11 批量删除队列

批量删除队列

Path： /openapi/dataqueues

Method： DELETE

请求参考示例：

{
  "ids": ["68a4009a-6231-430e-9a0d-519d78695bba","68a4009a-6231-430e-9a0d-519d78695bba"],    // 唯一标识列表
  "companyId": "99f56d3d-9d0d-4301-9fc0-dedc96f92dde",    // 公司id
  "departmentId": "7d89bc98-3bd3-4148-a37f-b3ea5ccb9eb8"    // 部门id
}

响应参考示例：

无内容


5.3 文件管理

5.3.1 获取文件列表

获取指定目录下的文件列表

Path： /openapi/files

Method： GET

Query string：

参数名称参数类型描述
pathString文件夹路径

请求参考示例：

无内容

响应参考示例：

[
  {
    "nodeName": "this is a string",    // 名称
    "fileType": "File",    // 类型:File;Directory
    "size": 68    // 大小（当为文件夹时，Size是0）
  }
  //,{ 更多元素略 }
]


5.3.2 创建文件夹

创建文件夹

  1. 根目录必须存在，否则将报错“文件夹不存在”

  2. 创建文件夹时，若文件夹已存在，也将返回成功

Path： /openapi/files

Method： POST

Query string：

参数名称参数类型描述
pathString文件夹路径

请求参考示例：

无内容

响应参考示例：

无内容


5.3.3 上传文件

上传文件到指定路径，要求目标文件夹存在（若不存在，须先创建），若文件已存在将不会覆盖，报错“文件已存在”

Path： /openapi/files/upload

Method： POST

Query string：

参数名称参数类型描述
pathString目标存储路径
overwriteBoolean覆盖已有文件

请求参考示例：

注意：请求头信息Content-Type应设置application/octet-stream

[二进制文件流数据]

响应参考示例：

无内容


5.3.4 删除文件/文件夹

根据路径删除指定文件或文件夹

Path： /openapi/files

Method： DELETE

Query string：

参数名称参数类型描述
pathString文件或文件夹路径

请求参考示例：

无内容

响应参考示例：

无内容


5.3.5 获取文件下载地址

Path： /openapi/files/downloadurl

Method： GET

Query string：

参数名称参数类型描述
pathString要下载的文件路径

请求参考示例：

无内容

响应参考示例：

{
  "url": "this is a string"    // 下载地址
}


5.4 数据表

5.4.1 查询数据表列表

根据指定查询条件，获取数据表列表

Path： /openapi/tables

Method： GET

Query string：

参数名称参数类型描述
startTimeDateTime开始时间[创建时间]，格式:"2022-09-07T06:41:13.908Z"
endTimeDateTime结束时间[创建时间]，格式:"2022-09-07T06:41:13.921Z"
isDescBoolean是否按创建时间降序排序，默认true,说明:true-降序；false-升序
keywordString关键字 (对[Name,Tags,Description]等字段进行模糊匹配)
pageIndexInt页码（从0开始）
pageSizeInt页大小（默认20）

请求参考示例：

无内容

响应参考示例：

{
  "count": 27,    // 查询命中总记录数
  "list": [// 当前页记录集合
    {
      "columns": [{"name":"Name","type":"String"},{"name":"Age","type":"Int"}],    // 数据列，列数量范围1-128
      "id": "0c0be880-b48c-4e03-bbf5-10dba160f9c6",    // 唯一标识
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "tags": ["this is a string","this is a string"],    // 标签
      "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
      "createdAt": "2022-09-07T06:41:13.984Z",    // 创建时间
      "createdBy": "1913513c-dfee-47de-8b98-72314f48b874",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedBy": "a79c06bb-d345-4565-8d19-d16937cbe77a",    // 更新人id
      "modifiedByName": "administrator",    // 更新人名称
      "modifiedAt": "2022-09-07T06:41:13.984Z",    // 更新时间
      "companyId": "5e9a7b69-9387-436e-a145-7ded4b7b186d",    // 公司id
      "departmentId": "db2a01d3-c12d-4bcb-8f89-ed5e878a937e"    // 部门id
    }
    //,{ 更多元素略 }
  ]    
}


5.4.2 获取数据表详情

根据id获取数据表详情

Path： /openapi/tables/{tableId}

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "columns": [{"name":"Name","type":"String"},{"name":"Age","type":"Int"}],    // 数据列，列数量范围1-128
  "id": "0c0be880-b48c-4e03-bbf5-10dba160f9c6",    // 唯一标识
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "createdAt": "2022-09-07T06:41:13.984Z",    // 创建时间
  "createdBy": "1913513c-dfee-47de-8b98-72314f48b874",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedBy": "a79c06bb-d345-4565-8d19-d16937cbe77a",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "modifiedAt": "2022-09-07T06:41:13.984Z",    // 更新时间
  "companyId": "5e9a7b69-9387-436e-a145-7ded4b7b186d",    // 公司id
  "departmentId": "db2a01d3-c12d-4bcb-8f89-ed5e878a937e"    // 部门id
}


5.4.3 创建数据表

创建数据表

Path： /openapi/tables

Method： POST

请求参考示例：

{
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"}    // 附加属性
}

响应参考示例：

{
  "columns": [{"name":"Name","type":"String"},{"name":"Age","type":"Int"}],    // 数据列，列数量范围1-128
  "id": "0c0be880-b48c-4e03-bbf5-10dba160f9c6",    // 唯一标识
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "createdAt": "2022-09-07T06:41:13.984Z",    // 创建时间
  "createdBy": "1913513c-dfee-47de-8b98-72314f48b874",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedBy": "a79c06bb-d345-4565-8d19-d16937cbe77a",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "modifiedAt": "2022-09-07T06:41:13.984Z",    // 更新时间
  "companyId": "5e9a7b69-9387-436e-a145-7ded4b7b186d",    // 公司id
  "departmentId": "db2a01d3-c12d-4bcb-8f89-ed5e878a937e"    // 部门id
}


5.4.4 修改数据表

修改指定数据表

Path： /openapi/tables/{tableId}

Method： PATCH

请求参考示例：

{
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"}    // 附加属性
}

响应参考示例：

{
  "columns": [{"name":"Name","type":"String"},{"name":"Age","type":"Int"}],    // 数据列，列数量范围1-128
  "id": "0c0be880-b48c-4e03-bbf5-10dba160f9c6",    // 唯一标识
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "createdAt": "2022-09-07T06:41:13.984Z",    // 创建时间
  "createdBy": "1913513c-dfee-47de-8b98-72314f48b874",    // 创建人id
  "createdByName": "administrator",    // 创建人名称
  "modifiedBy": "a79c06bb-d345-4565-8d19-d16937cbe77a",    // 更新人id
  "modifiedByName": "administrator",    // 更新人名称
  "modifiedAt": "2022-09-07T06:41:13.984Z",    // 更新时间
  "companyId": "5e9a7b69-9387-436e-a145-7ded4b7b186d",    // 公司id
  "departmentId": "db2a01d3-c12d-4bcb-8f89-ed5e878a937e"    // 部门id
}


5.4.5 删除指定数据表

删除数据表

Path： /openapi/tables/{tableId}

Method： DELETE

请求参考示例：

无内容

响应参考示例：

无内容


5.4.6 保存数据到数据表

保存数据到数据表(覆盖现有数据表的结构和数据)

Path： /openapi/tables/names/{name}/data

Method： PUT

请求参考示例：

{
  "columns": [{"name":"Name","type":"String"},{"name":"Age","type":"Int"}],    // 数据列，列数量范围1-128
  "rows": [["张三",15],["张四",16]]    // 数据行，列数量范围1-65536
}

响应参考示例：

无内容


5.4.7 追加数据到数据表

追加数据到数据表

Path： /openapi/tables/names/{name}/data

Method： POST

请求参考示例：

{
  "columns": [{"name":"Name","type":"String"},{"name":"Age","type":"Int"}],    // 数据列，列数量范围1-128
  "rows": [["张三",15],["张四",16]]    // 数据行，列数量范围1-65536
}

响应参考示例：

无内容


6 管理中心接口

6.1 公司管理

6.1.1 查询用户所属公司列表

根据条件查询用户所属公司列表

Path： /openapi/companies/companylist

Method： GET

Query string：

参数名称参数类型描述
nameString名称

请求参考示例：

无内容

响应参考示例：

{
  "companies": [// 公司列表
    {
      "companyUserId": "b58e5911-52bd-473d-a98c-9960a1276a09",    // 用户id
      "companyUserName": "this is a string",    // 用户名称
      "id": "4fa6344f-ce24-49b2-9f81-0006536b8e14",    // 唯一标识
      "name": "this is a string",    // 名称
      "description": "this is a string",    // 备注
      "tags": ["this is a string","this is a string"],    // 标签
      "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
      "createdAt": "2022-07-29T12:13:49.775Z",    // 创建时间
      "createdBy": "c3048593-d4ab-44d9-aad0-128ff0f31da6",    // 创建人id
      "createdByName": "administrator",    // 创建人名称
      "modifiedBy": "ef0c107a-1ea8-4132-8492-9bbb902dab92",    // 更新人id
      "modifiedByName": "administrator",    // 更新人名称
      "modifiedAt": "2022-07-29T12:13:49.776Z",    // 更新时间
      "companyId": "5a56b12c-4726-48cd-8050-c6e2b58bff0b",    // 公司id
      "edition": "Enterprise"    // 版本类型:Enterprise-企业版;Community-社区版
    }
    //,{ 更多元素略 }
  ]    
}


6.2 部门管理

6.2.1 获取当前公司部门树

获取公司下整个部门树形层级结构

Path： /openapi/departments/tree

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "count": 35,    // 查询命中总记录数
  "rootDepartment": {// 部门树根节点
    "children": [// 子部门列表
      {
        "children": { /* 略，结构同上级节点 */ },    // 子部门列表
        "departmentPath": "this is a string",    // 部门树路径
        "visitorHasAnyRole": false,    // 用户是否在此部门中拥有角色
        "visitorHasPermission": false,    // 用户是否在此部门中拥有权限
        "userCount": 99,    // 用户数量
        "id": "c4768455-bc87-44a6-9ebf-d73030c53381",    // 唯一标识
        "departmentId": "04c743fa-2074-4a9a-83a1-ba703e71c3d1",    // 部门id
        "parentId": "aaeace38-b62f-4af3-a732-63929a8d4557",    // parent id
        "name": "this is a string",    // 名称
        "description": "this is a string",    // 备注
        "eTag": "this is a string",    // 版本控制标记
        "tags": ["this is a string","this is a string"],    // 标签
        "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
        "createdAt": "2022-07-29T12:13:49.779Z",    // 创建时间
        "modifiedAt": "2022-07-29T12:13:49.779Z",    // 更新时间
        "companyId": "bea00011-59e7-4d85-ac01-c8ce222875b4"    // 公司id
      }
      //,{ 更多元素略 }
    ],    
    "departmentPath": "this is a string",    // 部门树路径
    "visitorHasAnyRole": false,    // 用户是否在此部门中拥有角色
    "visitorHasPermission": false,    // 用户是否在此部门中拥有权限
    "userCount": 99,    // 用户数量
    "id": "c4768455-bc87-44a6-9ebf-d73030c53381",    // 唯一标识
    "departmentId": "04c743fa-2074-4a9a-83a1-ba703e71c3d1",    // 部门id
    "parentId": "aaeace38-b62f-4af3-a732-63929a8d4557",    // parent id
    "name": "this is a string",    // 名称
    "description": "this is a string",    // 备注
    "eTag": "this is a string",    // 版本控制标记
    "tags": ["this is a string","this is a string"],    // 标签
    "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
    "createdAt": "2022-07-29T12:13:49.779Z",    // 创建时间
    "modifiedAt": "2022-07-29T12:13:49.779Z",    // 更新时间
    "companyId": "bea00011-59e7-4d85-ac01-c8ce222875b4"    // 公司id
  }    
}


6.3 用户管理

6.3.1 查询当前用户信息

获取当前公司用户自己的信息

Path： /openapi/companyusers/self

Method： GET

请求参考示例：

无内容

响应参考示例：

{
  "userExtensionInfo": {// user extensiong info
    "extensionId": "this is a string",    // 扩展字段-id
    "extensionMobile": "this is a string",    // 扩展字段-手机号
    "extensionEmail": "this is a string"    // 扩展字段-邮箱
  },    
  "isExternalUser": false,    // is third party user
  "hasModifiedPassword": false,    // 
  "id": "b9e1ef45-36a0-459b-abf2-26f6433f3c40",    // 唯一标识
  "userId": "fb2e0462-a048-4da4-b817-572e019a4b42",    // user id
  "companyId": "9758f386-542e-4c5e-bf0c-ec2aecd4a585",    // 公司id
  "isCompanyOwner": false,    // is company owner
  "roleIds": ["67546cd8-1d7d-475d-a054-4fed08294a39","67546cd8-1d7d-475d-a054-4fed08294a39"],    // roleIds
  "status": "Active",    // 状态:Active-活跃;Inactive-未激活;Banned-禁用
  "assignedDepartmentId": "35b7da12-e098-4a10-b88d-8fb27a67f3b6",    // 当前选中部门id
  "name": "this is a string",    // 名称
  "description": "this is a string",    // 备注
  "eTag": "this is a string",    // 版本控制标记
  "tags": ["this is a string","this is a string"],    // 标签
  "properties": {"Field1":"value1","Field2":"value2"},    // 附加属性
  "createdAt": "2022-07-29T12:13:49.784Z",    // 创建时间
  "modifiedAt": "2022-07-29T12:13:49.784Z",    // 更新时间
  "lastLoginAt": "2022-07-29T12:13:49.784Z",    // 最近登录时间
  "departmentPath": "this is a string",    // 部门树路径
  "email": "this is a string",    // 邮箱
  "phoneNumber": "this is a string",    // user phone number
  "userName": "this is a string"    // account user name
}


7 示例代码