importGroups

Categoria	Modificação de metadados
Descrição	Importar grupos de usuários que você criou no Workday principal ou em um sistema externo. Se for bem-sucedida, a API retorna os detalhes dos grupos que você importou. Você não pode usar essa API para atualizar grupos de usuários criados na interface de usuário do Adaptive Planning.
Permissões obrigatórias para invocar	Permissão Gerenciar grupos de usuários globais
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. O usuário deve ter a permissão

Acesso administrativo

para gerenciar grupos de usuários globais

para importar os grupos de usuários.

Formato da solicitação

<?xml version='1.0' encoding='UTF-8'?>
<call method="importGroups" callerName="a string that identifies your client application"
dataSource="WORKDAY/EXTERNAL" mode="REPLACE_ALL/UPDATE" userIdentifier="userName/userGUID/wid">
  <credentials login="sampleuser@company.com" password="my_pwd" />
    <groups>
        <group
          externalID="userGroup_ID_1"
          name="new user group"
           >
          <users>
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2E"
                  userName="user1"
                  wid="A9ADBCB81AA2F9BAE040307F02092C2E" />
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2F"
                   userName="user3"
                   wid="A9ADBCB81AA2F9BAE040307F02092C2F" />
          </users>
        </group>
     </groups>
</call>

Atributos de consulta

Nome	Descrição	Obrigatório
dataSource	A origem dos dados dos grupos de usuários: WORKDAY A origem dos dados dos grupos de usuários é o Workday. Esses grupos não podem ser editados no Adaptive Planning. EXTERNA A origem dos dados dos grupos de usuários é qualquer outro sistema fora do Workday. Na página Definição geral, seu administrador pode habilitar a edição de grupos com uma fonte de dados EXTERNA. Em seguida, você pode atualizar esses grupos usando a interface de usuário do Adaptive Planning. Consulte Referência: definição geral.	S
modo	O modo para a chamada à API: REPLACE_ALL. O modo substitui todos os grupos de usuários na sua instância do Adaptive Planning pelos grupos de usuários que você especifica na carga. ATUALIZAR O modo atualiza apenas os grupos de usuários que você especifica na carga.	S
userIdentifier	A ID dos usuários especificados nos grupos de usuários: userName. O nome de usuário para o usuário especificado. userGUID. A ID de usuário global para o usuário especificado. wid. A ID Workday para o usuário especificado.	S

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 é executada como esse usuário. Qualquer trilha de auditoria ou histórico de ações no sistema mostra que esse usuário executou a ação. Portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API seja bem-sucedida.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
login	S	O nome de conexão 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. Além disso, para formatar números e datas de saída (usando o separador de milhares adequado, nomes de período e formatação de data). Os parâmetros regionais também especificam o idioma em que todas 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 especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não é especificada, a instância por padrão do usuário é usada. Para determinar os códigos de instância disponíveis, use a API exportInstances.	MYINSTANCE1
Conteúdo do elemento
Nenhuma

elemento de grupo
Nome da etiqueta		grupo
Descrição		Especifica um conjunto de grupos de usuários a serem criados ou atualizados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
externalID	S	O identificador externo do grupo de usuários.	user_group_1
nome	S	O nome do grupo de usuários.	Administradores de segurança
Conteúdo do elemento
Elemento Usuários

elemento de usuário
Nome da etiqueta		usuário
Descrição		Especifica um usuário ou usuários a serem adicionados ao grupo de usuários.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
userGUID	Y (desde que a ID de usuário especificada pelo chamador da API seja userGUID)	A ID global do usuário.	B9ADBCB81AA2F9BAE040307F02092C2
userName	Y (desde que a ID de usuário especificada pelo chamador da API seja userName)	O nome de usuário do usuário.	updateMail@company.com
wid	Y (desde que a ID de usuário especificada pelo chamador da API seja WID)	A ID Workday do usuário.	A9ADBCB81AA2F9BAE040307F02092C2E
Conteúdo do elemento
No caso de um usuário inválido (ou seja, userGUID/userName/WID inválido), o usuário inválido específico será ignorado e a solicitação será processada para o grupo para o restante dos usuários válidos. No entanto, para os seguintes cenários relacionados ao elemento <user>, todo o grupo será rejeitado na carga. ID de usuário ausente: <user/> <user userName=""/> <user userName/userGUID/wid=" "/> Mensagem de erro; A ID de usuário está ausente. Especifique um userName/userGUID/WID válido para todos os usuários. WID de formato inválido: Comprimento da WID menor ou maior que 32 caracteres. Mensagem de erro: especifique uma userWID válida para todos os usuários. userGUID não é um formato válido: Comprimento de userGUID menor ou maior que 32 caracteres. userGUID não é alfanumérico. Mensagem de erro: especifique uma userGUID válida para todos os usuários.

Formato da resposta

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
      <result>
          <imported_groups>
              <group success="true" externalID="ID_1" id="33" name="New Group 1" />
          </imported_groups>
      </result>
  </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 em sua resposta.	verdadeiro
Conteúdo do elemento
Dependendo se você fez a chamada de criação ou atualização, um único elemento de resultado com os elementos de status created_usergroup ou created_usergroup.

imported_groups element
Nome da etiqueta		imported_groups
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito do grupo	S	O status retornado é verdadeiro ou falso.	"true"
mensagem	S	A mensagem de status.	"grupo de usuários - novo grupo de usuários criado com êxito." "Carga parcialmente bem-sucedida na limpeza de associações de usuário. Tente novamente e, se o problema persistir, entre em contato com o suporte."
Conteúdo do elemento
Nenhum.