createLevel

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

createLevel

Sem suporte na API v20+. Use updateLevels.

Categoria	Modificação de metadados
Descrição	Crie um nível. Se for bem-sucedida, a API retorna detalhes do nível que acabou de ser criado.
Permissões obrigatórias para invocar	Estrutura organizacional
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 permissão de estrutura organizacional para criar o nível.

Esse método retorna um erro se há alterações não publicadas.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="createLevel" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <level
       name="New Level Name"
       shortName="NewLvlName"
       parentId="2"
    >
         <attributes>
             <attribute attributeId="20" valueId="199" />
         </attributes>
     </level>
</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. Este 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ível
Nome da etiqueta		level
Descrição		Especifica um nível a ser criado.
Atributos do elemento
parentId	S	A ID do nível do qual criar este nível como filho.	34
nome	S	O nome do nível. O nome deve ser exclusivo.	Nome do novo nível
shortName	N	O nome curto do nível.	NewLvName
prossiga-ComWarnings	N	Indica se o usuário quer ignorar as mensagens de aviso e prosseguir com a operação de criação. 0 para não, 1 para sim. Se houver avisos e continueWithWarnings=0, o nível não será criado. Defina continueWithWarnings=1 para criar o nível quando houver avisos.	1
Conteúdo do elemento
Um elemento de atributos opcionais se você quiser definir um ou mais atributos de nível associados ao nível.

elemento de atributos
Nome da etiqueta		atributos
Descrição		Contêiner para um ou mais elementos de atributo de nível.
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		Contêiner para elemento de atributo de um nível.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
attributeID	S	A ID do atributo de nível gerada pelo sistema.	20
valueID	S	A ID exclusiva do valor de atributo de nível gerado pelo sistema. Se esse valor é 0, esse atributo é removido da conta.	170
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
       <levels>
           <level="41" name="New Level Name" shortName="NewLvlName" currency="USD">
               <attribute attributeId="20" name="Regional Code" valueId="199" value="A-145" />
           </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 o elemento de nível.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
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
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
shortName	N	A abreviação do nível, se houver, conforme inserida em Administração da organização.	Dev
AvailableStart	N	A data de início da disponibilidade do 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 mês específico, no formato "MM/AAAA" ou o valor especial "INÍCIO" que indica o início da versão.	01/2013
AvailableEnd	N	A data de término da disponibilidade do 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 mês específico, no formato "MM/AAAA" 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	Indica se o nível é um nível vinculado. 0 para não, 1 para sim.	1
isElimination	S	Indica se o nível é um nível de eliminação. 0 para não, 1 para sim.	0
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	S	O valor do atributo de nível associado ao nível.	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)

createDimensionValue

createUser

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