Retorna uma lista paginada de relatórios do módulo de Riscos.
URL
{RMUrl}/api/risk/reports[?[[&]$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 de páginas a serem exibidas. 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 os relatórios listados 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
Guid Id;
string ReportName;
string Culture;
Nota: O campo Culture pode assumir os seguintes valores: "pt-BR", "en-US" e "es-ES".
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
Os 10 primeiros relatórios (por padrão, 10 relatórios são listados por vez):
{RMUrl}/api/risk/reports
Filtrar pelo ID do relatório:
{RMUrl}/api/risk/reports?$filter=Id eq guid'6fe49ce4-56d4-475f-9483-1adca6b2976c'
Filtrar os relatórios com nome "rar" em inglês:
{RMUrl}/api/risk/reports?$filter=ReportName eq 'rar' and Culture eq 'en-US'
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os relatórios de acordo com os filtros e o tamanho da página especificados.
Report[].
EXEMPLO DE RESPOSTAS DE SUCESSO
[
{
"Id": "b7d8c127-bacd-11e9-80cd-000d3a011c02",
"ReportName": "Sample Report",
"Culture": "pt-br",
"ModelType": "Risk",
"AuthorId": "230f6d36-b240-11e9-80cd-000d3a011c02",
"FromModulo": false,
"LastUpdate": "/Date(-62135596800000)/",
"DataSources": [
{
"Name": "Aplicabilidade - Soma dos Requisitos",
"DisplayName": "Aplicabilidade - Soma dos Requisitos",
"QueryProvider": "SqlQuery",
"Origin": "Risk"
},
{
"Name": "Aplicabilidade - Geral",
"DisplayName": "Aplicabilidade - Geral",
"QueryProvider": "SqlQuery",
"Origin": "Risk"
},
{
"Name": "Aplicabilidade - Situações",
"DisplayName": "Aplicabilidade - Situações",
"QueryProvider": "SqlQuery",
"Origin": "Risk"
}
]
},
{
"Id": "4d2da0d3-d1fe-11ea-8d69-000d3a9a4e49",
"ReportName": "ror",
"Culture": "en-us",
"ModelType": "Risk",
"AuthorId": "00000000-0000-0000-0000-000000000000",
"FromModulo": true,
"LastUpdate": "/Date(1596070074477-0300)/"
},
...
]