Retorna uma lista paginada com os integrantes de um perfil.
URL
{RMUrl}/api/admin/profiles/<IDdoPerfil>/members[?[[&]$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.
profile_id: esse parâmetro é fornecido na URL e não precisa ser enviado através do GET.
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 integrantes 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 Name;
string Type
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 integrantes de um perfil (por padrão, 10 integrantes são listados por vez):
{RMUrl}/api/admin/profiles/1/members
Os integrantes de um perfil de 11 a 20 (segunda página):
{RMUrl}/api/admin/profiles/1/members?page=2
Filtrar pelo ID do integrante de um perfil:
{RMUrl}/api/admin/profiles/1/members?$filter=Id eq guid'4144d537-9c02-11e6-80ed-00155d000602'
Filtrar por "Administrar" no campo "Name":
{RMUrl}/api/admin/profiles/1/members?$filter=substringof('Administrar',Name)
RESPOSTA DE SUCESSO
Lista de privilégios de acordo com os filtros e o tamanho da página especificados.
Member[].
O objeto Member está no seguinte formato:
Member
{
Guid Id;
string Name;
string Type;
}
EXEMPLO DE RESPOSTA DE SUCESSO
[
{
"Id" : "fe80e585-e1f1-4f01-8193-e5bfb87b53d5",
"Name": "Grupo da Raquel",
"Type" : "Grupo"
},
{
"Id" : "Id=7b06ee69-12d6-11e5-80d9-00155d00020d",
"Name": "Administrador",
"Type" : "Pessoa"
},
....
]