Listar KRIs

Retorna uma lista paginada dos KRIs cadastrados na solução ERM.

URL

{RMUrl}/api/enterpriseriskmanagement/kris[?[[&]$filter=<filtro>][[&]page=<Página>][[&]page_size=<Tamanhodapágina>][[&]$orderby=<campo1[desc],campo2[desc]…campoN[desc]>]]

MÉTODO DE SOLICITAÇÃO

GET

PARÂMETROS DA URL

page: número da página a ser exibida. Valores válidos: de 1 ao número máximo de páginas. Se omitido, o valor 1 é utilizado. Se o valor for maior que o número máximo de páginas, uma lista em branco será retornada.

page_size: número de itens exibidos por página. Valores válidos: de 1 a 1.000. Se omitido, o valor padrão de 10 itens por página é utilizado.

filter: consulta baseada na sintaxe do protocolo OData para configurar filtros. Os campos permitidos estão listados abaixo. Siga os exemplos para identificar as operações permitidas.

orderby: ordena as instâncias listadas na página por campo. Para ordenar por mais de um campo, utilize a vírgula entre os campos. Para utilizar a ordem decrescente, digite a palavra-chave "desc" para cada campo desejado. Os campos permitidos estão listados abaixo.

CAMPOS SUPORTADOS PELO FILTRO

byte Id;

string Name;

string Variable;

string Description;

double LastValue;

int LastStatus/Id;

int ErmRisk/Id;

int OperationType/Id;

string MonitoredLossEventField;

guid MonitoredLossEventType/Id;

string LastLevel/Color;

string LastLevel/Name;

int LastLevel/Index;

double LastLevel/MinValue;

double LastLevel/MaxValue;

datetime LastProcessed;

string Author/Name;

guid Author/Id;

Para informações detalhadas sobre os filtros, como os operadores suportados, quais filtros se aplicam a quais tipos de dados e mais exemplos, veja o Apêndice 3: Filtros.

EXEMPLOS DE SOLICITAÇÃO

Listar os KRIs (por padrão, somente 10 KRIs são listados por vez):

{RMUrl}/api/enterpriseriskmanagement/kris

Os KRIs de 11 a 20 (segunda página):

{RMUrl}/api/enterpriseriskmanagement/kris?page=2

Filtrar pelos KRIs com ID maior que 5:

{RMUrl}/api/enterpriseriskmanagement/kris?$filter=Id gt 5

Filtrar KRIs pelo limite máximo igual a 2060:

{RMUrl}/api/enterpriseriskmanagement/kris?$filter=LastLevel/MaxValue eq 2060

RESPOSTA DE SUCESSO

Lista de KRIs.

ERMKri[].

O objeto ERMKri está no seguinte formato:

ERMKri

{

int Id;

string Name;

string Variable;

string Description;

int LastValue;

object LastStatus;

object ErmRisk;

object OperationType;

object MonitoredLossEventType;

object Conditions;

object Thresholds;

object LastLevel;

object Author;

string MonitoredLossEventField;

DateTime LastProcessed;

}

EXEMPLO DE RESPOSTA DE SUCESSO

[

{

"Id":21,

"Name":"KRI Financeiro",

"Variable":"financeiro0001",

"Description":"indicador de risco financeiro",

"ErmRisk":{"Id":6188},"OperationType":{"Name":"Soma","Id":1},

"MonitoredLossEventField":"numero_all",

"MonitoredLossEventType":{"Id":"75eca6ad-2689-11e5-80dc-00155d00020d","Name":"Tipo 1"},

"Conditions":[{"LeftOperandName":"Value","RightOperandName":"12.0","Operator":{"Id":3,"Name":"é maior ou igual a"}}],

"Thresholds":

[

{"Color":"lawnGreen","Name":"!@#$%¨&*( baixa","Index":0,"MinValue":-3.40282347E+38,"MaxValue":90.0},

{"Color":"yellow","Name":"[média]","Index":1,"MinValue":90.0,"MaxValue":200.0},

{"Color":"red","Name":"Alta","Index":2,"MinValue":200.0,"MaxValue":3.40282347E+38}

]

}