exportTime

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: 2023-06-23

exportTime

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

Categoría	Metadata retrieval
Descripción	Devuelve metadatos de tiempo para una versión específica o para todas las versiones si no se especifica ninguna.
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 contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama y una etiqueta de versión opcional para especificar la versión para la que se va a recuperar la información. Si no se especifica ninguna versión, el método devuelve información de horas para el rango de horas que abarca las horas de inicio y finalización de todas las versiones. Una vez verificada la persona que llama, el método devuelve un documento XML que describe el conjunto completo de información de horas para la versión en forma de árbol anidado.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportTime" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" locale="fr_FR" instanceCode="INSTANCE1"/>
<options includeAllLocales="1" includeLegacyInformation="1" />
</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)

Elemento de opciones
Nombre de etiqueta		Opciones
Descripción		Especifica las opciones que se utilizarán al exportar periodos.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
includeAllLocales	No	Opcionalmente, haga que la exportación de tiempo exporte todas las conversiones para cada estrato/periodo temporal. Si no se especifica, solo se exporta la configuración regional especificada en el bloque de credenciales.	"1"
includeLegacyInformation	No	Opcionalmente, haga que la exportación de horas exporte atributos adicionales que contengan información de horas heredada. Estos atributos adicionales no se incluirán si isCustom = 1	"1"
leafStratumId Compatible con API v16 +	No	Opcionalmente, proporcione el ID de un estrato temporal para tratarlo como hoja. Los estratos temporales que sean más precisos que el estrato temporal dado no se incluirán en la respuesta, ni tampoco los periodos que pertenezcan a estratos temporales que sean más precisos que el estrato temporal dado.	"5"
calendarId Compatible con API v33 +	No	Opcionalmente, proporcione el ID del calendario/jerarquía que se va a recuperar. Si no se especifica, la API solo devolverá valores de tiempo en la jerarquía por defecto.	"1"
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. El usuario debe poder acceder a la versión especificada y no puede ser una carpeta. No es obligatorio incluir un elemento de versión, pero si se incluye, la versión especificada debe ser válida.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
opción actualizado en API v18	No	Establece el rango de tiempo que se va a exportar. Puede definirse como "todo", "único" u omitirse. El valor por defecto es "único". Si es soltero, el usuario también debe especificar "name" o "id". Devuelve el rango temporal de la versión única especificada y el saldo inicial de esa versión. Si se especifican tanto el nombre como el ID, deben hacer referencia a la misma versión. En caso afirmativo, devuelva el rango temporal de mínimo a máximo de todas las versiones, incluido el periodo de saldo inicial para el primer estrato en el rango temporal mínimo-máximo. Si es todo, no debe especificar la versión "name" o "id". Si se omite, devuelve todo el tiempo definido. Al especificar una sola versión, la llamada solo se realizará correctamente si el usuario tiene acceso a la versión.	soltero
nombre	No	El nombre de la versión que se utilizará para recuperar los datos. Solo se puede acceder a una versión en una sola llamada a la API. Si no se proporciona un nombre, debe incluirse un ID. Si se proporcionan ambos, deben corresponder a la misma versión.	Presupuesto 2014
ID	No	El ID de la versión que se utilizará para recuperar los datos. Solo se puede acceder a una versión en una sola llamada a la API. Si la opción es "single" y no se proporciona un ID, debe proporcionarse un nombre. Si se proporcionan ambos, deben corresponder a la misma versión.	3
Contenido del elemento
(ninguno)

Formato de respuesta (con includeAllLocales="0" o sin especificar)


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
  <output>
    <time isCustom="1" seqNo="24">
      <stratum code="year" label="Year" shortName="Yr" id="3" inUse="1">
        <stratum code="qtr" label="Quarter" shortName="Qtr" id="2" inUse="1">
          <stratum code="month" label="Month" shortName="Mon" id="1" inUse="1" isDefault="1" />
        </stratum>
      </stratum>
      <period code="2015" label="FY2015" shortName="FY2015" stratumId="3" timeslot="15" encodedTimePeriod="3::15" id="15003" end="2016-01-01">
        <period code="Q1-2015" label="Q1-FY15" shortName="Q1-FY15" stratumId="2" timeslot="60" encodedTimePeriod="2::60" id="60002" end="2015-04-01">
          <period code="01/2015" label="Jan-2015" shortName="Jan-2015" stratumId="1"timeslot="180" encodedTimePeriod="1::180" id="180001" end="2015-02-01" />
          <period code="02/2015" label="Feb-2015" shortName="Feb-2015" stratumId="1" timeslot="181" encodedTimePeriod="1::181" id="181001" end="2015-03-01" />
          <period code="03/2015" label="Mar-2015" shortName="Mar-2015" stratumId="1" timeslot="182" encodedTimePeriod="1::182" id="182001" end="2015-04-01" />
        </period>
        <period code="Q2-2015" label="Q2-FY15" shortName="Q2-FY15" stratumId="2" timeslot="61" encodedTimePeriod="2::61" id="61002" end="2015-07-01">
          <period code="04/2015" label="Apr-2015" shortName="Apr-2015" stratumId="1" timeslot="183" encodedTimePeriod="1::183" id="183001" end="2015-05-01" />
          <period code="05/2015" label="May-2015" shortName="May-2015" stratumId="1" timeslot="184" encodedTimePeriod="1::184" id="184001" end="2015-06-01" />
          <period code="06/2015" label="Jun-2015" shortName="Jun-2015" stratumId="1" timeslot="185" encodedTimePeriod="1::185" id="185001" end="2015-07-01" />
        </period>
        <period code="Q3-2015" label="Q3-FY15" shortName="Q3-FY15" stratumId="2" timeslot="62" encodedTimePeriod="2::62" id="62002" end="2015-10-01">
          <period code="07/2015" label="Jul-2015" shortName="Jul-2015" stratumId="1" timeslot="186" encodedTimePeriod="1::186" id="186001" end="2015-08-01" />
          <period code="08/2015" label="Aug-2015" shortName="Aug-2015" stratumId="1" timeslot="187" encodedTimePeriod="1::187" id="187001" end="2015-09-01" />
          <period code="09/2015" label="Sep-2015" shortName="Sep-2015" stratumId="1" timeslot="188" encodedTimePeriod=""1::188" id="188001" end="2015-10-01" />
        </period>
        <period code="Q4-2015" label="Q4-FY15" shortName="Q4-FY15" stratumId="2" timeslot="63" encodedTimePeriod="2::63" id="63002" end="2016-01-01">
          <period code="10/2015" label="Oct-2015" shortName="Oct-2015" stratumId="1" timeslot="189" encodedTimePeriod="1::189" id="189001" end="2015-11-01" />
          <period code="11/2015" label="Nov-2015" shortName="Nov-2015" stratumId="1" timeslot="190" encodedTimePeriod="1::190" id="190001" end="2015-12-01" />
          <period code="12/2015" label="Dec-2015" shortName="Dec-2015" stratumId="1" timeslot="191" encodedTimePeriod="1::191" id="191001" end="2016-01-01" />
        </period>
      </period>
      <period code="2016" label="FY2016" shortName="FY2016" stratumId="3" timeslot="16" encodedTimePeriod="3::16" id="16003" end="2017-01-01">
        <period code="Q1-2016" label="Q1-FY16" shortName="Q1-FY16" stratumId="2" timeslot="64" encodedTimePeriod="2::64" id="64002" end="2016-04-01">
          <period code="01/2016" label="Jan-2016" shortName="Jan-2016" stratumId="1" timeslot="192" encodedTimePeriod="1::192" id="192001" end="2016-02-01" />
          <period code="02/2016" label="Feb-2016" shortName="Feb-2016" stratumId="1" timeslot="193" encodedTimePeriod="1::193" id="193001" end="2016-03-01" />
          <period code="03/2016" label="Mar-2016" shortName="Mar-2016" stratumId="1" timeslot="194" encodedTimePeriod="1::194" id="194001" end="2016-04-01" />
        </period>
        <period code="Q2-2016" label="Q2-FY16" shortName="Q2-FY16" stratumId="2" timeslot="65" encodedTimePeriod="2::65" id="65002" end="2016-07-01">
          <period code="04/2016" label="Apr-2016" shortName="Apr-2016" stratumId="1" timeslot="195" encodedTimePeriod="1::195" id="195001" end="2016-05-01" />
          <period code="05/2016" label="May-2016" shortName="May-2016" stratumId="1" timeslot="196" encodedTimePeriod="1::196" id="196001" end="2016-06-01" />
          <period code="06/2016" label="Jun-2016" shortName="Jun-2016" stratumId="1" timeslot="197" encodedTimePeriod="1::197" id="197001" end="2016-07-01" />
        </period>
        <period code="Q3-2016" label="Q3-FY16" shortName="Q3-FY16" stratumId="2" timeslot="66" encodedTimePeriod="2::66" id="66002" end="2016-10-01">
          <period code="07/2016" label="Jul-2016" shortName="Jul-2016" stratumId="1" timeslot="198" encodedTimePeriod="1::198" id="198001" end="2016-08-01" />
          <period code="08/2016" label="Aug-2016" shortName="Aug-2016" stratumId="1" timeslot="199" encodedTimePeriod="1::199" id="199001" end="2016-09-01" />
          <period code="09/2016" label="Sep-2016" shortName="Sep-2016" stratumId="1" timeslot="200" encodedTimePeriod="1::200" id="200001" end="2016-10-01" />
        </period>
        <period code="Q4-2016" label="Q4-FY16" shortName="Q4-FY16" stratumId="2" timeslot="67" encodedTimePeriod="2::67" id="67002" end="2017-01-01">
          <period code="10/2016" label="Oct-2016" shortName="Oct-2016" stratumId="1" timeslot="201" encodedTimePeriod="1::201" id="201001" end="2016-11-01" />
          <period code="11/2016" label="Nov-2016" shortName="Nov-2016" stratumId="1" timeslot="202" encodedTimePeriod="1::202" id="202001" end="2016-12-01" />
          <period code="12/2016" label="Dec-2016" shortName="Dec-2016" stratumId="1" timeslot="203" encodedTimePeriod="2::203" id="203001" end="2017-01-01" />
        </period>
      </period>
    </time>
  </output>
</response>

Formato de respuesta parcial (con includeAllLocales="1")

Normalmente hay un bloque de configuraciones regionales para cada periodo y estrato. A continuación, solo se muestra la sección de estrato. El formato de las configuraciones regionales/el bloque de configuración regional para los periodos temporales es idéntico.


          <stratum code="year" label="Year" shortName="Year" id="3">
            <locales>
                <locale locale="en" label="Year" shortName="Year" />
                <locale locale="de" label="Jahr" shortName="Jahr" />
                <locale locale="fr" label="Anne" shortName="Anne" />
                <locale locale="es" label="Ao" shortName="Ao" />
                <locale locale="pt" label="Ano" shortName="Ano" />
                <locale locale="nl" label="Jaar" shortName="Jaar" />
                <locale locale="ja" label="年" shortName="年" />
            </locales>
            <stratum code="qtr" label="Quarter" shortName="Quarter" id="2">
                <locales>
                    <locale locale="en" label="Quarter" shortName="Quarter" />
                    <locale locale="de" label="Quartal" shortName="Quartal" />
                    <locale locale="fr" label="Trimestre" shortName="Trimestre" />
                    <locale locale="es" label="Trimestre" shortName="Trimestre" />
                    <locale locale="pt" label="Trimestre" shortName="Trimestre" />
                    <locale locale="nl" label="Kwartaal" shortName="Kwartaal" />
                    <locale locale="ja" label="四半期" shortName="四半期" />
                </locales>
                <stratum code="month" label="Month" shortName="Month" id="1" isDefault="1">
                    <locales>
                        <locale locale="en" label="Month" shortName="Month" />
                        <locale locale="de" label="Monat" shortName="Monat" />
                        <locale locale="fr" label="Mois" shortName="Mois" />
                        <locale locale="es" label="Mes" shortName="Mes" />
                        <locale locale="pt" label="Ms" shortName="Ms" />
                        <locale locale="nl" label="Maand" shortName="Maand" />
                        <locale locale="ja" label="月" shortName="月" />
                    </locales>
                </stratum>
            </stratum>
        </stratum>

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
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(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.	ID de valor de atributo no válido
Contenido del elemento
El texto del mensaje. Este texto está en el idioma de la configuración regional especificada en la solicitud (suponiendo que la configuración regional sea compatible). El texto también puede contener información variable, como el número de filas que se han procesado o la columna o el valor concretos que han provocado el error.

elemento de resultado
Nombre de etiqueta	salida
Atributos del elemento
(ninguno)
Contenido del elemento
Un único elemento de periodo obligatorio. 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 periodo
Nombre de etiqueta		time
Descripción		Contenedor para un elemento de estrato raíz, cero o un elemento de saldo inicial y uno o varios elementos de periodo de estrato raíz.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
isCustom	Sí	1 o 0, lo que indica si el calendario de esta instancia se ha personalizado o no.	1
q1FirstMonth	No	El mes en el que comienza el ejercicio contable (a partir de 0). Este atributo solo aparece si includeLegacyInformation era 1 en la solicitud y si isCustom es 0.	8
lastMonthIsFY	No	Indica si el ejercicio contable es equivalente al año natural en el que finaliza el ejercicio contable. Este atributo solo aparece includeLegacyInformation era 1 en la solicitud y si isCustom es 0.	0
seqNo Añadido en API v17, pero reservado para uso futuro.
Contenido del elemento
Exactamente un elemento de estrato, cero o un elemento de saldo inicial y uno o varios elementos de periodo de estrato raíz.

elemento de estrato
Nombre de etiqueta		estrato
Descripción		Representa un estrato del calendario que se devuelve desde la llamada a la API exportTime.
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
etiqueta	Sí	Un identificador de texto no exclusivo definido por el usuario para el estrato temporal.	Ejercicio contable
shortName	Sí	Un identificador de texto no exclusivo definido por el usuario que se utiliza cuando se desea un nombre más corto. Si no se define un nombre corto, la etiqueta se mostrará aquí.	Año
ID	Sí	El identificador entero exclusivo generado por el sistema para el estrato temporal.	7
en uso Compatible con API v16 +	No	Marca que indica si una hoja de cubo o una hoja modelada están asociadas al estrato temporal, o si este es el estrato temporal por defecto.	1
isDefault Compatible con API v16 +	No	Marca que indica si el estrato temporal es el estrato por defecto o no.	1
Contenido del elemento
Cero o un elemento de configuración regional. Solo se incluye si se establece includeAllLocales. Cero o un elemento de estrato. Cada estrato, excepto la hoja, tiene exactamente un elemento de estrato. El elemento de estrato hoja no contiene elementos de estrato.

elemento de saldo inicial
Nombre de etiqueta		saldo-inicial
Descripción		Representa el último periodo temporal anterior al inicio de la versión que se devuelve en la respuesta a una llamada a la API exportTime. Solo se incluye si se solicita una y solo una versión.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	El identificador exclusivo definido por el usuario para el periodo temporal de saldo inicial.	12/2003
etiqueta	Sí	El identificador de texto no exclusivo definido por el usuario para el periodo temporal de saldo inicial.	Dec-2003
nombre corto	Sí	El identificador de texto corto definido por el usuario y no exclusivo para el periodo temporal de saldo inicial. Si no se ha definido ningún nombre corto, se muestra la etiqueta.	Dic
stratumId	Sí	El ID del estrato al que pertenece el saldo inicial.	1
franja horaria	Sí	La franja horaria del periodo al que pertenece el saldo inicial.	47
encodedTimePeriod	Sí	Los datos codificados para el periodo temporal, con el formato strutumId::timeslot.	1::47
ID	Sí	El identificador entero exclusivo generado por el sistema para el periodo temporal de saldo inicial.	47001
inicio	Sí	La fecha inicial (incluida) del saldo inicial, con el formato AAAA-MM-DD.	2003-12-01
fin	Sí	La fecha final (excluida) del saldo inicial, con el formato AAAA-MM-DD.	2004-01-01
legacyReportTimeId	No	El ID de informe que se habría mostrado para este periodo en versiones anteriores de esta API. Este atributo solo aparece includeLegacyInformation era 1 en la solicitud y si isCustom es 0.	200312
legacySheetTimeId	No	El ID de horas de hoja que se habría utilizado para este periodo en versiones anteriores de esta API. Este atributo solo aparece includeLegacyInformation era 1 en la solicitud y si isCustom es 0.	48, Q63 o Y72
Contenido del elemento
Cero o un elemento `de configuración regional` .

Elemento de periodo
Nombre de etiqueta		periodo
Descripción		Representa un solo periodo de calendario que se devuelve desde la llamada a la API exportTime.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador exclusivo definido por el usuario para el periodo.	Q1-2004
etiqueta	Sí	Un identificador de texto no exclusivo definido por el usuario para el periodo.	Q1-FY04
shortName	Sí	Un identificador de texto no exclusivo definido por el usuario que se utiliza cuando se desea un nombre más corto. Si no se define un nombre corto, la etiqueta se mostrará aquí.	T1
stratumId	Sí	El ID del estrato al que pertenece el periodo temporal.	2
ID	Sí	El identificador entero exclusivo generado por el sistema para el periodo.	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-04-01
legacyReportTimeId	No	El ID de informe que se habría mostrado para este periodo en versiones anteriores de esta API. Este atributo solo aparece includeLegacyInformation era 1 en la solicitud y si isCustom es 0.	200491
legacySheetTimeId	No	El ID de horas de hoja que se habría utilizado para este periodo en versiones anteriores de esta API. Este atributo solo aparece includeLegacyInformation era 1 en la solicitud y si isCustom es 0.	48, Q63 o Y72
Contenido del elemento
Cero o un elemento de configuración regional.

Elemento de configuraciones regionales
Nombre de etiqueta		configuraciones regionales
Descripción		Contenedor para uno o varios elementos `de configuración regional` .
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios elementos de configuración regional.

elemento de configuración regional
Nombre de etiqueta		configuración regional
Descripción		Descripción de la configuración regional. Tenga en cuenta que el texto seguirá las reglas de reserva de la configuración regional.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
configuración regional	Sí	El código de la configuración regional.	es
etiqueta	Sí	La etiqueta localizada para el periodo/estrato.	FY2016
shortName	Sí	El nombre abreviado localizado del periodo/estrato temporal.	2016
Contenido del elemento
(ninguno)

exportSheets

exportTransactionDefinition

¿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