Ver detalhes de uma consulta do Workflow

Retorna os detalhes de uma consulta do módulo Workflow. Somente as consultas criadas pelo próprio usuário ou aquelas em que ele foi alocado como editor ou membro da audiência poderão ser acessadas.

URL

{WSUrl}/api/queries/<Consulta>/metadata

MÉTODO DE SOLICITAÇÃO

GET

PARÂMETROS DA URL

Query: esse parâmetro é fornecido na URL e pode ser tanto o nome quanto o GUID da consulta. Consultas com caracteres especiais em seus nomes não podem ser executadas através da API.

EXEMPLOS DE SOLICITAÇÃO

{WSUrl}/api/queries/Agrupamento/metadata

{WSUrl}/api/queries/cc45b704-b3d5-11e0-8b69-001ec91f4b0a/metadata

RESPOSTA DE SUCESSO

Retorna uma QueryMetadata no seguinte formato:

QueryMetadata

{

Guid Id;

string Name;

ColumnMetadata[] Columns;

}

O campo "Columns" tem o seguinte formato:

{

string Name;

string Caption;

int? Order;

bool IsGroup;

bool IsCustomAttribute;

ColumnType? Type;

}

O campo "ColumnType" pode ter os seguintes valores: Text, Number, Real, Date, DateTime, Time, Boolean.

EXEMPLO DE RESPOSTAS DE SUCESSO

{

"Name":"Consulta de Eventos",

"Oid":1,

"Columns":[

{"Caption":"Código","IsCustomAttribute":false,"IsGroup":false,"Name":"EventID","Type":"Text"},

{"Caption":"Situação","IsCustomAttribute":false,"IsGroup":false,"Name":"Status","Type":"Text"},

{"Caption":"Título","IsCustomAttribute":false,"IsGroup":false,"Name":"Title","Type":"Text"},

{"Caption":"Tipo","IsCustomAttribute":false,"IsGroup":false,"Name":"Type","Type":"Text"}

]

}