importModeledSheet

Adaptive Planning

Documentação do Workday Adaptive Planning (Workday 2025R2)
Integração
Como gerenciar a integração de dados
Documentação da API
Métodos de criação, atualização e leitura de metadados e dados

Última atualização: 2023-06-23

importModeledSheet

Atualizado na API v40 (21 de setembro de 2024)

Categoria	Recuperação de metadados
Descrição	Importa a planilha modelada fornecida.
Permissões obrigatórias para invocar	MOD (criar, editar e excluir planilhas)
Parâmetros obrigatórios na solicitação	Credenciais e uma especificação da planilha que está sendo solicitada.

Formato da solicitação


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

O elemento call contém um elemento credenciais, bem como um único elemento ConfigureableModel.

Códigos de planilha editáveis (aplicáveis à API v39+)

Formato de solicitação para a API v39+ configurávelModelElement que requer os atributos de nome e 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">
 ...

Regras de validação de dados de modelo (aplicáveis na API v39 e posteriores)

Oferecemos suporte para a importação de regras de validação de dados usando a solicitação importModeledSheet. Veja o exemplo de solicitação abaixo:

<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 credenciais
Nome da etiqueta		credenciais
Descrição		Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
login	S	O nome de logon do usuário que invoca o método de API. Esse usuário deve ter as permissões necessárias para invocar o método.	sampleuser@company.com
senha	S	A senha do usuário que invoca o método de API.	my_password
parâmetros regionais	N	Especifique os parâmetros regionais a serem usados para interpretar números e datas de entrada e para formatar números e datas de saída (usando o separador de milhares, nomes de meses e formatação de data adequados). Os parâmetros regionais também são usados para especificar o idioma em que as mensagens do sistema na resposta devem ser exibidas. Se não especificado, en_US (inglês americano) é usado.	fr_FR
instanceCode	N	Se o usuário especificado nas credenciais tem acesso a mais de uma instância do Adaptive Planning , esse atributo pode ser usado para especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não for especificada, a instância por padrão do usuário será usada. Para determinar os códigos de instância disponíveis, use a API exportInstances.	MYINSTANCE1
Conteúdo do elemento
(nenhum)

Elemento ConfigurableModel
Nome da etiqueta		ConfigurableModel
Descrição		Representa uma única planilha modelada carregada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código (API v38 e versões anteriores) nome (API v39+)	S	O nome da planilha. Isso pode ser usado para identificar planilhas em outras chamadas de API, como importModeledSheet. A planilha será importada se ainda não existir uma planilha com esse nome na instância.	Clonar posições disponíveis
prefixo (API v38 e versões anteriores) código (API v39+)	S	O prefixo da planilha usado para prefixar as contas da planilha. Deve ser exclusivo. O código da planilha usado para prefixar as contas da planilha. Deve ser exclusivo	VagasClone
descrição	N	A descrição da planilha, se houver.	Clone de posições disponíveis a serem preenchidas
Conteúdo do elemento
Consulte a solicitação XML acima

Formato da resposta


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

A resposta terá o atributo de êxito definido como verdadeiro se a importação for bem-sucedida. Além disso, opcionalmente, uma ou mais mensagens informativas indicarão se novas dimensões foram criadas.

Se a criação falhar devido a um erro do sistema, a resposta será a seguinte:


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

Formato de resposta ao criar atributo de nível

<?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 coluna de exibição de planilha modelada para API v40+

ImportModeledSheet

O oferece suporte a códigos exclusivos para colunas de exibição. Se uma planilha modelada tem uma coluna de exibição, a

exportModeledSheet

a resposta da API incluirá uma nova propriedade 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" />

Observe a nova propriedade,

account-code

, que agora aponta para o código da conta associada. Enquanto isso, a propriedade de código permanece, mas agora pode ser usada para criar um identificador editável e exclusivo para a coluna especificada. No entanto, para manter a compatibilidade com versões anteriores, o

account-code

A propriedade é opcional. Se o

account-code

não for incluída na solicitação, o código exclusivo será gerado processualmente e, em vez disso, a propriedade de código será usada para vincular a coluna de exibição a uma determinada conta.

importGroups

Atualização em massa de metadados

Este conteúdo foi útil?

O que precisamos melhorar? Informações corretas Responde à minha pergunta Fácil de encontrar Fácil de entender Ajuda a concluir minha tarefa Informações completas e detalhadas

O que precisamos melhorar? Informações incorretas Não responde à minha pergunta Não é fácil de encontrar Não é fácil de entender Não ajuda a concluir minha tarefa Informações incompletas ou pouco detalhadas

Conte-nos sobre a tarefa que você está executando. Quais informações adicionais podem melhorar este conteúdo? Há mais algum detalhe que gostaria de compartilhar?

Nome completo

E-mail

A Workday usará seu nome e e-mail para fornecer respostas relacionadas ao seu feedback. Suas informações serão tratadas de acordo com a nossa Declaração de Privacidade.

Agradecemos seu feedback