exportGroups

Categoria	Recuperação de metadados
Descrição	Retorna a lista completa de todos os grupos definidos para a instância especificada. Isso inclui os grupos definidos globalmente em toda a instância e os grupos definidos pelos usuários.
Permissões obrigatórias para invocar	Administrador de usuários
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém apenas uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. Depois de verificado, o método retorna um documento XML que descreve o conjunto completo de todos os grupos definidos na instância.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportGroups" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
</call>

elemento de credenciais
Nome da etiqueta		credenciais
Descrição		Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
login	S	O nome de logon do usuário que invoca o método de API. Esse usuário deve ter as permissões necessárias para invocar o método.	sampleuser@company.com
senha	S	A senha do usuário que invoca o método de API.	my_password
parâmetros regionais	N	Especifique os parâmetros regionais a serem usados para interpretar números e datas de entrada e para formatar números e datas de saída (usando o separador de milhares, nomes de meses e formatação de data adequados). Os parâmetros regionais também são usados para especificar o idioma em que as mensagens do sistema na resposta devem ser exibidas. Se não especificado, en_US (inglês americano) é usado.	fr_FR
instanceCode	N	Se o usuário especificado nas credenciais tem acesso a mais de uma instância do Adaptive Planning , esse atributo pode ser usado para especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não for especificada, a instância por padrão do usuário será usada. Para determinar os códigos de instância disponíveis, use a API exportInstances.	MYINSTANCE1
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
 <output>
    <groups>
       <group id="1" name="Corporate and Operations" isGlobal="true"/>
       <group id="2" name="Admins" isGlobal="true"/>
       <group id="3" name="Ops and Admins" isGlobal="true"/>
       <group id="4" name="My group" isGlobal="false" ownerId="3"/>
    </groups>
 </output>
</response>

elemento de resposta
Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	Verdadeiro ou falso, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso na resposta.	verdadeiro
Conteúdo do elemento
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório.

elemento de mensagens
Nome da etiqueta		mensagens
Descrição		Contêiner para um ou mais elementos de mensagem.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de mensagem.

elemento de mensagem
Nome da etiqueta		mensagem
Descrição		Representa uma mensagem que está sendo enviada pelo sistema de volta para o autor da chamada. As mensagens são usadas para mensagens de erro quando as solicitações não são bem-sucedidas, para mensagens de aviso quando as solicitações são bem-sucedidas e para mensagens de confirmação quando as solicitações são bem-sucedidas.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
chave	N		Quando fornecida, uma chave é uma forma de identificar uma determinada mensagem ou tipo de mensagem, útil para fins de registro automatizado de erros e recuperação em programas cliente. As chaves não são alteradas em diferentes parâmetros regionais de solicitações, mesmo quando o idioma da mensagem é alterado. As chaves também não devem ser alteradas no futuro devido a ajustes de texto ou alterações de terminologia.
Conteúdo do elemento
O texto da mensagem. Esse texto está no idioma dos parâmetros regionais especificados na solicitação (supondo que haja suporte para os parâmetros regionais). O texto também pode conter informações variáveis, como o número de linhas que foram processadas ou a coluna ou valor específico que causou um erro.

elemento de saída
Nome da etiqueta	saída
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de grupos. Esse invólucro de saída é padrão em todas as respostas de API e inclui a saída válida de qualquer chamada de API bem-sucedida.

elemento de grupos
Nome da etiqueta		grupos
Descrição		Contêiner para um ou mais elementos de grupo.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Zero ou mais elementos de grupo.

elemento de grupo
Nome da etiqueta		grupo
Descrição		Representa um único grupo que está sendo retornado em resposta a uma chamada à API exportGroups.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número da ID do sistema interno do grupo de usuários.	2
nome	S	O nome do grupo de usuários.	Operações e administradores
isGlobal	S	Indica se o grupo de usuários é global na instância.	3
ownerId	S	A ID do sistema interno do usuário que é proprietário deste grupo de usuários. Definido somente quando isGlobal="false".	5
Conteúdo do elemento
(nenhum)