exportSheetDefinition

Formato de solicitação de planilha modelada


 <?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheetDefinition" callerName="a string that identifies your client application">
    <credentials login="sampleuser@company.com" password="my_pwd"/>
    <modeled-sheet id="3"/>
   </call>

O elemento call contém um elemento credenciais, bem como uma única planilha modelada.

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 de planilha modelada
Nome da etiqueta		modeled-sheet
Descrição		Identifica uma única planilha modelada solicitada por meio de uma chamada à API exportSheetDefinition.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno da planilha.	234
displayNameEnabled Disponível somente na API v31+ para instâncias que habilitam o nome de exibição.	N	displayNameEnabled=true indica que exportSheetDefinition deve respeitar as propriedades de nome de exibição de code , displayNameType e description quando Habilitar nome de exibição está ATIVADO para a instância. displayNameEnabled=false indica que a API exportSheetDefinition 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 exportSheetDefinition ignora as propriedades code , displayNameType e description . O valor por padrão para displayNameEnabled é "falso".	false
Conteúdo do elemento
(nenhum)

Formato de resposta da planilha modelada


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
   <output>
       <modeled-sheet id="11" prefix="Personnel" name="Personnel" description="Personnel Sheet"
                              available-in-actuals="false" allow-splits="true" split-column-title="Is Split Child Row" strataId="51">
           <columns>
               <levels code="Plan" name="Plan" read-only="false" splittable="false" required="true">
                   <level id="1" />
                   <level id="7" />
               </levels>
               <text code="LastName" name="Last Name" read-only="false" splittable="false" required="false" />
               <text code="FirstName" name="First Name" read-only="false" splittable="false" required="false" />
               <text code="ID" name="ID" read-only="false" splittable="false" required="false" />
               <dimension code="JobCode" name="JobCode" read-only="false" splittable="false" required="false" id="9">
                   <value id="19" name="E1" />
                   <value id="20" name="E2" />
                   <value id="21" name="E3" />
               </dimension>
               <text-selector code="BenefitsSelector" name="Benefits" read-only="false" splittable="false" required="true" id="27">
                   <value id="208" name="No" />
                   <value id="209" name="Yes" />
               </text-selector>
               <date code="StartDate" name="Start" read-only="false" splittable="false" required="false" />
               <date code="EndDate" name="End" read-only="false" splittable="false" required="false" />
               <number code="HoursPerWeek" name="Hr/Week" read-only="false" splittable="false" required="false" />
               <text-selector code="per" name="per" read-only="false" splittable="false" required="true" id="28">
                   <value id="210" name="Yr" />
                   <value id="211" name="Hr" />
               </text-selector>
               <initial-balance code="PayRate" name="Pay Rate" read-only="false" splittable="false" required="false" id="143" />
               <display code="PayRate" name="Pay Rate Display Column" read-only="true" splittable="false" required="false" id="7" />
               <level-currency code="" name="Currency" read-only="true" splittable="false" required="false" id="8" />
           </columns>
       </modeled-sheet>
   </output>
</response>

O elemento modeled-sheet contém uma única coluna filho contendo uma ou mais destas na ordem definida para a planilha:

níveis

dimensão

seletor de texto

texto

número

data

saldo inicial

nível-moeda

display

duração de tempo

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 planilha modelada
Nome da etiqueta		modeled-sheet
Descrição		Representa uma única planilha modelada que está sendo retornada em resposta a uma chamada de exportação à API de planilhas.
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	S	O prefixo da planilha.	Capital
nome	S	O nome da planilha.	Modelo de capital
valores reais disponíveis	S	Pode ser verdadeiro ou falso. Indica se a planilha modelada está disponível na versão de valores reais ou não.	verdadeiro
descrição	N	A descrição textual da planilha, se houver.	Este é o modelo de capital...
permitir-divisões	S	Verdadeiro significa que a planilha modelada permite divisões.	verdadeiro
split-column-title	N	O título da coluna adicional para importação quando permitir divisões está habilitado. Use uma cadeia de caracteres localizada se um parâmetro regional for especificado na solicitação. Esse atributo está presente somente quando allowed-splits está definido como verdadeiro e pelo menos uma coluna pode ser dividida.	Linha secundária dividida
strataId	S	A ID dos estratos associada a esta planilha modelada	2
Conteúdo do elemento
Um elemento de colunas únicas.

elemento de colunas
Nome da etiqueta		colunas
Descrição		Contêiner para um ou mais elementos de coluna.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais dos seguintes elementos, ordenados conforme aparecem na planilha: níveis dimensão seletor de texto texto número data saldo inicial nível-moeda display duração de tempo

elemento de níveis
Nome da etiqueta		níveis
Descrição		Representa a coluna "nível" em uma planilha modelada. Contêiner para um ou mais elementos de nível.
Atributos do elemento
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna.	false
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	verdadeiro
Conteúdo do elemento
Um ou mais elementos de nível.

elemento de nível
Nome da etiqueta		level
Descrição		Um dos níveis definidos para esta empresa que está nesta planilha (ou no qual esta planilha foi colocada). Os metadados de nível, incluindo a estrutura hierárquica, podem ser obtidos por uma chamada a exportLevels.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	Identificador numérico interno para o nível.	42
Conteúdo do elemento
(nenhum)

elemento de texto
Nome da etiqueta		texto
Descrição		Representa uma coluna na planilha que contém o texto inserido pelo usuário.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna.	false
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	false
Conteúdo do elemento
(nenhum)

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Uma das dimensões definidas para esta empresa. Representa uma coluna na planilha que contém a dimensão.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna.	false
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	false
Conteúdo do elemento
Um ou mais elementos de valor, cada um deles um valor selecionável válido na dimensão desta planilha. Se um valor da dimensão não é incluído aqui, ele não pode ser usado nas linhas de dados desta planilha.

elemento de valor
Nome da etiqueta		valor
Descrição		Um dos valores definidos para esta dimensão ou seletor de texto. Os metadados de dimensão completos, incluindo a estrutura hierárquica, podem ser obtidos por uma chamada separada para exportDimensions.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	Identificador numérico interno para o valor.	42
código Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O código para o valor do membro da dimensão, se houver, conforme inserido em Administração de dimensões.	México
nome	S	Representação impressa do valor.	México
displayName Disponível somente na API v30+ para instâncias que habilitam o nome de exibição.	N	O nome de exibição do valor do membro, conforme derivado de displayNameType.	México
Conteúdo do elemento
(nenhum)

elemento de seletor de texto
Nome da etiqueta		seletor de texto
Descrição		Lista personalizada de valores definidos para esta planilha. Representa uma coluna de seletor de texto em uma planilha modelada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna.	false
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	verdadeiro
ID	S	Identificador numérico interno.	42
Conteúdo do elemento
Um ou mais elementos de valor.

elemento de número
Nome da etiqueta		número
Descrição		Representa uma coluna na planilha que contém um número inserido pelo usuário.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna.	false
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	false
Conteúdo do elemento
(nenhum)

elemento de data
Nome da etiqueta		data
Descrição		Representa uma coluna na planilha que contém uma data inserida pelo usuário.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna.	false
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	false
Conteúdo do elemento
(nenhum)

elemento de saldo inicial
Nome da etiqueta		saldo inicial
Descrição		Representa uma coluna na planilha que contém um valor fornecido pelo usuário para o saldo inicial de uma conta com uma fórmula que determina a alteração mensal no valor da conta.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna.	false
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	false
ID	S	Identificador numérico interno da conta associada a esta coluna.	42
Conteúdo do elemento
(nenhum)

elemento de moeda de nível
Nome da etiqueta		nível-moeda
Descrição		Representa uma coluna na planilha que exibe o código da moeda associada a cada linha. Essa é a moeda do nível em que a linha está localizada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna. Para elementos de moeda de nível, esse valor é sempre verdadeiro.	verdadeiro
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	false
ID	S	Identificador numérico interno.	42
Conteúdo do elemento
(nenhum)

elemento de exibição
Nome da etiqueta		display
Descrição		Representa uma coluna na planilha que contém um cálculo somente leitura com base em linhas.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna.	false
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	false
ID	S	Identificador numérico interno.	42
Conteúdo do elemento
(nenhum)

elemento de período temporal
Nome da etiqueta		duração de tempo
Descrição		No máximo uma por planilha, representa um conjunto de colunas de período temporal, que aparecem à direita da planilha e podem conter dados periódicos.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
código	S	Um identificador símbolo para a coluna, usado em fórmulas de planilha e referências.	MyColumn
nome	S	Título exibível da coluna, como visto na planilha.	Minha coluna
somente leitura	S	Verdadeiro se a coluna está marcada como somente leitura na planilha, falso se valores podem ser inseridos na coluna.	false
divisível	S	Verdadeiro se as divisões de linhas podem ter valores diferentes para esta coluna, falso se as divisões devem ter o mesmo valor que o pai.	verdadeiro
obrigatório	S	Verdadeiro se este atributo é um campo obrigatório.	false
ID	S	Identificador numérico interno da conta associada a este período temporal.	42
Conteúdo do elemento
(nenhum)

Formato de solicitação de planilha de cubo


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheetDefinition" callerName="a string that identifies your client application">
     <credentials login="sampleuser@company.com" password="my_pwd"/>
     <cube-sheet id="4"/>
   </call>

O elemento call contém um elemento credenciais, bem como uma única planilha de cubo.

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 um conjunto de permissões que contenha as permissões obrigatórias para o método que está sendo invocado.	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)

elemento de planilha de cubo
Nome da etiqueta		cube-sheet
Descrição		Identifica uma única planilha de cubo solicitada por meio de uma chamada à API exportSheetDefinition.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno da planilha.	234
Conteúdo do elemento
(nenhum)

Formato de resposta da planilha de cubo


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
    <output>
        <cube-sheet id="24" prefix="SummaryCube" name="Summary Cube" isGlobal="0" description="" strataId="1" horizontalAxis="-3" verticalAxis="-2" maxColumnWidth="0" suppressZeroRows="0" rearrangeGLAndCustomAccounts="0" hideRollupTotals="0">
            <dimensions>
                <dimension id="3" uncategorized="false" rollup="false" name="Company" newValueBehavior="parent" editableOnSheet="false">
                    <value id="35" />
                </dimension>
                <dimension id="4" uncategorized="false" rollup="false" name="CountryRegion" newValueBehavior="parent" editableOnSheet="false">
                    <value id="144" />
                    <value id="133" uncategorized="true" />
                    <value id="133" rollup="true" />
                    <value id="122" rollup="true" />
                    <value id="143" />
                </dimension>
                <levels>
                    <level id="1" />
                    <level id="2" />
                    <level id="8" />
                    <level id="10" />
                    <level id="9" />
                    <level id="5" />
                    <level id="3" />
                    <level id="4" />
                    <level id="11" />
                    <level id="13" />
                    <level id="15" />
                    <level id="16" />
                </levels>
                <accounts>
                    <account id="455" code="" isAssumption="false" />
                    <account id="456" code="" isAssumption="false" />
                    <account id="457" code="SummaryCube.Input" isAssumption="false" />
                    <account id="458" code="SummaryCube.CubeMetric" isAssumption="false" />
                </accounts>
                <time initialBalance="true" visibleTimeStratumCodes="month" />
            </dimensions>
        </cube-sheet>
    </output>
</response>

O elemento de planilha de cubo contém um filho de dimensões únicas que os contém na ordem definida para a planilha:

dimensão (uma ou mais)

atributo (zero ou mais)

níveis (um)

contas (uma)

tempo (um)

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 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.
strataId	S	A ID dos estratos da planilha.	5
horizontalAxis	S	A ID da dimensão que deve ser mostrada no eixo horizontal por padrão.	-3
verticalAxis	S	A lista de IDs de dimensão que devem ser mostradas no eixo vertical por padrão.	-2
maxColumnWidth	S	A largura máxima em pixels para colunas (zero se não for especificada).	20
suppressZeroRows	S	"1" se zero linhas forem suprimidas, "0" se não forem.	suppressZeroRows="0"
rearrangeGLAndCustomAccounts	S	"1" se a planilha de cubo deve usar o tratamento de contas do livro-razão, "0" se não for.	rearrangeGLAndCustomAccounts="0"
hideRollupTotals	S	"1" se os totais consolidados devem ser ocultados, "0" se não forem.	hideRollupTotals="0"
Conteúdo do elemento
(nenhum)

elemento de dimensões
Nome da etiqueta		dimensões
Descrição		Contêiner para as dimensões da planilha.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais níveis, dimensões, contas e elementos de tempo.

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Uma das dimensões definidas para esta planilha de cubo.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O identificador numérico interno da dimensão.	34
não categorizado	S	Verdadeiro significa que o elemento sem categoria da própria dimensão (o elemento raiz sem categoria) está disponível como uma seleção no cubo.	verdadeiro
consolidação	S	Verdadeiro significa que o elemento de consolidação da própria dimensão (a consolidação de todos os elementos) está disponível como uma seleção no cubo.	verdadeiro
nome Disponível na API v22+	S	Nome desta dimensão.	Item de produto
Conteúdo do elemento
Um ou mais elementos de valor, indicando quais valores de dimensão estão disponíveis na planilha.

elemento atributo
Nome da etiqueta		atributo
Descrição		Um dos atributos inseridos nesta planilha de cubo. Os metadados de atributo, incluindo a estrutura hierárquica, podem ser obtidos por uma chamada a exportAttributes.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O identificador numérico interno do atributo.	34
não categorizado	S	Verdadeiro significa que o elemento sem categoria do próprio atributo (o elemento sem categoria raiz) está disponível como uma seleção no cubo.	verdadeiro
consolidação	S	Verdadeiro significa que o elemento de consolidação do próprio atributo (a consolidação de todos os elementos) está disponível como uma seleção no cubo.	verdadeiro
nome Disponível na API v22 +	S	O nome do atributo.	Tipo de loja
newValueBehavior	S	Comportamento esperado para a disponibilidade de um novo valor de dimensão, disponível, indisponível ou pai.	principal
Conteúdo do elemento
Um ou mais elementos de valor, indicando quais valores do atributo estão disponíveis na planilha.

elemento de valor
Nome da etiqueta		valor
Descrição		Um dos valores para esta dimensão que foi marcado como disponível na planilha. A mesma ID de valor pode aparecer até duas vezes: com e sem não categorizado definido como verdadeiro. Os metadados de dimensão, incluindo a estrutura hierárquica, podem ser obtidos por meio de uma chamada a exportDimensions.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	Identificador numérico interno para o valor da dimensão.	34
consolidação	N	true indica a consolidação deste valor de dimensão. Permitido somente se o valor tem valores filho na dimensão. Se o atributo estiver ausente, será usado falso.	verdadeiro
não categorizado	N	true indica o valor sem categoria deste valor de dimensão. Permitido somente se o valor tem valores filho na dimensão. Se o atributo estiver ausente, será usado falso.	verdadeiro
Conteúdo do elemento
(nenhum)

elemento de níveis
Nome da etiqueta		níveis
Descrição		Contêiner aplicado a um ou mais elementos de nível. Os níveis individuais são retornados, mesmo que afetem apenas a visibilidade. Os dados podem ser importados para qualquer nível.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de nível.

elemento de nível
Nome da etiqueta		level
Descrição		Um nível encontrado nesta planilha, no qual esta planilha aparece. Os metadados de nível, incluindo a estrutura hierárquica, podem ser obtidos por uma chamada para exportLevels.
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	Identificador numérico interno para o nível.	12
Conteúdo do elemento
(nenhum)

elemento de contas
Nome da etiqueta		contas
Descrição		Contêiner aplicado a um ou mais elementos de conta. Contas individuais são retornadas, mesmo que afetem apenas a visibilidade. Os dados podem ser importados para qualquer conta de entrada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de conta. Elementos de conta disponíveis e ordem determinados pela opção Usar tratamento de contas LR nas propriedades da planilha de cubo.

elemento de conta
Nome da etiqueta		account
Descrição		Uma das contas definidas para esta planilha de cubo. Os metadados da conta, incluindo a estrutura hierárquica, podem ser obtidos por uma chamada para exportAccounts.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	Identificador numérico interno da conta.	23
código Disponível na API v22+	N	O código da conta.	SalesCubeWithAttribute.Unit_Price
Conteúdo do elemento
(nenhum)

elemento de tempo
Nome da etiqueta		time
Descrição		Dimensão de tempo aplicada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
InitialBalance	S	Verdadeiro quando a dimensão de tempo tem um valor de saldo inicial.	"true"
visibleTimeStratumCodes	N	Lista de códigos de estratos de tempo selecionados por dimensão de tempo.	"trim,mês,ano"
(nenhum)
Conteúdo do elemento
(nenhum)

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Uma das dimensões definidas para esta planilha de cubo.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O identificador numérico interno da dimensão.	34
não categorizado	S	Verdadeiro significa que o elemento sem categoria da própria dimensão está disponível como uma seleção no cubo.	verdadeiro
consolidação	S	Verdadeiro significa que o elemento de consolidação da própria dimensão (a consolidação de todos os elementos) está disponível como uma seleção no cubo.	verdadeiro
nome	S	Nome desta dimensão.	"Item de produto"
newValueBehavior	S	Comportamento esperado para a disponibilidade de um novo valor de dimensão, disponível, indisponível ou pai.	principal
isEditableOnSheet	N	Sinalizador que indica se essa dimensão é editável na planilha.	verdadeiro
(nenhum)
Conteúdo do elemento
Um ou mais elementos de valor.

elemento de usuários
Nome da etiqueta		usuários
Descrição		Contêiner para planilhas atribuídas a usuário que indica as propriedades de acessibilidade de uma planilha de cubo. O usuário que faz a chamada requer a permissão de modelo para visualizar este elemento e todos os filhos dele.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
isExcludedFromWorkflow	S	Sinalizador que indica se uma planilha é excluída ou não do fluxo de trabalho.	verdadeiro
Conteúdo do elemento
Um ou mais elementos de usuário.

elemento de usuário
Nome da etiqueta		usuário
Descrição		Um dos usuários atribuídos à planilha.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	Valor inteiro que indica a ID exclusiva de um usuário atribuído.	11
Conteúdo do elemento
(nenhum)

Categoria	Recuperação de metadados
Descrição	Retorna a definição da planilha modelada ou de cubo especificada.
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 e uma especificação da planilha que está sendo solicitada.