exportDimensionFamilies

Categoría	Metadata retrieval
Descripción	Devuelve metadatos que describen las relaciones entre los conjuntos de cuentas y los conjuntos de dimensiones.
Permisos obligatorios para invocar	Ninguna (deben ser credenciales válidas para la instancia)
Parámetros obligatorios bajo petición	Credenciales

La solicitud de este método solo contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. Una vez verificado, el método devuelve un documento XML que describe un conjunto de familias de dimensiones, que describen cómo se relacionan conjuntos específicos de dimensiones con conjuntos de cuentas específicos. Cada familia consta de un conjunto de cuentas y un conjunto de dimensiones, lo que indica que esas dimensiones se aplican a esas cuentas, mientras que otras dimensiones no. Las cuentas y las dimensiones pueden pertenecer a muchas familias. Las familias se definen de la siguiente manera:

Las cuentas de una hoja modelada pertenecen a una familia de esa hoja, que contiene todas las dimensiones colocadas en esa hoja y todas las dimensiones de organización.

Las cuentas de una hoja de cubo pertenecen a una familia de esa hoja, que contiene todas las dimensiones colocadas en esa hoja y todas las dimensiones de organización.

Las cuentas de una hoja estándar con dimensiones pertenecen a una familia de esa hoja, que contiene todas las dimensiones colocadas en esa hoja y todas las dimensiones de organización.

Las hojas estándar que no tienen dimensiones insertadas no tienen una familia de dimensiones asociada.

Formato de solicitud


<?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 credenciales
Nombre de etiqueta		credenciales
Descripción		Todas las llamadas a la API deben contener un único elemento de credenciales para identificar al usuario que invoca la API. A continuación, la llamada a la API se realiza como este usuario (cualquier pista de auditoría o historial de acciones en el sistema mostrará que este usuario ha realizado la acción) y, por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción a fin de que la API llamada correcta.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
inicio de sesión	Sí	El nombre de conexión del usuario que invoca el método API. Este usuario debe tener los permisos necesarios para invocar el método.	sampleuser@company.com
contraseña	Sí	La contraseña del usuario que invoca el método API.	my_password
configuración regional	No	Especifique la configuración regional que se utilizará para interpretar los números y las fechas de entrada, y para dar formato a los números y las fechas de salida (utilizando el separador de miles, los nombres de mes y el formato de fecha adecuados). La configuración regional también se utiliza para especificar el idioma en el que deben aparecer los mensajes del sistema en la respuesta. Si no se especifica, se utiliza en_US (inglés americano).	fr_FR
instanceCode	No	Si el usuario especificado en las credenciales tiene acceso a más de una instancia de Adaptive Planning , este atributo se puede utilizar para especificar que el usuario tiene la intención de acceder a una instancia distinta a la instancia por defecto. Si no se especifica, se utilizará la instancia por defecto del usuario. Para determinar los códigos de instancia disponibles, utilice la API exportInstances.	MYINSTANCE1
Contenido del elemento
(ninguno)

Formato de respuesta


<?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 respuesta
Nombre de etiqueta		respuesta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	Verdadero o falso, que indica si la llamada a la API se ha realizado correctamente o no. Incluso las llamadas correctas pueden contener mensajes de aviso en su respuesta.	verdadero
obsoleto	No	Si está presente en la etiqueta de respuesta y se establece en verdadero, este atributo indica que la versión del método o API que se está invocando ha quedado obsoleta y está oficialmente desaprobada. Aunque sigue funcionando en este momento, es posible que deje de funcionar en un breve periodo de tiempo. Normalmente, este atributo no está presente.	falso
Contenido del elemento
Un único elemento de mensajes opcional y exactamente un elemento de resultado obligatorio.

elemento de resultado
Nombre de etiqueta	salida
Atributos del elemento
(ninguno)
Contenido del elemento
Un solo elemento de cuentas Este contenedor de salida es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta.

elemento de familias
Nombre de etiqueta		familias
Descripción		Contenedor para uno o varios elementos de familia.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios elementos de familia.

elemento de familia
Nombre de etiqueta		familia
Descripción		Describe una sola familia de dimensiones asociada a una sola hoja modelada o de cubo. También se genera una sola familia para todos los supuestos y tipos de cambio no modelados ni de cubo. Esta familia comodín tiene el ID = 0.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre de la familia de dimensiones. La familia compuesta por todos los supuestos que no son de cubo y las cuentas de tipo de cambio (que no tienen dimensiones) tendrá el nombre "*". La familia de dimensiones de una hoja estándar tiene el mismo nombre que la hoja estándar, mientras que la familia de dimensiones de una hoja de cubo o modelada utiliza el prefijo de la hoja como nombre de familia.	Capital
ID	Sí	El ID de la familia de dimensiones, que es el ID de la hoja que describe esta familia.	3
cuentas	Sí	El conjunto de números de ID de cuenta que pertenecen a esta familia. Los IDs son los IDs de sistema internos de las cuentas, visibles en la llamada a la API exportAccounts. Los ID están separados por comas y pueden contener rangos con guiones, lo que indica que se incluyen todos los ID dentro del rango.	734-739,744
dimensiones	Sí	El conjunto de números de ID de dimensión que pertenecen a esta familia. Los IDs son los IDs de sistema internos de las dimensiones, visibles en la llamada a la API exportDimensions. Los ID están separados por comas y pueden contener rangos con guiones, lo que indica que se incluyen todos los ID dentro del rango.	9321,9422,9455,9458
Contenido del elemento
(ninguno)