Retorna uma lista paginada dos grupos cadastrados no módulo Organização.
URL
{RMUrl}/api/organization/groups[?[[&]$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 grupos 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 Description;
string Email;
string AdditionalInformation;
Guid ResponsibleId;
string ResponsibleName;
string ResponsibleEmail;
string ResponsiblePhone;
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 grupos (por padrão, 10 grupos são listados por vez):
{RMUrl}/api/organization/groups
Os grupos de 11 a 20 (segunda página):
{RMUrl}/api/organization/groups?page=2
Filtrar pelo ID do grupo:
{RMUrl}/api/organization/groups?$filter=Id eq guid'6fe49ce4-56d4-475f-9483-1adca6b2976c'
Filtrar por "Equipe" no campo "Name":
{RMUrl}/api/organization/groups?$filter=substringof('Equipe',Name)
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os grupos de acordo com os filtros e o tamanho da página especificados.
Group[].
O objeto Group está no seguinte formato:
Group
{
Guid Id;
string Name;
string Description;
string Email;
string AdditionalInformation;
object Responsible;
object CustomAttributes[];
}
Para mais informações sobre os atributos customizados, veja o tópico Apêndice 1: Tipos de atributo.
EXEMPLO DE RESPOSTAS DE SUCESSO
[
{
"Id":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"Equipe de TI",
"Description":"Equipe de TI da filial Brasil",
"Email":"tibrasil@exemplo.com.br",
"AdditionalInformation":"Equipe de TI da filial Brasil da Empresa ABC",
"Responsible":{"Email":"email@empresaabc.com.br",
"Id":"00d6dccf-1a9c-11e1-b470-0800270094a6",
"Name":"Alexandre Ferreira",
"Phone":"+55 (21) 5555-0000"},
},
{
"Id":"63e5fe02-5773-4a49-ba13-22506f022316",
"Name":"Grupo de diretores",
"Description":"Grupo de diretores",
"Email":"diretores@exemplo.com.br",
"AdditionalInformation":"Grupo de usuários dos diretores da Empresa ABC",
"Responsible":{"Email":"email@empresaabc.com.br",
"Id":"00d6dccf-1a9c-11e1-b470-0800270094a6",
"Name":"Alexandre Ferreira",
"Phone":"+55 (21) 5555-0000"},
"CustomAttributes":{
"link":"https:\/\/empresa.com.br",
"text":"Texto"}
}
]