工作流端点
工作流端点和参数
上传新工作流
检索所有工作流
要详细了解对象关系以及如何在 API 中使用对象关系,请转至 对象关系 部分。
如需详细了解工作流,请访问 工作流 帮助页面。
上传新工作流
要上传新工作流,请使用
POST {baseURL}/v3/workflows
端点。
参数
file (file):必填。选择您想上传到系统的实际文件。媒体类型必须是 YXZP 文件。
name (string):必填。输入工作流名称。这是要在 Server UI 中显示的工作流名称。
ownerId (string):必填。输入所有者 ID。
workerTag (string):可选。指定在工作程序中定义的工作程序标签,以帮助将作业分配给某些工作程序节点。如需了解详情,请访问 工作程序 帮助页面。
districtTags (string):可选。以 JSON 格式的数组进行提交,例如,["id1", "id2"]。使用分区功能,按照标记对共享的公共工作流进行分组,以便用户可以轻松找到。如需了解详情,请访问 分区 帮助页面。
comments (string):必填。输入注释。
isPublic (boolean):必填。选择工作流是否可以公开获取。
isReadyForMigration (boolean):必填。选择工作流是否已准备好进行迁移。如需详细了解如何从一个 Server 环境迁移到另一个 Server 环境,请参阅 启用工作流迁移 帮助页面。
sourceAppId (string):必填。
othersMayDownload (boolean):必填。指定其他用户是否可以下载此工作流。
othersCanExecute (boolean):必填。指定其他用户是否可以执行此工作流。
executionMode (string):必填。接受的值为“Safe”(安全)、“SemiSafe”(半安全)、“Standard”(标准)。如需详细了解执行模式,请参阅 安全和半安全运行模式:阻止的工具、事件和数据连接器 帮助页面。
hasPrivateDataExemption (boolean):可选。给予豁免以允许运行包含私有数据的工作流。选择“true”,以允许豁免;或选择“false”,以拒绝豁免。如需了解详情,请访问 管理员界面中的工作流选项 页面。
上传现有工作流的新版本
要上传现有工作流的新版本,请使用
POST {baseURL}/v3/workflows/{workflowId}/versions
端点。
参数
workflowId (string):必填。输入要为其上传新版本的工作流 ID。
file (file):可选。选择您想作为新版本上传到系统的实际文件。媒体类型必须是 YXZP 文件。
name (string):必填。输入工作流名称。这是要在 Server UI 中显示的工作流名称。
ownerId (string):必填。输入所有者 ID。
othersMayDownload (boolean):必填。默认值设置为 true。
othersCanExecute (boolean):必填。默认值设置为 true。
executionMode (string):必填。接受的值为“Safe”(安全)、“SemiSafe”(半安全)、“Standard”(标准)。如需详细了解执行模式,请参阅 安全和半安全运行模式:阻止的工具、事件和数据连接器 帮助页面。
hasPrivateDataExemption (boolean):可选。给予豁免以允许运行包含私有数据的工作流。选择“true”,以允许豁免;或选择“false”,以拒绝豁免。如需了解详情,请访问 管理员界面中的工作流选项 页面。
comments (string):必填。输入注释。
makePublished (boolean):必填。默认值设置为 true。makePublished 参数用来控制推送到 Server 的工作流的新版本是否应为发布版本。当您将工作流推送到 Server 时,可以将其设置为 false,这样只有您才能运行它。
检索所有工作流
要获取有关所有工作流记录的信息,请使用
GET {baseURL}/v3/workflows/
端点。
参数
view (string):可选。选择显示工作流信息的方式。可以保留此参数但不为其提供值。您可以从以下值中选择:“默认值(Default)”和“全部(Full)”。如果此参数设置为“Default”,则将返回一个减小的视图对象。未指定时,将使用“默认值(Default)”。
name (string):可选。输入工作流名称,以便按名称筛选工作流。这是在 Server UI 中显示的工作流名称。
ownerId (string):可选。输入所有者 ID,以便按其所有者筛选工作流。
createdAfter (string):可选。输入日期和时间,工作流是在此之后创建的。以 ISO8601 格式 输入日期和时间。
createdBefore (string):可选。输入日期时间,工作流是在此之前创建的。以 ISO8601 格式 输入日期和时间。
请求示例:cUrl
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
检索特定工作流记录
要获取有关特定工作流的信息,请使用
GET {baseURL}/v3/workflows/{workflowId}
端点。
参数
workflowId (string):必填。输入工作流 ID,以获取有关此工作流的信息。
请求示例:cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
更新现有工作流
要上传现有工作流的新版本,请使用
PUT {baseURL}/v3/workflows/{workflowId}
端点。
注意
要更改 ownerId,新所有者与当前所有者必须在同一订阅中。
参数
workflowId (string):必填。输入要更新的工作流 ID。
updateWorkflowContract (body):必填。输入要更新的工作流信息。
name (string):必填。输入工作流名称。这是要在 Server UI 中显示的工作流名称。
versionId (string):必填。输入版本 ID。
makePublished (boolean):可选。未指定时,保持之前的值不变。makePublished 参数用来控制推送到 Server 的工作流的新版本是否应为发布版本。当您将工作流推送到 Server 时,可以将此参数设置为 false,这样只有您才能运行它。
ownerId (string):必填。输入所有者 ID。
workerTag (string):必填。如果没有 workerTag,请改用 ""。
districtTags (string):必填。输入分区标签。使用分区功能,按照标记对共享的公共工作流进行分组,以便用户可以轻松找到。如需了解详情,请访问 分区 帮助页面。
comments (string):必填。输入注释。
isPublic (boolean):可选。未指定时,保持之前的值不变。
isReadyForMigration (boolean):可选。未指定时,保持之前的值不变。
othersMayDownload (boolean):可选。未指定时,保持之前的值不变。将其对公共工作流设置为 false 时,工作流将无法使用。
othersCanExecute (boolean):可选。未指定时,保持之前的值不变。将其对公共工作流设置为 false 时,工作流将无法使用。
executionMode (string):可选。接受的值为“Safe”、“SemiSafe”、“Standard”。如需详细了解执行模式,请参阅 安全和半安全运行模式:阻止的工具、事件和数据连接器 帮助页面。
hasPrivateDataExemption (boolean):可选。给予豁免以允许运行包含私有数据的工作流。选择“true”,以允许豁免;或选择“false”,以拒绝豁免。未指定时,保持之前的值不变。如需了解详情,请访问 管理员界面中的工作流选项 页面。
删除工作流
要删除特定工作流,请使用
DELETE {baseURL}/v3/workflows/{workflowId}
端点。
参数
workflowId (string):必填。输入要删除的工作流 ID。
force (boolean):可选。如果未选择,则默认值为 false。如果已计划工作流,将此参数设置为 true 会在删除工作流之前删除所有计划。
对象关系
如果您要上传工作流,则可以按如下方式使用创建的对象:
创建的对象:“ workflowId ”(例如,“id”: “7917969784f84bd09442f66996ecb8f3”)
您可以将其用作:
Postman 请求示例
GET /v3/workflows/{workflowId}
![Use GET /v3/workflows/{workflowId} endpoint.](../../../../image/uuid-0f4fcce4-2727-8722-e734-53dd81a439b3.png)