importConfigurableModelData

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: 2024-09-20

Actualizado en API v40 (21 de septiembre de 2024).

Categoría	Envío de datos
Descripción	Inserta, sustituye o actualiza datos en una hoja modelada.
Permisos obligatorios para invocar	Importar
Parámetros obligatorios bajo petición	Credenciales, ImportDataOptions, Versión, Hoja, 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 puede:

Añada nuevas filas a la hoja.

Reemplazar todas las filas que hay actualmente en la hoja modelada con la importación.

Sustituir todos los datos de la hoja, pero solo para los niveles importados

Actualice las filas existentes haciendo coincidir las filas de la importación con una clave de importación.

Actualice las filas existentes haciendo coincidir las filas de la importación con una clave de importación y añada nuevas filas.

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

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.

A partir de la API v37, limitamos el número máximo de filas nuevas que puede importar a las hojas modeladas. Póngase en contacto con el servicio de asistencia técnica si se encuentra con este límite.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="importConfigurableModelData" 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" useMappings="false" replaceExisting="2"/>
<version name="Budget 2014" isDefault="false" />
<sheet name="Personnel" isUserAssigned="false" />
<rowData>
 <header>Level|Region|Title|JobCode|Benefits|per|Last Name|First Name|ID|Start|End|Hr/Week|Pay Rate|Pay Rate Display Column</header>
 <rows>
   <row>Corporate Plan|Any|CEO|E1|Yes|Yr|Topdog|Andy|1000|12/20/2013|12/30/2014|80|500,000.12|888,888</row>
 </rows>
</rowData>
</call>

Formato de solicitud para actualizar filas existentes con importKey


<?xml version='1.0' encoding='UTF-8'?>
<call method="importConfigurableModelData" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"instanceCode="INSTANCE1"/>
<importDataOptions planOrActuals="Plan" replaceExisting="3" importKey="Region" allowParallel="false" moveBPtr="false" useMappings="false"/>
<version name="Budget 2014" isDefault="false" />
<sheet name="Personnel" isUserAssigned="false" />
<rowData>
 <header>Plan|Region|Benefits|per</header>
 <rows>
   <row>Europe Sales|W-US|Yes|Hr</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, 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)

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í	Establecer en uno dePlan oCifras 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 la etiqueta Versión, el valor de la etiqueta Versión tiene prioridad y este parámetro se ignora.	Plan
moveBPtr	No	Solo se utiliza cuando los datos que se importan tienen un conjunto de números de marco temporal de cada fila. 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 establecerse en false si planOrActuals se establece en Plan.	false
allowParallel	Sí	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
replaceExisting	No	Establezca el valor "1" o "verdadero" para sustituir todas las filas existentes en todos los niveles por las nuevas filas que se van a importar. (es decir, borrar todas las filas existentes anteriormente en todos los niveles). Solo los usuarios con el permiso Importar a todas las ubicaciones pueden utilizar esta opción. Establézcalo como "0" o "falso" para añadir las filas importadas a las filas existentes, aunque las nuevas filas estén duplicadas. Establezca el valor "2" para sustituir las filas existentes en la hoja modelada por las nuevas filas que se van a importar, pero solo para las filas con el nivel coincidente y las dimensiones seguras. Las filas de combinaciones de dimensiones seguras y de nivel que no tengan filas sin dividir en la hoja de cálculo cargada no verán eliminadas sus filas existentes, a menos que la fila sea una división de una fila que la carga sustituya. replaceExisting examina las dimensiones utilizadas y si existen datos en el mismo nivel, cuenta, periodo y versión. Si existe una clave de fila, también la cotejamos con la columna o columnas de la clave de fila. Si existen datos en el sistema en la misma ubicación, la importación los sustituye. Esta sustitución se produce fila por fila. La importación no sustituye todo a la vez. Las filas de importación sin cotejar se añaden a la hoja. Por ejemplo, realiza dos importaciones. El primer archivo de importación carga datos que el segundo archivo de importación no contiene. Los datos existentes permanecerán después de la segunda importación. Si desea eliminar todos los datos de una columna en particular, incluya la columna pero deje sus valores de columna en blanco. Los valores de columna de las columnas no mencionadas permanecen inalterados. Establézcalo en "3" para actualizar las filas existentes en la hoja modelada para reflejar las nuevas filas que se están importando. Se devolverá un aviso si alguna fila no coincide con una fila existente. Este modo requiere una clave de importación. Las hojas con Permitir divisiones seleccionadas no admiten actualizaciones. Establézcalo en "4" para actualizar las filas existentes en la hoja modelada para reflejar las nuevas filas que se están importando e insertar nuevas filas para las que no coincidan con una fila existente. Este modo requiere una clave de importación. Las únicas columnas obligatorias son Clave de importación, Nivel y cualquier selector de texto, incluso cuando no se añaden filas nuevas. Las hojas con Permitir divisiones seleccionadas no admiten actualizaciones. Establézcalo en 5 para sustituir las filas existentes en función del ámbito, que actualmente solo admite niveles de entrada para la funcionalidad de sustitución solo por nivel. El ámbito se proporciona mediante un nuevo elemento de ámbito. Solo las filas que coincidan con el ámbito dado se sustituirán por la carga útil en la importación. Las filas que no coincidan con el ámbito no se verán afectadas. El valor por defecto es verdadero.	verdadero
importKey	No	El nombre de la columna de la hoja modelada que se utilizará como clave de importación al actualizar las filas de la hoja modelada. Adaptive Planning utiliza la columna de clave de importación para cotejar cada fila de la importación con las filas de la hoja modelada. El valor de clave de importación de cada fila debe ser exclusivo. Este atributo solo se puede utilizar cuando replaceExisting es "3" o "4". Las columnas de clave de importación pueden ser una de las siguientes: una columna de nivel una columna de dimensión	Nivel
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 v31+ para instancias que activan el nombre de visualización.	No	displayNameEnabled=true indica que la API debe esperar las columnas Código de cuenta, Código de nivel, Código de dimensión y Nombre de dimensión en la carga útil cuando el parámetro Activar nombre de visualización está activado para la instancia. displayNameEnabled=false indica que la API debe continuar siguiendo el contrato de API anterior a la v30 aunque el parámetro Activar nombre de visualización esté activado para la instancia. El valor por defecto de displayNameEnabled es "false".	falso
applyValidationRules Solo disponible en API v38 +.	No	applyValidationRules=true indica que la API realizará validaciones de reglas de hoja modelada para todos los datos importados cuando la versión de la API sea superior a la v38. applyValidationRules=false indica que el API ignorará las validaciones de regla de hoja modelada para todos los datos importados. El valor por defecto de applyValidationRules es "true".	falso
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 2014
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		Ámbito (disponible con API v40)
Descripción		Especifica el ámbito de esta importación. Ejemplo: <scope> <levels> mode="INPUT"/> </scope> Solo se permite cuando el atributo replaceExisting del elemento importDataOptions es 5.

rowData element
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 los periodos temporales 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.

Ejemplo de éxito


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
 <message key="modeled-import-success">Personnel import successful. Rows imported: 1</message>
 <message key="modeled-import-replace">All existing rows were replaced.</message>
</messages>
</response>

Error (con contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
 <messages>
     <message key="modeled-import-failed">The Personnel import has failed.</message>
     <message key="error-import">Import Failed with the following error: 1 Error(s) Occurred.</message>
     <message key="import-detail">Additional information:</message>
     <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Plan do not exist: Development1.</message>
     <message key="invalid-plan-choice-withCoordinate">
         <context>
             <col header="Plan" value="Development1" />
             <col header="Region" value="C-US" />
             <col header="Title" value="CEO" />
             <col header="JobCode" value="E1" />
             <col header="Benefits" value="Yes" />
             <col header="per" value="Yr" />
             <col header="Last Name" value="Topdog" />
             <col header="First Name" value="Andy" />
             <col header="ID" value="1000" />
             <col header="Start" value="12/20/2013" />
             <col header="End" value="12/30/2014" />
             <col header="Hr/Week" value="80.0" />
             <col header="Pay Rate" value="500000.12" />
             <col header="Pay Rate Display Column" value="888,888" />
 
         </context>
   Invalid Level Choice: Development1 on row 1 column A

     </message>
   </messages>
</response>

Error (sin contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
 <messages>
     <message key="modeled-import-failed">The Personnel import has failed.</message>
     <message key="error-import">Import Failed with the following error: 1 Error(s) Occurred.</message>
     <message key="import-detail">Additional information:</message>
     <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Plan do not exist: Development1.</message>
     <message key="invalid-plan-choice-withCoordinate">Invalid Level Choice: Development1 on row 1 column A</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.	true
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.	invalid-attributevalueid
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		columna
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.	"Account"
valor	Sí	El valor de la columna.	"GL-29482-38233"
Contenido del elemento
(ninguno)

Referencia: condiciones de rendimiento de customReportValues

importCubeData

¿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