exportDimensions
Esta API solo admite usuarios Concepto: reglas de acceso en API v22 y superior.
Categoría
| Metadata retrieval |
Descripción
| Devuelve los metadatos de la lista completa de todas las dimensiones del sistema. |
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 el conjunto completo de dimensiones personalizadas del sistema, incluidos todos sus valores de miembro. Este método no devuelve ninguna de las dimensiones de sistema obligatorias, como Versión, Tiempo o Cuentas, cada una de las cuales está disponible en su propia llamada API de metadatos. Los valores de miembro de una dimensión se devuelven en forma de árbol, y los miembros principales contienen a sus elementos secundarios.
Puede buscar IDs de dimensión mediante un
exportDimensions
solicitud sin elemento dimensionIDs. Esto genera una lista de todas las dimensiones y sus IDs. Revise la respuesta para buscar los IDs de dimensión que necesita. Los IDs de dimensión no están disponibles en la Adaptive Planning
interfaz de usuario web.Formato de solicitud
<?xml version='1.0' encoding='UTF-8'?> <call method="exportDimensions" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <include versionName="Budget 2004" dimensionIDs="1,2,4,5" dimensionValues="true"/> </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 llamada a la API se lleve a cabo. 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) | |||
incluir elemento
| |||
Nombre de etiqueta
| incluir | ||
Descripción
| Representa un conjunto de indicadores que indican qué aspectos de la información de "valores de dimensión" deben incluirse o excluirse de la respuesta. Este elemento es opcional: si no está presente, el valor por defecto está en blanco (o todas las versiones) para versionName/versionID. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
versionName Actualizado en API v18 | No | Indica si la respuesta debe excluir los valores de dimensión que no están disponibles para el nombre de versión solicitado. El valor por defecto, si el elemento o su atributo no está presente, es devolver todas las dimensiones y valores. Si se especifica un nombre de versión, no se devolverán los valores de dimensión que no estén disponibles para la versión especificada. Si no se encuentra el nombre de versión especificado, esta API devuelve un error. Si se pasan los atributos versionName y versionID, se ignora el valor de versionID. <?xml version='1.0' encoding='UTF-8'?> <response Success="true"> <output> <dimensions> <dimension id="6" name="Department" shortName="" autoCreate=" 0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35"> <dimensionValue id="7" name="Engr" description="Ingeniería" shortName=""> <dimensionValue id=" 52" name="QA" description="Control de calidad" shortName="" /> <dimensionValue id="53" name="Dev" description="Desarrollo" shortName="" /></dimensionValue> </dimension> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" seqNo="21"> <dimensionValue id="32" name ="Graduado" description="Graduado" shortName=""> <attributes> <attributeAttributeId="21" name="Education Type" valueId="197" value="Tech1" /> </attributes> </dimensionValue > <dimensionValue id="33" name="Máster" description="Máster" shortName=""> <attributes> <attribute atributoId="21" name="Tipo de estudios" valueId="196" value="Gestión" /> </atributo tes> </dimensionValue> <dimensionValue id="34" name="Phd" description="Phd" shortName="" /> </dimension> </dimensions> </output> </response> Al especificar una versión, la llamada solo se realizará correctamente si el usuario tiene acceso a la versión. | Presupuesto 2004 |
versionID Admitido en API v17 + Actualizado en API v18 | No | Igual que versionName (anterior), excepto que se toma un número de ID de versión como parámetro. Indica si la respuesta debe excluir los valores de dimensión que no están disponibles para la versión solicitada. El valor por defecto, si el elemento o su atributo no está presente, es devolver todas las dimensiones y valores. Si se especifica un ID de versión, no se devolverán los valores de dimensión que no estén disponibles para la versión especificada. Si no se encuentra el ID de versión especificado, esta API devuelve un error. Si se pasan los atributos versionName y versionID, se ignora el valor de versionID. Al especificar una versión, la llamada solo se realizará correctamente si el usuario tiene acceso a la versión. | 3 |
dimensionIDs Compatible con API v17 + | No | Una lista de IDs que aparecerán en la respuesta de API. Esto filtra por una dimensión, pero no por un valor de dimensión. | "1,2,3,14" |
atributos | No | Indica si la respuesta debe incluir los atributos de la respuesta para cada dimensión plana. | falso |
inaccessibleValues Compatible con API v18 + | No | Indica si la respuesta debe incluir valores inaccesibles para el usuario actual. El valor por defecto es falso. Solo los usuarios con los permisos "Modelado" o "Importar a todos los niveles" pueden definir esta opción como verdadera. | 1 |
dimensionValues Compatible con API v22+ | No | Indica si la respuesta debe incluir valores de dimensión para cada dimensión. El valor por defecto es verdadero. Si se establece en falso, solo devuelve las dimensiones filtradas, no los valores de dimensión. Si dimensionValues no forma parte del elemento de inclusión, devuelve todas las dimensiones y sus valores. Si el elemento de inclusión no forma parte de la solicitud, se devolverán todas las dimensiones y sus valores. | falso |
displayNameEnabled
Solo está disponible en API v30+ para instancias que activan el nombre de visualización. | No | displayNameEnabled=true indica que exportDimensions debe respetar las propiedades de nombre de visualización de code , displayNameType y description cuando Activar nombre de visualización está activado para la instancia.displayNameEnabled=false indica que la API exportDimensions debe seguir el contrato de la API anterior a la v30 aunque la opción Activar nombre de visualización esté activada para la instancia. La API exportDimensions ignora las propiedades de nombre de visualización code , displayNameType y description .El valor por defecto de displayNameEnabled es "false". | verdadero |
Contenido del elemento
| |||
(ninguno) | |||
Formato de respuesta
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <dimensions> <dimension id="6" name="Department" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35"> <dimensionValue id="7" name="Engr" description="Engineering" shortName=""/> <dimensionValue id="52" name="QA" description="Quality Assurance" shortName=""/> <dimensionValue id="53" name="Dev" description="Development" shortName=""/> </dimension> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" seqNo="21"> <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" /> </attributes> </dimensionValue> <dimensionValue id="33" name="Masters" description="Masters degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="196" value="Management" /> </attributes> </dimensionValue> <dimensionValue id="34" name="Phd" description="Phd" shortName=""/> </dimension> <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" seqNo="14" property1="Latitude" property2="Longitude"> <dimensionValue id="521" name="United States" description="USA" shortName=""> <dimensionValue id="555" name="Alabama" description="1" shortName=""> <dimensionValue id="579" name="205" description="1" shortName=""> <dimensionValue id="4718" name="35004" description="1" shortName=""> <properties> <property name="Latitude" value="33.606" /> <property name="Longitude" value="-86.502" /> </properties> </dimensionValue> <dimensionValue id="4719" name="35005" description="" shortName=""> <properties> <property name="Latitude" value="33.593" /> <property name="Longitude" value="-86.96" /> </properties> </dimensionValue> <dimensionValue id="5073" name="35006" description="" shortName="" /> <dimensionValue id="5074" name="35007" description="" shortName="" /> </dimensionValue> </dimensionValue> <properties> <property name="Latitude" value="37.0902" /> <property name="Longitude" value="95.7129" /> </properties> </dimensionValue> </dimension> </dimensions> </output> </response>
Las dimensiones se ordenan por nombre.
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 dimensiones
| |
Nombre de etiqueta
| dimensiones |
Descripción
| Contenedor para uno o varios elementos de dimensión. |
Atributos del elemento
| |
(ninguno) | |
Contenido del elemento
| |
Uno o varios elementos de dimensión. | |
elemento de dimensión
| |||
Nombre de etiqueta
| dimensión | ||
Descripción
| Representa una sola dimensión personalizada que se devuelve en la respuesta a una llamada a la API exportDimensions. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
ID | Sí | El número de ID de sistema interno para la dimensión. Esto se puede utilizar para identificar dimensiones en otras llamadas a la API, como exportDimensionFamilies. | 16 |
nombre | Sí | El nombre de la dimensión, tal como aparece en informes y hojas. | Cliente |
código
Solo disponible en API v39+. | No | El nombre de la dimensión, tal como aparece en informes y hojas. Solo se mostrará con API v39+ | Cliente |
displayNameType
Solo está disponible en API v30+ para instancias que activan el nombre de visualización. | No | La representación interna del formato de nombre de visualización seleccionado para los valores en las páginas Administración de dimensiones.
| NOMBRE |
shortName | No | El nombre corto de la dimensión, si lo hay, tal como se ha introducido en Administración de dimensiones. | cliente |
creación automática | Sí | 1 si la dimensión seleccionada tiene definido el campo "La importación de datos crea automáticamente valores de dimensión"; 0 en caso contrario. | 0 |
listDimension | Sí | 1 si la dimensión seleccionada es una dimensión de lista, 0 en caso contrario. | 1 |
keepSorted | Sí | 1 si la dimensión seleccionada se mantiene ordenada, 0 en caso contrario. | 1 |
useOnLevels | Sí | 1 si la dimensión seleccionada se puede utilizar en niveles; 0 en caso contrario. | 1 |
seqNo Añadido en API v17, pero reservado para uso futuro. | |||
descripción
Solo está disponible en API v30+ para instancias que activan el nombre de visualización. | No | La descripción tal como se ha introducido en Administración de dimensiones. | |
Contenido del elemento
| |||
Cero o más elementos dimensionValue. Cada elemento dimensionValue incluido representa un valor de dimensión raíz en la dimensión, un valor que no tiene ningún valor principal. | |||
dimensionValue element
| |||
Nombre de etiqueta
| dimensionValue | ||
Descripción
| Representa un valor de miembro único de una dimensión personalizada que se devuelve en la respuesta a una llamada a la API exportDimensions. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
ID | Sí | El número de ID de sistema interno para este valor de miembro de la dimensión. | 34 |
código
Solo está disponible en API v30+ para instancias que activan el nombre de visualización. | No | El código del valor de miembro de la dimensión, si lo hay, tal como se ha introducido en Administración de dimensiones. | Empresa A |
nombre | Sí | La etiqueta del valor de miembro de la dimensión, tal como se muestra en los informes y se utiliza en las fórmulas. | Empresa A |
displayName
Solo está disponible en API v30+ para instancias que activan el nombre de visualización. | No | El nombre de visualización del valor de miembro, derivado de displayNameType. | Empresa A |
shortName | No | El nombre corto del valor de dimensión, si lo hay, tal como se ha introducido en Administración de dimensiones | A |
descripción | No | La descripción del valor de dimensión, si lo hay, tal como se ha introducido en Administración de dimensiones | Corporación A |
Contenido del elemento
| |||
Cero o más elementos dimensionValue opcionales. Cada elemento dimensionValue incluido representa un "valor de dimensión secundario" de este valor de dimensión, cuyos miembros se agrupan implícitamente en este valor. Un elemento de propiedades opcional. | |||
elemento de propiedades
| |||
Nombre de etiqueta
| propiedades | ||
Descripción
| Elemento opcional que contiene elementos de propiedad. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
(ninguno) | |||
Contenido del elemento
| |||
Hasta cinco elementos de propiedad. | |||
elemento de propiedad
| |||
Nombre de etiqueta
| propiedad | ||
Descripción
| Especifica una propiedad personalizada. Los valores de los elementos de propiedad solo contienen caracteres numéricos. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
nombre | Sí | El nombre de la propiedad. | Latitud |
valor | No | El valor de la propiedad. | 33,6015 |
Contenido del elemento
| |||
(ninguno) | |||
elemento de atributos
| |||
Nombre de etiqueta
| atributos | ||
Descripción
| Contenedor para uno o varios elementos de atributo de dimensión. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
(ninguno) | |||
Contenido del elemento
| |||
Uno o varios elementos de atributo | |||
elemento de atributo
| |||
Nombre de etiqueta
| atributo | ||
Descripción
| Contenedor para un elemento de atributo de dimensión. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
attributeID | Sí | El ID del atributo de dimensión generado por el sistema. | 20 |
nombre | Sí | El nombre del atributo de dimensión | Tipo de estudios |
valueID | Sí | El ID exclusivo del valor de atributo de dimensión generado por el sistema. | 170 |
valor
Se admite en API v34 cuando el parámetro Nombre de visualización efectivo está activado. | Sí | El valor del atributo de dimensión. | Tech1 |
valueCode
Solo está disponible en API v32 y API v33 para instancias que activan el nombre de visualización. No se admite en API v34. | No | El código de valor de atributo para este atributo.
Para API v32 y API v33, valueCode solo es significativo cuando:
| Tech1 |
valueName
Solo está disponible en API v32 y API v33 para instancias que activan el nombre de visualización. No se admite en API v34. | No | El nombre de valor de atributo para este atributo.
Para API v32 y API v33, valueName solo es significativo cuando:
| Tech1 |
valueDisplayName
Solo está disponible en API v32+ para instancias que activan el nombre de visualización. | Sí | Para API v32 y posteriores, valueDisplayName solo es significativo cuando:
| Tech1 |
Contenido del elemento
| |||
(ninguno) | |||