流程
工作流是描述事件检索过程的 XML 文档。工作流定义一个或多个参数,这些参数可以是工作流 XML 中显式分配的值,也可以从工作流参数值 XML 文档中派生值。工作流由按顺序运行的多个操作组成。运行工作流时,参数值将添加到 状态,然后可以在工作流运行时通过操作访问和更改状态。
下表显示了工作流属性。
名字 |
描述 |
必填 |
---|---|---|
名字 |
工作流的名称。 |
是的 |
描述 |
工作流的说明。 |
不 |
版本 |
工作流的版本。 |
是的 |
最小复发率 |
工作流允许的最小重复周期(以秒为单位)。您可以为请求之间时间最短的 API 设置此属性。 |
不 |
参数
使用工作流 操作 访问参数值。参数主要由身份验证凭据组成,但也可用于您希望用户配置的任何内容。下表显示了工作流参数。
名字 |
数据类型 |
描述 |
---|---|---|
名字 |
字符串 |
参数的名称。该名称必须与参数值 XML 中的相应名称值匹配。 |
标签 |
字符串 |
参数的显示名称。 |
描述 |
字符串 |
参数的说明。 |
必填 |
布尔 |
指示是否需要该参数。 |
秘密 |
布尔 |
指示参数是否机密,例如密码。 |
默认 |
字符串 |
参数的默认值。如果未在参数值 XML 中输入此参数的值,则使用默认值。 |
XML 示例
此示例显示了一个工作流示例,该示例需要具有用户名和密码的主机。
<Workflow name="Example" description="An example workflow." version="1.0"> <Parameters> <Parameter name="host" label="Host" required="true" /> <Parameter name="username" label="Username" required="true" /> <Parameter name="password" label="Password" required="true" /> </Parameters> <Actions> ... </Actions> </Workflow>