importStandardData

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

importStandardData

Actualizado en API v40 (13 de septiembre de 2024)

Categoría	Envío de datos
Descripción	Inserta o sustituye datos en cuentas estándar.
Permisos obligatorios para invocar	Importar a todas las ubicaciones Borrar datos (API v36+ para admitir el modo REPLACE)
Parámetros obligatorios bajo petición	Credentials, ImportDataOptions, Version, RowData

includeDescendants

La solicitud de este método contiene los parámetros que se utilizarán para determinar qué versión recibirá las filas de datos proporcionadas. Los datos se pueden importar a cualquier cuenta estándar (cuenta de libro mayor, cuenta personalizada, supuesto o tipo de cambio) independientemente de si la cuenta se ha colocado en una hoja.

importStandardData no puede importar a cuentas que utilicen Entrada de datos
para configuración de fórmula de sustitución
.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="importStandardData" 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" />
<version name="Budget 2004" isDefault="false" />
<rowData>
<header>Account|Level|Split Label|Product|Region|11/2005|01/2006</header>
<rows>
<row>70110|Corporate Plan||Bunnyrabbit Toy|Western-US|2037|4032</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

rowData

cabecera

filas

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.

Para API v36+, si el atributo de modo importDataOptions es REPLACE, también se debe especificar un elemento de ámbito:

Ejemplo: solicitud de modo de sustitución

Solo disponible en API v36+


<?xml version='1.0' encoding='UTF-8'?>
<call method="importStandardData" callerName="a string that identifies your client application">
<credentials login="nobody@company.com" password="password" instanceCode="INSTANCE1"/>
<importDataOptions planOrActuals="Plan" allowParallel="true" moveBPtr="false" useMappings="false" mode="replace" />
<version name="Budget 2011" isDefault="false" />
<scope>
<accounts mode="explicit">
<account includeDescendants="false">30490</account>
<account includeDescendants="false">70313</account>
</accounts>
<levels mode="explicit">
<level includeDescendants="false">Development</level>
<level includeDescendants="true">Sales</level>
</levels>
<time mode="input" />
</scope>
<rowData>
<header>Account|Level|Split Label|Base Pay|CapitalAssetClass|Company|CountryRegion|01/2011</header>
<rows>
<row>30490|Asia Sales||120-150K|Furniture|ABC Cons|Washington|1</row>
<row>70313|Development||100-120K|OtherEquipment|ABC Cons|Maharashtra|2</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 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í

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

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

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

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.

displayNameEnabled=true indica que se debe esperar importStandardData

Account Code

Level Code

Dimension Code

Dimension Name Column

en la carga útil cuando Activar nombre de visualización está activado para la instancia.

displayNameEnabled=false indica que la API importStandardData 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 importStandardData ignora las propiedades de nombre de visualización

Account Code

Level Code

Dimension Code

Dimension Name Column

El valor por defecto de displayNameEnabled es "false".

falso

splitsToUnsplit

Solo disponible en API v40+

splitsToUnsplit=true permiten importar divisiones a la ubicación de anulación de división con datos existentes. El valor por defecto de este atributo es falso.

falso

modo

Solo disponible en API v36+

Especifica el modo de importación, que es APPEND o REPLACE.

Anexar	Se actualizan los hechos existentes o se añaden nuevos hechos. No se eliminará ningún hecho.
Sustituir	La solicitud debe incluir un elemento de ámbito que represente las coordenadas del hipercubo en el que los datos se sustituirán por los proporcionados en la carga útil. Se eliminarán todos los datos existentes dentro del ámbito que no tengan una coordenada coincidente en la carga útil.

Este atributo de modo es compatible con API v36 y versiones posteriores. Llamar a una versión anterior de la API con mode="REPLACE" es un error.

El valor por defecto de modo cuando no se especifica es APPEND.

ANEXO

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 como verdadero en este elemento. Para obtener una lista de las versiones de moneda convertidas y sus nombres, realice una solicitudexportVersions con currencyVersions=true en el elemento de inclusión.	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 ámbito
Nombre de etiqueta		ámbito Solo disponible en la versión API 36+
Descripción		Especifica el ámbito de esta importación. Solo se permite cuando el atributo de modo del elemento importDataOptions es REPLACE.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
eraseCellNotes	No	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 tiempo , un elemento de cuentas y un elemento de niveles son obligatorios.

elemento de cuentas
Nombre de etiqueta		cuentas Solo disponible en la versión API 36+
Descripción		Especifica las cuentas para el ámbito de importación. Si existe una cuenta especificada, 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. Solo se permite cuando el atributo de modo del elemento importDataOptions es REPLACE.
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. Nota: no se permite el modo de cuentas="ALL" para el ámbito de importación estándar.	EXPLÍCITO
Contenido del elemento
Si el modo es INPUT , no debe haber ningún subelemento <account>. Si el modo es EXPLICIT , debe haber uno o más subelementos <account>. Si el modo es EXPLICIT y algún código de cuenta de un subelemento <account> no es válido, todo el elemento <accounts> y, por extensión, el <scope>, se considerarán no válidos. Se incluirá un mensaje de error en la respuesta por cada código no válido.

elemento de cuenta
Nombre de etiqueta		cuenta Solo disponible en la versión API 36+
Descripción		Especifica el código de cuenta que se incluirá en el ámbito de la importación. Solo se permite cuando el atributo de modo del elemento importDataOptions es REPLACE.
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. Es un error si la cuenta es una cuenta principal e includeDescendants es falso. Solo podemos importar a cuentas hoja. Este es un atributo opcional y el valor por defecto se considerará falso.	true
selector	No	Especifica el tipo de contenido del elemento de cuenta: Código. El contenido del elemento de cuenta es un código de cuenta. Ejemplo: <account selector="code">30440</account> En este ejemplo, 30440 es un código de cuenta. Tipo El contenido del elemento de cuenta es un tipo de cuenta. Ejemplo: <account selector="type">GL</account> En este ejemplo, el tipo de elemento de cuenta es todas las cuentas de libro mayor. Actualmente, solo admitimos "Libro mayor" y "CUSTOM" para el tipo de cuenta en las importaciones estándar. El resto del contenido da como resultado un error. El valor por defecto del selector es el código.
Contenido del elemento
El código de cuenta que distingue entre mayúsculas y minúsculas de la cuenta utilizada como parte del ámbito de importación. Por ejemplo, Cuentas por pagar. El código no debe estar en blanco y debe existir la cuenta correspondiente al código. La cuenta no puede ser una cuenta de sistema ni vinculada. Si la cuenta es una cuenta calculada, debe haber una sustitución de entrada de datos para esa cuenta; de lo contrario, se considerará no válida. Si un código de cuenta no es válido, todo el elemento <accounts> y, por extensión, el <scope>, se consideran no válidos.

elemento de niveles
Nombre de etiqueta		niveles Solo disponible en la versión API 36+
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. Solo se permite cuando el atributo de modo del elemento importDataOptions es REPLACE.
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. EXPLICIT : si se especifica este modo, esperamos ver uno o más subelementos <level> que determinarían 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.	EXPLÍCITO
Contenido del elemento
Si el modo es INPUT o ALL, no debe haber ningún subelemento <level>. Si el modo es EXPLÍCITO, debe haber uno o más subelementos <level>. Si el modo es EXPLÍCITO, y si algún código de nivel en un subelemento <level> no es válido, todo el elemento <levels> y, por extensión, el <scope>, se considerarán no válidos. Se incluirá un mensaje de error en la respuesta por cada código no válido.

elemento de nivel
Nombre de etiqueta		nivel Solo disponible en la versión API 36+
Descripción		Especifica el código de nivel que se incluirá en el ámbito de la importación. Solo se permite cuando el atributo de modo del elemento importDataOptions es REPLACE.
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 incluirán en el ámbito a menos que otros elementos de nivel lo especifiquen explícitamente.	true
Contenido del elemento
Especifica el código que distingue entre mayúsculas y minúsculas del nivel. Por ejemplo, <level>Desarrollo</level>. Si hay un problema con el código de nivel, por ejemplo, un nivel en el que no se encuentra el código, los <levels> completos y, por extensión, el <scope> se consideran no válidos. Se incluirá un mensaje de error en la respuesta por cada código no válido.

elemento de periodo
Nombre de etiqueta		time Solo disponible en la versión API 36+
Descripción		Especifica uno o varios rangos de tiempo que representan el ámbito temporal de la importación. Solo se permite cuando el atributo de modo del elemento importDataOptions es REPLACE.
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 <header> elemento 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 el modo es INPUT o VERSION, no se permite ningún subelemento timeRange. Si hay subelementos timeRange, se tratará como un error.	INPUT
Contenido del elemento
Uno o varios elementos timeRange, a menos que el modo sea INPUT o VERSION.

timeRange element
Nombre de etiqueta		timeRange Solo disponible en la versión API 36+
Descripción		Especifica un solo rango temporal para el ámbito temporal. Solo se permite cuando el atributo de modo del elemento importDataOptions es REPLACE.
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
Uno o varios elementos timeRange, a menos que el modo sea INPUT o VERSION.

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 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 cuenta estándar.

Ejemplo de éxito


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

Error (con contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
<messages>
<message key="error-empty-account">
    <context>
        <col header="Account" value="" />
        <col header="Level" value="Corporate Plan" />
        <col header="Split Label" value="" />
        <col header="Product" value="Bunnyrabbit Toy" />
        <col header="Region" value="Western-US" />
        <col header="11/2005" value="2037" />
        <col header="01/2006" value="4032" />

    </context>
Account cannot be empty on row 1.

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

Error (sin contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
<messages>
<message key="error-empty-account">Account cannot be empty on row 1.</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)

importCubeData

importTransactions

¿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