Get Procedure

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

Parâmetros de caminho

agent_idstringObrigatório
Agent ID to get the procedure draft from
branch_idstringObrigatório
Branch ID to get the procedure draft from
procedure_idstringObrigatório
The procedure ID

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

version_idstringOpcional
The version ID to retrieve. If omitted, returns the version at branch HEAD.
agent_version_idstringOpcional
The agent version ID to retrieve the procedure for.

Resposta

Successful Response
procedure_idstring
Procedure ID
namestring<=200 characters
Procedure name
contentstring<=50000 characters
Procedure content
version_idstringOpcional
Version ID of a version of the procedure. None for a procedure never versioned.
typeenumOpcionalPadrão é free_form
Procedure type
Valores permitidos:
triggerstringOpcionalPadrão é

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_idstringOpcional
Procedure ID of the folder this procedure is placed in. None means root.

Erros

422
Procedures Get Request Unprocessable Entity Error