importModeledSheet

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

importModeledSheet

Actualizado en API v40 (21 de septiembre de 2024)

Categoría	Metadata retrieval
Descripción	Importa la hoja modelada especificada.
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.

Formato de solicitud


<call method="importModeledSheet" callerName="a string that identifies your client application">
  <credentials credentials login="sampleuser@company.com" password="my_pwd" />

  <ConfigurableModel allow-actuals="false"
              allow-allocation="true" allow-edits-in-rollup-mode="false"
              breakback-pattern="0" code="Open Positions Clone" description="Open positions Clone to be filled"
              frozen-column-count="0" has-salary-detail="true" id="15" isglobal="1"
              prefix="OpeningsClone" 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">
      <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="1" 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="1" name="G & A"
                          sort-order="4" />
              <DimensionValue abbr="" id="10" in-use="1" 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="" requiredColumn="false">
              <DimensionValue abbr="" id="64" in-use="1" 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="1" 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="1" 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="" requiredColumn="false">
              <DimensionValue abbr="" id="22" in-use="1" 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="1" 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=">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="" requiredColumn="false">
              <DimensionValue abbr="" id="28" in-use="1" name="Full Time"
                          sort-order="1" />
              <DimensionValue abbr="" id="29" in-use="1" name="Part Time"
                          sort-order="2" />
              <DimensionValue abbr="" id="30" in-use="1" 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="" requiredColumn="false">
              <DimensionValue abbr="" id="32" in-use="1" name="Masters"
                          sort-order="1" />
              <DimensionValue abbr="" id="33" in-use="0" name="Phd"
                          sort-order="2" />
              <DimensionValue abbr="" id="31" in-use="1" 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>
</call>

El elemento de llamada contiene un elemento de credenciales, así como un único elemento ConfigureableModel.

Códigos de hoja editables (aplicable en API v39+)

Formato de solicitud para API v39+ configurableModelElement que requiere atributo de nombre y código

<call method="importModeledSheet" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd" />

  <ConfigurableModel allow-actuals="false"
              allow-allocation="true" allow-edits-in-rollup-mode="false"
              breakback-pattern="0" name="Open Positions Clone" description="Open positions Clone to be filled"
              frozen-column-count="0" has-salary-detail="true" id="15" isglobal="1"
              code="OpeningsClone" 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">
 ...

Reglas de validación de datos de modelo (aplicable en API v39 y posteriores)

Admitimos la capacidad de importar reglas de validación de datos mediante la solicitud importModeledSheet. Consulte la solicitud de muestra que aparece a continuación:

<call method="importModeledSheet" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd" />
<ConfigurableModel allow-actuals="false" allow-allocation="false" allow-edits-in-rollup-mode="false" breakback-pattern="7" code="SampleDef" description="TestDef Sheet" frozen-column-count="0" has-salary-detail="false" id="142" isglobal="0" name="SampleDef" recalculateOnDemand="false" revision="0" selected-plan-ids="1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24" state="A" strata-code="month" strata-id="1">
 <Columns>
    <Driver abbr="" code="InitialBalance" data-privacy="0" decimal-precision="0" display-as="0" driver-type="3" formula="0" hiddenColumn="true" id="1163" is-split-key="false" is-splitable="false" name="Initial Balance" read-only="false" show-total-at-bottom="false" tool-tip="" />
    <Dimension abbr="" code="CorporateDiscount" codeHasBeenUpdated="false" hasOverriddenTitle="false" hiddenColumn="true" id="25" is-splitable="false" isEditDimension="false" isHiddenOnSheet="false" isTextSelector="false" name="CorporateDiscount" read-only="true" show-total-at-bottom="false" tagType="2" tool-tip="">
       <DimensionValue abbr="" id="215" in-use="0" name="Not Applicable" sort-order="0" />
       <DimensionValue abbr="" id="216" in-use="0" name="TBD" sort-order="1" />
       <DimensionValue abbr="" id="217" in-use="1" name="Available" sort-order="2" />
       <DimensionValue abbr="" id="218" in-use="1" name="Not Available" sort-order="3" />
       <LookupTables />
    </Dimension>
    <AssignablePlan abbr="" code="Plan" id="0" is-splitable="false" name="Level" read-only="false" show-total-at-bottom="false" tool-tip="" />
 </Columns>
 <CalculatedAccounts />
 <Assumptions />
 <DataValidationRules>
    <Rule actionType="C" expression="if (ROW.InitialBalance=10, 1, 0)" helpText="Test" id="268" name="TestInitialBalance" status="A" />
    <Rule actionType="C" expression="if (ROW.CorporateDiscount="na"
, 1, 0)" helpText="Test" id="137" name="TestLAttribRule" status="A" />
 </DataValidationRules>
</ConfigurableModel>
</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 ConfigurableModelConfigurableModel element
Nombre de etiqueta		ConfigurableModelConfigurableModel
Descripción		Representa una sola hoja modelada cargada.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código (API v38 y anteriores) nombre (API v39+)	Sí	El nombre de la hoja. Esto se puede usar para identificar hojas en otras llamadas a la API, como importModeledSheet. La hoja se importará si aún no existe una hoja con este nombre en la instancia.	Clon de posiciones vacantes
prefijo (API v38 y anteriores) código (API v39+)	Sí	El prefijo de la hoja que se utiliza como prefijo de las cuentas de la hoja. Debe ser exclusivo. El código de la hoja que se utiliza como prefijo de las cuentas de la hoja. Debe ser exclusivo	AperturasClonar
descripción	No	La descripción de la hoja, si la hay.	Clon de posiciones vacantes para cubrir
Contenido del elemento
Consulte el XML de solicitud anterior

Formato de respuesta


<response success="true">
  <messages>
      <message type="INFO">Dimension Created: Base Pay New</message>
      <message type="INFO">Dimension Created: ABC</message>
  </messages>
</response>

La respuesta tendrá el atributo de éxito definido como verdadero si la importación se realiza correctamente. Además, opcionalmente, uno o varios mensajes informativos indicarán si se han creado nuevas dimensiones.

Si la creación falla debido a un error del sistema, la respuesta será la siguiente:


<response success="false">
  <messages>
      <message key="exception-caught">Caught Exception: Failed to create modeled
          sheet.
      </message>
  </messages>
</response>

Formato de respuesta al crear atributo de nivel

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<messages>
<message type="INFO">Level attribute created: CorporateDiscount</message>
<message type="INFO">The modeled sheet named SampleDef has been created.</message>
</messages>
</response>

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

ImportModeledSheet

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. Sin embargo, para mantener la compatibilidad con versiones anteriores, el

account-code

La propiedad es opcional. Si el

account-code

no está incluido en la solicitud, el código exclusivo se generará mediante el procedimiento y, en su lugar, se utilizará la propiedad de código para vincular la columna de visualización a una cuenta determinada.

importGroups

Actualización masiva de metadatos

¿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