Grupos

Ponto de extremidade de URL

VERBOS HTTP com suporte

GET:

Solicitação:

/groups/{groupId}

Recupera a lista de todos os grupos e seus usuários/Membros definidos para a instância especificada.

Exemplo de URI de solicitação:

HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=globalsales&offset=2&limit=1

Cabeçalho de solicitação de amostra:

Accept-Language: en

Corpo da solicitação de amostra

Parâmetros de consulta

Nome	Descrição	Obrigatório
groupId	A ID do grupo que você quer retornar individualmente	N
includeUsers	Para determinar se os usuários dos grupos que estão sendo chamados devem ou não ser retornados. Por padrão, a opção Incluir usuários está ativada.	N
limit	O número máximo de objetos em uma única resposta.	N
offset	Para mostrar uma determinada quantidade de grupos por página. Se houver mais grupos do que o limite, os grupos extras passarão para a próxima página. Para acessar uma determinada página, você precisa especificar o valor de deslocamento.	N
instanceCode	Por padrão, retorna o usuário da instância por padrão atribuído. Ao informar um valor, você pode chamar instâncias às quais seu usuário tem acesso, incluindo instâncias pai/filho.	N

Exemplo de resposta

Exemplo de resposta

{ "links": { "next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1", "previous": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1" }, "total": 3, "groups": [ { "id": 2, "name": "Admins", "groupType": "NATIVE", "users": [ { "userGuid": "randomValue", "wid": "", "userName": "test@email.com" }, { "userGuid": "randomValue", "wid": "", "userName": "test2@email.com" }, ] }, { "id": 1, "name": "Corporate and Operations", "groupType": "NATIVE", "users": [] }, { "id": 3, "name": "Ops and Admins", "groupType": "NATIVE", "users": [], "groups": [ { "id": 2, "name": "Admins", "groupType": "NATIVE" }, { "id": 1, "name": "Corporate and Operations", "groupType": "NATIVE" } ] } ] }

Elemento de resposta

Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
total	S	Número total de grupos.	3
grupos	S	Informações de grupo de todos os grupos ou de grupos especificados. Se um grupo está dentro de outro grupo, também mostra os grupos associados ao grupo indicado.	{ "id": 1, "name": "Corporate and Operations", "groupType": "NATIVE", "users": [] }
groupType	S	Mostra o tipo de grupo.	Externo
ID	S	ID associada do grupo.	1
nome	S	Nome do grupo.	"Administradores"
usuários	N	Se includeUsers = true ou includeUsers é o valor por padrão, são fornecidos o GUID, o WID e o nome de usuário do usuário. caso contrário, não é retornado.	"users": [ { "userGuid": "randomValue", "wid": "", "userName": "test@example.com" }, { "userGuid": "randomValue", "wid": "", "userName": "test2@example.com" }
links	N	Quando o limite e/ou deslocamento é fornecido e você precisa de um meio para se mover para diferentes páginas de grupos, pode usar links para avançar e voltar.	"links": { "next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1", "previous": "HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1" }
próximo	N	Se o limite é fornecido e há uma próxima página disponível, "links" aparece com "próximo".	"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
anterior	N	Se limite e deslocamento são fornecidos e você está no meio, em que uma página anterior e posterior está disponível, a opção "anterior" está disponível.	"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
Conteúdo do elemento
Informações relacionadas aos elementos indicados.

Respostas de erro

Erros	Causa
Especifique valores de parâmetros válidos para limite e deslocamento.	entrada inválida para valores de limite/deslocamento
GroupAPI: para getGroupByGroupId, grupo não localizado para o código de instância: {TENANT}	groupId não existe para o código de instância
Você não tem todas as permissões para executar esta API: Gerenciar grupos de usuários globais.	as credenciais de usuário não têm as permissões adequadas para evocar a chamada à API
Credencial inválida	as credenciais usadas estão incorretas para a instância
HTTP 404 não encontrado	o parâmetro groupId é inválido