recalculateSheet

Compatible con API v16 +

Categoría	Envío de datos
Descripción	Recalcular hojas con la propiedad Recalcular a petición.
Permisos obligatorios para invocar	Permiso de edición de hoja
Parámetros obligatorios bajo petición	Credenciales

La solicitud de este método contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. El usuario debe tener permiso de "Edición de hoja" para volver a calcular.

Formato de solicitud


<?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 version: genera un error si no se especifica la versión.

elemento de hoja: si no se especifica ningún elemento de hoja, todas las hojas con opciones de recálculo bajo demanda se vuelven a calcular en el nivel superior de la versión determinada. En este caso, se ignora el nivel.

elemento de nivel

Si no se especifica ningún nivel, la hoja se vuelve a calcular en el nivel superior de la versión determinada.

Si el usuario no tiene acceso al nivel especificado, se genera un error.

La hoja se vuelve a calcular para el nivel y sus descendientes en la versión dada.

elemento de credenciales
Nombre de etiqueta		credenciales
Descripción		Todas las llamadas API deben contener un solo credentials para identificar al usuario que invoca la API. A continuación, la llamada a la API se realiza como este usuario (cualquier pista de auditoría o historial de acciones en el sistema mostrará que este usuario ha realizado la acción) y, por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción a fin de que la llamada a la API se lleve a cabo. correcta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
inicio de sesión	Sí	El nombre de conexión del usuario que invoca el método API. Este usuario debe tener los permisos necesarios para invocar el método.	sampleuser@company.com
contraseña	Sí	La contraseña del usuario que invoca el método API.	my_password
configuración regional	No	Especifique la configuración regional que se utilizará para interpretar los números y las fechas de entrada, y para dar formato a los números y las fechas de salida (utilizando el separador de miles, los nombres de periodo y el formato de fecha adecuados). La configuración regional también se utiliza para especificar el idioma en el que deben aparecer los mensajes del sistema en la respuesta. Si no se especifica, se utiliza en_US (inglés americano).	fr_FR
instanceCode	No	Si el usuario especificado en las credenciales tiene acceso a más de una instancia de Adaptive Planning , este atributo se puede utilizar para especificar que el usuario tiene la intención de acceder a una instancia distinta a la instancia por defecto. Si no se especifica, se utilizará la instancia por defecto del usuario. Para determinar los códigos de instancia disponibles, utilice la API exportInstances.	MYINSTANCE1
Contenido del elemento
(ninguno)

elemento de versión
Nombre de etiqueta		versión
Descripción		Indica qué versión debe utilizarse para recibir los datos solicitados. Se debe proporcionar una versión para cada llamada.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	No	El nombre de la versión.	Estructura por defecto
ID	No	ID de la versión. El ID solo se tiene en cuenta si el nombre no está presente.	4
Contenido del elemento
(ninguno)

elemento de hoja
Nombre de etiqueta		hoja
Descripción		Hoja definida por nombre o ID
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	No	El nombre de la hoja	Cubo de gastos
ID	No	ID de la hoja. El ID solo se tiene en cuenta si el nombre no está presente.	1
Contenido del elemento
(ninguno)

elemento de nivel
Nombre de etiqueta		nivel
Descripción		Nivel definido por nombre o ID
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	No	El nombre del nivel	Plan corporativo
ID	No	ID del nivel. El nivel solo se tiene en cuenta si el nombre no está presente.	1
Contenido del elemento
(ninguno)

Formato de respuesta


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

elemento de respuesta
Nombre de etiqueta		respuesta
Descripción		Nivel definido por nombre o ID
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	"Verdadero" o "falso", que indica si la llamada a la API se ha realizado correctamente o no. Incluso las llamadas correctas pueden contener mensajes de aviso en su respuesta.	verdadero
Contenido del elemento
Un único elemento de mensajes opcional.

elemento de mensajes
Nombre de etiqueta		mensajes
Descripción		Contenedor para uno o varios elementos de mensaje
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos de mensaje

elemento de mensaje
Nombre de etiqueta		mensaje
Descripción		Representa un mensaje que se envía desde el sistema a la persona que llama. Los mensajes se utilizan para los mensajes de error cuando las solicitudes no se realizan correctamente, para los mensajes de aviso cuando las solicitudes se realizan correctamente y para los mensajes de confirmación cuando se realizan correctamente.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
clave	No	Cuando se proporciona, una clave es una forma de identificar un mensaje o tipo de mensaje concreto, lo que resulta útil para el registro de errores automatizado y la recuperación en los programas cliente. Las claves no cambian en las distintas configuraciones regionales de las solicitudes, aunque cambie el idioma del mensaje. Tampoco es probable que las claves cambien en el futuro debido a ajustes de redacción o cambios de terminología.	ID de valor de atributo no válido
Contenido del elemento
El texto del mensaje. Este texto está en el idioma de la configuración regional especificada en la solicitud (suponiendo que la configuración regional sea compatible). El texto también puede contener información variable, como el número de filas que se han procesado o la columna o el valor concretos que han provocado el error. Un elemento de contexto opcional.