Saltar al contenido principal
Documentación
Documentación
Adaptive Planning
Última actualización: 2024-06-14
eraseActuals

eraseActuals

Categoría
Envío de datos
Descripción
Borra los datos numéricos de los periodos temporales y las cuentas de una versión de cifras reales.
Permisos obligatorios para invocar
Borrar datos
Parámetros obligatorios bajo petición
Credenciales, BorrarOpciones
Este método borrará los valores numéricos de una versión de cifras reales para todos los niveles del conjunto de cuentas especificado para un marco temporal determinado. No se borrará ninguna fórmula (como las fórmulas compartidas, las fórmulas de celda o las fórmulas de cuenta). Se eliminarán las divisiones de cuenta que queden vacías como resultado del proceso de borrado de cifras reales. Una división vacía es aquella que no contiene datos, fórmulas ni notas de celda. Si al borrar las cifras reales se eliminan los últimos datos de una división, esa división se eliminará. Esta API dejará intactas las divisiones si estaban vacías antes de llamar a la API.

Formato de solicitud

Para borrar los valores numéricos y las nuevas divisiones vacías de los periodos entre el inicio y el final de todas las cuentas de libro mayor para todos los niveles de la versión de cifras reales por defecto:

 <?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 borrar valores numéricos y notas de celda de una sola hoja de cubo para todos los niveles de una versión de cifras reales específica entre el inicio y el final 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 credenciales
Nombre de etiqueta
credenciales
Descripción
Todas las llamadas API deben contener un solocredentials 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)
eraseOptions element
Nombre de etiqueta
eraseOptions
Descripción
Especifica las opciones que se utilizarán al borrar cifras reales.
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
actualsVersionName
No
Obligatorio cuando hay más de una versión de cifras reales. Si esta instancia solo contiene el producto de planificación,EraseActuals borrará los datos de la única versión de cifras reales.
Cifras reales
accountType
Sí
Especifica si el tipo de cuenta es libro mayor ("libro mayor"), personalizado ("CUSTOM") o una hoja de cubo ("CUBO").
Libro mayor
cubeSheetName
No
Obligatorio siaccountType="CUBE". Especifica el nombre de la hoja de cubo.
Cubo de ventas
inicio
Sí
Especifica el código del periodo inicial del rango de horas de cifras reales. El código debe hacer referencia a un periodo temporal en el estrato temporal de la cuenta.
Si especifica una hoja de cubo, el código debe hacer referencia a un periodo en el estrato temporal de la hoja de cubo.
Si especifica un tipo de cuenta personalizada o de libro mayor, el código debe hacer referencia al estrato temporal por defecto.
Para API v15+, el periodo temporal especificado debe alinearse con el estrato temporal de la cuenta. Por ejemplo, si la cuenta tiene un estrato temporal de Trimestres que comienzan en enero, no puede seleccionar febrero como inicio.
01/2013
fin
Sí
Especifica el código del periodo temporal final del rango temporal de cifras reales. El código debe hacer referencia a un periodo temporal en el estrato temporal de la cuenta.
Si especifica una hoja de cubo, el código debe hacer referencia a un periodo en el estrato temporal de la hoja de cubo.
Si especifica un tipo de cuenta personalizada o de libro mayor, el código debe hacer referencia al estrato temporal por defecto.
Para API v15+, el periodo temporal especificado debe alinearse con el estrato temporal de la cuenta. Por ejemplo, si la cuenta tiene un estrato temporal de Trimestres que comienza en enero, no puede seleccionar febrero como fecha final.
03/2013
includeCellNotes
Sí
Si se establece en "verdadero", entoncesEraseActuals borrará todas las notas de celda en la versión, el tipo de cuenta y el rango de tiempo seleccionados, independientemente de que también se borren los datos de la celda. Si "false", no se eliminará ninguna nota de celda.
verdadero
Contenido del elemento
(ninguno)

Formato de respuesta


 <?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 respuesta
Nombre de etiqueta
respuesta
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
éxito
Sí
Cualquieraverdadero ofalse, 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 solo opcionalelemento de mensajes
elemento de mensajes
Nombre de etiqueta
mensajes
Descripción
Contenedor para uno o varioselementos de mensaje
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varioselementos 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.
advertencia-invalid-timespan-start
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.