工作流端点

file (file)：必填。选择您想上传到系统的实际文件。媒体类型必须是 YXZP 文件。

name (string)：必填。输入工作流名称。这是要在 Server UI 中显示的工作流名称。

ownerId (string)：必填。输入所有者 ID。

workerTag (string)：可选。指定在工作程序中定义的工作程序标签，以帮助将作业分配给某些工作程序节点。如需了解详情，请访问工作程序帮助页面。

districtTags (string)：可选。以 JSON 格式的数组进行提交，例如，["id1", "id2"]。使用分区功能，按照标记对共享的公共工作流进行分组，以便用户可以轻松找到。如需了解详情，请访问分区帮助页面。

comments (string)：可选。输入注释。

isPublic (boolean)：必填。选择“true”将工作流设为公开可用。选择“false”将工作流设为私有，不允许公开使用。

isReadyForMigration (boolean)：必填。选择工作流是否已准备好进行迁移。如需详细了解如何从一个 Server 环境迁移到另一个 Server 环境，请参阅启用工作流迁移帮助页面。

sourceAppId (string)：可选。设置工作流的源应用程序 ID。您可以将其用作 POST admin/v1/workflows 端点的“sourceId”。提供预先存在的 sourceAppId 将导致请求无效。

othersMayDownload (boolean)：必填。指定其他用户是否可以下载此工作流。

othersCanExecute (boolean)：必填。指定其他用户是否可以执行此工作流。

executionMode (string)：必填。接受的值为“Safe”（安全）、“SemiSafe”（半安全）和“Standard”（biao'zhun）。如需详细了解执行模式，请参阅安全和半安全运行模式：阻止的工具、事件和数据连接器帮助页面。

hasPrivateDataExemption (boolean)：可选。给予豁免以允许运行包含私有数据的工作流。选择“true”，以允许豁免；或选择“false”，以拒绝豁免。如需了解详情，请访问管理员界面中的工作流选项页面。

workflowCredentialType (string)：必填。接受的值为“Default”、“Required”和“Specific”。

credentialId (string)：可选。为此工作流指定 credentialId。

collectionIds (string)：可选。输入应将此工作流添加到的集合的 collectionId。以 JSON 格式的数组进行提交，例如：["id1", "id2"]。

workflowId (string)：必填。输入要为其上传新版本的工作流 ID。

file (file)：必填。选择您想作为新版本上传到系统的实际文件。媒体类型必须是 YXZP 文件。

name (string)：必填。输入工作流名称。这是要在 Server UI 中显示的工作流名称。

ownerId (string)：必填。输入所有者 ID。

othersMayDownload (boolean)：必填。默认值设置为“true”。

othersCanExecute (boolean)：必填。默认值设置为“true”。

executionMode (string)：必填。接受的值为“Safe”（安全）、“SemiSafe”（半安全）和“Standard”（biao'zhun）。如需详细了解执行模式，请参阅安全和半安全运行模式：阻止的工具、事件和数据连接器帮助页面。

hasPrivateDataExemption (boolean)：可选。给予豁免以允许运行包含私有数据的工作流。选择“true”，以允许豁免；或选择“false”，以拒绝豁免。如需了解详情，请访问管理员界面中的工作流选项页面。

comments (string)：可选。输入注释。

makePublished (boolean)：必填。默认值设置为“true”。makePublished 参数用来控制推送到 Server 的工作流的新版本是否应为发布版本。当您将工作流推送到 Server 时，可以将其设置为“false”，这样只有您才能运行它。

workflowCredentialType (string)：必填。输入用于此工作流的凭证类型。接受的值为“Default”、“Required”和“Specific”。

credentialId (string)：可选。为此工作流指定 credentialId。如需详细了解凭证端点，请参阅凭证端点。

view (string)：可选。选择显示工作流信息的方式。可以保留此参数但不为其提供值。您可以从以下值中选择：“默认值（Default）”和“全部（Full）”。如果此参数设置为“Default”，则将返回一个减小的视图对象。未指定时，将使用“默认值（Default）”。

name (string)：可选。输入工作流名称，以便按名称筛选工作流。这是在 Server UI 中显示的工作流名称。

ownerId (string)：可选。输入所有者 ID，以便按其所有者筛选工作流。

createdAfter (string)：可选。输入日期和时间，工作流是在此之后创建的。以 ISO8601 格式输入日期和时间。

createdBefore (string)：可选。输入日期时间，工作流是在此之前创建的。以 ISO8601 格式输入日期和时间。

workflowId (string)：必填。输入工作流 ID，以获取有关此工作流的信息。

workflowId (string)：必填。输入要更新的工作流 ID。

updateWorkflowContract (body)：必填。输入要更新的工作流信息。

updateWorkflowContract 的示例值：

{
  "name": "string",
  "versionId": "string",
  "makePublished": true,
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "othersMayDownload": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true,
  "workflowCredentialType": "Default",
  "credentialId": "string"
}

workflowId (string)：必填。输入要为其下载包的工作流 ID。

versionId (string)：可选。输入工作流的版本 ID。如果未提供版本，则下载发布版本。

workflowId (string)：必填。输入要为其检索信息的的工作流 ID。

versionId (string)：可选。输入工作流的版本 ID。如果未提供版本，则使用发布版本。

workflowId (string)：必填。输入要为其检索信息的的工作流 ID。

sortField (string)：可选。输入要作为结果排序依据的字段名称。

direction (string)：可选。在此处指定排序顺序。接受的值为“asc”（升序）和“desc”（降序）。如果未指定排序顺序，则默认按升序排序。

offset (string)：可选。是指要作为结果开始位置的记录。

limit (string)：可选。是指要作为结果结束位置的最后一条记录。

status (string)：可选。作业执行的总体状态。已经完成的作业仍有可能失败。接受的值包括：“已完成”、“错误”、“正在运行”和“在排队待处理”。

resultCode (string)：可选。工作流执行的结果代码。这表明工作流失败，但作业成功。接受的值包括：“成功”、“警告”和“错误”。

workflowId (string)：必填。输入要删除的工作流 ID。

force (boolean)：可选。未选择时，默认值为“false”。如果已计划工作流，将参数设置为“true”会在删除工作流之前删除所有计划。