importConfigurableModelData

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 envio de dados

Última atualização: 2024-09-20

Atualizado na API v40 (21 de setembro de 2024).

Categoria	Envio de dados
Descrição	Insere, substitui ou atualiza dados em uma planilha modelada.
Permissões obrigatórias para invocar	Importar
Parâmetros obrigatórios na solicitação	Credentials, ImportDataOptions, Version, Sheet, RowData

A solicitação desse método contém os parâmetros que serão usados para determinar qual planilha e qual versão receberá as linhas de dados fornecidas.

Esse método pode:

Anexe novas linhas à planilha.

Substituir todas as linhas atualmente na planilha modelada pela importação.

Substituir todos os dados na planilha somente para os níveis importados

Atualize as linhas existentes fazendo a correspondência das linhas da importação com uma chave de importação.

Atualize as linhas existentes combinando as linhas da importação com uma chave de importação e adicione novas linhas.

Cada invocação desta chamada de API deve conter exatamente um elemento de cada um dos tipos listados:

credenciais

importDataOptions

versão

planilha

rowData

Uma incompatibilidade entre o número de caracteres de barra vertical ( | ) no cabeçalho e os dados causará um erro na API v30 ou superior.

A partir da API v37, limitamos o número máximo de novas linhas que você pode importar para as planilhas modeladas. Entre em contato com o suporte se você encontrar esse limite.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="importConfigurableModelData" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false" useMappings="false" replaceExisting="2"/>
<version name="Budget 2014" isDefault="false" />
<sheet name="Personnel" isUserAssigned="false" />
<rowData>
 <header>Level|Region|Title|JobCode|Benefits|per|Last Name|First Name|ID|Start|End|Hr/Week|Pay Rate|Pay Rate Display Column</header>
 <rows>
   <row>Corporate Plan|Any|CEO|E1|Yes|Yr|Topdog|Andy|1000|12/20/2013|12/30/2014|80|500,000.12|888,888</row>
 </rows>
</rowData>
</call>

Formato de solicitação para atualizar linhas existentes com importKey


<?xml version='1.0' encoding='UTF-8'?>
<call method="importConfigurableModelData" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"instanceCode="INSTANCE1"/>
<importDataOptions planOrActuals="Plan" replaceExisting="3" importKey="Region" allowParallel="false" moveBPtr="false" useMappings="false"/>
<version name="Budget 2014" isDefault="false" />
<sheet name="Personnel" isUserAssigned="false" />
<rowData>
 <header>Plan|Region|Benefits|per</header>
 <rows>
   <row>Europe Sales|W-US|Yes|Hr</row>
 </rows>
</rowData>
</call>

elemento de credenciais

Nome da etiqueta		credenciais
Descrição		Todas as chamadas de API devem conter um únicoCredenciais para identificar o usuário que está invocando 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
password	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 adequado, nomes de período e formatação de data). 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)

importDataOptions element
Nome da etiqueta		importDataOptions
Descrição		Especifica as opções a serem usadas na importação.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
planOrActuals	S	Definir como uma dePlano ouValores reais para especificar o tipo de dados que estão sendo importados. Se essa configuração está em conflito com a versão especificada na etiqueta Versão, o valor da etiqueta Versão tem precedência e esta configuração é ignorada.	Plano
moveBPtr	N	Usada somente quando os dados que estão sendo importados têm um conjunto de números de períodos temporais de cada linha. SemoveBPtr está definido comoVerdadeiro, a importação moverá o indicador de disponibilidade de valores reais na versão de valores reais para o período mais recente encontrado nos dados importados. Se definido comoSe for falso, a importação não afetará quais períodos mostram valores reais em nenhuma versão. Esse atributo deve ser definido como falso se planOrActuals for definido como Plano.	falso
allowParallel	S	Se definido comotrue, a importação prosseguirá mesmo se já houver outra importação de valores reais ou de transações em andamento para esta instância. Se definido comofalse, a tentativa de importação falhará se já houver uma importação de valores reais ou de transações sendo processada para esta instância.	false
useMappings	N	Especifica se mapeamentos de importação devem ser usados para contas, planos e valores de dimensão dentro dos elementos de linha. Consideradotrue por padrão. Sefalse, os identificadores internos devem ser usados: as contas são identificadas por código, os níveis e os valores de dimensão por nome.	false
substituirExisting	N	Defina como "1" ou "true" para substituir todas as linhas existentes em todos os níveis pelas novas linhas que estão sendo importadas. (ou seja, apaga todas as linhas existentes em todos os níveis). Somente usuários com a permissão Importar para todos os locais podem usar essa opção. Defina como "0" ou "falso" para anexar as linhas importadas às linhas existentes, mesmo que as novas linhas sejam duplicatas. Defina como "2" para substituir as linhas existentes na planilha modelada pelas novas linhas que estão sendo importadas, mas somente para linhas com nível correspondente e dimensões seguras. Linhas de combinações de dimensões seguras e de nível que não têm linhas não divididas na planilha carregada não terão as linhas existentes removidas, a menos que a linha seja uma divisão de uma linha que está sendo substituída pelo carregamento. A funçãosubstituirExistingexamina as dimensões usadas e se existem dados no mesmo nível, conta, período e versão. Se houver uma chave de linha, é feita a correspondência com a coluna ou colunas-chave de linha também. Se houver dados no sistema no mesmo local, a importação os substituirá. Essa substituição ocorre linha por linha. A importação não substitui tudo de uma vez. Linhas de importação não correspondentes são anexadas à planilha. Por exemplo, você executa duas importações. O primeiro arquivo de importação carrega dados que o segundo arquivo de importação não contém. Esses dados existentes permanecerão após a segunda importação. Se você quer excluir todos os dados em uma coluna específica, inclua a coluna, mas deixe os valores dela em branco. Os valores das colunas não mencionadas permanecem inalterados. Defina como "3" para atualizar as linhas existentes na planilha modelada e refletir as novas linhas que estão sendo importadas. Um aviso será retornado se alguma linha não corresponder a uma linha existente. Esse modo requer uma importKey. As planilhas com a opção Permitir divisões selecionada não têm suporte para atualizações. Defina como "4" para atualizar as linhas existentes na planilha modelada para refletir as novas linhas que estão sendo importadas e inserir novas linhas para aquelas que não correspondem a uma linha existente. Esse modo requer uma importKey. As únicas colunas obrigatórias são Chave de importação, Nível e todos os seletores de texto, mesmo quando não há adição de novas linhas. As planilhas com a opção Permitir divisões selecionada não têm suporte para atualizações. Defina como 5 para substituir as linhas existentes com base no escopo que atualmente só oferece suporte a níveis de entrada para a funcionalidade de substituição somente por nível. O escopo é fornecido usando um novo elemento de escopo. Somente as linhas que correspondem ao escopo fornecido serão substituídas pela carga na importação. As linhas que não correspondem ao escopo não são afetadas. O valor por padrão é verdadeiro.	verdadeiro
importKey	N	O nome da coluna da planilha modelada a ser usado como chave de importação ao atualizar linhas da planilha modelada. Adaptive Planning usa a coluna-chave de importação para corresponder cada linha na importação às linhas na planilha modelada. O valor da chave de importação de cada linha deve ser exclusivo. Esse atributo só pode ser usado quando o valor de substituirExisting é "3" ou "4". As colunas-chave de importação podem ser uma das seguintes: uma coluna de nível uma coluna de dimensão	Nível
includeContext	N	Especifica se as mensagens podem incluir o bloco de contexto. Os valores sãofalso (nunca mostrar contexto) outrue (mostra o contexto, se apropriado). Se não for especificado,é assumida como verdadeira.	false
displayNameEnabled Disponível somente na API v31+ para instâncias que habilitam o nome de exibição.	N	displayNameEnabled=true indica que a API deve esperar as colunas Código da conta, Código do nível, Código da dimensão e Nome da dimensão na carga quando a configuração Habilitar nome de exibição está ATIVADA para a instância. displayNameEnabled=false indica que a API deve continuar seguindo o contrato de API anterior à v30, mesmo quando a configuração Habilitar nome de exibição está ATIVADA para a instância. O valor por padrão para displayNameEnabled é "falso".	false
applyValidationRules Disponível somente na API v38 +.	N	applyValidationRules=true indica que a API executará validações de regras de planilha modeladas para todos os dados importados quando a versão da API for posterior à v38. applyValidationRules=false indica que a API ignorará as validações de regras de planilhas modeladas para todos os dados importados. O valor por padrão de applyValidationRules é "true".	false
Conteúdo do elemento
(nenhum)

elemento de versão
Nome da etiqueta		versão
Descrição		Indica qual versão deve ser usada para receber os dados solicitados. Uma versão deve ser fornecida para cada chamada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	N	O nome da versão a ser usada para receber os dados. Somente uma versão pode ser acessada em uma única chamada de API. Se um nome não é fornecido, oO indicador isDefault deve ser definido comotrue neste elemento.	Orçamento de 2014
isDefault	N	Se o autor da chamada deseja acessar a versão por padrão atual da instância, independentemente do nome, esse atributo pode ser definido como verdadeiro; nesse caso, o atributo de nome da etiqueta (se presente) é ignorado. Caso contrário, se esse valor é falso ou se esse atributo não está presente, uma versão com o nome fornecido deve existir e estar acessível ao usuário para que essa chamada seja bem-sucedida.	false
Conteúdo do elemento
(nenhum)

elemento de planilha
Nome da etiqueta		planilha
Descrição		Indica qual planilha deve receber os dados importados. Cada chamada de API pode ter como alvo somente os dados de uma planilha.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da planilha para a qual os dados serão importados.	Pessoal
isUserAssigned	N	Indica que a planilha é uma planilha atribuída a usuário. Se não especificada, o valor por padrão é falso, o que indica que é uma planilha atribuída a nível.	false
Conteúdo do elemento
(nenhum)

Elemento de escopo
Nome da etiqueta		Escopo (disponível com a API v40)
Descrição		Especifica o escopo desta importação. Exemplo: <scope> <levels> mode="INPUT"/> </scope> Permitido somente quando o atributosubstituirExisting do elemento importDataOptions é 5.

elemento rowData
Nome da etiqueta		rowData
Descrição		Contêiner para as linhas de dados que estão sendo importadas.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Exatamente umelemento de cabeçalho e exatamente umelemento de linhas.

elemento de cabeçalho
Nome da etiqueta		cabeçalho
Descrição		Especifica os nomes e a ordem das colunas dos dados na tabela correspondente.elemento de linhas.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Uma linha de texto com nomes de colunas separadas por barras verticais. Esses nomes de coluna devem corresponder aos nomes das dimensões ou campos na planilha ou aos códigos dos períodos que podem conter dados. Eles são idênticos aos nomes das colunas encontrados no modelo de importação da planilha para a qual os dados estão sendo importados, com cada cabeçalho de coluna separado do seguinte por uma barra vertical ou símbolo de barra vertical \| . Para instâncias que habilitam o nome de exibição, o cabeçalho não oferece suporte "<dimension>" em combinação com "<dimension> Name" ou "<dimension> Code" na API v30 ou superior para parâmetros regionais com suporte no Adaptive Planning.

elemento de linhas
Nome da etiqueta		linhas
Descrição		Contêiner para um ou maiselementos de linha.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou maiselementos de linha.

elemento de linha
Nome da etiqueta		linha
Descrição		Dados de uma única linha sendo importados.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Dados para os campos em uma única linha que estão sendo importados, com o valor de cada campo separado por uma barra vertical ou símbolo de barra vertical. Os campos de dados devem estar na mesma ordem que a linha no elemento de cabeçalho. Se os números nos valores usam separadores de milhar, presume-se que sejam os separadores de vírgula usados nos parâmetros regionais especificados nas credenciais da solicitação.

Formato da resposta

Estes são exemplos de respostas para importação de dados bem-sucedida e malsucedida.

Exemplo de êxito


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
 <message key="modeled-import-success">Personnel import successful. Rows imported: 1</message>
 <message key="modeled-import-replace">All existing rows were replaced.</message>
</messages>
</response>

Falha (com contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
 <messages>
     <message key="modeled-import-failed">The Personnel import has failed.</message>
     <message key="error-import">Import Failed with the following error: 1 Error(s) Occurred.</message>
     <message key="import-detail">Additional information:</message>
     <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Plan do not exist: Development1.</message>
     <message key="invalid-plan-choice-withCoordinate">
         <context>
             <col header="Plan" value="Development1" />
             <col header="Region" value="C-US" />
             <col header="Title" value="CEO" />
             <col header="JobCode" value="E1" />
             <col header="Benefits" value="Yes" />
             <col header="per" value="Yr" />
             <col header="Last Name" value="Topdog" />
             <col header="First Name" value="Andy" />
             <col header="ID" value="1000" />
             <col header="Start" value="12/20/2013" />
             <col header="End" value="12/30/2014" />
             <col header="Hr/Week" value="80.0" />
             <col header="Pay Rate" value="500000.12" />
             <col header="Pay Rate Display Column" value="888,888" />
 
         </context>
   Invalid Level Choice: Development1 on row 1 column A

     </message>
   </messages>
</response>

Falha (sem contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
 <messages>
     <message key="modeled-import-failed">The Personnel import has failed.</message>
     <message key="error-import">Import Failed with the following error: 1 Error(s) Occurred.</message>
     <message key="import-detail">Additional information:</message>
     <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Plan do not exist: Development1.</message>
     <message key="invalid-plan-choice-withCoordinate">Invalid Level Choice: Development1 on row 1 column A</message>

 </messages>
</response>

elemento de resposta
Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	Qualquer umverdadeiro oufalse, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso na resposta.	true
Conteúdo do elemento
Um único opcionalelemento de mensagens.

elemento de mensagens
Nome da etiqueta		mensagens
Descrição		Contêiner para um ou maiselementos da mensagem
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou maiselementos da mensagem

elemento de mensagem
Nome da etiqueta		mensagem
Descrição		Representa uma mensagem que está sendo enviada pelo sistema de volta para o autor da chamada. As mensagens são usadas para mensagens de erro quando as solicitações não são bem-sucedidas, para mensagens de aviso quando as solicitações são bem-sucedidas e para mensagens de confirmação quando as solicitações são bem-sucedidas.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
chave	N	Quando fornecida, uma chave é uma forma de identificar uma determinada mensagem ou tipo de mensagem, útil para fins de registro automatizado de erros e recuperação em programas cliente. As chaves não são alteradas em diferentes parâmetros regionais de solicitações, mesmo quando o idioma da mensagem é alterado. As chaves também não devem ser alteradas no futuro devido a ajustes de texto ou alterações de terminologia.	invalid-attributevalueid
Conteúdo do elemento
O texto da mensagem. Esse texto está no idioma dos parâmetros regionais especificados na solicitação (supondo que haja suporte para os parâmetros regionais). O texto também pode conter informações variáveis, como o número de linhas que foram processadas ou a coluna ou valor específico que causou um erro. Um elemento de contexto opcional.

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

elemento col
Nome da etiqueta		col
Descrição		Representa o contexto da mensagem. Fornece um par cabeçalho/valor para que a linha que gera a mensagem possa ser identificada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
cabeçalho	S	O cabeçalho da coluna.	"Account"
valor	S	O valor na coluna.	"GL-29482-38233"
Conteúdo do elemento
(nenhum)

Referência: condições de desempenho de customReportValues

importCubeData

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