importCubeData

Adaptive Planning

Documentación de Workday Adaptive Planning (Workday 2025R2)
Integración
Gestión de integración de datos
Documentación de API
Métodos de envío de datos

Última actualización: 2023-06-23

importCubeData

Categoría	Envío de datos
Descripción	Inserta o sustituye datos en una hoja de cubo. Este método también se puede utilizar para eliminar datos de una hoja de cubo importando ceros a ubicaciones en el cubo. Al importar un cero a una hoja de cubo, se borrarán los datos en la ubicación del cero.
Permisos obligatorios para invocar	Importar
Parámetros obligatorios bajo petición	Credentials, ImportDataOptions, Version, Sheet, RowData

La solicitud de este método contiene los parámetros que se utilizarán para determinar qué hoja y qué versión recibirán las filas de datos proporcionadas. Este método también se puede utilizar para eliminar datos de una hoja de cubo importando ceros a ubicaciones en el cubo. Al importar un cero a una hoja de cubo, se borrarán los datos en la ubicación del cero.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="importCubeData" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false"/>
<version name="Budget 2014" isDefault="false" />
<sheet name="Sales Cube" isUserAssigned="false" />
<rowData>
   <header>ProductFurniture|CountryRegion|FabricationMachine|Customer|Account|Level|06/2014|07/2014|08/2014|09/2014|01/2015</header>
   <rows>
     <row>Coffee table|Argentina|Do-All 15 Vertical|Aeropostale|Price|Corporate Plan|0|0|0|0|0</row>
   </rows>
</rowData>
</call>

Cada invocación de esta llamada API debe contener exactamente un elemento de cada uno de los tipos enumerados:

credenciales

importDataOptions

versión

hoja

rowData

Además, cuando el modo se especifica como REPLACE, se debe especificar el elemento de ámbito.

Una discrepancia entre el número de caracteres de barra vertical ( | ) de la cabecera y los datos provocará un error para API v30 o superior.

Solicitud de ejemplo que especifica el modo de sustitución con ámbito:

<?xml version='1.0' encoding='UTF-8'?>
<call method="importCubeData" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
 <version name="Budget 2022" isDefault="true" />
 <sheet name="Expense Cube" isUserAssigned="false" />
 <importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false" mode="REPLACE" />
 <!-- Scope parameter specifying the import scope.-->
 <scope>
 <!-- Specifies the time scope for import. All values will be specified as time codes.-->
  <time mode="EXPLICIT">
   <timeRange start="01/2021" end="10/2021" />
  </time>
  <!-- Specifies list of accounts in the scope. All values will be specified as code field.-->
  <accounts mode="EXPLICIT">
   <account includeDescendants="true">Op_Expense_Inputs</account>
   <account includeDescendants="true">Op_Expense_Drivers</account>
  </accounts>
  <!-- Specifies list of levels in the scope. All values will be specified as code field.-->
  <levels mode="INPUT"/>
 </scope>
 <rowData>
  <header>ProductFurniture|CountryRegion|FabricationMachine|Customer|Account|Level|01/2022|02/2022|03/2022|04/2022|05/2022|06/2022|07/2022|08/2022|09/2022|10/2022|11/2022|12/2022</header>
  <rows>
   <row>Coffee Table|Argentina|Do-All 15 Vertical|Aeropostale|Units|Development|44567.33|21345.77|22341.43|65567.32|298145.12|12641.83|77821.53|7766342.09|211441.21|88712.43|61940.41|662341.03|775420.25|800345.17</row>
  </rows>
 </rowData>
</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 adecuado,nombres de periodos y formato de fecha). 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 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)

importDataOptions element
Nombre de etiqueta		importDataOptions
Descripción		Especifica las opciones que se utilizarán al realizar la importación.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
planOrActuals	Sí	Establezca uno de "Plan" o "Cifras reales" para especificar el tipo de datos que se van a importar. Si este parámetro entra en conflicto con la versión especificada en elLa etiqueta de versión, laEl valor de la etiqueta de versión tiene prioridad y este parámetro se ignora.	Plan
moveBPtr	No	Solo se utiliza cuando elEl atributo planOrActuals está definido comoCifras reales SimoveBPtr se establece entrue, la importación moverá el puntero de disponibilidad de cifras reales en la versión de cifras reales para que sea el último periodo temporal encontrado en los datos importados. Si se establece enfalse, la importación no afectará a los periodos que muestran cifras reales en cualquier versión. Este atributo debe definirse como falso siplanOrActuals se establece enPlan	false
allowParallel	Sí	Solo se utiliza cuando elEl atributo planOrActuals está definido comoCifras reales Si se establece entrue, la importación continuará aunque ya haya otra importación de cifras reales o transacciones en curso para esta instancia. Si se establece enfalse, se producirá un error al intentar importar si ya hay una importación de cifras reales o transacciones procesada para esta instancia.	falso
useMappings	No	Especifica si se deben utilizar asignaciones de importación para cuentas, planes y valores de dimensión dentro de los elementos de fila. Consideradotrue por defecto. Sifalse, se deben usar los identificadores internos: las cuentas se identifican por código, los niveles y los valores de dimensión por nombre.	falso
includeContext	No	Especifica si los mensajes pueden incluir el bloque de contexto. Los valores sonfalse (nunca mostrar contexto) otrue (muestre el contexto si procede). Si no se especifica,se asume verdadero.	falso
displayNameEnabled Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	displayNameEnabled=true indica que importCubeData debe esperar Account Code , Level Code , Dimension Code y Dimension Name Column en la carga útil cuando Activar nombre de visualización está activado para la instancia. displayNameEnabled=false indica que la API importCubeData 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 importCubeData ignora las propiedades de nombre de visualización Account Code , Level Code , Dimension Code y Dimension Name Column . El valor por defecto de displayNameEnabled es "false".	falso
modo Disponible en API v32+	No	Especifica el modo de importación, que es APPEND o REPLACE. APPEND: se actualizan los hechos existentes o se insertan nuevos hechos. No se eliminará ningún hecho. REPLACE: el autor de la llamada debe especificar un elemento de ámbito que represente las coordenadas del cubo en el que se sustituirán los datos por los proporcionados en la carga útil. Todos los datos existentes dentro del ámbito se sustituirán por los datos de la carga útil de la llamada. Esta opción es compatible con API v32 y versiones posteriores. Si se llama a la API con versiones anteriores, se producirá un error. El valor por defecto de modo cuando no se especifica es APPEND.	SUSTITUIR
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 que se utilizará para recibir los datos. Solo se puede acceder a una versión en una sola llamada a la API. Si no se proporciona un nombre, elEl indicador isDefault debe establecerse entrue en este elemento.	Presupuesto 2012
isDefault	No	Si la persona que llama desea acceder a la versión por defecto actual de la instancia independientemente de su nombre, este atributo se puede establecer en verdadero, en cuyo caso se ignora el atributo de nombre de la etiqueta (si está presente). De lo contrario, si este valor es falso o si este atributo no está presente, debe existir una versión con el nombre proporcionado y ser accesible para el usuario para que esta llamada se realice correctamente.	falso
Contenido del elemento
(ninguno)

elemento de hoja
Nombre de etiqueta		hoja
Descripción		Indica qué hoja debe recibir los datos importados. Cada llamada a la API solo puede tener como destino los datos de una hoja.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre de la hoja a la que se importarán los datos.	Personal
isUserAssigned	No	Indica que la hoja es una hoja asignada al usuario. Si no se especifica, el valor por defecto es falso, lo que indica que se trata de una hoja asignada a nivel.	falso
Contenido del elemento
(ninguno)

elemento de ámbito
Nombre de etiqueta		Alcance
Descripción		Especifica el ámbito de esta importación. Solo es aplicable cuando el modo de importación se especifica como REPLACE. Disponible en API v32+
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
modo	Sí	Especifica si se borran o no las notas de celda del ámbito. Debe ser uno de los tres valores enumerados: NONE: no se borran las notas de celda. TODO: borra todas las notas de celda dentro del ámbito. MODIFIED_ONLY: borra las notas de celda de las celdas dentro del ámbito que se modifican mediante la importación. Esto incluye celdas previamente vacías a las que se han importado hechos y celdas cuyos hechos se han borrado. Si no se especifica eraseCellNotes, el valor por defecto es NONE.	NINGUNO
Contenido del elemento
Un elemento de periodos, un elemento de cuentas y un elemento de niveles, todos ellos obligatorios.

elemento de periodo
Nombre de etiqueta		Periodo
Descripción		Especifica uno o varios rangos de tiempo que representan el ámbito temporal de la importación. Disponible en API v32+
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
modo	Sí	Especifica el modo para el ámbito temporal. Debe ser una de las tres opciones siguientes: INPUT: cuando se especifica este modo, el ámbito temporal lo determinarán los códigos de tiempo del elemento <header>. Si la cabecera contiene dos meses, el ámbito de la importación serán estos dos meses. EXPLICIT: si se especifica este modo, se espera ver uno o varios subelementos timeRange que determinen el ámbito temporal de la importación. VERSION: cuando se especifica este modo, el ámbito temporal será el inicio y el final de la versión, incluido cualquier periodo de saldo inicial. Si se especifica el modo y es INPUT o VERSION, no se debe incluir ningún elemento timeRange. Si está presente, se trataría como una condición de error. Al especificar VERSION, se tiene en cuenta la fecha inicial de la versión incluso cuando la fecha inicial del plan es posterior a la fecha inicial de la versión.	ENTRADA
Contenido del elemento
Uno o varios elementos timeRange, a menos que el modo sea INPUT o VERSION.

elemento timeRange
Nombre de etiqueta		TimeRange
Descripción		Especifica un solo rango temporal para el ámbito temporal. Disponible en API v32+
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
inicio	Sí	El periodo inicial del rango temporal de importación.	07/2021
fin	Sí	el periodo final del rango temporal de importación.	08/2021
Contenido del elemento
(ninguno)

elemento de cuentas
Nombre de etiqueta		cuentas
Descripción		Especifica los códigos de cuenta para el ámbito de importación. Si existe un código de cuenta aquí, pero no hay datos para esta cuenta en los datos de importación, los datos de esta cuenta se eliminarán para el rango temporal y el resto de las coordenadas del ámbito. Disponible en API v32+
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
modo	Sí	Especifica el modo para el ámbito de cuenta. Debe ser una de las tres opciones siguientes: EXPLÍCITO: si se especifica este modo, esperamos ver uno o más subelementos de cuenta que determinen el ámbito de cuenta para la importación. INPUT: cuando se especifica este modo, el ámbito de la cuenta lo determinará el conjunto exclusivo de cuentas presente en los datos de importación. ALL: cuando se especifica este modo, el ámbito de la cuenta será todas las cuentas para la importación. Para una importación de hoja de cubo, esto representará todas las cuentas que se pueden importar para esa hoja de cubo. Si se especifica el modo y es INPUT o ALL, no se debe incluir ningún subelemento de cuenta. Si está presente, se trataría como una condición de error.	EXPLÍCITO
Contenido del elemento
Uno o varios elementos de cuenta, a menos que el modo sea INPUT o ALL.

elemento de cuenta
Nombre de etiqueta		cuenta
Descripción		Especifica el código de cuenta que se incluirá en el ámbito de la importación. Disponible en API v32+
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
includeDescendants	No	Si la cuenta es una cuenta secundaria, includeDescendants no tiene ningún efecto. Si la cuenta es una cuenta principal, al especificar este atributo como verdadero se incluirán todos los descendientes de hoja de esta cuenta en el ámbito. Si la cuenta es una cuenta principal e includeDescendants es falso, este elemento de cuenta se tratará como si no se hubiera especificado. El motivo de este tratamiento de las cuentas principales es que, en ocasiones, una cuenta secundaria puede promocionarse para convertirse en una cuenta principal y es posible que la especificación de importación no se actualice a tiempo para reflejar este cambio. Ignorar una cuenta principal con includeDescendants=false evita la eliminación no intencionada de datos. Este es un atributo opcional y el valor por defecto se considerará falso.	verdadero
Contenido del elemento
Especifica el código de cuenta de la cuenta utilizada como parte del ámbito de importación. Por ejemplo, Operational_Expense.

elemento de niveles
Nombre de etiqueta		niveles
Descripción		Especifica los códigos de nivel para el ámbito de importación. Si se especifica aquí un código de nivel, pero no hay datos para este nivel en los datos de importación, los datos de este nivel se eliminarán para el rango temporal y el resto de las coordenadas del ámbito. Disponible en API v32+
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
modo	Sí	Especifica el modo para el ámbito de nivel. Debe ser una de las tres opciones siguientes: EXPLÍCITO: si se especifica este modo, esperamos ver uno o más subelementos de nivel que determinen el ámbito de nivel para la importación. INPUT: cuando se especifica este modo, el ámbito de nivel lo determinará el conjunto exclusivo de niveles presente en los datos de importación. ALL: cuando se especifica este modo, el ámbito de nivel será todos los niveles importables. Si se especifica el modo y es INPUT o ALL, no se debe incluir ningún subelemento de nivel. Si está presente, se trataría como una condición de error.	ENTRADA
Contenido del elemento
Uno o varios elementos de nivel, a menos que el modo se especifique como INPUT o ALL.

elemento de nivel
Nombre de etiqueta		nivel
Descripción		Especifica el código de nivel que se incluirá en el ámbito de importación. Disponible en API v32+
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
includeDescendants	No	Si el nivel es un nivel principal, al especificar este atributo como verdadero se incluirán todos los descendientes de hoja de este nivel, incluido él mismo (el nodo Solo) en el ámbito. Este es un atributo opcional. Si no se proporciona el atributo, el valor por defecto será falso. Si el atributo no se proporciona o se proporciona como falso y el nivel especificado es un nivel principal, esto significaría que la importación tendrá en cuenta el nodo Solo (por ejemplo, Solo ingeniería) para ese nivel para el ámbito. Los elementos secundarios del nivel no se considerarán en el ámbito a menos que se especifique explícitamente con otros elementos de nivel.	verdadero
Contenido del elemento
Especifica el código de nivel del nivel como parte del ámbito de importación. Por ejemplo, Desarrollo.

elemento rowData
Nombre de etiqueta		rowData
Descripción		Contenedor de las filas de datos que se van a importar.
Atributos del elemento
(ninguno)
Contenido del elemento
Exactamente unoelemento de cabecera y exactamente unoelemento de filas

elemento de cabecera
Nombre de etiqueta		cabecera
Descripción		Especifica los nombres y el orden de las columnas de los datos en el correspondienteelemento de filas
Atributos del elemento
(ninguno)
Contenido del elemento
Una línea de texto con nombres de columnas separados por barras verticales. Estos nombres de columna deben corresponderse con los nombres de las dimensiones o los campos de la hoja, o con los códigos de periodo temporal que pueden contener datos. Son idénticos a los nombres de columna que se encuentran en la plantilla de importación de la hoja a la que se importan los datos, con cada cabecera de columna separada de la siguiente por una barra vertical o un símbolo de barra vertical. En las instancias que activan Nombre de visualización, la cabecera no admite "<dimension>" en combinación con "<dimension> Name" o "<dimension> Code" en API v30 o superior para configuraciones regionales admitidas por Adaptive Planning.

elemento de filas
Nombre de etiqueta		filas
Descripción		Contenedor para uno o varioselementos de fila
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varioselementos de fila

elemento de fila
Nombre de etiqueta		fila
Descripción		Se están importando los datos de una sola fila.
Atributos del elemento
(ninguno)
Contenido del elemento
Los datos de los campos de una sola fila que se están importando, el valor de cada campo separado por una barra vertical o un símbolo de barra vertical. Los campos de datos deben estar en el mismo orden que la línea del elemento de cabecera. Si los números de los valores utilizan separadores de miles, se supone que son los separadores de coma utilizados en la configuración regional especificada en las credenciales de la solicitud.

Formato de respuesta

Estos son ejemplos de respuestas para la importación correcta y no correcta de datos de cubo.

Ejemplo de éxito


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
  <message key="warning-no-data-imported-dimension-unmapped">Warning: Row 3 was not imported because Coffeee table is unmapped.</message>
</messages>
</response>

Error (con contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="err-incomplete-cube-row">
           <context>
               <col header="ProductFurniture" value="Coffee table" />
               <col header="CountryRegion" value="" />
               <col header="Account" value="Do-All 15 Vertical" />
               <col header="Level" value="Aeropostale" />
               <col header="06/2014" value="Price" />
               <col header="07/2014" value="Corporate Plan" />
               <col header="08/2014" value="0.0" />
               <col header="09/2014" value="0.0" />
               <col header="01/2015" value="0.0" />
     
           </context>
     Row 1 is missing a value.
   
       </message>
       <message key="err-no-rows">You must import at least one row of data.</message>
     </messages>
</response>

Error (sin contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="err-incomplete-cube-row">Row 1 is missing a value.</message>
       <message key="err-no-rows">You must import at least one row of data.</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.	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.

elemento de contexto
Nombre de etiqueta		contexto
Descripción		Contenedor para uno o varios elementos de columna.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ninguno
Contenido del elemento
Uno o varios elementos col.

elemento col
Nombre de etiqueta		col
Descripción		Representa el contexto del mensaje. Proporciona un par de cabecera/valor para que se pueda identificar la fila que genera el mensaje.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
cabecera	Sí	La cabecera de la columna.	"Cuenta"
valor	Sí	El valor de la columna.	"GL-29482-38233"
Contenido del elemento
(ninguno)

importConfigurableModelData

importStandardData

¿Ha resultado útil?

¿Qué requiere nuestra atención? Es correcta Responde a mi pregunta Fácil de encontrar Fácil de entender Me ayuda a completar mi tarea Es completa y detallada

¿Qué requiere nuestra atención? No es correcta No responde a mi pregunta No es fácil de encontrar No es fácil de entender No me ayuda a completar mi tarea Es incompleta o poco detallada

Díganos la tarea que está realizando. ¿Qué información adicional podría mejorar este contenido? ¿Algún detalle adicional que quiera compartir?

Nombre y apellidos

Correo electrónico

Workday utilizará su nombre y correo electrónico para proporcionarle respuestas relacionadas con sus comentarios. Su información se tratará de acuerdo con nuestra Declaración de privacidad.

Gracias por el feedback