importTransactions

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

importTransactions

Categoria	Envio de dados
Descrição	Insere novas transações.
Permissões obrigatórias para invocar	Importar
Parâmetros obrigatórios na solicitação	Credentials, ImportTransactionsOptions, RowData

Esse método se aplica somente se você tem acesso a Transações.

Você só pode excluir transações durante a importação. Se você quer remover todas as transações durante a importação, considere importar uma linha em branco e excluir os dados restantes.

Esse método pode ser usado para excluir linhas de transação existentes que correspondem a determinados critérios, para inserir novas linhas de transação no sistema ou para executar as duas ações em uma invocação (ou seja, substituir um conjunto de linhas de transação por outro conjunto de linhas).

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="importTransactions" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
 <importTransactionsOptions allowParallel="false" useMappings="false"/>
  <rowData>
    <header>Posting Date|Transaction Type|Account|Plan|Transaction Amount</header>
    <rows>
       <row>01/02/2011|Invoice|70110|Marketing|100</row>
    </rows>
  </rowData>
</call>

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

credenciais

importTransactionsOptions

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.

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, 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)

importTransactionsOptions element
Nome da etiqueta		importTransactionsOptions
Descrição		Especifica as opções a serem usadas na importação. Se pelo menos um dosdeleteStartDate,deleteEndDate outransactionTypes são especificados, essa chamada de método tentará excluir todas as transações existentes que correspondam aos critérios especificados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
deleteStartDate	N	Se essa chamada de método tem como objetivo excluir algumas transações existentes, esse atributo especifica a data de início do conjunto de transações a ser excluída (inclusive). Se não especificada, todas as transações com data igual ou anterior àdeleteEndDate (e que corresponde a um dos opcionais especificados)TransactionTypes) serão excluídos.	11/01/2012
deleteEndDate	N	Se essa chamada de método tem como objetivo excluir algumas transações existentes, esse atributo especifica a data de término do conjunto de transações a ser excluída (inclusive). Se não especificada, todas as transações com data igual ou posterior àdeleteStartDate (e que correspondem a um dos opcionais especificados)TransactionTypes) serão excluídos.	12/31/2012
transactionTypes	N	Um conjunto de tipos de transação que serão excluídos, separados pelo símbolo de barra vertical. Se não especificada, todas as transações especificadas entredeleteStartDate edeleteEndDate serão excluídos. Se nãodeleteStartDate oudeleteEndDate é especificado, todas as transações dos tipos especificados são excluídas, independentemente de suas datas.	Pedido de compra
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
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
Conteúdo do elemento
(nenhum)

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 meses 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 transação.

Exemplo de êxito


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <messages>
       <message key="row-imported">1 row was imported.</message>
   </messages>
</response>

Falha (com contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</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 Transaction Type do not exist: Invoice12.</message>
       <message key="invalid-dimension-choice-withCoordinate">
           <context>
               <col header="Posting Date" value="01/02/2011" />
               <col header="Transaction Type" value="Invoice12" />
               <col header="Account" value="70110" />
               <col header="Plan" value="Marketing" />
               <col header="Transaction Amount" value="100.0" />
     
           </context>
     Invalid Dimension Choice: Invoice12 on row 1 column B
   
       </message>
     </messages>
</response>

Falha (sem contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</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 Transaction Type do not exist: Invoice12.</message>
       <message key="invalid-dimension-choice-withCoordinate">Invalid Dimension Choice: Invoice12 on row 1 column B</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)

importStandardData

eraseActuals

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