exportData

Adaptive Planning

Novedades (Workday 2025R2)

exportData

Categoría	Recuperación de datos
Descripción	Devuelve un conjunto de datos de la versión solicitada en la instancia de solicitud.
Permisos obligatorios para invocar	Ninguna (deben ser credenciales válidas para la instancia)
Parámetros obligatorios bajo petición	Credenciales, versión, formato y filtros

La solicitud de este método contiene los parámetros que se utilizarán para buscar los datos en la versión especificada y devolver valores que coincidan con los filtros y el formato solicitados. Este es el método básico que se utiliza para recuperar datos de Adaptive Planning y puede utilizarse para recuperar valores de cualquier cuenta, incluidas las cuentas estándar, las cuentas de libro mayor, las cuentas modeladas, las cuentas de cubo, las cuentas personalizadas, las cuentas de métrica, los supuestos y los tipos de cambio.

Si exporta una versión de plan, su exportación incluirá datos de cifras reales para cualquier periodo de superposición de cifras reales. Verá las cifras reales o los datos del plan como lo haría en la interfaz de usuario de las hojas.

Los valores de divisiones individuales se agregan cuando se exportan por

exportData.

Para API v16 y posteriores,

exportData

también exporta datos para versiones virtuales.

Consulte customReportValuespara un enfoque más específico de la recuperación de datos.

Consulte Referencia: rendimiento de exportData para obtener información sobre cómo garantizar que sus solicitudes aprovechen las mejoras de rendimiento y escalabilidad publicadas en 2024R1 para API v39.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportData" callerName="a string that identifies your client application" stream="true">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<version name="Budget 2014" isDefault="false"/>
<format useInternalCodes="true" includeUnmappedItems="false" />
<filters>
<accounts>
<account code="A100" isAssumption="true" includeDescendants="false"/>
<account code="L100" isAssumption="false" includeDescendants="true"/>
</accounts>
<levels>
<level name="Development" isRollup="true" includeDescendants="true"/>
<level name="QA" isRollup="false" includeDescendants="false"/>
</levels>
<dimensionValues>
<dimensionValue dimName="Customer" name="A Corp" directChildren="true"/>
<dimensionValue dimName="Region" name="" uncategorized="true" directChildren="false"/>
</dimensionValues>
<timeSpan start="11/2013" end="12/2014"/>
</filters>
<dimensions>
<dimension name="Product"/>
<dimension name="CountryRegion"/>
</dimensions>
<rules includeZeroRows="false" includeRollups="false" markInvalidValues="false" markBlanks="false" timeRollups="single">
<currency useCorporate="false" useLocal="false" override="AUD"/>
</rules>
</call>

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

llamada

credenciales

versión

format

Una solicitud también puede contener uno de los siguientes elementos:

filtros

cuentas > cuenta

niveles > nivel

dimensionValues > dimensionValue

timeSpan

dimensiones > dimensión

reglas > moneda

elemento de llamada
Nombre de etiqueta		llamada
Descripción		Indica a qué método de API se llama mediante su atributo de método.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
método	Sí	El método al que se llama.	exportData
callerName	Sí	Una cadena que identifica su aplicación cliente.	"ejemplo de aplicación cliente de Adaptive Planning"
stream Disponible en API v39+	No	Permite que exportData comience a transmitir datos al cliente en cuanto se procesen. Por defecto, se establece en falso. Tenga en cuenta que activar la transmisión en exportData requiere cambios en el formato de respuesta.	verdadero
Contenido del elemento
Exactamente un elemento de cada uno de estos tipos: credenciales versión format

elemento de credenciales
Nombre de etiqueta		credenciales
Descripción		Todas las llamadas a la API deben contener un único elemento de credenciales 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 realice correctamente. .. El permiso Exportar capacidades en la interfaz de usuario de Planning no afecta a exportData.
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 mes 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 usar 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)

elemento de versión
Nombre de etiqueta		versión
Descripción		Indica qué versión debe utilizarse para recuperar 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, el indicador isDefault debe establecerse como verdadero 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 formato
Nombre de etiqueta		format
Descripción		Indica el tipo de formato que debe utilizarse en los campos individuales de los datos que se devolverán.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
useInternalCodes	Sí	Establezca el valor "verdadero" para que los códigos de cuenta y los códigos de nivel se emitan utilizando los códigos de cada uno introducidos en los administradores de cuenta y nivel. Establezca el valor "false" para que los códigos se asignen en los datos de salida mediante Export Account Mappings o Export Level Mappings que se encuentran en la ficha Exportar.	verdadero
useIds	No	Establezca el valor "verdadero" para que las cuentas, los niveles y las dimensiones de las respuestas se expresen en sus IDs, en lugar de en sus códigos. Además, requerirá que las cuentas, los niveles y las dimensiones de la sección `` se expresen en sus IDs. El valor por defecto es "false" si no está presente en la solicitud.	verdadero
includeUnmappedItems	No	Este atributo solo se aplica si useInternalCodes es falso y se utilizan asignaciones de exportación. Si no se especifica lo contrario, los elementos que no tengan Asignación de exportación en la ficha Exportar no se emitirán en el resultado. Si includeUnmappedItems se establece en "true", se emitirán las cuentas o los niveles que no tengan asignación de exportación, utilizando sus códigos internos (los definidos en Administración de cuentas o niveles) como sus códigos, lo que producirá una combinación de elementos asignados y no asignados en el datos, sino un conjunto completo de datos. Si este indicador se establece en "false", es posible que algunos elementos solicitados no se emitan, si esos elementos no tienen asignación de exportación.	falso
includeCodes	No	Esta opción solo es útil cuando el parámetro Activar nombre de visualización efectivo está activado. Establézcalo como "verdadero" para incluir la columna de código para el nivel en la respuesta de API. Establezca el valor "false" para excluir la columna de código del nivel en la respuesta de API. El valor por defecto es falso.	falso
includeNames Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	Esta opción solo es útil cuando el parámetro Activar nombre de visualización efectivo está activado. Defina "verdadero" para incluir la columna de nombre para el nivel en la respuesta de API. Defina "false" para excluir la columna de nombre del nivel en la respuesta de API. El valor por defecto es falso.	falso
includeDisplayNames Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	Esta opción solo es útil cuando el parámetro Activar nombre de visualización efectivo está activado. Defina "verdadero" para incluir la columna de nombre de visualización para el nivel en la respuesta de API. Defina "false" para excluir la columna de nombre de visualización para el nivel en la respuesta de API. El valor por defecto es falso.	falso
displayNameEnabled Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	displayNameEnabled=true indica que la API exportData requiere el atributo de código en la solicitud para especificar las entidades de nivel y dimensión cuando la opción Activar nombre de visualización está activada para la instancia. displayNameEnabled=false indica que la API exportData sigue el contrato de la API anterior a la v30 aunque el parámetro Activar nombre de visualización esté activado para la instancia. Se utiliza el atributo de nombre en lugar del atributo de código. Para cada nivel y dimensión, los valores de los atributos de nombre y código deben coincidir. El valor por defecto de displayNameEnabled es "false".	falso
Contenido del elemento
(ninguno)

Elemento de filtros
Nombre de etiqueta	filtros
Descripción	Contiene la especificación de los filtros que determinan qué datos de la versión solicitada recupera la API. Este elemento especifica las cuentas, los niveles, los meses y los valores de dimensión que se recuperarán.
Atributos del elemento
(ninguno)
Contenido del elemento
Un solo elemento de cuentas obligatorio, un solo elemento de niveles opcionales, un solo elemento obligatorio de timeSpan y un solo elemento opcional de dimensionValues.

elemento de cuentas
Nombre de etiqueta	cuentas
Descripción	Contenedor para uno o varios elementos de cuenta.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos de cuenta

elemento de cuenta
Nombre de etiqueta		cuenta
Descripción		Especifica una cuenta para exportar sus datos en la llamada a la API exportData. Si se coloca más de un elemento de cuenta en el elemento de cuentas, se exportarán todas las cuentas que coincidan con cualquiera de los elementos de cuenta. Si un elemento de cuenta determinado no da como resultado ninguna cuenta que coincida con él, ese elemento se ignora mientras que los demás elementos siguen aplicándose.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	El código de la cuenta que se va a exportar. Este código es el especificado en Administración de cuentas.	Current_Assets
esAsunción	Sí	Indica si el código especifica una cuenta de supuesto o no de supuesto. Puede usar un solo código tanto para un supuesto como para una cuenta. Utilice este indicador para indicar el tipo de cuenta.	falso
includeDescendants	Sí	Indica si la exportación debe incluir o no a todos los descendientes de la cuenta especificada. Si se establece en verdadero, se exportarán todos los elementos secundarios de esta cuenta, al igual que sus elementos secundarios, etc. Si se establece en falso, esta cuenta se exportará como un solo valor de cuenta de agrupación.	verdadero
Contenido del elemento
(ninguno)

elemento de niveles
Nombre de etiqueta	niveles
Descripción	Contenedor para uno o varios elementos de nivel.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos de nivel Si la solicitud incluye niveles inaccesibles, solo habrá un elemento de nivel, que representa el nivel superior de la organización.

elemento de nivel
Nombre de etiqueta		nivel
Descripción		Especifica un nivel de organización para exportar sus datos en la llamada a la API exportData. Si se coloca más de un elemento de nivel en el elemento de niveles, se exportarán todos los niveles especificados. Si un elemento de nivel determinado no tiene niveles coincidentes en la instancia, ese elemento se ignora mientras se siguen aplicando los demás elementos. Debe filtrar por código en lugar de por nombre cuando cumpla todas las condiciones siguientes: La instancia permite duplicar metadatos activando Nombre de visualización. Llamando API v30 o superior. La propiedad displayNameEnabled el elemento de formato es verdadera.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	Sí El código siempre se excluye mutuamente con el nombre. Cuando se aplican estas dos condiciones, solo debe usar código: El parámetro Activar nombre de visualización está activado. displayNameEnabled="true" en el elemento de formato De lo contrario, no incluya el código.	El código del nivel que se va a exportar. Este código se especifica en Administración de organización. El código solo se admite cuando el parámetro Activar nombre de visualización efectivo está activado.	Desarrollo
nombre	Sí El nombre siempre se excluye mutuamente con el código. Cuando displayNameEnabled="false" en el elemento de formato, solo debe usar el nombre. Este es el valor por defecto si no se especifica.	El nombre del nivel que se va a exportar. Este nombre es el especificado en Administración de organización. El nombre solo se admite para solicitudes de API anteriores a v30 cuando la configuración de activación efectiva de nombre de visualización está desactivada. Dado que la API recupera niveles haciendo coincidir su atributo de código con la cadena de nombre incluida en la solicitud, el atributo de nombre se trata funcionalmente como el atributo de código. Para recuperar correctamente los niveles por nombres, sus atributos de nombre y código deben coincidir.	Desarrollo
isRollup	Sí	Si este nivel tiene elementos secundarios, isRollup="true" generará el valor de agrupación para el nivel (incluidos los valores de todos sus elementos secundarios) e isRollup="false" solo generará el valor sin categorizar para el nivel (los valores introducidos en Editar datos para ese nivel). Si este nivel no tiene elementos secundarios, isRollup debe establecerse como falso (u omitirse por completo de la etiqueta).	falso
includeDescendants	Sí	Indica si la exportación debe incluir o no a todos los descendientes del nivel especificado. Si se establece en verdadero, también se exportarán todos los elementos secundarios de este nivel, al igual que sus elementos secundarios, etc. Si se establece en falso, este nivel se exportará solo. Tenga en cuenta que esto es diferente a isRollup: isRollup afecta al valor que se generará para este nivel, mientras que include Descendants indica si los descendientes también deben incluirse en la exportación. Si tanto isRollup como includeDescendants se establecen en verdadero y el nivel es un nivel principal, el resultado contendrá valores tanto para los niveles agrupados como para los no agrupados (sin categorizar) para este nivel y cada uno de sus descendientes.	verdadero
Contenido del elemento
(ninguno)

timeSpan element
Nombre de etiqueta		timeSpan
Descripción		Indica qué periodos temporales deben devolverse en la respuesta. Los periodos de tiempo entre el rango especificado, inclusive, se incluyen en el resultado como columnas de datos independientes; no se agregan ni agrupan.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
inicio	Sí	El código del primer periodo del rango de periodos en los que se exportarán sus datos. El periodo temporal inicial debe ser un periodo temporal hoja.	01/2015
fin	Sí	El código del último periodo en el rango de periodos en los que se exportarán sus datos. El periodo temporal final debe ser un periodo hoja.	03/2015
stratum	No	El código del estrato temporal para los datos exportados. Cuando se especifica, los periodos iniciales y finales deben estar dentro del estrato temporal. El estrato temporal debe ser igual o superior a la cuenta con el estrato temporal más alto en la solicitud. Consulte lo siguiente: Cambio de los estratos temporales por defecto. Cambio de los estratos temporales por defecto en hojas modeladas y de cubo con datos. Por ejemplo, para indicar un estrato de trimestre es necesario que todas las cuentas tengan el estrato de trimestre, año o superior.	mes
Contenido del elemento
(ninguno)

dimensionValues element
Nombre de etiqueta	dimensionValues
Descripción	Contenedor para uno o varios elementos dimensionValue. Este elemento es opcional y no debería aparecer si no se desea filtrar valores de dimensión.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos dimensionValue.

elemento dimensionValue
Nombre de etiqueta		dimensionValue
Descripción		Indica que los datos exportados solo deben contener valores que coincidan con el valor de dimensionValue especificado. Varios valores de distintas dimensiones en el elemento dimensionValues funcionan como si estuvieran agrupados por sus dimensiones. Se devuelven datos si al menos uno de los valores de dimensiónValues coincide en cada dimensión. En el caso de los valores de dimensión de la misma dimensión, los datos pueden coincidir en cualquier valor de dimensión. Por ejemplo, si una solicitud especifica los valores de dimensión Region=East, Region=West y Product=Product_A, los datos deben coincidir con la Región Este u Oeste, pero también deben coincidir con Product_A Product para que se puedan exportar. Debe filtrar por código en lugar de por nombre cuando cumpla todas las condiciones siguientes: La instancia permite duplicar metadatos activando Nombre de visualización. Llamando API v30 o superior. La propiedad displayNameEnabled del elemento format es verdadera.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
dimName	No	El nombre de la dimensión a la que pertenece el valor de dimensión (consulte el atributo de nombre a continuación).	Región
código Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	El código del valor de dimensión que se va a exportar. El atributo de código solo es significativo cuando el parámetro Activar nombre de visualización efectivo está activado para la instancia.
nombre	No	El nombre del valor de dimensión que se va a exportar. El nombre solo se admite para solicitudes de API anteriores a v30 cuando la configuración de activación efectiva de nombre de visualización está desactivada.	Oeste de EE. UU.
directChildren	No	Si se establece en verdadero, la API exportará datos de agrupación para cada uno de los elementos secundarios directos de este valor de dimensión, pero no una agrupación para el valor en sí. En otras palabras, esto hará que exportData exporte los valores "un nivel por debajo" en el árbol de dimensiones del valor especificado. Si no se especifica, el valor por defecto es falso.	falso
sin categorizar	No	Si se establece en verdadero, coincide con el valor "sin categorizar" del valor de dimensión y no con los valores de ninguno de sus valores descendientes (si los hay). No afecta a los valores de dimensión sin elementos secundarios. Si no se especifica, el valor por defecto es falso.	verdadero
uncategorizedOfDimension	No	Especifique el atributo uncategorizedOfDimension en lugar de los atributos dimName/name. Si se especifica, el valor del atributo debe ser un número de ID de sistema interno de una dimensión (no un valor de dimensión) y el filtro especifica que los datos deben estar completamente sin categorizar en esta dimensión para que coincidan con el filtro. Los atributos directChildren y sin categorizar se ignorarán y se asumirá que son falsos y verdaderos, respectivamente. Se ignora si se especifica dimName.	15
directChildrenOfDimension	No	Especifique los atributos directChildrenOfDimension en lugar de los atributos dimName/name. Si se especifica, el valor del atributo debe ser un número de ID de sistema interno de una dimensión (no un valor de dimensión) y el filtro especifica todos los valores de dimensión de primer nivel de la dimensión. Los atributos directChildren y sin categorizar se ignorarán y se asumirá que son verdaderos y falsos, respectivamente. Ignored if dimName or uncategorizedOfDimension is specified.	12
ID	No	Especifique el ID en lugar de los atributos dimName/name. El número de ID de sistema interno del valor de dimensión que se va a exportar. Debe especificarse en lugar de los atributos dimName/ name para especificar el valor de dimensión. Para determinar los ID internos, consulte la API exportDimensions. Ignored if either dimName, uncategorizedOfDimension or directChildrenOfDimension is specified.	14
Contenido del elemento
(ninguno)

elemento de dimensiones
Nombre de etiqueta	dimensiones
Descripción	Contenedor para uno o varios elementos de dimensión.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos de dimensión.

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Indica que los datos exportados se deben desglosar o segmentar según la dimensión especificada. Tenga en cuenta que esta etiqueta no forma parte de la etiqueta de filtros y no controla el filtrado: en su lugar, controla cuántas filas se exportan para cada combinación de cuenta/nivel. Para cada dimensión especificada en la etiqueta de dimensiones, cada combinación de valores existente se exportará como una fila de datos independiente. Cada dimensión presente en el elemento de dimensiones también hace que aparezca una columna adicional en el resultado, etiquetada con ese nombre de dimensión.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	Nombre de la dimensión por la que se debe dividir la exportación. Las filas de datos de la exportación que la dimensión no puede segmentar aparecerán solo una vez y mostrarán el nombre de la dimensión en la columna donde aparecería el nombre del valor de dimensión para esta dimensión.	Cliente
Contenido del elemento
(ninguno)

elemento de reglas
Nombre de etiqueta		reglas
Descripción		Especifica algunas reglas de salida adicionales que controlan qué tipos de filas se emiten y cómo se representarán algunos valores de campo.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
includeZeroRows	No	Establézcalo como "verdadero" para emitir filas aunque solo contengan ceros o espacios en blanco. Establezca el valor "false" para omitir las filas sin datos de la salida. El valor por defecto es falso. Esta opción no está disponible en la interfaz de usuario de la aplicación para las exportaciones que incluyen dimensiones. Para las llamadas a la API, True se ignora al exportar datos por dimensión. Solo emitirá datos para los valores de dimensión que tengan datos.	verdadero
includeRollups Disponible en API v24 y anteriores. No disponible en API v25+.	No	Si se establece como verdadero, los valores de agrupación de todas las cuentas y niveles de la etiqueta de filtros se incluirán además de los valores de sus descendientes. Este atributo no afecta al comportamiento de las dimensiones personalizadas especificadas en los filtros dimensionValue o en la etiqueta de dimensiones. El valor por defecto es falso. El indicador includeRollups solo se aplica cuando no se aplica ningún filtro explícito a las cuentas o a los niveles. Si se incluyen cuentas individuales en un filtro, debe especificar las cuentas de agrupación individuales si desea que se incluyan.	falso
includeRollupAccounts Disponible en API v25+.	No	Si se establece en verdadero, se incluirán los valores de agrupación de todas las cuentas en la etiqueta de filtros además de los valores de sus descendientes. Este atributo no afecta al comportamiento de las dimensiones personalizadas especificadas en los filtros dimensionValue o en la etiqueta de dimensiones. El valor por defecto es falso.	falso
includeRollupLevels Disponible en API v25+.	No	Si se establece como verdadero, los valores de agrupación de todos los niveles de la etiqueta de filtros se incluirán además de los valores de sus descendientes. Este atributo no afecta al comportamiento de las dimensiones personalizadas especificadas en los filtros dimensionValue o en la etiqueta de dimensiones. El valor por defecto es falso.	falso
markInvalidValues	No	Si se establece en verdadero, la exportación añadirá la letra "I" a los valores no válidos. De lo contrario, añade "=NA()" a los valores no válidos para que sean compatibles con Excel. El valor por defecto es falso.	falso
markBlanks Actualizado en API v24.	No	Si se establece en verdadero, los valores en blanco se mostrarán como "B". De lo contrario, los valores que estén en blanco se mostrarán como ceros. El valor por defecto es falso. Cuando includeZeroRows=false, las filas con una combinación de solo espacios en blanco y ceros no se mostrarán en la respuesta, incluso si markBlanks=true.	falso
timeRollups	No	Tiene tres valores posibles: verdadero, falso y único. Si se establece en verdadero, las agrupaciones de trimestres y años aparecerán en el lugar que les corresponde dentro del marco de meses exportado. Las agrupaciones de trimestre aparecen inmediatamente después del último mes de su trimestre, y las agrupaciones de año aparecen inmediatamente después de la agrupación de trimestre de su último trimestre. Si se establece en único, no se devuelven meses, trimestres ni años individuales y solo se devuelve una única agrupación de periodos de todos los meses cubiertos en el elemento de marco temporal. Si se establece en falso, solo se devuelven meses individuales, sin columnas de agrupación de periodos. El valor por defecto es falso.	falso
Contenido del elemento
Un elemento de moneda opcional para especificar qué moneda debe utilizarse en la exportación.

elemento de moneda
Nombre de etiqueta		moneda
Descripción		Indica qué moneda debe utilizarse en el resultado al emitir los valores de las cuentas de moneda.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
useCorporate	No	Solo se puede definir uno de los tres atributos para un elemento de moneda. Si useCorporate se establece en verdadero, indica que se debe utilizar la "moneda corporativa" (la moneda en la parte superior del árbol de la organización). El valor por defecto es falso.	falso
useLocal	No	Solo se puede definir uno de los tres atributos para un elemento de moneda. Si useLocal se establece en verdadero, indica que los valores de moneda deben emitirse en la moneda del Nivel de organización en el que residen. Cada fila del resultado indica un Nivel de organización, y los valores de moneda de esa fila estarán en la moneda de ese nivel. El valor por defecto es falso.	falso
sustituir	No	Solo se puede definir uno de los tres atributos para un elemento de moneda. Si la sustitución está presente, debe especificar el código de moneda de tres letras de una de las monedas configuradas para la instancia. Cuando se especifica, todos los importes de moneda de la exportación se convertirán a esa moneda.	AUD
Contenido del elemento
(ninguno)

Los siguientes elementos permiten a los usuarios (con los permisos adecuados) solicitar exportaciones para agrupaciones de periodos arbitrarias. Estos elementos requieren solicitudes que utilicen API v40 y superior.

horaelemento
Nombre de etiqueta		time
Descripción		Contiene el XML de calendario que debe utilizarse para asignar periodos al exportar datos. Debe tener un formato simplificado del XML de horas generado en el exportTime API Los periodos incluidos en esta sección deben coincidir con el elemento de marco temporal del filtro. Este elemento SOLO es obligatorio cuando se utiliza el calendario de agrupación arbitrario. Solo disponible en API v40 y superior
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo

Contenido del elemento
(ninguno)

estratoelemento
Nombre de etiqueta		stratum
Descripción		Representa un estrato del calendario. Solo disponible en API v40 y superior
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador exclusivo definido por el usuario para el estrato temporal.	Año
ID	Sí	El identificador entero exclusivo generado por el sistema para el estrato temporal.	7
Contenido del elemento
(ninguno)

periodoelemento
Nombre de etiqueta		periodo
Descripción		Representa un solo periodo de calendario. Solo disponible en API v40 y superior
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador exclusivo definido por el usuario para el periodo.	Q1-2004
stratumId	Sí	El ID del estrato al que pertenece el periodo temporal.	2
timeslot	Sí	La franja horaria del periodo.	16
ID	Sí	El identificador entero exclusivo generado por el sistema para el periodo temporal.	16002
inicio	Sí	La fecha inicial (incluida) del periodo temporal, con el formato AAAA-MM-DD.	2004-01-01
fin	Sí	La fecha final (excluida) del periodo, con el formato AAAA-MM-DD.	2004-01-01
Contenido del elemento
(ninguno)

Ejemplo de solicitud de agrupación de periodos arbitraria
:


<call method="exportData" callerName="test caller api name">
<credentials login="admin@example.com" password="password" locale="en_US" instanceCode="EXAMPLEINST" />
<version name="Budget 2004" isDefault="true" />
<format useInternalCodes="true" includeUnmappedItems="false" useIds="false" />
<rules includeZeroRows="false" includeRollupAccounts="true" includeRollupLevels="false" markInvalidValues="false" markBlanks="false" timeRollups="false">
   <currency useCorporate="false" useLocal="true" />
</rules>
<filters>
   <accounts>
       <account code="70310" isAssumption="false" includeDescendants="true" />
   </accounts>
   <timeSpan start="01/1999" end="06/1999" />
</filters>
<time isCustom="1">
   <stratum code="month" label="Month" shortName="Month" id="1" />
   <period code="01/1999" label="Jan-1999" shortName="Jan" stratumId="1" id="-12001" start="1999-01-01" end="1999-02-01" />
 <period code="02/1999" label="Feb-1999" shortName="Feb" stratumId="1" id="-11001" start="1999-02-01" end="1999-03-01" />
 <period code="03/1999" label="Mar-1999" shortName="Mar" stratumId="1" id="-10001" start="1999-03-01" end="1999-04-01" />
 <period code="04/1999" label="Apr-1999" shortName="Apr" stratumId="1" id="-9001" start="1999-04-01" end="1999-05-01" />
 <period code="05/1999" label="May-1999" shortName="May" stratumId="1" id="-8001" start="1999-05-01" end="1999-06-02" />
 <period code="06/1999" label="Jun-1999" shortName="Jun" stratumId="1" id="-7001" start="1999-06-01" end="1999-07-01" />
</time>
</call>

Formato de respuesta

Formato de respuesta para no-streaming


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
<message key="warning-invalid-timespan-start">Ignoring start of timespan, which precedes start of version; timsepan start: Nov-2009, version start date: Jan-2014</message>
</messages>
<output><![CDATA[
Account Name,Account Code,Level Name,[01/2014,02/2014,03/2014,04/2014,05/2014,06/2014,07/2014,08/2014,09/2014,10/2014,11/2014,12/2014]
"Benefits",30120,"Engineering (Rollup)",10653.75,10653.75,10653.75,11506.05,11506.05,11506.05,11506.05,11506.05,11506.05,10462.05,10426.05,10426.05
"Furniture",70310,"Engineering (Rollup)",1740.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0
...
]]>
</output>
</response>

Formato de respuesta para transmisión


<?xml version="1.0" encoding="UTF-8"?>
<response>
<output>
<![CDATA[Account Name,Account Code,Level Name,Q1-2004,Q2-2004,Q3-2004,Q4-2004,Q1-2005,Q2-2005
"Current Assets","Current_Assets","Engineering",33.0,33.0,33.0,33.0,33.0,33.0
"Other Assets","Other_Assets","Engineering",41.0,41.0,41.0,41.0,41.0,41.0]]>
</output>
<messages>
<message>Exporting data failed. Retry the export. Contact Support if the export continues to fail. </message>
</messages>
<status success="false" rowCountSent="2"/>
</response>

Tenga en cuenta que hay un cambio en la estructura de la respuesta para las solicitudes de transmisión frente a las que no lo son. Por ejemplo, el elemento y el estado del mensaje se producen después de la salida.

elemento de respuesta
Nombre de etiqueta		respuesta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	Verdadero o falso, 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
obsoleto	No	Si está presente en la etiqueta de respuesta y se establece en verdadero, este atributo indica que la versión del método o API que se está invocando ha quedado obsoleta y está oficialmente desaprobada. Aunque sigue funcionando en este momento, es posible que deje de funcionar en un breve periodo de tiempo. Normalmente, este atributo no está presente.	falso
Contenido del elemento
Un único elemento de mensajes opcional y exactamente un elemento de resultado obligatorio.

elemento de mensajes
Nombre de etiqueta	mensajes
Descripción	Contenedor para uno o varios elementos de mensaje.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos 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.

elemento de resultado
Nombre de etiqueta	salida
Descripción	Contiene los datos resultantes de la exportación en un bloque CDATA adjunto.
Atributos del elemento
(ninguno)
Contenido del elemento
Un bloque CDATA que contiene los datos con formato CSV de la exportación. Las filas están separadas por caracteres de nueva línea. La primera fila de datos devueltos es el conjunto de "cabeceras de columna" que describen el formato de cada una de las siguientes filas. Las dimensiones y los elementos de filtrado se enumeran en primer lugar, seguidos de la serie de valores de periodo temporal solicitados. Los códigos de periodo temporal y las etiquetas generadas por el sistema, como el sufijo "(Rollup)" en los niveles de agrupación, se traducen a la configuración regional de la solicitud siempre que sea posible. Los valores se emiten en formato normalizado, sin comas, utilizando un punto como separador decimal.

elemento de estado
Nombre de etiqueta		estado
Descripción		Contiene información de estado para la solicitud y el recuento de filas (SOLO para solicitudes de transmisión)
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	"true" or "false". Informa si la solicitud se ha completado correctamente o no. Incluso las solicitudes correctas pueden contener mensajes de aviso. Esto sustituye al atributo de la respuesta SOLO en las solicitudes de transmisión.	"true"
rowCountSent	Sí	r"\d+". Representa el valor numérico del número de filas de la respuesta.	"10"

¿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