Retorna uma lista paginada dos eventos de perda cadastrados na solução ERM.
URL
{RMUrl}/api/objects/ERMEvent[?[[&]$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;
boolean Deleted;
Nota: 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 eventos de perda (por padrão, somente 10 eventos são listados por vez):
{RMUrl}/api/objects/ERMEvent
As instâncias de 11 a 20 (segunda página):
{RMUrl}/api/objects/ERMEvent?page=2
Filtrar pelos eventos com Id maior que 5:
{RMUrl}/api/objects/ ERMEvent?$filter=Id gt 5
Filtrar pelos eventos ativos:
{RMUrl}/api/objects/ ERMEvent?$filter=Deleted eq false
Filtrar pelos eventos removidos:
{RMUrl}/api/objects/ ERMEvent?$filter=Deleted eq true
RESPOSTA DE SUCESSO
Lista de eventos de perda.
ERMEvent[].
O objeto ERMEvent está no seguinte formato:
ERMEvent
{
int Id;
string Name;
string Description;
bool Deleted;
}
EXEMPLO DE RESPOSTAS DE SUCESSO
{
"Id": 52,
"Deleted": false,
"DateCreated": "/Date(1398703889957-0300)/",
"DateUpdated": "/Date(1398703889957-0300)/",
"Name": "Evento de Perda 1",
"LossEventResponsible": {
"Id": "942d78f0-2986-408d-96ba-0915bbcb76ce",
"Caption": "[API] userERM"
},
"Value": 1,
"AccountingDate": "/Date(1398643200000)/",
"Type": "Genérico"
}