Retorna uma lista paginada de relatórios do módulo Organização.
URL
{RMUrl}/api/organization/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;
int ModelType;
Nota 1: O campo
"ModelType" indica o tipo de relatório e retorna os seguintes valores: Risk=1 e
Organization=4. Observe que no filtro esse campo é um inteiro, mas ele retorna
como uma string na resposta da solicitação.
Nota 2: 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/organization/reports
Filtrar pelo ID do relatório:
{RMUrl}/api/organization/reports?$filter=Id eq guid'6fe49ce4-56d4-475f-9483-1adca6b2976c'
Filtrar os relatórios com nome "ror" em português:
{RMUrl}/api/organization/reports?$filter=ReportName eq 'ror' and Culture eq 'pt-BR'
Filtrar os relatórios genéricos da organização:
{RMUrl}/api/organization/reports?$filter=ModelType eq 4
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 RESPOSTA DE SUCESSO
[
{
"Id": "e7cc0086-a69c-11ea-80d2-000d3a011c02",
"ReportName": "3 Relatorio LGPD Areas Vertical",
"Culture": "pt-br",
"ModelType": "Organization",
"AuthorId": "01c835a3-1b05-11e7-80c8-000d3a011c02",
"FromModulo": false,
"LastUpdate": "/Date(-62135596800000)/",
"DataSources": [
{
"Name": "Processos",
"DisplayName": "Processos",
"Description": "",
"QueryProvider": "AggregatedQuery",
"Origin": "Organization"
},
{
"Name": "Rel 3 LGPD Areas",
"DisplayName": "Rel 3 LGPD Areas",
"QueryProvider": "SqlQuery",
"Origin": "Organization"
}
]
},
...
]