exportLevels

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

exportLevels

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 níveis da organização 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 uma etiqueta de credenciais para identificar e autorizar o usuário que faz a chamada e uma etiqueta de inclusão opcional para indicar quais níveis incluir na resposta. Depois que as credenciais do usuário são verificadas, o método retorna um documento XML que descreve o conjunto de níveis da organização no sistema correspondente à solicitação. Os níveis são retornados em formato de árvore aninhada, com uma etiqueta de nível envolvendo outra se o nível representado pela etiqueta de inclusão é o pai do nível delimitado.

Filtragem de nível

A filtragem de nível/versão indisponível sempre se aplica quando uma versão é especificada.

Se um usuário especifica uma planilha atribuída a usuário na solicitação:

Os níveis retornam se o usuário tem acesso a essa planilha. Para usuários administradores, se

inaccessibleValues

é verdadeira, os níveis retornam para a planilha.

Todos os níveis da planilha retornam se o usuário tem acesso à planilha, independentemente do nível de acesso do usuário.

Se um usuário especifica uma planilha atribuída a nível na solicitação:

A filtragem de acesso de usuário se aplica quando exigido por

inaccessibleValues,

que determina se a resposta deve incluir níveis aos quais o usuário não tem acesso.

Em seguida, o filtro da planilha é aplicado.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportLevels" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_pwd"/>
   <include versionID="3" inaccessibleValues="false"/>
   <sheet id="3" />
</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
Nome da etiqueta		incluir
Descrição		Representa um conjunto de indicadores que indicam quais aspectos das informações dos níveis devem ser incluídos ou excluídos da resposta. Esse elemento é opcional: se não estiver presente, o valor por padrão será falso para inacessívelValues e em branco (ou todas as versões) para versionName/versionID.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
grupos Disponível na API v23 ou superior	N	Indica se os elementos de nível 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 nível 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
inacessívelValores Disponível na API v18+.	N	Se a resposta deve incluir níveis aos quais o usuário não tem acesso. Verdadeiro ou falso. O valor por padrão, se o elemento ou seu atributo não está presente, é falso. Se definida como falsa, a resposta incluirá apenas os níveis aos quais o usuário tem acesso aos dados, direto ou implícito. Observe que isso significa que a resposta pode não ser mais uma única árvore de níveis com raiz, mas pode ser uma série de subárvores separadas da árvore geral. Somente usuários com as permissões "Estrutura organizacional: todos os níveis" ou "Importar para todos os níveis" podem definir essa opção como verdadeira.	false
inacessívelNíveis Disponível na API v17 e anteriores. Não disponível na API v18+.	N	Verdadeiro ou falso. Se a resposta deve incluir níveis aos quais o usuário não tem acesso. O valor por padrão, se o elemento ou seu atributo não está presente, é verdadeiro. Se definida como falsa, a resposta incluirá apenas os níveis aos quais o usuário tem acesso aos dados, direto ou implícito. Observe que isso significa que a resposta pode não ser mais uma única árvore de níveis com raiz, mas pode ser uma série de subárvores separadas da árvore geral.	verdadeiro
versionName Atualizado na API v18	N	Indica se a resposta deve incluir apenas os níveis disponíveis para o nome da versão solicitada. O valor por padrão, se o elemento ou seu atributo não estiver presente, é retornar todos os níveis. Se um nome de versão é especificado, somente os níveis disponíveis para a versão especificada serão retornados. Se presente, o atributo inacessívelValues também será aplicado e somente os níveis que estiverem disponíveis na versão especificada e acessíveis pelo usuário solicitante serão retornados. Se o nome da versão especificada não é encontrado, essa API retorna um erro. Se os atributos versionName e versionID são passados, versionID é ignorado. Ao especificar uma versão, a chamada será bem-sucedida somente se o usuário tiver acesso à versão.	Engenharia
versionID Atualizado na API v18	N	Igual a versionName (acima), exceto que usa um número de ID de versão como parâmetro. Indica se a resposta deve incluir apenas os níveis disponíveis para a versão solicitada. O valor por padrão, se o elemento ou seu atributo não estiver presente, é retornar todos os níveis. Se uma ID de versão é especificada, somente os níveis disponíveis para a versão especificada serão retornados. Se presente, o atributo inacessívelValues também será aplicado e somente os níveis que estiverem disponíveis na versão especificada e acessíveis pelo usuário solicitante serão retornados. Se a ID de versão especificada não é encontrada, essa API retorna um erro. Se os atributos versionName e versionID são passados, versionID é ignorado. Ao especificar uma versão, a chamada será bem-sucedida somente se o usuário tiver acesso à versão.	3
não categorizado Com suporte na API v22+ quando a instância usa regras de acesso para segurança.	N	Indica se os níveis fantasmas devem ser incluídos na resposta. O valor por padrão é falso. Os níveis 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 exportLevels deve respeitar as propriedades de nome de exibição de code , displayNameType e description quando Habilitar nome de exibição está ATIVADO para a instância. displayNameEnabled=false indica que a API exportLevels deve continuar seguindo o contrato de API anterior à v30, mesmo quando a opção Habilitar nome de exibição está ATIVADA para a instância. A API exportLevels ignora as propriedades de nome de exibição code , displayNameType e description . O valor por padrão para displayNameEnabled é "falso".	false
Conteúdo do elemento
(nenhum)

elemento de planilha
Nome da etiqueta		planilha
Descrição		Representa uma planilha, em que somente os níveis disponíveis para essa planilha serão incluídos na resposta. Esse elemento é opcional: se não estiver presente, a API retornará informações de nível independentemente de uma planilha específica. Se a planilha especificada é uma planilha atribuída a nível, esse filtro é aplicado sobre a versão e o filtro de acesso do usuário, se houver. Se a planilha fornecida é uma planilha atribuída a usuário à qual o usuário atual tem acesso, todos os níveis dessa planilha são retornados após qualquer filtro de versão.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno da planilha.	234
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
 <levels seqNo="21">
   <level id="1" name="Corporate Rollup" currency="USD" isImportable="1" workflowStatus="I">
     <level id="2" name="Engineering" currency="USD" shortName="Engr" isImportable="1" workflowStatus="I">
       <level id="7" name="Development" currency="USD" shortName="Dev" isImportable="1" workflowStatus="I"/>
       <level id="8" name="QA" currency="INR" isImportable="0" workflowStatus="L"/>
       <level id="9" name="Documentation" currency="PKR" shortName="Doc" isImportable="1" workflowStatus=R"/>
     </level>
     <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" isImportable="0" workflowStatus="A">
       <attributes>
         <attribute name="Corporate Discount" value="Available" attributeId="20" valueId="188" />
         <attribute name="Transfers Restricted" value="Yes" attributeId="21" valueId="194" />
       </attributes>
     </level>
   </level>
 </levels>
</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 níveis
Nome da etiqueta		níveis
Descrição		Contêiner para o elemento de nível.
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 nível. Se a solicitação incluir níveis inacessíveis, haverá apenas um elemento de nível, que representa o nível superior da organização.

elemento de nível
Nome da etiqueta		level
Descrição		Representa um único nível da organização que está sendo retornado em resposta a uma chamada à API exportLevels.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno para o nível.	7
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O código do nível.	Desenvolvimento
nome	S	O nome do nível, como aparece em relatórios e planilhas.	Desenvolvimento
displayName Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O nome de exibição do nível conforme derivado de displayNameType.	Desenvolvimento
moeda	S	O código da moeda atribuída a este nível da organização. A moeda será uma das moedas configuradas para a instância, encontradas na chamada exportActiveCurrencies.	INR
publishCurrency Disponível na API v24+	N	O código da moeda atribuída a ser publicada neste nível. Essa propriedade é aplicável somente quando o Power of One foi habilitado para a instância. A moeda será uma das moedas configuradas para a instância, encontradas na chamada exportActiveCurrencies.	USD
shortName	N	A abreviação do nível, se houver, conforme inserida em Administração de nível.	Dev
AvailableStart	N	O período de início para a disponibilidade de nível para a versão de valores reais, aplicável somente quando a versão de valores reais é especificada na solicitação. O valor pode ser um código de período, como "01/2012" ou o valor especial "START" que indica o início da versão.	01/2013
AvailableEnd	N	O período de término para a disponibilidade de nível para a versão de valores reais, aplicável somente quando a versão de valores reais é especificada na solicitação. O valor pode ser um código de período, como "12/2013" ou o valor especial "END" que indica o fim da versão.	12/2013
isImportable	N	Indica se o nível associado pode ser importado na versão especificada. '0' significa que não é importável e '1' significa que é importável. Um nível é importável se pelo menos um intervalo de tempo na versão especificada é importável. O atributo isImportable é emitido somente se versionName ou versionID é especificado na solicitação. Observação: isImportable indica apenas que um nível está disponível para importação na versão especificada, não que o usuário que faz a chamada à API tem permissão para importar para a versão ou o nível. Use exportVersions para ver quais versões estão disponíveis para importação pelo usuário.	1
workflowStatus	N	Emite o status do fluxo de trabalho para o nível associado. I para "Em andamento", S para "Enviado", R para "Rejeitado", A para "Aprovado" e L para "Bloqueado". Incluído na resposta somente se o fluxo de trabalho estiver habilitado para esta empresa e um versionName ou versionID do Planning for especificado na solicitação. O fluxo de trabalho não está disponível em versões de valores reais.	I
isLinked	S	1 se o nível é um nível vinculado; caso contrário, 0.	1
isElimination	S	1 se o nível é um nível de eliminação; caso contrário, 0.	0
hasChildren	N	Indica se o nível tem filhos. "false" para não, "true" para sim. Esse atributo é definido para qualquer nível que tenha filhos, independentemente de os filhos serem acessíveis ou não. Se um nível tem filhos, mas os filhos não estão acessíveis, o atributo hasChildren ainda é definido como verdadeiro.	verdadeiro
descrição Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	A descrição do nível, se houver, conforme inserida em Administração de nível.
Conteúdo do elemento
Um elemento de nível aninhado para cada nível filho direto deste nível. Um elemento de atributos se esse nível tem um ou mais atributos associados a ele.

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

elemento atributo
Nome da etiqueta		atributo
Descrição		Representa um único mapeamento de atributos de nível não em branco ao qual um nível está associado.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome do atributo de nível	Desconto corporativo
valor Com suporte na API v34 quando a configuração de Nome de exibição vigente está ATIVADA.	S	O valor do atributo de nível associado ao nível.	Sim
valueCode Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34 quando a configuração de Nome de exibição vigente está ATIVADA.	N	O código de valor deste atributo. Para as APIs v32 e v33, valueCode só faz sentido quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1	S
valueName Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34 quando a configuração de Nome de exibição vigente está ATIVADA.	N	O nome do valor deste atributo. Para API v32 e API v33, valueName é significativo somente quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1value	Sim
valueDisplayName Disponível somente na API v32+ para instâncias que habilitam o nome de exibição.	S	O nome de exibição do valor de atributo. Para a API v32 e versões mais recentes, valueDisplayName é significativo somente quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1value	Sim
attributeID	S	O número de ID do sistema interno do atributo de nível.	20
valueID	S	O número de ID do sistema interno do valor do atributo de nível.	188
Conteúdo do elemento
(nenhum)

exportInstances

exportLocales

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