exportAttributes

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: 2023-06-23

exportAttributes

Esta API oferece suporte somente a usuários Conceito: regras de acesso na API v22 e superiores.

Categoria	Recuperação de metadados
Descrição	Retorna metadados para a lista completa de todos os atributos no sistema.
Permissões obrigatórias para invocar	Nenhum (devem ser credenciais válidas para a instância)
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. Uma vez verificado, o método retorna um documento XML que descreve o conjunto completo de todos os atributos personalizados (excluindo o atributo de sistema de parceiro comercial para instâncias de consolidação), incluindo todos os valores de membro. Os valores de membro em um atributo são retornados em forma de árvore, com os membros pai contendo seus filhos.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportAttributes" 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 API chamada será bem-sucedida.
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 Com suporte na API v17 +
Nome da etiqueta		incluir
Descrição		Representa um conjunto de indicadores que indicam quais aspectos das informações de "valores de atributo" devem ser incluídos ou excluídos da resposta. Esse elemento é opcional: se não estiver presente, todos os atributos serão exibidos na resposta.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
attributeIDs Com suporte na API v17 +	N	Uma lista de IDs que serão exibidas na resposta da API. Isso funciona como um filtro.	"1,2,3,14"
inacessívelValores Com suporte na API v18 +	N	Indica se a resposta deve incluir valores inacessíveis ao usuário atual. O valor por padrão é falso. Somente usuários com as permissões "Modelagem" ou "Importar para todos os níveis" podem definir essa opção como verdadeira.	false
não categorizado Com suporte na API v22+ quando a instância usa regras de acesso para segurança.	N	Indica se a resposta deve incluir os nós fantasmas na resposta para cada atributo. O valor por padrão é falso. Os nós fantasmas são incluídos na resposta somente quando o usuário tem acesso a eles.	false
displayNameEnabled Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	displayNameEnabled=true indica que exportAttributes deve respeitar as propriedades de nome de exibição quando Habilitar nome de exibição está ATIVADO para a instância. displayNameEnabled=false indica que a API exportAttributes deve continuar seguindo o contrato de API anterior à versão 30, mesmo quando a opção Habilitar nome de exibição está ATIVADA para a instância. A API exportAttributes ignora as propriedades de nome de exibição. O valor por padrão para displayNameEnabled é "falso".	verdadeiro
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
  <response success="true">
   <output>
     <attributes>
       <attribute id="13" name="AP Eligible" type="account" seqNo="21">
         <attributeValue id="118" name="No" />
         <attributeValue id="117" name="Yes">
           <attributeValue id="136" name="Full" />
           <attributeValue id="135" name="Partial" />
         </attributeValue>
       </attribute>
       <attribute id="11" name="Product Line" type="account" seqNo="3">
         <attributeValue id="34" name="A" />
         <attributeValue id="35" name="B" />
       </attribute>
       <attribute id="9" name="Corporate Discount" type="level" seqNo="11">
         <attributeValue id="56" name="Available" />
         <attributeValue id="54" name="Not Applicable" />
         <attributeValue id="57" name="Not Available" />
         <attributeValue id="55" name="TBD" />
       </attribute>
       <attribute id="10" name="Tax Code" type="level" seqNo="33">
         <attributeValue id="146" name="TT-PYT" />
         <attributeValue id="145" name="TT-TRE" />
       </attribute>
       <attribute id="16" name="Industry" type="dimension" dimension-id="15" seqNo="43">
         <attributeValue id="335" name="Apparel">
            <attributeValue id="354" name="Mens Apparel" />
            <attributeValue id="355" name="Shoes" />
            <attributeValue id="356" name="Womens Apparel" />
         </attributeValue>
       </attribute>
     </attributes>
   </output>
</response>

elemento de resposta
Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	"True" ou "false", 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
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um único elemento de atributos obrigatórios. 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 atributos
Nome da etiqueta		atributos
Descrição		Contêiner para zero ou mais elementos de atributo. Os atributos serão ordenados de forma que estejam na seguinte ordem de acordo com o tipo: "conta", "nível" e "dimensão". Atributos com o mesmo tipo serão ordenados por nome.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Zero ou mais elementos de atributo.

elemento atributo
Nome da etiqueta		atributo
Descrição		Representa um único atributo que está sendo retornado na resposta a uma chamada à API exportAttributes.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número da ID do sistema interno para o atributo.	16
nome	S	O nome do atributo como aparece na página de administração de atributos.	Setor
displayNameType Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.		A representação interna do formato de nome de exibição selecionado para valores nas páginas de administração de atributos. NOME CÓDIGO NAME_CODE CODE_NAME	NOME
type	S	O tipo do atributo. Será "conta" se o atributo for para uma conta, "nível" se o atributo for para um nível ou "dimensão" se o atributo for para uma dimensão.	dimensão
autoCreate Com suporte na API v20+	S	1 se o atributo selecionado tem o campo "A importação de nível/conta/dimensão cria automaticamente valores de atributo" definido; caso contrário, 0.	0
keepSorted Com suporte na API v20+	S	"1" indica que os valores deste atributo são sempre classificados em ordem alfabética. "0" (ou não especificado) significa que os valores de atributo são classificados com base em sua posição na carga da solicitação. Se o XML contém o valor pai e pelo menos um irmão de um valor de atributo hierárquico não listado, o valor não listado é movido para o fim dos irmãos listados durante a atualização (ao reordenar os filhos do pai, todos os irmãos listados vêm primeiro, em ordem em que são especificados no XML. Todos os irmãos não listados vêm por último, na ordem em que já estão no sistema). O método leaveSorted se aplica aos filhos de cada valor de atributo pai.	1
dimension-id	N	A ID da dimensão, se o atributo for do tipo "dimensão".	15
seqNo Adicionado na API v17, mas reservado para uso futuro.
Conteúdo do elemento
Zero ou mais elementos attributeValue opcionais. Cada elemento attributeValue incluído representa um "valor de atributo raiz" no atributo, um valor que não tem valor pai.

attributeValue element
Nome da etiqueta		attributeValue
Descrição		Representa um valor de membro único de um atributo que está sendo retornado na resposta a uma chamada à API exportAttributes.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno para esse valor de membro do atributo.	34
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O código do valor de membro do atributo.	Disponível
nome	S	O rótulo do valor de membro do atributo conforme exibido na página de administração de atributos.	Disponível
displayName Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O displayName do valor do membro do atributo como derivado do displayNameType do atributo.	Disponível
descrição Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	A descrição do valor do membro do atributo conforme exibido na página de administração de atributos.
Conteúdo do elemento
Zero ou mais elementos attributeValue opcionais. Cada elemento attributeValue incluído representa um "valor de atributo filho" desse valor de atributo, cujos membros são consolidados implícitamente nesse valor.

exportActiveCurrencies

exportCalendar

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