Retorna uma lista paginada de relatórios do módulo de Compliance.
URL
{RMUrl}/api/compliance/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 POR 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/compliance/reports
Filtrar pelo ID do relatório:
{RMUrl}/api/compliance/reports?$filter=Id eq guid'6fe49ce4-56d4-475f-9483-1adca6b2976c'
Filtrar os relatórios com nome "rac" em português:
{RMUrl}/api/compliance/reports?$filter=ReportName eq 'rac' and Culture eq 'pt-BR'
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": "e62a2f77-3b39-11eb-b5f2-782bcbbc381e",
"ReportName": "rac teste",
"Culture": "en-us",
"ModelType": "Compliance",
"AuthorId": "54fabdbe-1a62-11e7-80c8-000d3a011c02",
"FromModulo": false,
"LastUpdate": "/Date(-62135596800000)/",
"DataSources": [
{
"Name": "[LGPD] Camada 1 anv",
"DisplayName": "[LGPD] Camada 1 anv",
"Description": "",
"QueryProvider": "AggregatedQuery",
"Origin": "Organization"
},
{
"Name": "Ativos top 100",
"DisplayName": "Ativos top 100",
"QueryProvider": "SqlQuery",
"Origin": "Compliance"
}
]
},
{
"Id": "0679384b-1a40-11e7-80c8-000d3a011c02",
"ReportName": "rac",
"Culture": "en-us",
"ModelType": "Compliance",
"AuthorId": "00000000-0000-0000-0000-000000000000",
"FromModulo": true,
"LastUpdate": "/Date(1491424736597-0300)/"
},
{
"Id": "0679384a-1a40-11e7-80c8-000d3a011c02",
"ReportName": "rac",
"Culture": "pt-br",
"ModelType": "Compliance",
"AuthorId": "00000000-0000-0000-0000-000000000000",
"FromModulo": true,
"LastUpdate": "/Date(1491424725657-0300)/"
}
]