recalculateSheet

Com suporte na API v16 +

Categoria	Envio de dados
Descrição	Recalcular planilhas com a propriedade Recalcular sob demanda.
Permissões obrigatórias para invocar	Permissão de edição de planilha
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. O usuário deve ter a permissão "Permissão para edição de planilha" para recalcular.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="recalculateSheet" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <version name="Default Structure"/>
   <sheet name="Expense Cube"/>
   <level name="Corporate Plan"/>
</call>

elemento de versão - Lança um erro se a versão não é especificada.

elemento de planilha - se nenhum elemento de planilha é especificado, todas as planilhas com opções de recálculo sob demanda são recalculadas no nível superior de uma determinada versão. Nesse caso, o nível é ignorado.

elemento de nível

Se nenhum nível é especificado, a planilha é recalculada no nível superior de uma determinada versão.

Se o usuário não tem acesso ao nível especificado, é gerado um erro.

A planilha é recalculada para o nível e seus descendentes na versão fornecida.

elemento de credenciais
Nome da etiqueta		credenciais
Descrição		Todas as chamadas de API devem conter um único Credenciais 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 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.	Estrutura por padrão
ID	N	ID da versão. A ID é considerada somente se o nome não está presente.	4
Conteúdo do elemento
(nenhum)

elemento de planilha
Nome da etiqueta		planilha
Descrição		Planilha definida por nome ou ID
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	N	O nome da planilha	Cubo de despesas
ID	N	ID da planilha. A ID é considerada somente se o nome não está presente.	1
Conteúdo do elemento
(nenhum)

elemento de nível
Nome da etiqueta		level
Descrição		Nível definido por nome ou ID
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	N	O nome do nível	Plano corporativo
ID	N	ID do nível. O nível é considerado somente se o nome não está presente.	1
Conteúdo do elemento
(nenhum)

Formato da resposta


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
</response>

elemento de resposta
Nome da etiqueta		resposta
Descrição		Nível definido por nome ou ID
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	"True" ou "false", 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 elemento de mensagens opcionais.

elemento de mensagens
Nome da etiqueta		mensagens
Descrição		Contêiner para um ou mais elementos da mensagem
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos 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.