exportModeledSheet

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

exportModeledSheet

Atualizado na versão 40 (21 de setembro de 2024)

Categoria	Recuperação de metadados
Descrição	Retorna a definição da planilha modelada especificada.
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.

Recuperar a definição de uma planilha modelada.

Formato da solicitação


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

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

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 API chamada será bem-sucedida.
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 exportModel
Nome da etiqueta	exportModel
Descrição	Campos relevantes para a exportação da planilha de modelo.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
sheetToExport	S	O nome da planilha modelada.	Modelo de capital
displayNameEnabled	N	displayNameEnabled=true indica que exportModeledSheet deve respeitar as propriedades de nome de exibição quando Habilitar nome de exibição está ATIVADO para a instância. displayNameEnabled=false indica que a API exportModeledSheet deve continuar seguindo o contrato de API anterior à versão 30, mesmo quando a opção Habilitar nome de exibição está ATIVADA para a instância. A API exportModeledSheet ignora as propriedades de nome de exibição.	verdadeiro

Formato da resposta


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

A resposta conterá a definição da planilha em um elemento ConfigurableModel.

Elemento ConfigurableModel
Nome da etiqueta		ConfigurableModel
Descrição		Representa uma única planilha modelada que está sendo retornada em resposta a uma chamada à API export-ModeledSheet.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	O nome da planilha. Isso pode ser usado para identificar planilhas em outras chamadas de API, como importModeledSheet.	Posições disponíveis
descrição	N	A descrição da planilha, se houver.	Posições disponíveis a serem preenchidas
Conteúdo do elemento
Ver o XML da resposta

Códigos de coluna de exibição de planilha modelada para API v40+

exportModeledSheet

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.

exportDimensionMapping

exportPermissionSets

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