importCubeData

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

importCubeData

Categoria	Envio de dados
Descrição	Insere ou substitui dados em uma planilha de cubo. Esse método também pode ser usado para excluir dados de uma planilha de cubo importando zeros para locais no cubo. A importação de um zero para uma planilha de cubo apagará os dados no local do zero.
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 também pode ser usado para excluir dados de uma planilha de cubo importando zeros para locais no cubo. A importação de um zero para uma planilha de cubo apagará os dados no local do zero.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="importCubeData" 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"/>
<version name="Budget 2014" isDefault="false" />
<sheet name="Sales Cube" isUserAssigned="false" />
<rowData>
   <header>ProductFurniture|CountryRegion|FabricationMachine|Customer|Account|Level|06/2014|07/2014|08/2014|09/2014|01/2015</header>
   <rows>
     <row>Coffee table|Argentina|Do-All 15 Vertical|Aeropostale|Price|Corporate Plan|0|0|0|0|0</row>
   </rows>
</rowData>
</call>

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

credenciais

importDataOptions

versão

planilha

rowData

Além disso, quando o modo é especificado como REPLACE, o elemento de escopo deve ser especificado.

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.

Exemplo de solicitação especificando o modo de substituição com o escopo:

<?xml version='1.0' encoding='UTF-8'?>
<call method="importCubeData" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
 <version name="Budget 2022" isDefault="true" />
 <sheet name="Expense Cube" isUserAssigned="false" />
 <importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false" mode="REPLACE" />
 <!-- Scope parameter specifying the import scope.-->
 <scope>
 <!-- Specifies the time scope for import. All values will be specified as time codes.-->
  <time mode="EXPLICIT">
   <timeRange start="01/2021" end="10/2021" />
  </time>
  <!-- Specifies list of accounts in the scope. All values will be specified as code field.-->
  <accounts mode="EXPLICIT">
   <account includeDescendants="true">Op_Expense_Inputs</account>
   <account includeDescendants="true">Op_Expense_Drivers</account>
  </accounts>
  <!-- Specifies list of levels in the scope. All values will be specified as code field.-->
  <levels mode="INPUT"/>
 </scope>
 <rowData>
  <header>ProductFurniture|CountryRegion|FabricationMachine|Customer|Account|Level|01/2022|02/2022|03/2022|04/2022|05/2022|06/2022|07/2022|08/2022|09/2022|10/2022|11/2022|12/2022</header>
  <rows>
   <row>Coffee Table|Argentina|Do-All 15 Vertical|Aeropostale|Units|Development|44567.33|21345.77|22341.43|65567.32|298145.12|12641.83|77821.53|7766342.09|211441.21|88712.43|61940.41|662341.03|775420.25|800345.17</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
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 adequado,nomes de períodos e formatação de datas). 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	Defina como uma de "Plano" ou "Valores reais" para especificar o tipo de dados que estão sendo importados. Se essa configuração está em conflito com a versão especificada noEtiqueta de versão, aO valor da etiqueta de versão tem precedência e essa configuração é ignorada.	Plano
moveBPtr	N	Usado somente quando oO atributo planOrActuals está definido comoValores reais 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 seplanOrActuals está definido comoPlano	falso
allowParallel	S	Usado somente quando oO atributo planOrActuals está definido comoValores reais 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
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 v30+ para instâncias que habilitam o nome de exibição.	N	displayNameEnabled=true indica que importCubeData deve ser esperado Account Code , Level Code , Dimension Code e Dimension Name Column na carga quando Habilitar nome de exibição está ATIVADO para a instância. displayNameEnabled=false indica que a API importCubeData deve continuar seguindo o contrato de API anterior à versão 30, mesmo quando a opção Habilitar nome de exibição está ATIVADA para a instância. A API importCubeData ignora as propriedades de nome de exibição Account Code , Level Code , Dimension Code e Dimension Name Column . O valor por padrão para displayNameEnabled é "falso".	false
modo Disponível na API v32+	N	Especifica o modo de importação, que é APPEND ou REPLACE. ANEXO - Os fatos existentes são atualizados ou novos fatos são inseridos. Nenhum fato será excluído. REPLACE – o autor da chamada deve especificar um elemento de escopo que representa as coordenadas do cubo no qual os dados serão substituídos pelos fornecidos na carga. Todos os dados existentes no escopo serão substituídos pelos dados na carga da chamada. Essa opção tem suporte na API v32 e versões superiores. Chamar a API com versões anteriores resultará em erro. O valor por padrão para o modo, quando não especificado, é APPEND.	SUBSTITUIR
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 2012
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
Descrição		Especifica o escopo desta importação. Aplicável somente quando o modo de importação é especificado como REPLACE. Disponível na API v32+
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
modo	S	Especifica se as observações de célula devem ou não ser apagadas no escopo. Deve ser um dos três valores enumerados: NENHUM - Não apaga observações de célula. ALL - Apaga todas as observações de célula no escopo. MODIFIED_ONLY - Apaga observações de células dentro do escopo que são modificadas pela importação. Isso inclui células vazias que têm fatos importados e células cujos fatos foram apagados. Se eraseCellNotes não é especificado, o valor por padrão é NONE.	NENHUM
Conteúdo do elemento
Um elemento de tempo, um de contas e um de níveis, todos obrigatórios.

elemento de tempo
Nome da etiqueta		Tempo
Descrição		Especifica um ou mais intervalos de tempo que representam o escopo de tempo da importação. Disponível na API v32+
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
modo	S	Especifica o modo para o escopo de tempo. Deve ser uma das três opções a seguir: INPUT - Quando esse modo é especificado, o escopo de tempo é determinado pelos códigos de entrada de horas no elemento <header>. Se o cabeçalho contém dois meses, o escopo da importação será esses dois meses. EXPLÍCITO - Se esse modo é especificado, espera-se ver um ou mais subelementos timeRange que determinam o escopo de tempo para a importação. VERSÃO - Quando esse modo é especificado, o escopo de tempo será o início e o término da versão, incluindo qualquer período de saldo inicial. Se o modo é especificado e é INPUT ou VERSION, nenhum elemento timeRange deve ser incluído. Se presente, seria tratada como uma condição de erro. A especificação de VERSÃO leva em consideração a data de início da versão, mesmo quando a data de início do plano é posterior à data de início da versão.	INPUT
Conteúdo do elemento
Um ou mais elementos timeRange, a menos que o modo seja INPUT ou VERSION.

elemento timeRange
Nome da etiqueta		TimeRange
Descrição		Especifica um único intervalo de tempo para o escopo de tempo. Disponível na API v32+
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
início	S	O período inicial do intervalo de tempo de importação.	07/2021
fim	S	o período final para o intervalo de tempo de importação.	08/2021
Conteúdo do elemento
(nenhum)

elemento de contas
Nome da etiqueta		contas
Descrição		Especifica os códigos de conta para o escopo de importação. Se existe um código de conta aqui, mas não há dados para esta conta nos dados de importação, os dados nesta conta serão removidos para o intervalo de tempo e o restante das coordenadas do escopo. Disponível na API v32+
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
modo	S	Especifica o modo para o escopo da conta. Deve ser uma das três opções a seguir: EXPLÍCITO - Se esse modo é especificado, espera-se ver um ou mais subelementos de conta que determinam o escopo da conta para a importação. INPUT - Quando esse modo é especificado, o escopo da conta é determinado pelo conjunto exclusivo de contas presentes nos dados de importação. ALL - quando esse modo é especificado, o escopo da conta será todas as contas da importação. Para uma importação de planilha de cubo, isso representará todas as contas importáveis para essa planilha de cubo. Se o modo é especificado e é INPUT ou ALL, nenhum subelemento de conta deve ser incluído. Se presente, será tratada como uma condição de erro.	EXPLÍCITO
Conteúdo do elemento
Um ou mais elementos de conta, a menos que o modo seja INPUT ou ALL.

elemento de conta
Nome da etiqueta		account
Descrição		Especifica o código da conta a ser incluído no escopo da importação. Disponível na API v32+
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
includeDescendants	N	Se a conta é uma conta folha, includeDescendants não tem efeito. Se a conta é uma conta pai, especificar esse atributo como verdadeiro incluirá todos os descendentes folha dessa conta no escopo. Se a conta é uma conta pai e includeDescendants é falso, esse elemento de conta é tratado como se não tivesse sido especificado. A justificativa para esse tratamento de contas pai é que, às vezes, uma conta folha pode ser promovida para se tornar uma conta pai e a especificação de importação pode não ser atualizada a tempo de refletir essa alteração. Ignorar uma conta pai com includeDescendants=false evita a exclusão não intencional de dados. Este é um atributo opcional e o valor por padrão será considerado falso.	verdadeiro
Conteúdo do elemento
Especifica o código da conta usada como parte do escopo de importação. Por exemplo, Operational_Expense.

elemento de níveis
Nome da etiqueta		níveis
Descrição		Especifica os códigos de nível para o escopo de importação. Se um código de nível é especificado aqui, mas não há dados para este nível nos dados de importação, os dados neste nível serão removidos para o intervalo de tempo e o restante das coordenadas do escopo. Disponível na API v32+
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
modo	S	Especifica o modo para o escopo do nível. Deve ser uma das três opções a seguir: EXPLÍCITO - Se esse modo é especificado, espera-se ver um ou mais subelementos de nível que determinam o escopo do nível para a importação. INPUT - Quando esse modo é especificado, o escopo do nível é determinado pelo conjunto exclusivo de níveis presentes nos dados de importação. ALL - quando esse modo é especificado, o escopo do nível inclui todos os níveis importáveis. Se o modo é especificado e é INPUT ou ALL, nenhum subelemento de nível deve ser incluído. Se presente, será tratada como uma condição de erro.	INPUT
Conteúdo do elemento
Um ou mais elementos de nível, a menos que o modo seja especificado como INPUT ou ALL.

elemento de nível
Nome da etiqueta		level
Descrição		Especifica o código de nível a ser incluído no escopo da importação. Disponível na API v32+
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
includeDescendants	N	Se o nível é um nível pai, especificar esse atributo como verdadeiro incluirá todos os descendentes folha desse nível, incluindo ele mesmo (o único nó) no escopo. Esse é um atributo opcional. Se o atributo não é fornecido, o valor por padrão é falso. Se o atributo não é fornecido ou é fornecido como falso e o nível especificado é um nível pai, isso significa que a importação considerará o nó Somente (exemplo Somente engenharia) desse nível para fins de escopo. Os filhos do nível não serão considerados no escopo, a menos que sejam explicitamente especificados com outros elementos de nível.	verdadeiro
Conteúdo do elemento
Especifica o código do nível como parte do escopo de importação. Por exemplo, Desenvolvimento.

rowData element
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 de período 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 um 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 bem-sucedida e malsucedida de dados de cubo.

Exemplo de êxito


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
  <message key="warning-no-data-imported-dimension-unmapped">Warning: Row 3 was not imported because Coffeee table is unmapped.</message>
</messages>
</response>

Falha (com contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="err-incomplete-cube-row">
           <context>
               <col header="ProductFurniture" value="Coffee table" />
               <col header="CountryRegion" value="" />
               <col header="Account" value="Do-All 15 Vertical" />
               <col header="Level" value="Aeropostale" />
               <col header="06/2014" value="Price" />
               <col header="07/2014" value="Corporate Plan" />
               <col header="08/2014" value="0.0" />
               <col header="09/2014" value="0.0" />
               <col header="01/2015" value="0.0" />
     
           </context>
     Row 1 is missing a value.
   
       </message>
       <message key="err-no-rows">You must import at least one row of data.</message>
     </messages>
</response>

Falha (sem contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="err-incomplete-cube-row">Row 1 is missing a value.</message>
       <message key="err-no-rows">You must import at least one row of data.</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.	verdadeiro
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		contexto
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.	"Conta"
valor	S	O valor na coluna.	"GL-29482-38233"
Conteúdo do elemento
(nenhum)

importConfigurableModelData

importStandardData

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