updateLevels

HTTP	Descrição
Method	Post
Content-Type	text/xml

Exemplo de curvatura


curl -H "Content-Type: text/xml" -d @C:/temp/updateLevels.xml -X POST https://api.adaptiveplanning.com/api/v19

updateLevels.xml contents

Formato da solicitação

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"/>
<levels>
<level id="1" name="HQ">
 <level id="2" name="Engineering" currency="USD" shortName="Engr">
   <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0"/>
   <level id="9" name="QA" currency="INR" eliminationTradingPartner="1"/>
   <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1">
      <version name="Budget 2011" available="1"/>
      <version name="Budget 2012" available="0"/>
      <version name="Budget 2013" available="1"/>
   </level>
 </level>
 <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1">
     <attribute name="Corporate Discount" value="Available"/>
     <attribute name="Transfers Restricted" value="Yes"/>
     <dimension name="Region" value="C-US"/>
 </level>
</level>
</levels>
</call>

Para cargas grandes, você pode publicar arquivos XML compactados (zipados). Consulte Atualização em massa de metadados.

As seguintes condições se aplicam a updateLevels:

Os níveis são identificados para atualização por meio de seu número de ID interno.

Para criar novos níveis, forneça a eles uma propriedade de ID em branco ou ausente.

Você pode mover um item existente (não novo) para que ele se torne filho de um novo item. Isso cria o novo item e move o item existente abaixo dele como um filho.

A disponibilidade da planilha e o acesso do usuário não podem ser atualizados por meio de

updateLevels

.

Formato de solicitação para criação de um novo nível

Para criar um novo nível, inclua o nível pai pela ID. Por exemplo, para adicionar um novo nível filho abaixo do

Engr

valor que tem

id 7

, você pode usar:

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateLevels" callerName="Steve C">
 <credentials login="stevec@greenco.com" password="password"/>
 <levels>
   <level id="7">
     <level id="" name="Documentation" description="docs" shortName="" >
     </level>
   </level>
 </levels>
</call>

Este método não altera nada no nível

id 7

. Ele cria um novo filho chamado

Documnentation

para

id 7

. Todos os filhos não mencionados de

Engr

mover para o fim da lista de filhos. Isso equivale a "definir o pai" para o novo nível.

Formato de entrada 1: a carga inclui toda a árvore

A API updateLevels funciona melhor quando um chamador quer fornecer o novo estado da árvore sem se preocupar com alterações.

A API updateLevels calcula as alterações na estrutura de nível e somente os níveis recém-adicionados ou alterados são atualizados. Observe que o

levels

o elemento contém apenas um filho direto

level

elemento. Esse elemento filho contém o restante da hierarquia.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<levels>
   <level id="1" name="HQ">
      <level id="2" name="Engineering" currency="USD" shortName="Engr">
         <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" />
         <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" />
         <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" />
      </level>
      <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1" />
   </level>
</levels>
</call>

Formato de entrada 2: a carga inclui estrutura de subárvore de níveis

Esse formato oferece suporte a casos de uso em que as alterações são limitadas a apenas uma parte da estrutura de árvore de níveis.

Por exemplo, as alterações estão dentro do nível Engenharia. Mais uma vez, o

levels

o elemento contém apenas um filho direto

level

elemento. Esse nível contém o restante dos níveis da estrutura de subárvore. A menor subárvore para este formato inclui apenas um pai e um filho.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<levels>
   <level id="2" name="Engineering" currency="USD" shortName="Engr">
      <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" />
      <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" />
      <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" />
   </level>
</levels>
</call>

Formato de entrada 3: atualizando um único nível

Esse formato oferece suporte ao tratamento do caso de uso quando as alterações são limitadas a apenas um nível. O

levels

o elemento contém apenas um filho direto

level

elemento.

Use somente o formato de entrada 3 quando atualizar um único nível. O formato de entrada 3 não é o formato preferencial para atualizar vários níveis. Você não pode criar um novo nível com este formato. Use o formato de entrada 2 para adicionar novos níveis filho.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<levels>
   <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" />
</levels>
</call>

Formato de entrada 4: formato simples contendo todas as etiquetas de nível sob a etiqueta de níveis

Este formato contém

level

etiquetas abaixo de

levels

em um formato simples sem hierarquia. Você só atualiza as propriedades de cada nível listado, sem alterar as hierarquias de níveis.

Use somente o formato simples para deltas ou alterações incrementais em partes muito pequenas da hierarquia. O formato de entrada 1 oferece o melhor desempenho para carregar toda a hierarquia de níveis.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="steve@steveco.com" password="" />
<levels>
   <level id="2" name="Engineering" currency="USD" shortName="Engr" />
   <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" />
   <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" />
   <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1">
      <version name="Budget 2011" available="1" />
      <version name="Budget 2012" available="0" />
      <version name="Budget 2013" available="1" />
   </level>
</levels>
</call>

Tratamento de várias renomeações em uma única chamada updateLevels

Várias renomeações da mesma entidade podem ocorrer em um sistema remoto entre

updateLevels

chamadas. Os nomes de entidades no sistema remoto podem ser trocados pelas mesmas IDs de entidade. Quando

updateLevels

chamadas ocorrem após a troca de nomes, o

updateLevels

O call gerencia essas alterações rastreando as IDs nas alterações de nome. A chamada também pode lidar com a introdução de uma nova ID que usa um nome existente.

Para que cada um dos exemplos seja bem-sucedido, a troca completa de IDs deve ocorrer com os valores exclusivos.

Exemplo 1: uma simples troca de nome no sistema remoto.


ID     Unique Value   New Unique Value
1      AA             BB
2      BB             AA

Exemplo 2: uma sequência de três renomeações no sistema remoto.


ID     Unique Value   New Unique Value
1      AA             BB
2      BB             CC
3      CC             AA

Exemplo 3: uma nova entidade que usa um valor exclusivo existente.


ID     Unique Value   New Unique Value
4                     AA
1      AA             BB
2      BB             Old BB

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
conectar-se	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)

elemento de níveis
Nome da etiqueta		níveis
Descrição		A solicitação de apenas um elemento de nível é permitida por carga. Ele contém um ou mais elementos de nível.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
retainExisitingOrder Disponível na API v26+	N	MaintainExistingOrder="1" indica que a updateLevels API deve ignorar a ordem dos elementos na carga XML e a ordem definida existente será mantida. retExistingOrder="0" indica que a updateLevels API deve atualizar a ordem dos elementos com base na posição da etiqueta em relação a outros irmãos na carga XML. O atributo MaintainExistingOrder é ignorado na versão da API anterior à API v26. O valor por padrão para reterExistingOrder é "0" na versão 26. Para a versão v27 e posteriores da API, o valor por padrão de MaintainExistingOrder é "1".	1
displayNameEnabled Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	displayNameEnabled = 1 indica que updateLevels 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=0 indica que a updateLevels API 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 updateLevels ignora as propriedades de nome de exibição code , displayNameType e description . O valor por padrão para displayNameEnabled é "0".	1
Conteúdo do elemento
Contém um ou mais elementos de nível.

elemento de nível
Nome da etiqueta		level
Descrição		Especifica um nível a ser criado.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	A ID do nível que está sendo atualizado.	34
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O código exclusivo do nível. Essa propriedade só fica disponível quando a opção Habilitar nome de exibição está ATIVADA para a instância.	NewLevelName
nome	N	O nome do nível. Quando Habilitar nome de exibição está ATIVADO para uma instância com API v30 ou superior, o nome permite valores duplicados. Quando Habilitar nome de exibição está DESATIVADO para uma instância, o código não fica disponível e o nome deve ser exclusivo.	NewLevelName
shortName atualizado na API v30	N	Título exibível da coluna, como visto na planilha.	NewLevelShortName
moeda	N	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.	USD
publishCurrency Disponível na API v24+	N	PublishCurrency define a moeda da empresa da Workday quando um plano financeiro é publicado. A moeda de publicação é carregada por meio do carregador de níveis do Planning na integração do Workday Adaptive Planning como um atributo de moeda adicional para um nível. PublishCurrency indica uma das moedas configuradas para a instância, encontradas na chamada exportActiveCurrencies e na interface de usuário de administração de níveis. Disponível somente quando você define o Adaptive Planning para o Workday. Consulte a seção Publicar planos de Etapas: configurar o Adaptive Planning para HCM e Finanças.	CAD
inWorkflow	N	Indica se este nível participa de um fluxo de trabalho.	1
propagateToDescendants	N	Indica se as alterações são propagadas para os filhos deste nível. 0 para não, 1 para sim. Nem todas as propriedades de nível são cobertas pelo propagateToDescendants. Para obter uma lista das propriedades afetadas por propagateToDescendants , consulte Comportamento propagateToDescendants durante solicitações UpdateLevels.	0
eliminationLevel	N	Indica se este é um nível de eliminação a ser usado em eliminações intercompanhias. Um nível pode ser um nível de eliminação ou um parceiro comercial de eliminação, mas não ambos.	1
eliminationTradingPartner	N	Indica se este nível é um parceiro comercial de eliminação. Um nível pode ser um parceiro comercial de eliminação ou um nível de eliminação, mas não ambos.	0
actualsStart	N	Indica o início dos valores reais para este nível. Deve ser um código de entrada de horas existente da Administração de horas no estrato de tempo por padrão.	Maio de 2013
actualsEnd	N	Indica o fim dos valores reais para este nível. Deve ser um código de entrada de horas existente da Administração de horas no estrato de tempo por padrão.	Dez-2018
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. Essa propriedade só fica disponível quando a opção Habilitar nome de exibição está ATIVADA para a instância.	O departamento mais alto.
Conteúdo do elemento
Um ou mais elementos de atributo, se você quiser definir um ou mais atributos de nível associados ao nível.

elemento de versão
Nome da etiqueta		versão
Descrição		Especifica a disponibilidade da versão de um nível. Requer uma versão preexistente.
Atributos do elemento
Nome do atributo	Obrigatório?		Exemplo
nome	S	O nome da versão, como aparece em Administração de versão.	Orçamento de 2015
disponível	S	Se 1, esta versão está disponível neste nível.	1
Conteúdo do elemento
Um ou mais elementos de versão para cada nível

elemento atributo
Nome da etiqueta		atributo
Descrição		Especifica um atributo a ser atualizado.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome atualizado na API v30	S	O nome do atributo.	Location
valor atualizado na API v34	S	O valor deste atributo. Para as APIs v32 e v33, esse atributo só é significativo quando a configuração Nome de exibição está DESATIVADA para a instância. Para a API v34 e versões mais recentes: Com suporte quando a configuração de Nome de exibição vigente está ATIVADA. A presença de valueCode e valueName causará erro. Quando a opção A importação de nível cria automaticamente valores de atributo está habilitada na UI de administração de atributos, a cadeia de caracteres do valor se torna o código e o nome, se o valor ainda não existir. Defina value="" para remover essa marcação de atributo.	170
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.	S	O código de valor deste atributo. A entrada valueCode é significativa somente quando displayNameEnabled = 1 e a configuração de nome de exibição está ATIVADA para a instância na API v32 e API v33. Defina valueCode="" para remover essa marcação de atributo.	SFO
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.	N	O atributo valueName é significativo somente quando: valueCode contém um valor de atributo inexistente. A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1 Chamando a API v32 e a API v33. valueName é ignorado quando valueCode contém um valor de atributo existente.	São Francisco
Conteúdo do elemento
(nenhum)

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Especifica as atribuições de valor de dimensão de nível.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome atualizado na API v30	S	O nome da dimensão.	Orçamento de 2015
valor atualizado na API v34	S	O valor da dimensão disponível neste nível. Para API v32 e API v33, o valor só faz sentido quando a configuração Nome de exibição está DESATIVADA para a instância. Para a API v34 e versões mais recentes: Com suporte quando a configuração de Nome de exibição vigente está ATIVADA. A presença de valueCode e valueName causará erro. Quando a opção A importação de dados cria automaticamente valores de dimensão está habilitada na interface de usuário de administração de dimensão, a cadeia de caracteres do valor se torna o código e o nome, se o valor ainda não existir.	Lahore
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.	S	O código de valor de dimensão para esta dimensão disponível neste nível. Para API v32 e API v33, valueCode só é significativo quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1	LHE
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.	N	O nome de um valor de dimensão recém-criado automaticamente. Para API v32 e API v33, valueName só faz sentido quando valueCode contém um valor de dimensão inexistente. A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1	Lahore
Conteúdo do elemento
(nenhum)

Processamento de carga de cima para baixo

Os atributos para níveis agrupam valores e marcam níveis de forma lógica. Como a updateLevels API processa a carga XML de cima para baixo, atribua um atributo de nível ao nível pai antes de alterar os valores de nível do atributo filho. Os níveis filho podem ser marcados com qualquer valor de atributo quando o valor do atributo de nível pai está em branco. Se os atributos de nível não estão alinhados com o atributo pai, ocorre um erro de validação de compatibilidade.

Considere a estrutura de árvore abaixo, em que o pai "Califórnia" tem dois níveis filho "Palo Alto" e "Pleasanton". Os atributos de nível "Palo Alto" e "Pleasanton" são irmãos.


Location
|__USA                              
|__California
   |__Palo Alto
   |__Pleasanton

Exemplo de solicitação XML original com atributos de nível

Observe que o valor do atributo de local "Palo Alto" é atribuído a "Engenharia" e a "Desenvolvimento".


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <attribute name="Location" value="" />
   <level id="2" name="Engineering">
      <attribute name="Location" value="Palo Alto" />
      <level id="8" name="Development">
         <attribute name="Location" value="Palo Alto" />
      </level>
   </level>  
</level>
</levels>

Exemplo de ordem incorreta para processamento de carga

A carga XML a seguir gera um erro: "

The attribute value Pleasanton is not compatible with the parent's attribute value

". O processamento de carga de cima para baixo considera que o nível pai "Engenharia" tem o valor de atributo de local "Palo Alto" do bloco de códigos anterior e processa "Pleasanton" como filho de "Palo Alto". O erro é gerado porque o nível filho "Desenvolvimento" só pode ter o atributo de local "Palo-Alto", conforme indicado na estrutura de árvore.


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <level id="2" name="Engineering">
      <level id="8" name="Development">
         <attribute name="Location" value="Pleasanton" />
      </level>
      <attribute name="Location" value="California" /> <!-- Level Attribute change ignored due to placement order-->
   </level>
   <attribute name="Location" value="" />
</level>
</levels>

Exemplo de pedido válido para processamento de carga

Reorganizar a ordem de posicionamento do atributo "Califórnia" abaixo de "Engenharia" permite que a API processe primeiro o atributo de nível pai, permitindo que o nível filho "Desenvolvimento" tenha o valor do atributo de local como "Palo Alto" ou "Pleasanton". .


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <attribute name="Location" value="" /> <!-- Level Attribute change processed due to correct placement order-->
   <level id="2" name="Engineering">
      <attribute name="Location" value="California" />
      <level id="8" name="Development">
         <attribute name="Location" value="Pleasanton" />
      </level>
   </level>
</level>
</levels>

A disponibilidade de versão de um nível funciona da mesma maneira. Defina a disponibilidade da versão de um nível antes de alterar os níveis filho para evitar erros de compatibilidade.

Exemplo de XML de solicitação original com versões

Observe que a disponibilidade da versão "Orçamento 2020" para os níveis "Engenharia" e "Desenvolvimento" está definida como "0".


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <version name="Budget 2020" available="0" />
   <level id="2" name="Engineering">
      <version name="Budget 2020" available="0" />
      <level id="8" name="Development">
         <version name="Budget 2020" available="0" />
      </level>
   </level>
</level>
</levels>

Exemplo de ordem incorreta para processamento de carga

A carga XML a seguir gera um erro, pois o processamento de cima para baixo da carga considera que o "Engenharia" pai está indisponível ("

available=0")

para a versão "Budget 2020" do bloco de códigos anterior e processa a disponibilidade do nível filho "Desenvolvimento" como "1". O nível filho "Desenvolvimento" não pode estar disponível quando o nível pai "Engenharia" está indisponível.


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <level id="2" name="Engineering">
      <level id="8" name="Development">
         <version name="Budget 2020" available="1" />
      </level>
      <version name="Budget 2020" available="1" /><!-- Parent version availability change ignored due to placement order-->
   </level>
   <version name="Budget 2020" available="1" />
</level>
</levels>

Exemplo de pedido válido para processamento de carga

Reorganizar a ordem de posicionamento da versão "Orçamento 2020" abaixo do nível pai "Engenharia" permite que a API processe a disponibilidade pai primeiro, permitindo que "Desenvolvimento" tenha o valor de disponibilidade da versão "1" ou "0".


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <version name="Budget 2020" available="1" />
   <level id="2" name="Engineering"><!-- Parent Version availability change processed due to correct placement order-->
      <version name="Budget 2020" available="1" />
      <level id="8" name="Development">
         <version name="Budget 2020" available="1" />
      </level>
   </level>
</level>
</levels>

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<levels>
  <level id="1" name="HQ" currency="CAD" shortName="" eliminationLevel="1" eliminationTradingPartner="0" inWorkflow="0" status="">
    <level id="2" name="Engineering" currency="USD" shortName="Engr" eliminationLevel="0" eliminationTradingPartner="1" inWorkflow="0" status="updated">
      <level id="8" name="Development" currency="USD" shortName="Dev" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="0" status="updated" />
      <level id="9" name="QA" currency="INR" shortName="" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="0" status="updated" />
      <level id="10" name="Documentation" currency="PKR" shortName="Doc" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="1" propagateToDescendants="1" actualsStart="05/2013" actualsEnd="12/2018" status="updated">
        <version name="Budget 2011" available="1" status="" />
        <version name="Budget 2012" available="0" status="updated" />
        <version name="Budget 2013" available="1" status="" />
      </level>
    </level>
    <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1" eliminationTradingPartner="0" inWorkflow="0" status="updated">
      <attribute name="Corporate Discount" value="Available" status="" />
      <attribute name="Transfers Restricted" value="Yes" status="" />
      <dimension name="Region" value="C-US" status="" />
    </level>
  </level>
</levels>
</output>
</response>

elemento de saída
Nome da etiqueta	saída
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de nível obrigatório. 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 um ou mais elementos de nível.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
reterOrdem existente	N	A API updateLevels deve atualizar a ordem de classificação com base no conteúdo da carga XML. A API updateLevels deve manter a ordem de classificação existente.	1
displayNameEnabled Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	displayNameEnabled = 1 indica que updateLevels 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.	1
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 updateLevels.
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 exclusivo do nível. Essa propriedade só fica disponível quando a opção Habilitar nome de exibição está ATIVADA para a instância.	SEDE
nome	S	O nome do nível, como aparece em relatórios e planilhas.	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	PublishCurrency define a moeda da empresa da Workday quando um plano financeiro é publicado. A moeda de publicação é carregada por meio do carregador de níveis do Planning na integração do Workday Adaptive Planning como um atributo de moeda adicional para um nível. A Moeda de publicação indica uma das moedas configuradas para a instância, encontradas na chamada exportActiveCurrencies e indicadas na interface de usuário de administração de nível. Requer o Workday Power of One habilitado pelo provisionamento.	CAD
shortName	N	A abreviação do nível, se houver, conforme inserida em Administração de nível.	Desv
eliminationLevel	N	Indica se o nível é um nível de eliminação. 0 para não, 1 para sim.	1
eliminationTradingPartner	N	descrição	1
inWorkflow	N	Indica se o nível está em um fluxo de trabalho. 0 para não, 1 para sim.	1
propagateToDescendants	N	Indica se as alterações são propagadas para os filhos deste nível. 0 para não, 1 para sim. Para saber mais sobre o comportamento propagateToDescendants, consulte Comportamento propagateToDescendants durante solicitações UpdateLevels.	1
actualsStart	N	O código de entrada de horas, conforme definido em Administração de horas, para o início da versão de valores reais deste nível.	05/2013
actualsEnd	N	O código de entrada de horas, conforme definido em Administração de horas, para o término da versão de valores reais deste nível.	12/2018
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. Essa propriedade só fica disponível quando a opção Habilitar nome de exibição está ATIVADA para a instância.	O departamento mais alto.
status	S	O status do nível após a atualização. Para aviso e erro, o elemento de mensagem contém o conteúdo da mensagem. O status atualizado não retorna nenhum conteúdo da mensagem. Erro: foi encontrado um erro na entidade Aviso: um aviso foi encontrado na entidade Criado: a entidade foi criada com êxito Atualizado: a entidade foi atualizada com êxito.	Atualizado
mensagem	N	A mensagem de erro para entrada de nível inválida	O nível UKregion2 está duplicado na carga ou já existe no sistema com a ID 6.
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 atributo
Nome da etiqueta		atributo
Descrição		Contêiner para elemento de atributo de um nível.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome do atributo de nível	Location
valor	S	O valor do atributo de nível.	SFO
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.	S	O código de valor deste atributo. Para a API v32 e versões mais recentes, valueCode só faz sentido quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1	SFO
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.	N	O nome de um valor de atributo recém-criado automaticamente. O atributo valueName é significativo somente quando: valueCode contém um valor de atributo inexistente. A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1value O nome é ignorado quando o valueCode contém um valor de atributo existente.	São Francisco
status	S	O status do atributo após a atualização. Para aviso e erro, o elemento de mensagem contém o conteúdo da mensagem. O status atualizado não retorna nenhum conteúdo da mensagem. Erro: foi encontrado um erro na entidade Aviso: um aviso foi encontrado na entidade Criado: a entidade foi criada com êxito Atualizado: a entidade foi atualizada com êxito.	atualizado
mensagem	N	A mensagem de erro para uma entrada de atributo inválida.	O nível UKregion2 está duplicado na carga ou já existe no sistema com a ID 6.
Conteúdo do elemento
(nenhum)

elemento de versão
Nome da etiqueta		versão
Descrição		Especifica a disponibilidade da versão de um nível.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da versão, como aparece em Administração de versão.	Orçamento de 2015
valor	S	Se 1, este nível está disponível nesta versão.	1
status	S	O status da versão após a atualização. Para aviso e erro, o elemento de mensagem contém o conteúdo da mensagem. O status atualizado não retorna nenhum conteúdo da mensagem. Erro: foi encontrado um erro na entidade Aviso: um aviso foi encontrado na entidade Criado: a entidade foi criada com êxito Atualizado: a entidade foi atualizada com êxito.	atualizado
Conteúdo do elemento
Um ou mais elementos de versão para cada valor de dimensão.

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Representa uma única dimensão personalizada que está sendo retornada em resposta a uma chamada à API updateLevels.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da dimensão, como aparece em relatórios e planilhas.	Região
valor	N	O valor de dimensão disponível para este nível.	C-USA
valueCode Disponível somente na API v32+ para instâncias que habilitam o nome de exibição.	S	O código de valor de dimensão para esta dimensão. Para a API v32 e versões mais recentes, valueCode só faz sentido quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1	CUS
valueName Disponível somente na API v32+ para instâncias que habilitam o nome de exibição.	N	O nome de um valor de dimensão recém-criado automaticamente. Para a API v32 e versões mais recentes, valueName só faz sentido quando: valueCode contém um valor de dimensão inexistente. A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1 valueName é ignorado quando valueCode contém um valor de dimensão existente.	C-USA
status	N	O status da versão após a atualização. Para aviso e erro, o elemento de mensagem contém o conteúdo da mensagem. O status atualizado não retorna nenhum conteúdo da mensagem. Erro: foi encontrado um erro na entidade Aviso: um aviso foi encontrado na entidade Criado: a entidade foi criada com êxito Atualizado: a entidade foi atualizada com êxito.	Atualizado
Conteúdo do elemento
(nenhum)

Descrições de mensagens de erro e de aviso

Tipo	Mensagem	Exemplo/Descrição
Erro	Ocorreu um erro de sistema. Entre em contato com o suporte para obter mais informações.	Erro do sistema
Erro	Não foi possível localizar o arquivo content.xml.	Já existe na updateDimensions API
Erro	A entrada fornecida não contém etiquetas de nível.	A etiqueta de nível está ausente na carga.
Erro	{0} não é reconhecido como um {1} definido.	Usada quando o nome ou o valor da versão é desconhecido.
Erro	O campo {0} não pode ficar vazio.	O nome da versão está em branco.
Erro	A disponibilidade da versão não pode ser alterada para valores reais.	Quando o usuário tenta modificar a visibilidade da versão de valores reais.
Erro	A disponibilidade da versão não pode ser alterada para o nível raiz {0}.	Quando o usuário tenta modificar a visibilidade da versão para o nível raiz.
Erro	A visibilidade da versão {0} no nível {1} não é compatível com a versão pai de {1}.	Quando a visibilidade da versão fornecida do nível não é compatível com o nível pai.
Erro	Você não tem acesso para atualizar um ou mais níveis ou versões especificados na solicitação.	Quando o usuário tenta atualizar informações de nível não acessíveis.
Erro	{0} não é reconhecido como um {1} definido.	Usada quando o nome ou o valor da dimensão é desconhecido.
Erro	O campo {0} não pode ficar vazio.	O nome da dimensão está em branco.
Erro	A dimensão de lista não pode ser usada no nível.	O usuário tenta mapear um valor de dimensão simples para um nível.
Erro	A dimensão {0} está desabilitada para o nível.	A dimensão está desabilitada para este nível.
Erro	O valor de dimensão {0} não é compatível com o valor de dimensão do pai.	Quando o mapeamento de dimensões de nível fornecido não é compatível com o nível pai.
Erro	{0} não é reconhecido como um {1} definido.	Usado quando o nome ou o valor do atributo é desconhecido.
Erro	O valor de atributo {0} não é compatível com o valor de atributo do pai.	Quando o valor do atributo de nível fornecido não é compatível com o nível pai.
Erro	O campo {0} não pode ficar vazio.	O nome do atributo está em branco.
Erro	Ocorreu uma exceção ao processar a solicitação de API updateLevels.	Erro do sistema
Erro	A ID {0} não existe.	ID de nível inexistente fornecida na carga da solicitação.
Erro	Um {0} não pode ter a mesma ID que seu pai.	Os níveis pai e filho têm a mesma ID.
Erro	{0} não pode ser filho de {1}.	Um nível específico não pode ser filho de outro nível específico.
Erro	A ID do nível-raiz está ausente.	A ID do nível raiz não foi fornecida.
Erro	A ID de nível raiz {0} com o nome de nível {1} não pode se tornar um nível filho.	O nível raiz não pode se tornar um nível filho.
Erro	A moeda do nível-raiz não pode ser alterada.	A moeda não pode ser alterada para o nível raiz.
Erro	A moeda {0} não é válida.	Nome de moeda desconhecido fornecido na etiqueta de nível.
Erro	O nível {0} está duplicado para IDs {1}.	Nome de nível duplicado fornecido.
Erro	O nível {0} está duplicado na carga {1} {2}.	Vários níveis novos contêm o mesmo nome.
Erro	O fluxo de trabalho do nível-raiz não pode ser alterado.	O status Entrada do fluxo de trabalho não pode ser alterado para o nível raiz.
Erro	A atribuição de atributo de nível {0} não é compatível com o valor de atributo do pai.	O valor do atributo de nível fornecido não é compatível com o nível pai.
Erro	O nível com ID {0} não existe.	Não existe um nível com a ID fornecida no Planning.
Erro	Você não tem acesso para atualizar um ou mais níveis ou versões especificados na solicitação.	Permissão de usuário ausente para um nível mencionado na carga.
Erro	A visibilidade da versão do nível {0} não é compatível com o nível {0} pai {1}.	A visibilidade da versão fornecida do nível não é compatível com o nível pai.
Erro	O nível {0} tem uma disponibilidade de valores reais que contém mais períodos do que seu nível pai {1}.	O intervalo de valores reais do nível atual foi alterado. O intervalo de valores reais modificado o torna menor do que um dos intervalos de valores reais de seu descendente.
Erro	Você não pode desabilitar o fluxo de trabalho para o nível ({0}) se deleteWorkflowSilently é igual a 0. Se você definir deleteWorkFlowSilently, 1, todas as suas tarefas de fluxo de trabalho associadas a este nível serão excluídas.	Quando a exclusão silenciosa do fluxo de trabalho está desativada, você não pode desabilitar o fluxo de trabalho. Se a opção Excluir fluxo de trabalho de forma silenciosa está ativada, todas as tarefas de fluxo de trabalho para o nível são excluídas.
Erro	Não foi possível atualizar as datas de início e de término dos valores reais para {0} porque o intervalo de datas é menor do que as datas de início e de término definidas para a versão de valores reais, e deleteActualsSilently está definido como falso, impedindo que os valores reais sejam excluídos para {1}.	O usuário tenta reduzir o intervalo de valores reais sem o indicador deleteActualsSilently definido.
Erro	O fluxo de trabalho não pode ser habilitado para o nível {0} porque seu nível pai tem um fluxo de trabalho desabilitado.	O fluxo de trabalho não pode ser habilitado para o nível porque seu pai tem o fluxo de trabalho desabilitado.
Erro	O TradingPartner ou o EliminationLevel não podem ser habilitados para o nível {0} porque seu nível pai tem o TradingPartner habilitado.	Quando o parceiro comercial já está habilitado para um pai, seus filhos não podem ter o parceiro comercial ou o nível de eliminação habilitado.
Erro	Não existe um pai com ID {0}.	Uma ID inexistente foi fornecida para um nível pai.
Erro	O nó pai {0} está se tornando filho de seu atual nó filho direto/indireto {1}.	Um relacionamento cíclica entre um pai e um filho está sendo criado.
Erro	Um nível não pode ser seu próprio nível principal.	Um nível não pode se tornar seu próprio pai em uma carga.
Erro	Não existe um nível com ID {0}.	A entidade fornecida não existe no Planning.
Erro	Eliminação e TradingPartner não podem ser definidos como "true" ao mesmo tempo.	Um nível pode ser um nível de eliminação ou um parceiro comercial, mas não ambos ao mesmo tempo.
Erro	Você só pode modificar a Eliminação neste nível enquanto seu pai tem o TradingPartner desabilitado.	A modificação da eliminação de um nível só pode ocorrer quando o nível pai desse nível tem um parceiro comercial desabilitado.
Erro	Um subnível abaixo deste nível é um nível de eliminação, assim este nível não pode ser marcado como parceiro comercial.	O nível atual não pode ser marcado como um parceiro comercial porque o nível abaixo dele é um nível de eliminação.
Erro	Você não pode habilitar o fluxo de trabalho neste nível quando seu nível pai tiver o fluxo de trabalho desabilitado.	O pai do nível tem o fluxo de trabalho desabilitado.
Erro	{0} só podem ser habilitados juntos para um nó e seus descendentes. Para fazer alterações neles, defina propagateToDescendants=1.	Para saber mais sobre o comportamento propagateToDescendants, consulte Comportamento propagateToDescendants durante solicitações UpdateLevels.
Erro	Não é possível tornar o nível "{0}" um nível de eliminação porque ele tem dados em uma ou mais contas intercompanhias.	Um nível não pode se tornar um nível de eliminação se contiver dados em contas intercompanhias.
Erro	actualsStart ou actualsEnd não podem ser alterados para o nível-raiz {0}.	O usuário tenta alterar o intervalo de valores reais para o nível raiz.
Erro	Você não pode adicionar níveis secundários a um nível vinculado.	O usuário tenta adicionar um nível filho a um nível vinculado.
Erro	Não existe um código de tempo {0}.	O código de entrada de horas fornecido não existe.
Erro	A data de início dos valores reais {0} não pode ser posterior à data de término dos valores reais {1}.	A hora de início dos valores reais fornecida é posterior à hora de término. A hora de início dos valores reais precisa ser anterior à hora de término.
Erro	Código de tempo "{0}" inválido. Os códigos de tempo definidos para actualsStart e actualsEnd devem corresponder aos estratos mais baixos disponíveis em Administração de tempo.	O código de entrada de horas fornecido não está no nível dos estratos mais baixos.
Erro	Código de tempo "{0}" inválido. O actualsStart {0} é anterior ao actualsStart {1} dos pais.	A hora de actualsStart fornecida é anterior à hora de início dos valores reais do nível pai.
Erro	Código de tempo "{0}" inválido. O actualsEnd {0} é posterior ao actualsEnd {1} dos pais.	A hora actualsEnd fornecida ultrapassa a hora de término dos valores reais do nível pai.
Erro	O actualsStart de {0} é anterior ao início da versão de valores reais de {1}. O actualsStart deve ser posterior a {1}.	A hora de actualsStart fornecida é anterior à hora de início da versão de valores reais.
Erro	O actualsEnd de {0} é posterior ao término da versão de valores reais de {1}. O actualsEnd deve vir antes de {1}.	A hora actualsEnd fornecida ultrapassa a hora de término da versão de valores reais.
Erro	Valor "{0}" inválido "{1}". O valor deve ser "1" ou "0".	O usuário forneceu algo diferente de "0" ou "1" como um valor para uma propriedade booliana.
Erro	{0} {1} inválido.	O usuário forneceu um valor inválido.
Erro	{0} NÃO é permitido como nome.	A palavra reservada "this", uma palavra que termina com "(+)" ou "(-)" foi fornecida como nome de nível.
Erro	A ID "{0}" não existe.	A entidade fornecida não existe no Planning.
Aviso	O nível {0} não pode ser movido para outro nível pai enquanto continueWithWarnings=0.	O usuário tenta mover o nível sem prosseguirWithWarning="1". prosseguiWithWarning="1" significa que a visibilidade da versão, o mapeamento de atributos e os dados serão ajustados para corresponder ao novo nível pai.
Aviso	A faixa de disponibilidade de valores reais foi reduzida para o nível {0}. Os dados dos valores reais fora desse intervalo foram excluídos.	O intervalo de disponibilidade dos valores reais foi reduzido. Os dados fora do intervalo são excluídos.
Aviso	deleteWorkflowSilently é um indicador global. E deve ter uma etiqueta de nível.	Excluir fluxo de trabalho de forma silenciosa é um indicador global. Ela pertence à etiqueta de nível, não a outra etiqueta.
Aviso	deleteActualsSilently é um indicador global. E deve ter uma etiqueta de nível.	Excluir valores reais sem aviso prévio é um indicador global. Ela pertence à etiqueta de nível, não a outra etiqueta.
Aviso	Os níveis não podem ser modificados porque há alterações não publicadas.	O Planning tem alterações pendentes para publicação do administrador.

Categoria	Modificação de metadados
Descrição	Atualize um conjunto de níveis existentes ou crie novos níveis e suas propriedades. Vários níveis com vários valores podem ser atualizados em uma chamada. Se for bem-sucedida, a API retorna detalhes dos níveis que foram atualizados/criados. Se a API falha, uma lista abrangente de erros e suas causas é retornada.
Permissões obrigatórias para invocar	Modelo e permissões em cada nível
Parâmetros obrigatórios na solicitação	Credenciais