Ver detalhes de uma consulta de riscos

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

URL

{RMUrl}/api/Risk/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/Risk/queries/Componentes de Ativo/metadata

{RMUrl}/api/Risk/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":"340e27e7-58d6-11e0-b958-001b78932efe","AuthorName":"Maria Diniz","AuthorPhone":"+55 (21) 2123-4600",","AuthorEmail":"maria@exemplo.com.br","Id":"62dda590-a43c-4c91-882e-9fc2fe7446fe","Name":"Resultados de Risco","Columns":[{"Name":"Name","SmallCaption":"Comp Ativo","Caption":"Nome do Componente do Ativo (Comp Ativo)","Order":0,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"AssetName","SmallCaption":"Ativo","Caption":"Nome do Ativo (Ativo)","Order":1,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"AssetType","SmallCaption":"Tipo Ativo","Caption":"Tipo de Ativo","Order":2,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"IdentifiedRisk","SmallCaption":"PSR Ident","Caption":"Risco Identificado (PSR Ident)","Order":3,"IsGroup":false,"IsCustomAttribute":false,"Type":"Number","SortOrder":"None"},{"Name":"GapIndex","SmallCaption":"Gap Index","Caption":"Gap Index","Order":4,"IsGroup":false,"IsCustomAttribute":false,"Type":"Percentual","SortOrder":"None"},{"Name":"RiskIndex","SmallCaption":"RI","Caption":"Risk Index (RI)","Order":5,"IsGroup":false,"IsCustomAttribute":false,"Type":"Percentual","SortOrder":"None"},{"Name":"SecurityIndex","SmallCaption":"SI","Caption":"Security Index (SI)","Order":6,"IsGroup":false,"IsCustomAttribute":false,"Type":"Percentual","SortOrder":"None"},{"Name":"ControlIndex","SmallCaption":"Ctrl Index","Caption":"Control Index (Ctrl Index)","Order":7,"IsGroup":false,"IsCustomAttribute":false,"Type":"Percentual","SortOrder":"None"}],"UpdatedOn":"\/Date(-62135596800000)\/"}