exportUsers

Adaptive Planning

Documentação do Workday Adaptive Planning (Workday 2025R2)
Integração
Como gerenciar a integração de dados
Documentação da API
Métodos de criação, atualização e leitura de metadados e dados

Última atualização: 2024-03-08

exportUsers

Categoria	Recuperação de metadados
Descrição	Retorna metadados para a lista completa de todos os usuários na instância.
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 usuários definidos na instância.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportUsers" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</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)

incluir elemento Disponível na API v17 e anteriores. Não disponível na API v18+.
Nome da etiqueta		incluir
Descrição		Representa um conjunto de indicadores que indicam quais aspectos das informações dos usuários devem ser incluídos ou excluídos da resposta. Esse elemento é opcional: se não estiver presente, os valores por padrão serão true para ownerLevels e false para HiddenVersions.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
grupos Disponível na API v23+.	N	A palavra true ou false. Indica se os elementos de usuário na resposta incluem um atributo groupIds. Se verdadeira, o groupIds na resposta conterá uma lista separada por vírgulas de todos os grupos em que o usuário está. Se o atributo não está presente ou se seu valor é diferente de verdadeiro ou falso, o valor por padrão falso é usado.	verdadeiro
ownerLevels Disponível na API v17 e anteriores. Não disponível na API v18+.	N	A palavra true ou false. Indica se os elementos de usuário na resposta devem incluir ou não os atributos ownerLevels. Se o atributo não está presente ou se seu valor é diferente de verdadeiro ou falso, o valor por padrão Verdadeiro é usado.	verdadeiro
hiddenVersions Disponível na API v17 e anteriores. Não disponível na API v18+.	N	A palavra true ou false. Indica se os elementos de usuário na resposta devem incluir ou não os atributos HiddenVersions. Se o atributo não está presente ou se seu valor é diferente de verdadeiro ou falso, o valor por padrão falso é usado.	false
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
   <users seqNo="55">
     <user id="19" guid="B9ADBCB81AA2F9BAE040307F02092C2E" login="analytica@fakecompany.com" email="analytica@fakecompany.com"
           name="Anna Analyzer" permissionSetId="3" timeZone="US/Pacific"/>
     <user id="123" guid="AAFF5218D55ABB9234660001BEC117A9" login="randomuser@fakecompany.com" email="randomuser@fakecompany.com"
           name="J. Random User" permissionSetId="2" timeZone="US/Pacific"/>
   </users>
</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
obsoleto	N	Se presente na etiqueta de resposta e definido como verdadeiro, esse atributo indica que a versão do método ou da API que está sendo invocada se tornou obsoleta e está oficialmente obsoleta. Embora continue a funcionar neste momento, pode deixar de funcionar em breve. Normalmente, esse atributo não está presente.	false
Conteúdo do elemento
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório.

elemento de saída
Nome da etiqueta	saída
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de contas. 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 usuários
Nome da etiqueta		usuários
Descrição		Contêiner para um ou mais elementos de usuário.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
seqNo Adicionado na API v17, mas reservado para uso futuro.
Conteúdo do elemento
Um ou mais elementos de usuário.

elemento de usuário
Nome da etiqueta		usuário
Descrição		Representa um único usuário que está sendo retornado na resposta a uma chamada à API exportUsers.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno do usuário.	19
guid	S	Um identificador globalmente exclusivo para o usuário. Este identificador nunca será alterado para este usuário, mesmo que seu logon ou nome seja alterado no futuro.	B9ADBCB81AA2F9BAE040307F02092C2E
login	S	O logon deste usuário.	analytica@fakecompany.com
e-mail	S	O endereço de e-mail deste usuário. Pode ficar em branco se o usuário não configurou um endereço de e-mail válido.	analytica@fakecompany.com
nome	S	O nome deste usuário.	Anna Analyzer
posição Disponível na API v39+	N	Posição do usuário.	"CEO"
permissionSetId Disponível na API v25+ Não disponível na API v36+	S	A ID do sistema interno do conjunto de permissões atribuídas a este usuário. Consulte também exportPermissionSets.
permissionSetIds Disponível na API v36+	S	As IDs do sistema interno dos conjuntos de permissões atribuídas a este usuário. Consulte também exportPermissionSets.
roleId Disponível na API v25 e anteriores Indisponível na API v25+	S	A ID do sistema interno da função atribuída a este usuário. Consulte também exportRoles.	3
ownerLevels Não disponível na API v18	S	Esse atributo só é incluído se o usuário incluído nas credenciais da solicitação tem permissão de administrador de nível para toda a árvore da organização e se a solicitação indica que ownerLevels deve ser incluído. Se incluído, o valor desse atributo é uma lista separada por vírgulas de IDs do sistema interno para os níveis da organização aos quais esse usuário tem acesso direto. O usuário também terá acesso a todos os níveis filho dos listados aqui	5,10,13
hiddenVersions Não disponível na API v18	N (ver descrição)	Esse atributo só é incluído se o usuário incluído nas credenciais da solicitação tem permissão de administrador de versão e se a solicitação indica que ocultasVersões devem ser incluídas. Se incluído, o valor desse atributo é uma lista separada por vírgulas de IDs do sistema interno para versões ou pastas de versões que estão ocultas para esse usuário (mas cujo pai é inexistente ou não está oculto). O usuário também não poderá ver nenhuma versão filho das versões listadas aqui.	121
alternateEmail Disponível na API v39+	N	O endereço de e-mail alternativo deste usuário.	"abc@greenco.com"
samlFedId Disponível na API v39+	N	A ID SAMLFederation deste usuário.	"1234"
timeZone	S	O fuso horário do usuário.	EUA/Pacífico
página inicial Disponível na API v39+	N	Página inicial do usuário.	"Bem-vindo"
país Disponível na API v39+	N	Código de país do usuário (código alfa-2).	"EUA"
usState Disponível na API v39+	N	Código do estado do usuário (o país deve ser EUA).	"CA"
perspectiva Disponível na API v39+	N	ID da perspectiva do usuário.	"111"
perspectiveName Disponível na API v39+	N	Nome da perspectiva da perspectiva do usuário.	"Testar perspectiva"
painel Disponível na API v39+	N	ID do painel para o usuário - requer a ID da perspectiva para definir a ID do painel. Se a ID da perspectiva é especificada e a do painel não é especificada, a ID do painel é definida como nula.	"222"
dashboardName Disponível na API v39+	N	Nome do painel do usuário.	"Testar painel"
netsuiteLogin Disponível na API v39+	N	Logon no Netsuite	"abc@netsuite.com"
salesforceLogin Disponível na API v39+	N	Logon do Salesforce	"abc@salesforce.com"
createdDate Disponível na API v39+	N	Data e hora em que o usuário foi criado.	"2023-08-15 08:02:16.0"
lastLogin Disponível na API v39+	N	Data e hora da última conexão do usuário.	"2023-11-13 22:22:39.0"
failedAttempts Disponível na API v39+	N	Número de tentativas de logon com falha para este usuário (consecutivas).	"0"
bloqueado Disponível na API v39+	N	Se o usuário está bloqueado/não pode ser conectado (devido a muitas falhas de logon).	"falso"
Conteúdo do elemento
Um elemento de assinaturas.

elemento de assinaturas
Nome da etiqueta		assinaturas
Descrição		Representa as configurações de assinatura de e-mail de um usuário.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nosubscriptions	S	Configuração para sinalizar que o usuário recusou todas as assinaturas. 1 significa que o usuário recusou todas as assinaturas.	0
systemAlertsAndUpdates	S	Configuração para assinatura de alertas e atualizações do sistema aceita pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	1
customerNewsLetter	S	Configuração para a assinatura de boletins informativos do cliente aceita pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	1
localEvents	S	Configuração para a inscrição de eventos locais escolhida pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	1
educationTraining	S	Configuração para a inscrição de eventos de formação e treinamento aceita pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	1
customerWebinars	S	Configuração para a inscrição de eventos de webinário do cliente aceita pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	1
newProductsAndEnhancements	S	Configuração para notificação de novos produtos e aprimoramentos aceita pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	1
partnerNewsLetter	S	Configuração para a assinatura de boletins informativos de parceiros aceita pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	1
partnerWebinars	S	Configuração para a inscrição de eventos de webinário de parceiros aceita pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	1
userGroups	S	Configuração para notificação de eventos de grupos de usuários aceita pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	1
pesquisas	S	Configuração para recebimento de pesquisas aceitas pelo usuário. 1 significa que o usuário aceitou e 0 significa que ele recusou.	0
Conteúdo do elemento
nenhum

exportTransactionDefinition

exportVersions

Este conteúdo foi útil?

O que precisamos melhorar? Informações corretas Responde à minha pergunta Fácil de encontrar Fácil de entender Ajuda a concluir minha tarefa Informações completas e detalhadas

O que precisamos melhorar? Informações incorretas Não responde à minha pergunta Não é fácil de encontrar Não é fácil de entender Não ajuda a concluir minha tarefa Informações incompletas ou pouco detalhadas

Conte-nos sobre a tarefa que você está executando. Quais informações adicionais podem melhorar este conteúdo? Há mais algum detalhe que gostaria de compartilhar?

Nome completo

E-mail

A Workday usará seu nome e e-mail para fornecer respostas relacionadas ao seu feedback. Suas informações serão tratadas de acordo com a nossa Declaração de Privacidade.

Agradecemos seu feedback