exportVersions

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 creación, actualización y lectura de metadatos y datos

Última actualización: 2024-09-20

exportVersions

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

Esta API solo admite usuarios Concepto: reglas de acceso en API v22 y superior.

Categoría	Metadata retrieval
Descripción	Una vez verificado, el método devuelve un documento XML que describe el conjunto de todas las versiones definidas en la instancia que no están ocultas para el usuario solicitante.
Permisos obligatorios para invocar	Ninguna (deben ser credenciales válidas para la instancia)
Parámetros obligatorios bajo petición	Credenciales

La solicitud de este método solo contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. Una vez verificado, el método devuelve un documento XML que describe el conjunto de todas las versiones definidas en la instancia que no están ocultas para el usuario solicitante.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportVersions" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</call>

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

incluir elemento
Nombre de etiqueta		incluir
Descripción		Representa un conjunto de indicadores que indican qué aspectos de la información de la versión deben incluirse o excluirse de la respuesta. Este elemento es opcional: si no está presente, la API devolverá toda la información de la versión.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
rootActuals No admitido en ninguna versión de API a partir de 2019.3	No	Indica si la versión raíz de cifras reales debe incluirse cuando las cifras reales están ocultas en el selector de versión.	falso
situaciones hipotéticas	No	Indica si se deben incluir situaciones hipotéticas privadas en la respuesta.	falso
CurrencyVersions Disponible en API v40+	No	Indica si las versiones de moneda de las cifras reales convertidas deben incluirse en la respuesta. Debe ponerse en contacto con su contacto de asistencia designado para ver si su instancia es elegible para esta función.	falso
Contenido del elemento
(ninguno)

Formato de respuesta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<versions seqNo="32">
  <version id="1" name="Actuals" shortName="" type="ACTUALS" isVirtual="false" description="Total Actuals" isDefaultVersion="false"
           isLocked="false" hasAuditTrail="false" isImportable="0"
           startVer="2012" completedValuesThru="03/2012"
           startScroll="01/2012" endVer="2016" lockLeading="" >
    <version id="5" name="Adjusted Actuals" shortName="SV-13" type="ACTUALS" isVirtual="false" description="Actuals SubVersion" isDefaultVersion="false"
             isLocked="false" hasAuditTrail="false" isImportable="0" >
      <version id="6" name="Original Import" shortName="SSV-13" type="ACTUALS" isVirtual="false" description="Values Imported from the GL" isDefaultVersion="false"
               isLocked="false" hasAuditTrail="false" isImportable="1" />
      <version id="8" name="Manual Adjustments" shortName="SSV-14" type="ACTUALS" isVirtual="false" description="Actuals Sub-Version for Manual Adjustments" isDefaultVersion="false"
               isLocked="false" hasAuditTrail="true" isImportable="1" />
    </version>
    <version id="9" name="Eliminations" shortName="ELIM" type="ACTUALS" isVirtual="false" description="Eliminating entries" isDefaultVersion="false"
             isLocked="false" hasAuditTrail="false" isImportable="0" />
  </version>
  <version id="2" name="Budget 2013" shortName="" type="PLANNING" isVirtual="false" description="This is the budget for 2013 with a five-year span." isDefaultVersion="true"
           isLocked="false" hasAuditTrail="true" isImportable="1"
           leftScroll="2013" startPlan="01/2013" endPlan="2017" lockLeading="05/2013" />
    <version id="10" name="Worst Case" shortName="S13-A-WC" type="SCENARIO" isVirtual="false" description="Worst Case for Budget 2013" isDefaultVersion="false" isLocked="false"
             hasAuditTrail="false" isImportable="0" isPredictive="false" />
  </version>
 <version id="3" name="Budget 2014" shortName="B-14" type="PLANNING" isVirtual="false" description="This is the budget for 2014 with a five-year span." isDefaultVersion="false"
           isLocked="false" hasAuditTrail="false" isImportable="1"
           leftScroll="2014" startPlan="01/2014" endPlan="2018" lockLeading="" />
</versions>
</output>
</response>

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 de la API que se está invocando ha quedado obsoleta y está obsoleta. 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 resultado
Nombre de etiqueta	salida
Atributos del elemento
(ninguno)
Contenido del elemento
Un solo elemento de cuentas Este contenedor de salida es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta.

elemento de versiones
Nombre de etiqueta		versiones
Descripción		Contenedor para uno o varios elementos de versión.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
seqNo Añadido en API v17, pero reservado para uso futuro.
Contenido del elemento
Uno o varios elementos de versión.

elemento de versión
Nombre de etiqueta		versión
Descripción		Representa una única versión que se devuelve en la respuesta a una llamada a la API exportVersions.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno para la versión o carpeta. Todos los ID son exclusivos entre todas las versiones, subversiones y carpetas.	2
nombre	Sí	El nombre de la versión o carpeta, tal como aparece en Administración de versiones.	Presupuesto 2015
shortName	No	Un nombre corto para la versión, si lo hay, tal como se ha introducido en Administración de versiones	B2015
tipo Actualizado en API v37.	Sí	Uno de los siguientes valores: ACTUALS = Versión o subversión de cifras reales estándar JOURNAL_ENTRY = Subversión de cifras reales de asiento PLANNING = Versión de plan VERSION_FOLDER = Carpeta SCENARIO = Una situación hipotética personal	CIFRAS REALES
isVirtual Disponible en API v16+	Sí	true o false para indicar si se trata de una versión virtual	falso
descripción	Sí	La descripción de la versión o carpeta, tal como aparece en Administración de versiones.	Este es el presupuesto para 2015 con un marco de cinco años.
isDefaultVersion	Sí	Indica si la versión es la versión por defecto. Verdadero si la versión es la versión por defecto; de lo contrario, falso.	verdadero
isLocked	No	Indica si la versión se ha "bloqueado globalmente" (tiene marcada la casilla Versión bloqueada). Si no está presente, la versión no se considera bloqueada. Siempre será "falso" para las versiones de cifras reales o para las carpetas.	verdadero
hasAuditTrail	Sí	Indica si la versión tiene Traza de auditoría activada.	verdadero
enabledForWorkflow Disponible en API v17+	No	Indica si la versión está activada para el flujo de trabajo.	1
isImportable	No	Indica si el usuario que solicita esta API puede importar datos a la versión. 0 significa que la versión no puede aceptar importaciones y 1 significa que sí. Una versión se puede importar si al menos un intervalo de tiempo de la versión especificada se puede importar para este usuario.	1
startVer	No	El código del periodo temporal raíz en el que comienza la versión. Equivale al inicio de la versión en la página de administración de versiones. Este atributo solo se muestra para la versión raíz de cifras reales. Este atributo es obligatorio para la versión raíz de cifras reales.	2015
endVer	No	El código del periodo temporal raíz en el que finaliza la versión. Equivale al final de la versión en la página de administración de versiones. Este atributo solo se muestra para la versión raíz de cifras reales. Este atributo es obligatorio para la versión raíz de cifras reales.	2015
startScroll	No	El código del periodo temporal de hoja en el que comienza la planificación. Equivalente a la ubicación de desplazamiento inicial en la página de administración de versiones. Este atributo solo se muestra para la versión raíz de cifras reales. Este atributo es obligatorio para la versión raíz de cifras reales.	01/2015
completedValuesThru	No	El código del último periodo temporal en el que se han rellenado las cifras reales raíz. En un calendario estándar, sería un mes. Equivalente a los valores finalizados en la página de administración de versiones. Este atributo solo se muestra para la versión raíz de cifras reales. Este atributo es opcional para la versión raíz de cifras reales.	03/2015
desplazamiento a la izquierda	No	El código del periodo temporal raíz en el que comienza la versión. Equivale al límite de desplazamiento a la izquierda en la página de administración de versiones. Este atributo solo se muestra para las versiones de planificación. Este atributo es obligatorio para las versiones de planificación.	2015
startPlan	No	El código del periodo temporal de hoja en el que comienza la planificación. Equivalente al inicio de plan en la página de administración de versiones. Este atributo solo se muestra para las versiones de planificación y es obligatorio para las versiones de planificación.	02/2015
endPlan	No	El código del periodo temporal raíz en el que finaliza la versión. Equivalente al final del plan en la página de administración de versiones. Este atributo solo se muestra para las versiones de planificación. Este atributo es obligatorio para las versiones de planificación.	2015
lockLeading	No	El código del periodo temporal hasta el que se bloquean los valores de versión. Equivale a bloquear los meses anteriores hasta en la página de administración de versiones. Este atributo solo se muestra para la versión raíz de cifras reales y las versiones de planificación. Este atributo es opcional para la versión raíz de cifras reales y las versiones de planificación.	05/2015
isPredictive Disponible en API v28 +	Sí	Indica si la versión es una versión predictiva.	falso
Contenido del elemento
Un elemento de versión anidado para cada versión secundaria directa de esta versión.

exportUsers

importDimensionMapping

¿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