Retorna uma lista paginada dos privilégios disponíveis no sistema.
URL
{RMUrl}/api/admin/privileges[?[[&]$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 privilégios 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
string Code;
int Id;
string Name;
object Module;
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 privilégios (por padrão, 10 privilégios são listados por vez):
{RMUrl}/api/admin/privileges
Os privilégios de 11 a 20 (segunda página):
{RMUrl}/api/admin/privileges?page=2
Filtrar pelo ID do privilégio:
{RMUrl}/api/admin/privileges?$filter=Id eq 1
Filtrar por "Administrar" no campo "Name":
{RMUrl}/api/admin/privileges?$filter=substringof('Administrar',Name)
RESPOSTA DE SUCESSO
Lista de privilégios de acordo com os filtros e o tamanho da página especificados.
Privilege[].
O objeto Privilege está no seguinte formato:
Privilege
{
string Code;
int Id;
string Name;
object Module;
}
EXEMPLO DE RESPOSTAS DE SUCESSO
[
{
"Code" : "/General/Search_Content",
"Id" : 2,
"Name": "Buscar Conteúdo",
"Module" : { "Id": 0, "Name" : "Geral" }
},
{
"Code" : "Administration/OrganizationMessages_Manage",
"Id" : 5,
"Name": "Administrar as Mensagens Corporativas",
"Module" : { "Id": 1, "Name" : "Administração" }
},
....
]