exportSheet

Categoria	Recuperação de metadados
Descrição	Retorna a lista completa de todas as planilhas definidas para a instância especificada. Isso inclui planilhas "incompletas" e planilhas atribuídas a usuário.
Permissões obrigatórias para invocar	IMP (importação de dados) ou Mod (criação, edição e exclusão de planilhas)
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém apenas uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. Uma vez verificado, o método retorna um documento XML que descreve o conjunto completo de todas as planilhas encontradas na instância do usuário.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheets" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd"/>
</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 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 adequado, nomes de meses e formatação de data). 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)

Formato da resposta


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
    <sheets>
      <modeled-sheet id="1" name="Personnel" prefix="Personnel" description="Personnel Sheet" />
      <modeled-sheet id="2" name="Crossover Personnel" prefix="Crossovers" description="Personnel Sheet" />
      <modeled-sheet id="3" name="Sales" prefix="Sales" description="Sales Sheet" />
      ...
      <standard-sheet id="6" name="Model Summary" prefix="" description="Configurable Model Summary Sheet" />
      <standard-sheet id="8" name="Expenses" prefix="" description="" />
      <standard-sheet id="9" name="Balance" prefix="" description="" />
      <standard-sheet id="10" name="Assumptions" prefix="" description="" />
      ...
      <cube-sheet id="17" name="Expense Cube" prefix="ExpenseCube" description="" />
      <cube-sheet id="19" name="Sale Cube" prefix="SalesCube" description="" />
    </sheets>
  </output>
</response>

elemento de resposta
Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	Verdadeiro ou falso, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso na resposta.	verdadeiro
obsoleto	N	Se presente na etiqueta de resposta e definido como verdadeiro, esse atributo indica que a versão do método ou da API que está sendo invocada se tornou obsoleta e está oficialmente obsoleta por Adaptive Planning . Embora continue a funcionar neste momento, pode deixar de funcionar em breve. Normalmente, esse atributo não está presente.	false
Conteúdo do elemento
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório.

elemento de saída
Nome da etiqueta		saída
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um único elemento de planilhas de cubo obrigatório. Esse invólucro de saída é padrão em todas as respostas de API e inclui a saída válida de qualquer chamada de API bem-sucedida.

elemento de planilha
Nome da etiqueta		planilha
Descrição		Contêiner para um ou mais elementos de planilha padrão, modelada e de cubo.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de planilha padrão, planilha modelada e planilha de cubo.

elemento de planilha padrão
Nome da etiqueta		planilha-padrão
Descrição		Representa uma única planilha padrão que está sendo retornada em resposta a uma chamada à API exportSheets.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno da planilha. Isso pode ser usado para identificar planilhas em outras chamadas de API, como exportSheetDefinition.	123
prefixo	S	O prefixo da planilha. Para planilhas padrão, esse campo está sempre vazio. Outros tipos de planilha têm valores não vazios para esse atributo.
nome	S	O nome da planilha.	Modos de consolidação
descrição	N	A descrição textual da planilha, se houver.	Estes são os modos de consolidação...
Conteúdo do elemento
(nenhum)

elemento de planilha modelada
Nome da etiqueta		modeled-sheet
Descrição		Representa uma única planilha modelada que está sendo retornada em resposta a uma chamada à API exportSheets.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno da planilha. Isso pode ser usado para identificar planilhas em outras chamadas de API, como exportSheetDefinition.	234
prefixo (API v38 e versões anteriores) código (API v39+)	S	API v38: prefixo da planilha. API v39: o código da planilha.	Capital
nome	S	O nome da planilha.	Modelo de capital
descrição	N	A descrição textual da planilha, se houver.	Este é o modelo de capital...
Conteúdo do elemento
(nenhum)

elemento de planilha de cubo
Nome da etiqueta		cube-sheet
Descrição		Representa uma única planilha de cubo que está sendo retornada em resposta a uma chamada à API exportSheets.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID		O número de ID do sistema interno da planilha. Isso pode ser usado para identificar planilhas em outras chamadas de API, como exportSheetDefinition.	34
prefixo		O prefixo da planilha.	ExpenseCube
nome		O nome da planilha.	Cubo de despesas
descrição		A descrição textual da planilha, se houver.

Conteúdo do elemento

(nenhum)