eraseData

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-08-16

eraseData

Com suporte na API v24 +.

Categoria	Envio de dados
Descrição	Apaga dados de plano ou de valores reais nos períodos especificados para uma conta com filtros opcionais para níveis e contas.
Permissões obrigatórias para invocar	Apagar dados
Parâmetros obrigatórios na solicitação	Credentials, EraseOptions

Apaga valores numéricos de um plano ou versão de valores reais para o conjunto de contas especificado em um determinado intervalo de tempo. Não apagará nenhuma fórmula (como fórmulas compartilhadas, fórmulas de célula, fórmulas de conta). Ele exclui as divisões de conta que ficam vazias como resultado do processo de exclusão. Uma divisão vazia é uma divisão que não contém dados, fórmulas ou observações de célula. Se o apagamento resultar na exclusão dos últimos dados de uma divisão, essa divisão será excluída. Essa API não altera as divisões se elas estavam em branco antes de chamar a API.

O método eraseData oferece os mesmos recursos que eraseActuals, mas também inclui a capacidade de apagar dados do plano, com controle adicional sobre combinações específicas de plano de conta que são alvos. As observações de célula que correspondem aos critérios também são excluídas.

Recursos de importação

- Apagar dados

é uma permissão de superusuário que permite apagar valores reais ou dados planejados no Adaptive Planning, inclusive em níveis bloqueados. Apagar dados substitui as regras de acesso e as restrições de propriedade de nível. Você só pode excluir dados de contas calculadas com substituição de entrada de dados.

Essa API valida o estrato de tempo nas contas escolhidas.

Apagar contas consolidadas

A API Erase Data não apaga dados de contas consolidadas. Inclua cada conta individualmente em sua solicitação.

Apagando níveis

Se você passar um nível pai em sua solicitação, a API eraseData apaga somente os dados no nível pai, e não nos níveis filho. Você deve incluir cada nível individualmente na solicitação de API.

Formato da solicitação

As solicitações rejeitam etiquetas não reconhecidas. As etiquetas permitem correspondência sem diferenciar maiúsculas de minúsculas. Exemplo: <accounts>, <Accounts> e <ACCOUNTS> são aceitáveis para o elemento Contas.

Apagar valores reais de todos os níveis da versão de valores reais por padrão

Para apagar valores numéricos e divisões vazias recentemente para os períodos entre o início e o fim de todas as contas do livro-razão para todos os níveis da versão de valores reais por padrão:


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseActuals" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE" locale="en_US"/>
<eraseOptions actualsVersionName="Actuals" accountType="GL" start="01/2013" end="03/2013" includeCellNotes="false" />

</call>

Para apagar valores numéricos e observações de célula de uma única planilha de cubo para todos os níveis de uma versão de valores reais específica entre o início e o fim especificados:


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseActuals" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_password"/>
<eraseOptions actualsVersionName="Actuals" accountType="CUBE" cubeSheetName="Sales Cube" start="01/2013" end="03/2013" includeCellNotes="true" />
</call>

Apagar dados de valores reais com filtros para contas em um nível específico

Para este exemplo, os dados de valores reais na versão de valores reais

ActualsSubVersion2013

para contas personalizadas

WAT_Input_Custom

WAT_Test_Custom

no nível

serão excluídos.


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData" callerName="test caller api name">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE" locale="en_US" />
<eraseOptions actualsVersionName="ActualsSubVersion2013" accountType="CUSTOM" start="01/2010" end="11/2010" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="WAT_Input_Custom"/>
    <Account code="WAT_Test_Custom"/>
  </Accounts>
  <Levels>
    <Level name="QA"/>
  </Levels>
</filters>
</eraseOptions>
</call>

Apagar dados do plano com um filtro a ser excluído de contas personalizadas específicas

Para este exemplo, os dados do plano na versão de plano

clone2013Budget

para contas personalizadas

SUM_TEXT

LAST_NB

serão excluídos.


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/>
<eraseOptions planVersionName="clone2013budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="SUM_TEXT"/>
    <Account code="LAST_NB"/>
  </Accounts>
</filters>
</eraseOptions>
</call>

Apagar dados do plano com filtros a serem excluídos de contas personalizadas específicas em níveis específicos

Para este exemplo, os dados do plano na versão de plano

clone2013Budget

para contas personalizadas

WA_SUM

SUM_SUM

nos níveis

Development

Hosting

serão excluídos.


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData" callerName="test caller api name">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/>
<eraseOptions planVersionName="clone2013Budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="WA_SUM"/>
    <Account code="SUM_SUM"/>
  </Accounts>
  <Levels>
    <Level name="Development"/>
    <Level name="Hosting"/>
  </Levels>
</filters>
</eraseOptions>
</call>

Apagar dados do plano com filtros a serem excluídos de uma conta de cubo específica em um nível específico

Para este exemplo, os dados do plano na versão de plano

10YearBudget

para conta de cubo

ExpenseCube.Units

no nível

WorldWide Sales

serão excluídos.


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData" callerName="test caller api name">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US" />
<eraseOptions planVersionName="10YearBudget" accountType="CUBE" cubeSheetName="Expense Cube" start="01/2010" end="12/2017" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="ExpenseCube.Units" />
  </Accounts>
  <Levels>
    <Level name="WorldWide Sales" />
  </Levels>
</filters>
</eraseOptions>
</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í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)

elemento eraseOptions
Nome da etiqueta		eraseOptions
Descrição		Especifica as opções usadas ao apagar valores reais ou dados planejados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
actualsVersionName	N	Obrigatório para apagar dados de valores reais. Especifica o nome da versão de valores reais da qual apagar os dados. Não apaga nenhuma fórmula (como fórmulas compartilhadas, fórmulas de célula, fórmulas de conta).	ActualsSubVersion2013
planVersionName	N	Obrigatório para apagar dados do plano. Especifica o nome da versão de plano da qual os dados serão apagados. Não apaga nenhuma fórmula (como fórmulas compartilhadas, fórmulas de célula, fórmulas de conta).	clone2013Budget
accountType	S	Especifica se o tipo de conta é livro-razão ("LR"), personalizada ("CUSTOM") ou planilha de cubo ("CUBE").	Livro-razão geral
cubeSheetName	N	Obrigatório seaccountType="CUBE". Especifica o nome da planilha de cubo.	Cubo de vendas
início	S	Especifica o código do período inicial do intervalo de tempo. O código deve se referir a um período no estrato de tempo da conta. Se você especifica uma planilha de cubo, o código deve fazer referência a um período no estrato de tempo da planilha de cubo. Se você especifica um tipo de conta LR ou personalizada, o código deve fazer referência ao estrato de tempo por padrão. O período especificado deve estar alinhado com o estrato de tempo da conta. Por exemplo, se a conta tem um estrato de tempo Trimestres que começa em janeiro, você não pode selecionar fevereiro como início.	01/2013
fim	S	Especifica o código do período final do intervalo de tempo. O código deve se referir a um período no estrato de tempo da conta. Se você especifica uma planilha de cubo, o código deve fazer referência a um período no estrato de tempo da planilha de cubo. Se você especifica um tipo de conta LR ou personalizada, o código deve fazer referência ao estrato de tempo por padrão. O período especificado deve estar alinhado com o estrato de tempo da conta. Por exemplo, se a conta tem um estrato de tempo de Trimestres começando em janeiro, você não pode selecionar Fevereiro como um término.	03/2013
includeCellNotes	S	Se definido como "true", então eraseData apaga todas as observações de célula na versão, tipo de conta e intervalo de tempo selecionados (e combinações de nível de conta que correspondem aos filtros, se especificados), independentemente de também apagar os dados do célula. Se for "falso", nenhuma observação de célula será excluída	verdadeiro
displayNameEnabled Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	displayNameEnabled=true indica que eraseData deve respeitar as propriedades de nome de exibição de code quando Habilitar nome de exibição está ATIVADO para a instância. displayNameEnabled=false indica que a API eraseData 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 eraseData ignora as propriedades de nome de exibição code . O valor por padrão para displayNameEnabled é "falso".	Verdadeiro
Conteúdo do elemento
(nenhum)

elemento de filtros
Nome da etiqueta		Filtros
Descrição		Especifica os filtros de conta e nível a serem usados ao apagar dados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
Conteúdo do elemento
Um elemento Contas, um elemento Níveis ou ambos, um elemento Contas e um elemento Níveis.

Elemento de contas
Nome da etiqueta		Contas
Descrição		Contêiner para um ou mais elementos de conta de um filtro eraseData.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
Conteúdo do elemento
Um ou mais elementos Conta.

Elemento de níveis
Nome da etiqueta		Níveis
Descrição		Contêiner para um ou mais elementos Nível de um filtro eraseData.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
Conteúdo do elemento
Um ou mais elementos Nível.

Elemento de conta
Nome da etiqueta		Conta
Descrição		A conta da qual os dados serão apagados, especificada pelo código da conta.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Especifica o código da conta dos dados que estão sendo apagados.	WA_SUM
Conteúdo do elemento
(nenhum)

Elemento de nível
Nome da etiqueta		Nível
Descrição		O nível dos dados da conta que estão sendo apagados, especificado pelo nome do nível.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Especifica o nome do nível dos dados da conta que estão sendo apagados.	Vendas internacionais
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O código do nível. Obrigatório quando a opção Habilitar nome de exibição está ativada para uma instância.	Vendas internacionais
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<messages>
 <message key="erase-actuals-success">Successfully erased actuals data.</message>
 <message key="erase-actuals-facts-deleted">4 facts deleted.</message>
 <message key="erase-actuals-notes-deleted">2 notes deleted.</message>
 <message key="erase-actuals-splits-deleted">1 splits deleted.</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.	warning-invalid-timespan-start
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.

eraseActuals

recalculateSheet

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