Ver detalhes de uma consulta de compliance

Retorna detalhes de uma consulta do módulo de Compliance. 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/Compliance/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/Compliance/queries/Objeto/metadata

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

RESPOSTA 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 ter os seguintes valores: Text, Percentual, Number, Command, TextOrLink, Link, GeoReference, Real, Date, DateTime, Html, Formattable.

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

EXEMPLO DE RESPOSTAS DE SUCESSO

{"AuthorId":"340e27e7-58d6-11e0-b958-001b78932efe","AuthorName":"Maria Diniz","AuthorPhone":"+55 (21) 2123-4600","AuthorEmail":"maria@exemplo.com.br","Id":"99031b1a-c877-4a78-9b22-033e83d6a066","Name":"Resultados de Compliance","Columns":[{"Name":"RequirementTitle","SmallCaption":"Tit Req","Caption":"Título do Requisito (Tit Req)","Order":0,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"RequirementLevel","SmallCaption":"Nível Req","Caption":"Nível de Requisito (Nível Req)","Order":1,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"ReferenceModelShortName","SmallCaption":"Nome Doc","Caption":"Nome Resumido do Documento de Referência (Nome Doc)","Order":2,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"ComplianceIndex","SmallCaption":"CI","Caption":"Compliance Index (CI)","Order":3,"IsGroup":false,"IsCustomAttribute":false,"Type":"Percentual","SortOrder":"None"},{"Name":"ComplianceLevel","SmallCaption":"NC","Caption":"Nível de Compliance (NC)","Order":4,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"QuantityOfInterviews","SmallCaption":"Qtd Entrevistas","Caption":"Quantidade de Entrevistas (Qtd Entrevistas)","Order":5,"IsGroup":false,"IsCustomAttribute":false,"Type":"Number","SortOrder":"None"},{"Name":"RequirementType","SmallCaption":"Tipo Req","Caption":"Tipo do Requisito (Tipo Req)","Order":6,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"ProjectCode","SmallCaption":"Código do Projeto","Caption":"Código do Projeto","Order":7,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"ProjectName","SmallCaption":"Projeto","Caption":"Nome do Projeto (Projeto)","Order":8,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"RequirementID","SmallCaption":"ID","Caption":"ID do Requisito (ID)","Order":9,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"RequirementCode","SmallCaption":"Cód. Req.","Caption":"Código do Requisito (Cód. Req.)","Order":10,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"}],"UpdatedOn":"\/Date(-62135596800000)\/"}