HighGear 工作流
HighGear 可便于大规模快速部署和管理工作。 作为高度可配置的无代码工作流平台,使用 HighGear 进行连接可以让你轻松集成业务应用程序。 在整个企业中连接整个团队,并开始构建无缝工作流和流程,并更直观、可审核性和实时度量所有工作活动。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 由世纪互联运营的中国云 |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 由世纪互联运营的中国云 |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 由世纪互联运营的中国云 |
| 联系人 | |
|---|---|
| Name | HighGear 支持 |
| URL | https://www.highgear.com/support/ |
| support@HighGear.com |
| 连接器元数据 | |
|---|---|
| 发布者 | HighGear Software, Inc. |
| 网站 | https://www.highgear.com |
| 隐私策略 | https://www.highgear.com/platform-privacy-policy/ |
| 类别 | 业务管理;协作 |
使用 HighGear 工作流连接器,可以更轻松地快速集成业务应用程序和任务关键型工作。 HighGear 的企业级安全性满足最严格监管行业的严格要求,同时允许日常业务用户快速构建简单的复杂工作流。 使用 HighGear 的无代码工作流和进程管理平台,实时分配任务、管理工作、跟踪进度和报告活动状态。 轻松且安全。
如果你有兴趣了解有关 HighGear 平台的详细信息, 请安排演示 或 联系我们。
先决条件
若要使用此连接器,需要 HighGear 应用程序版本 9.1.0 或更高版本。
还需要以下各项:
-
HighGear 系统的基 URL: 这是在 Web 浏览器地址栏中看到的 URL 的一部分,没有你正在使用的特定页面。
基 URL 的两种最常见模式是
https://SUBDOMAIN.example.comSUBDOMAIN 是“highgear”或类似内容。https://example.com/highgear - 集成帐户和 API 密钥: 这是必要的,以便连接器可以与 HighGear REST API 通信。 若要了解如何创建集成帐户,请转到 HighGear 系统中的帮助并搜索 “创建集成帐户”一文。
如何获取凭据
若要设置和使用连接器,需要使用 API 密钥在 HighGear 系统中使用集成帐户。
请转到 HighGear 系统中的帮助,并参阅以下文章,了解如何设置集成帐户并为其创建 API 密钥。
- 创建集成帐户
- 为帐户创建集成 API 密钥
连接器入门
若要开始使用 HighGear 工作流连接器,并在任务进入 HighGear 系统中的工作流 Web 请求节点时触发流,请执行以下步骤:
- 如果未创建,请创建 HighGear 工作流连接。 对于新连接,除了集成帐户的 API 密钥外,还输入 HighGear 系统的基 URL 和子域。
- 添加任务 进入 Web 请求节点 触发器并选择 HighGear 工作流和节点时。 当任务进入所选工作流节点时,这将触发流。
- 添加 “获取任务 ”作,从任务中获取数据。 使用 任务输入 Web 请求节点 触发器时的任务 ID,并选择要加载的数据字段的任务窗体。
- 添加另一个连接器以向其发送任务数据。 一些常见用例是从 HighGear 任务的开始和结束日期创建 Outlook 事件、向被分配者的电子邮件地址发送有关任务的电子邮件,或更新另一个系统中相应记录的状态。
已知问题和限制
- 连接器当前不支持来自 HighGear 工作流的出站 Web 请求附带的其他数据(即要发送的任务字段)。 现在,从 HighGear 系统收到触发器后,通过 “获取任务 ”作获取所需的数据。
有关 HighGear 工作流连接器的问题,请联系 HighGear 支持人员。
FAQ
-
如何查找帮助文章?
- 若要查找 HighGear 系统中的帮助文章,请单击右上角的 “帮助 ”按钮。
将打开包含 HighGear 用户文档的新选项卡。 - 单击右上角由放大镜图标表示的 “搜索 ”按钮。
- 在“搜索”文本框中,键入要打开的文章的名称。
下拉列表将显示搜索结果。* - 单击文章的名称。
- 若要查找 HighGear 系统中的帮助文章,请单击右上角的 “帮助 ”按钮。
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| API 密钥 | securestring | HighGear REST API 的 API 密钥 | True |
| 主机名 | 字符串 | 指定 HighGear 主机名(例如 test.highgear.app) | True |
| 子目录 | 字符串 | 指定子目录(例如开发或 prod) |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 创建任务 |
使用此作在 HighGear 系统中创建新任务。 此作返回新任务的 ID。 |
| 创建联系人 |
使用此作在 HighGear 系统中创建新的联系人(个人、组织单位、权限组、资产或队列)。 此作返回新联系人的 ID。 |
| 删除任务文件 |
使用此作可删除附加到 HighGear 系统中任务的文件。 |
| 删除联系人文件 |
使用此作可删除附加到 HighGear 系统中联系人的文件。 |
| 搜索任务 |
使用此作搜索 HighGear 系统中的任务。 搜索基于指定任务窗体的字段条件。 此作返回与搜索条件匹配的任务的 ID 和简短说明。 |
| 搜索联系人 |
使用此作搜索 HighGear 系统中的联系人。 搜索基于指定联系人类型的字段条件。 此作返回与搜索条件匹配的联系人的 ID、名称和电子邮件地址。 |
| 更新任务 |
使用此作可更新 HighGear 系统中任务的任务窗体字段。 此作返回任务的 ID 和一个布尔值,指示任务已修改(true 或 false)。 |
| 更新联系人 |
使用此作可更新 HighGear 系统中联系人的联系人类型字段。 此作返回已修改的联系人的 ID。 |
| 获取任务 |
使用此作可获取 HighGear 系统中任务的字段值。 |
| 获取任务文件内容 |
使用此作可获取附加到 HighGear 系统中任务的文件。 |
| 获取联系人 |
使用此作可获取 HighGear 系统中联系人的字段值。 |
| 获取联系人文件内容 |
使用此作可获取附加到 HighGear 系统中联系人的文件。 |
创建任务
使用此作在 HighGear 系统中创建新任务。 此作返回新任务的 ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务表单
|
job_type | True | integer |
新任务的任务窗体。 |
|
模型
|
model | True | dynamic |
新任务的字段数据。 |
返回
任务创建响应
- Body
- TaskCreateResponse
创建联系人
使用此作在 HighGear 系统中创建新的联系人(个人、组织单位、权限组、资产或队列)。 此作返回新联系人的 ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Contact 类
|
contact_class | True | string |
联系人分类 |
|
联系人类型
|
contact_type | True | integer |
新联系人的联系人类型 |
|
模型
|
model | True | dynamic |
新联系人的字段数据 |
返回
创建联系人响应
删除任务文件
使用此作可删除附加到 HighGear 系统中任务的文件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件 ID
|
fileId | True | integer |
任务文件标识符 |
返回
- response
- object
删除联系人文件
使用此作可删除附加到 HighGear 系统中联系人的文件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件 ID
|
fileId | True | integer |
联系人文件标识符 |
返回
- response
- object
搜索任务
使用此作搜索 HighGear 系统中的任务。 搜索基于指定任务窗体的字段条件。 此作返回与搜索条件匹配的任务的 ID 和简短说明。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务表单
|
job_type | True | integer |
包含要用作搜索条件的字段的任务窗体。 |
|
模型
|
model | True | dynamic |
返回
- response
- array of TaskSearchResponse
搜索联系人
使用此作搜索 HighGear 系统中的联系人。 搜索基于指定联系人类型的字段条件。 此作返回与搜索条件匹配的联系人的 ID、名称和电子邮件地址。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Contact 类
|
contact_class | True | string |
联系人分类 |
|
联系人类型
|
contact_type | True | integer |
包含要用作搜索条件的字段的联系人类型。 |
|
模型
|
model | True | dynamic |
返回
- response
- array of Contact
更新任务
使用此作可更新 HighGear 系统中任务的任务窗体字段。 此作返回任务的 ID 和一个布尔值,指示任务已修改(true 或 false)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
taskId | True | integer |
任务标识符 |
|
任务表单
|
job_type | True | integer |
包含要更新的字段的任务窗体。 |
|
模型
|
model | True | dynamic |
要为指定任务更新的字段。 |
返回
编辑任务响应
- Body
- TaskEditResponse
更新联系人
使用此作可更新 HighGear 系统中联系人的联系人类型字段。 此作返回已修改的联系人的 ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
联系人 ID
|
contactId | True | integer |
联系人标识符 |
|
Contact 类
|
contact_class | True | string |
联系人分类 |
|
联系人类型
|
contact_type | True | integer |
要更新的字段的联系人类型。 |
|
模型
|
model | True | dynamic |
要更新指定联系人的字段。 |
返回
创建联系人响应
获取任务
使用此作可获取 HighGear 系统中任务的字段值。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
taskId | True | integer |
任务标识符 |
|
任务表单
|
job_type | True | integer |
包含要检索的字段的任务窗体。 |
返回
获取任务文件内容
使用此作可获取附加到 HighGear 系统中任务的文件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件 ID
|
fileId | True | integer |
任务文件标识符 |
返回
文件的内容。
- 文件内容
- binary
获取联系人
使用此作可获取 HighGear 系统中联系人的字段值。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
联系人 ID
|
contactId | True | integer |
联系人标识符 |
|
Contact 类
|
contact_class | True | string |
联系人分类 |
|
联系人类型
|
contact_type | True | integer |
要检索的字段的联系人类型。 |
返回
获取联系人文件内容
使用此作可获取附加到 HighGear 系统中联系人的文件。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件 ID
|
fileId | True | integer |
联系人文件标识符 |
返回
文件的内容。
- 文件内容
- binary
触发器
| 任务进入 Web 请求节点时 |
当任务在 HighGear 系统定义的工作流中输入“生成 Web 请求”节点时,此作将触发一个新流。 |
任务进入 Web 请求节点时
当任务在 HighGear 系统定义的工作流中输入“生成 Web 请求”节点时,此作将触发一个新流。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Workflow
|
workflow_id | True | integer |
包含将触发流的“生成 Web 请求”节点的工作流。 |
|
Node
|
node_id | True | integer |
将触发流的“发出 Web 请求”节点。 |
|
Name
|
label | True | string |
为“发出 Web 请求”节点创建的订阅的名称。 此名称将显示在节点的活动订阅列表中。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
任务 ID
|
jobId | integer |
正在执行此作的任务的 ID |
|
登录用户 ID
|
loggedInUser | integer |
执行工作流时登录用户的 ID |
定义
TaskCreateResponse
任务创建响应
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
任务 ID
|
task_id | integer |
新任务的标识符 |
|
上传失败
|
upload_failures | array of string |
如果任何文件上传作失败,则上传失败字符串的列表。 |
TaskEditResponse
编辑任务响应
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
任务 ID
|
task_id | integer |
任务标识符 |
|
是否已修改任务
|
was_task_modified | boolean |
由于作,任务已更改(true 或 false)。 |
|
上传失败
|
upload_failures | array of string |
如果任何文件上传作失败,则上传失败字符串的列表。 |
TaskSearchResponse
任务搜索响应
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
任务 ID
|
task_id | integer |
任务标识符 |
|
简要说明
|
brief_description | string |
任务的简要说明 |
联系人
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
联系人 ID
|
contact_id | integer |
联系人标识符 |
|
Name
|
name | string |
联系人的姓名 |
|
电子邮件地址
|
email_address | string |
联系人的电子邮件地址 |
CreateContactResponse
创建联系人响应
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
联系人 ID
|
contact_id | integer |
新联系人的标识符 |
|
上传失败
|
upload_failures | array of string |
如果任何文件上传作失败,则上传失败字符串的列表。 |
对象
这是类型“object”。
二进制
这是基本数据类型“binary”。