Get Procedure

Retrieve a procedure at a specific version or the current branch HEAD.

路径参数

agent_idstring必需
Agent ID to get the procedure draft from
branch_idstring必需
Branch ID to get the procedure draft from
procedure_idstring必需
The procedure ID

请求头

xi-api-keystring可选

查询参数

version_idstring可选
The version ID to retrieve. If omitted, returns the version at branch HEAD.
agent_version_idstring可选
The agent version ID to retrieve the procedure for.

响应

Successful Response
procedure_idstring
Procedure ID
namestring<=200 characters
Procedure name
contentstring<=50000 characters
Procedure content
version_idstring可选
Version ID of a version of the procedure. None for a procedure never versioned.
typeenum可选默认为 free_form
Procedure type
允许的值:
triggerstring可选默认为

When the agent should use this procedure. Empty string means this is a sub-procedure that should only start when another procedure references it.

folder_parent_idstring可选
Procedure ID of the folder this procedure is placed in. None means root.

错误

422
Procedures Get Request Unprocessable Entity Error