Ver detalhes de uma consulta do ERM

Retorna os detalhes de uma consulta da solução ERM. Somente as consultas criadas pelo próprio usuário ou aquelas nas quais é membro da audiência poderão ser acessadas.

URL

{RMUrl}/api/enterpriseriskmanagement/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.

EXEMPLO DE SOLICITAÇÃO

{RMUrl}/api/enterpriseriskmanagement/queries/Objetivos Corporativos/metadata

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

RESPOSTAS DE SUCESSO

Retorna uma QueryMetadata no seguinte formato:

QueryMetadata

{

Guid Id;

string Name;

string AuthorId;

string AuthorName;

string AuthorPhone;

string AuthorEmail;

ColumnMetadata[] Columns;

}

O campo "Columns" tem o seguinte formato:

{

string Name;

string SmallCaption;

string Caption;

int? Order;

bool IsGroup;

bool IsCustomAttribute;

ColumnType? Type;

ColumnSortOrder SortOrder;

}

O campo "ColumnType" pode assumir os seguintes valores: Text, Percentual, Number, Command, TextOrLink, Link, GeoReference, Real, Date, DateTime, Html, Formattable.

O campo "ColumnSortOrder" pode assumir os seguintes valores: None, Ascending e Descending.

EXEMPLO DE RESPOSTA DE SUCESSO

{"AuthorId":"7b06ee69-12d6-11e5-80d9-00155d00020d","AuthorName":"Rachel Price","AuthorPhone":"16544654","AuthorEmail":"rprice@exemplo.com","Id":"8e73d274-efa5-4582-a6aa-1ccbcb4fb69b","Name":"API_02","Columns":[{"Name":"AccountingDate","SmallCaption":"Data de Contabilização","Caption":"Data de Contabilização","Order":0,"IsGroup":false,"IsCustomAttribute":true,"Type":"DateTime","SortOrder":"None"},

{"Name":"Name","SmallCaption":"Nome","Caption":"Nome","Order":1,"IsGroup":false,"IsCustomAttribute":true,"Type":"Text","SortOrder":"None"},

{"Name":"LossEventResponsible","SmallCaption":"Responsável","Caption":"Responsável","Order":2,"IsGroup":false,"IsCustomAttribute":true,"Type":"HRReference","SortOrder":"None"},

{"Name":"texto","SmallCaption":"Texto Obrigatório","Caption":"Texto Obrigatório","Order":3,"IsGroup":false,"IsCustomAttribute":true,"Type":"Text","SortOrder":"None"},

{"Name":"Type","SmallCaption":"Tipo","Caption":"Tipo","Order":4,"IsGroup":false,"IsCustomAttribute":true,"Type":"Text","SortOrder":"None"},

{"Name":"Value","SmallCaption":"Valor","Caption":"Valor","Order":5,"IsGroup":false,"IsCustomAttribute":true,"Type":"Number","SortOrder":"None"}],"UpdatedOn":"\/Date(-62135596800000)\/"}