exportModeledSheet

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

exportModeledSheet

Actualizado en v40 (21 de septiembre de 2024)

Categoría	Metadata retrieval
Descripción	Devuelve la definición de la hoja modelada dada.
Permisos obligatorios para invocar	MOD (creación, edición y eliminación de hojas)
Parámetros obligatorios bajo petición	Credenciales y una especificación de la hoja que se solicita.

Recuperar la definición de una hoja modelada.

Formato de solicitud


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

El elemento de llamada contiene un elemento de credenciales, así como un solo elemento exportModel.

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 API llamada 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 exportModel
Nombre de etiqueta	exportModel
Descripción	Campos relevantes para la exportación de la hoja modelo.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
sheetToExport	Sí	El nombre de la hoja modelada.	Modelo de capital
displayNameEnabled	No	displayNameEnabled=true indica que exportModeledSheet debe respetar las propiedades de nombre de visualización cuando la opción Activar nombre de visualización está activada para la instancia. displayNameEnabled=false indica que la API exportModeledSheet 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 exportModeledSheet ignora las propiedades de nombre de visualización.	verdadero

Formato de respuesta


<response success="true">
  <output>
      <ConfigurableModel allow-actuals="false" allow-allocation="true" allow-edits-in-rollup-mode="false" breakback-pattern="0" code="Open Positions" description="Open positions
to be filled" frozen-column-count="0" has-salary-detail="true" id="15" isglobal="1" prefix="Openings" revision="0" selected-plan-ids=
"1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18" state="A" strata-code="month" strata-id="3">
          <Columns>
              <AssignablePlan abbr="" code="Plan" id="0" is-splitable="false" name="Plan" read-only="false" show-total-at-bottom="false" tool-tip="" />
              <Driver abbr="" code="PositionCode" decimal-precision="0" driver-type="0" id="22" is-split-key="false" is-splitable="false" name="Position Code" read-only="false"
show-total-at-bottom="false" tool-tip="" />
              <Dimension abbr="" code="Department" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="6" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false"
isTextSelector="false" name="Department" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="" requiredColumn="true">
                  <DimensionValue abbr="" id="7" in-use="0" name="Engr" sort-order="0" />
                  <DimensionValue abbr="" id="40" in-use="0" name="QA" sort-order="1" />
                  <DimensionValue abbr="" id="8" in-use="0" name="PS" sort-order="3" />
                  <DimensionValue abbr="" id="41" in-use="0" name="Dev" sort-order="2" />
                  <DimensionValue abbr="" id="9" in-use="0" name="G & A" sort-order="4" />
                  <DimensionValue abbr="" id="10" in-use="0" name="Sales" sort-order="5" />
                  <LookupTables />
              </Dimension>
              <Dimension abbr="" code="Title" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="16" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false"
isTextSelector="false" name="Title" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="">
                  <DimensionValue abbr="" id="64" in-use="0" name="Sales Rep" sort-order="8" />
                  <DimensionValue abbr="" id="65" in-use="0" name="Engr Mgr" sort-order="10" />
                  <DimensionValue abbr="" id="66" in-use="0" name="Sr Engr" sort-order="11" />
                  <DimensionValue abbr="" id="67" in-use="0" name="Engr" sort-order="12" />
                  <DimensionValue abbr="" id="68" in-use="0" name="GUI Engr" sort-order="13" />
                  <DimensionValue abbr="" id="47" in-use="0" name="CFO" sort-order="1" />
                  <DimensionValue abbr="" id="48" in-use="0" name="VP Mkt" sort-order="3" />
                  <DimensionValue abbr="" id="49" in-use="0" name="Doc Mgr" sort-order="5" />
                  <DimensionValue abbr="" id="18" in-use="0" name="CEO" sort-order="0" />
                  <DimensionValue abbr="" id="50" in-use="0" name="VP Sales" sort-order="7" />
                  <DimensionValue abbr="" id="51" in-use="0" name="VP Engr" sort-order="9" />
                  <DimensionValue abbr="" id="61" in-use="0" name="Controller" sort-order="2" />
                  <DimensionValue abbr="" id="62" in-use="0" name="Mkt Assoc" sort-order="4" />
                  <DimensionValue abbr="" id="63" in-use="0" name="Doc Writer" sort-order="6" />
                  <LookupTables />
              </Dimension>
              <Dimension abbr="" code="Base Pay" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="1" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false"
isTextSelector="false" name="Base Pay" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="">
                  <DimensionValue abbr="" id="22" in-use="0" name="60-80K" sort-order="3" />
                  <DimensionValue abbr="" id="23" in-use="0" name="80-100K" sort-order="4" />
                  <DimensionValue abbr="" id="24" in-use="0" name="100-120K" sort-order="0" />
                  <DimensionValue abbr="" id="25" in-use="0" name="120-150K" sort-order="1" />
                  <DimensionValue abbr="" id="26" in-use="0" name="150-200K" sort-order="2" />
                  <DimensionValue abbr="" id="27" in-use="0" name="&gt;200K" sort-order="5" />
                  <LookupTables />
              </Dimension>
              <Dimension abbr="" code="Position Type" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="10" is-splitable="true" isEditDimension="false" isHiddenOnSheet=
"false" isTextSelector="false" name="Position Type" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="">
                  <DimensionValue abbr="" id="28" in-use="0" name="Full Time" sort-order="1" />
                  <DimensionValue abbr="" id="29" in-use="0" name="Part Time" sort-order="2" />
                  <DimensionValue abbr="" id="30" in-use="0" name="Contract" sort-order="0" />
                  <LookupTables />
              </Dimension>
              <Dimension abbr="" code="Education" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="7" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false"
isTextSelector="false" name="Education" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="">
                  <DimensionValue abbr="" id="32" in-use="0" name="Masters" sort-order="1" />
                  <DimensionValue abbr="" id="33" in-use="0" name="Phd" sort-order="2" />
                  <DimensionValue abbr="" id="31" in-use="0" name="Graduate" sort-order="0" />
                  <LookupTables />
              </Dimension>
              <Driver abbr="" code="Rate" decimal-precision="0" display-as="1" driver-type="1" id="23" is-split-key="false" is-splitable="false" name="Rate" read-only="false"
show-total-at-bottom="false" tool-tip="" />
              <Driver abbr="" code="YearsOfExperience" decimal-precision="0" display-as="1" driver-type="1" id="24" is-split-key="false" is-splitable="false" name="Years Of
Experience" read-only="false" show-total-at-bottom="false" tool-tip="" />
              <Driver abbr="" code="FillBy" decimal-precision="0" driver-type="2" id="25" is-split-key="false" is-splitable="false" name="Fill By" read-only="false"
show-total-at-bottom="false" tool-tip="" />
          </Columns>
          <CalculatedAccounts />
          <Assumptions />
      </ConfigurableModel>
  </output>
</response>

La respuesta contendrá la definición de hoja en un elemento ConfigurableModel.

Elemento ConfigurableModelConfigurableModel element
Nombre de etiqueta		ConfigurableModelConfigurableModel
Descripción		Representa una sola hoja modelada que se devuelve en respuesta a una llamada a la API export-ModeledSheet.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	El nombre de la hoja. Esto se puede usar para identificar hojas en otras llamadas a la API, como importModeledSheet.	Posiciones abiertas
descripción	No	La descripción de la hoja, si la hay.	Posiciones abiertas para cubrir
Contenido del elemento
Consulte el XML de respuesta

Códigos de columna de visualización de hoja modelada para API v40+

exportModeledSheet

admite códigos exclusivos para columnas de visualización. Si una hoja modelada tiene una columna de visualización, la

exportModeledSheet

La respuesta API incluirá una nueva propiedad para

DisplayColumn

<DisplayColumn abbr="" account-code="PayRate" account-id="370" code="PayRateDisplay" hiddenColumn="true" id="7" is-splitable="false" months="6" name="Pay Rate Display Column" read-only="true" show-total-at-bottom="true" start-time-adjust="1" start-time-index="2" start-time-relative-to="C" strata-code="qtr" tool-tip="Display Column" />

Tenga en cuenta la nueva propiedad,

account-code

, que ahora apunta al código de la cuenta asociada. Mientras tanto, la propiedad de código permanece, pero ahora se puede usar para crear un identificador único y editable para la columna dada.

exportDimensionMapping

exportPermissionSets

¿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