eraseActuals

Categoria	Envio de dados
Descrição	Apaga dados numéricos nos períodos e contas especificados de uma versão de valores reais.
Permissões obrigatórias para invocar	Apagar dados
Parâmetros obrigatórios na solicitação	Credentials, EraseOptions

Esse método apagará os valores numéricos de uma versão de valores reais para todos os níveis do 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). Isso excluirá as divisões de conta que ficarem vazias como resultado do processo de exclusão de valores reais. Uma divisão vazia é aquela que não contém dados, fórmulas ou observações de célula. Se o apagamento de valores reais resultar na exclusão dos últimos dados de uma divisão, essa divisão será excluída. Essa API deixará as divisões intactas se estiverem vazias antes de chamar a API.

Formato da solicitaçã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"/>
   <eraseOptions
     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>

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 a serem usadas ao apagar valores reais.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
actualsVersionName	N	Obrigatório quando há mais de uma versão de valores reais. Se essa instância contém apenas o produto Planning,ApagarActuals apagará os dados da única versão de valores reais.	Valores reais
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 de valores reais. 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. Para a API v15+, 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 de término do intervalo de tempo de valores reais. 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. Para a API v15+, 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 "verdadeiro", entãoApagarActuals apagará todas as observações de célula na versão, tipo de conta e intervalo de tempo selecionados, independentemente de também estar apagando os dados da célula. Se "false", nenhuma observação de célula será excluída.	verdadeiro
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.