exportDimensionFamilies

Categoria	Recuperação de metadados
Descrição	Retorna metadados que descrevem os relacionamentos entre conjuntos de contas e conjuntos de dimensões.
Permissões obrigatórias para invocar	Nenhum (devem ser credenciais válidas para a instância)
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 um conjunto de famílias de dimensões, que descrevem como conjuntos específicos de dimensões estão relacionados a conjuntos específicos de contas. Cada família consiste em um conjunto de contas e um conjunto de dimensões, o que indica que essas dimensões se aplicam a essas contas, enquanto outras dimensões não se aplicam. Contas e dimensões podem pertencer a muitas famílias. As famílias são definidas da seguinte forma:

As contas em uma planilha modelada pertencem a uma família dessa planilha, que contém todas as dimensões inseridas nessa planilha e todas as dimensões da organização.

As contas em uma planilha de cubo pertencem a uma família dessa planilha, que contém todas as dimensões inseridas nessa planilha e todas as dimensões da organização.

As contas em uma planilha padrão com dimensões pertencem a uma família dessa planilha, que contém todas as dimensões inseridas nessa planilha e todas as dimensões da organização.

As planilhas padrão que não têm dimensões inseridas não têm uma família de dimensões associada.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionFamilies" 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. Este 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, será usada a instância por padrão do usuário. 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>
   <families>
     <family name="Personal" id="381" accounts="734-739, 744" dimensions="9321,9422, 9455, 9458" />
     <family name="Capital" id="382" accounts="853" dimensions="4" />
     <family name="Sales" id="386" accounts="769, 4112" dimensions="" />
     <family name="Balance" id="255" accounts="545, 66" dimensions="6,7" />
   </families>
 </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 em sua 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. 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
(nenhum)
Conteúdo do elemento
Um único elemento de contas. 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 famílias
Nome da etiqueta		famílias
Descrição		Contêiner para um ou mais elementos da família.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de família.

elemento de família
Nome da etiqueta		família
Descrição		Descreve uma família de dimensões únicas associada a uma única planilha modelada ou de cubo. Uma única família também é gerada para todas as suposições e taxas cambiais não modeladas e não cubo. Esta família abrangente tem ID = 0.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome da família de dimensões. A família composta por todas as suposições não de cubo e contas de taxa cambial (que não têm dimensões) terá o nome "*". A família de dimensões de uma planilha padrão tem o mesmo nome da planilha padrão, enquanto a família de dimensões de uma planilha de cubo ou modelada usa o prefixo da planilha como nome de família.	Capital
ID	S	A ID da família de dimensões, que é a ID da planilha pela qual essa família é descrita.	3
contas	S	O conjunto de números de ID de conta que pertencem a esta família. As IDs são as IDs do sistema interno das contas, visíveis na chamada à API exportAccounts. As IDs são separadas por vírgulas e podem conter intervalos hifenizados, que indicam que todas as IDs dentro do intervalo estão incluídas.	734-739,744
dimensões	S	O conjunto de números de ID de dimensão que pertencem a esta família. As IDs são as IDs do sistema interno das dimensões, visíveis na chamada à API exportDimensions. As IDs são separadas por vírgulas e podem conter intervalos hifenizados, que indicam que todas as IDs dentro do intervalo estão incluídas.	9321,9422,9455,9458
Conteúdo do elemento
(nenhum)