Saltar al contenido principal
Documentación
Documentación
Adaptive Planning
Última actualización: 2024-08-16
eraseData

eraseData

Compatible con API v24 +.
Categoría
Envío de datos
Descripción
Borra los datos de plan o cifras reales en los periodos temporales especificados para una cuenta con filtros opcionales para niveles y cuentas.
Permisos obligatorios para invocar
Borrar datos
Parámetros obligatorios bajo petición
Credenciales, BorrarOpciones
Borra los valores numéricos de una versión de plan o de cifras reales 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). Elimina las divisiones de cuenta que quedan vacías como resultado del proceso de borrado. Una división vacía es una división que no contiene datos, fórmulas ni notas de celda. Si al borrar se eliminan los últimos datos de una división, esa división se eliminará. Esta API deja intactas las divisiones si estaban vacías antes de llamar a la API.
El método eraseData proporciona las mismas funciones que eraseActuals, pero también incluye la posibilidad de borrar datos de plan, con un control adicional sobre combinaciones específicas de cuenta y plan que son objetivos. También se eliminarán las notas de celda que coincidan con los criterios.
Importar capacidades
Borrar datos
 es un permiso de superusuario que permite borrar datos reales o datos de plan en Adaptive Planning, incluso en niveles bloqueados. Borrar datos sustituye a las reglas de acceso y a las restricciones de propiedad de nivel. Solo puede eliminar datos de cuentas calculadas con sustitución de entrada de datos.
Esta API valida el estrato temporal en las cuentas elegidas.

Borrado de cuentas de agrupación

La API de borrado de datos no borra los datos de las cuentas de agrupación. Incluya cada cuenta individualmente en su solicitud.

Borrado de niveles

Si pasa un nivel principal en su solicitud, la API eraseData solo borra los datos en el nivel principal y no en los niveles secundarios. Debe incluir cada nivel individualmente en la solicitud de API.

Formato de solicitud

Las solicitudes rechazan las etiquetas no reconocidas. Las etiquetas permiten coincidencias que no distinguen entre mayúsculas y minúsculas. Ejemplo: <accounts>, <Accounts> y <ACCOUNTS> son aceptables para el elemento Cuentas.

Borrado de cifras reales para todos los niveles de la versión de cifras reales por defecto

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" instanceCode="MYINSTANCE" locale="en_US"/>
<eraseOptions actualsVersionName="Actuals" 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>

Borrado de datos de cifras reales con filtros para cuentas en un nivel específico

En este ejemplo, los datos de cifras reales de la versión de cifras reales
ActualsSubVersion2013
 para cuentas personalizadas
WAT_Input_Custom
 y
WAT_Test_Custom
 en el nivel
QA
 se eliminará.

<?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>

Borrar datos de plan con un filtro para eliminar de cuentas personalizadas específicas

En este ejemplo, los datos de plan de la versión de plan
clone2013Budget
 para cuentas personalizadas
SUM_TEXT
 y
LAST_NB
 se eliminará.

<?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>

Borrado de datos de plan con filtros para eliminar de cuentas personalizadas específicas en niveles específicos

En este ejemplo, los datos de plan de la versión de plan
clone2013Budget
 para cuentas personalizadas
WA_SUM
 y
SUM_SUM
 en los niveles
Development
 y
Hosting
 se eliminará.

<?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>

Borrado de datos de plan con filtros para eliminar de una cuenta de cubo específica en un nivel específico

En este ejemplo, los datos de plan de la versión de plan
10YearBudget
 para cuenta de cubo
ExpenseCube.Units
 en el nivel
WorldWide Sales
 se eliminará.

<?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 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 utilizan al borrar cifras reales o datos de plan.
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
actualsVersionName
No
Obligatorio para borrar datos de cifras reales. Especifica el nombre de la versión de cifras reales de la que se van a borrar los datos.
No borra ninguna fórmula (como las fórmulas compartidas, las fórmulas de celda o las fórmulas de cuenta).
ActualsSubVersion2013
planVersionName
No
Obligatorio para borrar datos de plan. Especifica el nombre de la versión de plan de la que se van a borrar los datos.
No borra ninguna fórmula (como las fórmulas compartidas, las fórmulas de celda o las fórmulas de cuenta).
clone2013Budget
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 tiempo. 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.
El periodo temporal especificado debe coincidir 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 de tiempo. 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.
El periodo temporal especificado debe coincidir 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 "true", eraseData borra todas las notas de celda de la versión, el tipo de cuenta y el rango de tiempo seleccionados (y las combinaciones a nivel de cuenta que coincidan con los filtros, si se especifican), independientemente de si también borra los datos de la celda Si es "false", no se eliminará ninguna nota de celda.
verdadero
displayNameEnabled
Solo está disponible en API v30+ para instancias que activan el nombre de visualización.
No
displayNameEnabled=true indica que eraseData debe respetar las propiedades de nombre de visualización de
code
 cuando Activar nombre de visualización está activado para la instancia.
displayNameEnabled=false indica que la API eraseData debe seguir el contrato de la API anterior a la v30 aunque la opción Activar nombre de visualización esté activada para la instancia. La API eraseData ignora las propiedades de nombre de visualización
code
.
El valor por defecto de displayNameEnabled es "false".
Verdadero
Contenido del elemento
(ninguno)
elemento de filtros
Nombre de etiqueta
Filtros
Descripción
Especifica los filtros de cuenta y nivel que se utilizarán al borrar datos.
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
Contenido del elemento
Un elemento de Cuentas, un elemento de Niveles o un elemento de Cuentas y un elemento de Niveles.
Elemento de cuentas
Nombre de etiqueta
Cuentas
Descripción
Contenedor para uno o varios elementos de cuenta de un filtro eraseData.
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
Contenido del elemento
Uno o varios elementos de cuenta
Elemento de niveles
Nombre de etiqueta
Niveles
Descripción
Contenedor para uno o varios elementos Level de un filtro eraseData.
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
Contenido del elemento
Uno o varios elementos de nivel.
Elemento de cuenta
Nombre de etiqueta
Cuenta
Descripción
La cuenta de la que se borrarán los datos, especificada por el código de cuenta.
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
código
Sí
Especifica el código de cuenta de la cuenta de los datos que se están borrando.
WA_SUM
Contenido del elemento
(ninguno)
Elemento de nivel
Nombre de etiqueta
Nivel
Descripción
El nivel de los datos de cuenta que se están borrando, especificado por Nombre de nivel.
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
nombre
Sí
Especifica el nombre de nivel de los datos de cuenta que se están borrando.
Ventas en todo el mundo
código
Solo está disponible en API v30+ para instancias que activan el nombre de visualización.
No
El código del nivel.
Obligatorio cuando la opción Activar nombre de visualización está activada para una instancia.
Ventas a nivel mundial
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.