exportSheetDefinition

Formato de solicitud de hoja 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>

El elemento de llamada contiene un elemento de credenciales, así como una sola hoja modelada.

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 para realizarla correctamente.
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)

elemento de hoja modelada
Nombre de etiqueta		hoja modelada
Descripción		Identifica una sola hoja modelada solicitada mediante una llamada a la API exportSheetDefinition.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno de la hoja.	234
displayNameEnabled Solo está disponible en API v31+ para instancias que activan el nombre de visualización.	No	displayNameEnabled=true indica que exportSheetDefinition 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 exportSheetDefinition 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 exportSheetDefinition ignora las propiedades code , displayNameType y description . El valor por defecto de displayNameEnabled es "false".	falso
Contenido del elemento
(ninguno)

Formato de respuesta de hoja 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>

El elemento de hoja modelada contiene un elemento secundario de una sola columna que contiene uno o más de los siguientes en el orden definido para la hoja:

niveles

dimensión

text-selector

text

número

date

saldo-inicial

nivel-moneda

mostrar

marco temporal

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 por Adaptive Planning . 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 hoja modelada
Nombre de etiqueta		hoja modelada
Descripción		Representa una sola hoja modelada que se devuelve en respuesta a una llamada a la API export-Sheets.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno de la hoja. Esto se puede usar para identificar hojas en otras llamadas a la API, como exportSheetDefinition.	234
prefijo	Sí	El prefijo de la hoja.	Capital
nombre	Sí	El nombre de la hoja.	Modelo de capital
disponibles en cifras reales	Sí	Puede ser verdadero o falso. Indica si la hoja modelada está disponible en la versión de cifras reales o no.	verdadero
descripción	No	La descripción textual de la hoja, si la hay.	Este es el modelo de capital...
allow-splits	Sí	Verdadero significa que la hoja modelada permite divisiones.	verdadero
split-column-title	No	El título de la columna adicional para importar cuando la opción Permitir divisiones está activada. Utilice una cadena localizada si se especifica una configuración regional en la solicitud. Este atributo solo está presente cuando allow-splits se establece en verdadero y al menos una columna se puede dividir.	Es división de fila secundaria
strataId	Sí	El ID de estrato asociado a esta hoja modelada	2
Contenido del elemento
Un solo elemento de columnas.

elemento de columnas
Nombre de etiqueta		columnas
Descripción		Contenedor para uno o varios elementos de columna.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios de los siguientes elementos, ordenados tal y como aparecen en la hoja: niveles dimensión text-selector text número date saldo-inicial nivel-moneda mostrar marco temporal

elemento de niveles
Nombre de etiqueta		niveles
Descripción		Representa la columna "nivel" en una hoja modelada. Contenedor para uno o varios elementos de nivel.
Atributos del elemento
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna.	falso
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	verdadero
Contenido del elemento
Uno o varios elementos de nivel

elemento de nivel
Nombre de etiqueta		nivel
Descripción		Uno de los niveles definidos para esta empresa que está en esta hoja (o en el que se ha colocado esta hoja). Los metadatos de nivel, incluida la estructura jerárquica, se pueden obtener mediante una llamada a exportLevels.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Identificador numérico interno para el nivel.	42
Contenido del elemento
(ninguno)

elemento de texto
Nombre de etiqueta		text
Descripción		Representa una columna de la hoja que contiene texto introducido por el usuario.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna.	falso
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	falso
Contenido del elemento
(ninguno)

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Una de las dimensiones definidas para esta empresa. Representa una columna de la hoja que contiene la dimensión.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna.	falso
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	falso
Contenido del elemento
Uno o varios elementos de valor, cada uno de los cuales es un valor seleccionable válido en la dimensión de esta hoja. Si un valor de la dimensión no se incluye aquí, ese valor no se puede usar en las filas de datos de esta hoja.

elemento de valor
Nombre de etiqueta		valor
Descripción		Uno de los valores definidos para esta dimensión o selector de texto. Los metadatos de dimensión completos, incluida su estructura jerárquica, se pueden obtener mediante una llamada independiente a exportDimensions.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Identificador numérico interno para el valor.	42
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.	México
nombre	Sí	Representación impresa del valor.	México
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.	México
Contenido del elemento
(ninguno)

elemento de selector de texto
Nombre de etiqueta		text-selector
Descripción		Lista personalizada de valores definidos para esta hoja. Representa una columna de selector de texto en una hoja modelada.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna.	falso
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	verdadero
ID	Sí	Identificador numérico interno.	42
Contenido del elemento
Uno o varios elementos de valor

elemento de número
Nombre de etiqueta		número
Descripción		Representa una columna de la hoja que contiene un número introducido por el usuario.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna.	falso
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	falso
Contenido del elemento
(ninguno)

elemento de fecha
Nombre de etiqueta		date
Descripción		Representa una columna de la hoja que contiene una fecha introducida por el usuario.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna.	falso
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	falso
Contenido del elemento
(ninguno)

elemento de saldo inicial
Nombre de etiqueta		saldo-inicial
Descripción		Representa una columna de la hoja que contiene un valor proporcionado por el usuario para el saldo inicial de una cuenta con una fórmula que determina el cambio mensual en el valor de la cuenta.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna.	falso
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	falso
ID	Sí	Identificador numérico interno de la cuenta asociada a esta columna.	42
Contenido del elemento
(ninguno)

elemento de moneda de nivel
Nombre de etiqueta		nivel-moneda
Descripción		Representa una columna de la hoja que muestra el código de la moneda asociada a cada fila. Esta es la moneda del nivel en el que se encuentra la fila.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna. En el caso de los elementos de nivel de moneda, este valor siempre es verdadero.	verdadero
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	falso
ID	Sí	Identificador numérico interno.	42
Contenido del elemento
(ninguno)

elemento de visualización
Nombre de etiqueta		mostrar
Descripción		Representa una columna de la hoja que contiene un cálculo de solo lectura basado en filas.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna.	falso
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	falso
ID	Sí	Identificador numérico interno.	42
Contenido del elemento
(ninguno)

elemento de marco temporal
Nombre de etiqueta		marco temporal
Descripción		Como máximo una por hoja, esto representa un conjunto de columnas de marco temporal, que aparecen a la derecha de la hoja y pueden contener datos periódicos.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	Un identificador simbólico para la columna, que se utiliza en fórmulas y referencias de hoja.	MyColumn
nombre	Sí	Título visualizable de la columna, tal como se ve en la hoja.	Mi columna
solo lectura	Sí	Verdadero si la columna está marcada como de solo lectura en la hoja, falso si se pueden introducir valores en la columna.	falso
divisible	Sí	Verdadero si las divisiones de filas pueden tener valores diferentes para esta columna, falso si las divisiones deben tener el mismo valor que su elemento principal.	verdadero
obligatorio	Sí	Verdadero si este atributo es un campo obligatorio.	falso
ID	Sí	Identificador numérico interno de la cuenta asociada a este marco temporal.	42
Contenido del elemento
(ninguno)

Formato de solicitud de hoja 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>

El elemento de llamada contiene un elemento de credenciales, así como una sola hoja de cubo.

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 para realizarla correctamente.
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 un conjunto de permisos que contenga los permisos necesarios para el método que se invoca.	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 formatear 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)

elemento de hoja de cubo
Nombre de etiqueta		hoja-cúbica
Descripción		Identifica una sola hoja de cubo solicitada mediante una llamada a la API exportSheetDefinition.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno de la hoja.	234
Contenido del elemento
(ninguno)

Formato de respuesta de hoja 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>

El elemento cube-sheet contiene un elemento secundario de una sola dimensión que contiene las siguientes dimensiones en el orden definido para la hoja:

dimensión (una o varias)

atributo (cero o más)

niveles (uno)

cuentas (una)

tiempo (uno)

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 por Adaptive Planning . 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
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Un solo elemento de hojas de cubo obligatorio. 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 hoja de cubo
Nombre de etiqueta		hoja-cúbica
Descripción		Representa una sola hoja de cubo que se devuelve en respuesta a una llamada a la API exportSheets.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID		El número de ID de sistema interno de la hoja. Esto se puede usar para identificar hojas en otras llamadas a la API, como exportSheetDefinition.	34
prefijo		El prefijo de la hoja.	ExpenseCube
nombre		El nombre de la hoja.	Cubo de gastos
descripción		La descripción textual de la hoja, si la hay.
strataId	Sí	El ID de estrato de la hoja.	5
horizontalAxis	Sí	El ID de la dimensión que se mostrará en el eje horizontal por defecto.	-3
verticalAxis	Sí	La lista de IDs de dimensión que se mostrarán en el eje vertical por defecto.	-2
maxColumnWidth	Sí	El ancho máximo en píxeles para las columnas (cero si no se especifica).	20
suppressZeroRows	Sí	"1" si se suprimen cero filas, "0" si no lo están.	suppressZeroRows="0"
rerangeGLAndCustomAccounts	Sí	"1" si la hoja de cubo va a utilizar el Tratamiento de cuentas de libro mayor, "0" si no lo es.	rearrangeGLAndCustomAccounts="0"
hideRollupTotals	Sí	"1" si los totales de agrupación deben estar ocultos, "0" si no lo están.	hideRollupTotals="0"
Contenido del elemento
(ninguno)

elemento de dimensiones
Nombre de etiqueta		dimensiones
Descripción		Contenedor de las dimensiones de la hoja.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios niveles, dimensiones, cuentas y elementos de periodo.

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Una de las dimensiones definidas para esta hoja de cubo.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El identificador numérico interno de la dimensión.	34
sin categorizar	Sí	Verdadero significa que el elemento sin categorizar de la propia dimensión (el elemento raíz sin categorizar) está disponible como selección en el cubo.	verdadero
agrupación	Sí	Verdadero significa que el elemento de agrupación de la propia dimensión (la agrupación de todos los elementos) está disponible como selección en el cubo.	verdadero
nombre Disponible en API v22+	Sí	Nombre de esta dimensión.	Ítem de producto
Contenido del elemento
Uno o varios elementos de valor, que indican qué valores de dimensión están disponibles en la hoja.

elemento de atributo
Nombre de etiqueta		atributo
Descripción		Uno de los atributos colocados en esta hoja de cubo. Los metadatos de atributo, incluida su estructura jerárquica, se pueden obtener mediante una llamada a exportAttributes.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El identificador numérico interno del atributo.	34
sin categorizar	Sí	Verdadero significa que el elemento sin categorizar del propio atributo (el elemento raíz sin categorizar) está disponible como selección en el cubo.	verdadero
agrupación	Sí	Verdadero significa que el elemento de agrupación del propio atributo (la agrupación de todos los elementos) está disponible como selección en el cubo.	verdadero
nombre Disponible en API v22 +	Sí	El nombre del atributo.	Tipo de tienda
newValueBehavior	Sí	Comportamiento esperado para la disponibilidad del nuevo valor de dimensión, ya sea disponible, no disponible o principal.	principal
Contenido del elemento
Uno o varios elementos de valor, que indican qué valores del atributo están disponibles en la hoja.

elemento de valor
Nombre de etiqueta		valor
Descripción		Uno de los valores de esta dimensión que se ha marcado como disponible en la hoja. El mismo ID de valor puede aparecer hasta dos veces: con y sin sin categorizar definido como verdadero. Los metadatos de dimensión, incluida su estructura jerárquica, se pueden obtener mediante una llamada a exportDimensions.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Identificador numérico interno para el valor de dimensión.	34
agrupación	No	true indica la agrupación de este valor de dimensión. Solo se permite si el valor tiene valores secundarios en la dimensión. Si falta el atributo, se utiliza false.	verdadero
sin categorizar	No	true indica el valor sin categorizar de este valor de dimensión. Solo se permite si el valor tiene valores secundarios en la dimensión. Si falta el atributo, se utiliza false.	verdadero
Contenido del elemento
(ninguno)

elemento de niveles
Nombre de etiqueta		niveles
Descripción		Contenedor obligatorio para uno o varios elementos de nivel. Se devuelven niveles individuales, aunque solo afecten a la visibilidad. Los datos se pueden importar a cualquier nivel.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios elementos de nivel

elemento de nivel
Nombre de etiqueta		nivel
Descripción		Un nivel que se encuentra en esta hoja, en el que aparece esta hoja. Los metadatos de nivel, incluida su estructura jerárquica, se pueden obtener mediante una llamada a exportLevels.
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Identificador numérico interno para el nivel.	12
Contenido del elemento
(ninguno)

elemento de cuentas
Nombre de etiqueta		cuentas
Descripción		Contenedor obligatorio para uno o varios elementos de cuenta. Se devuelven cuentas individuales, aunque solo afecten a la visibilidad. Los datos se pueden importar a cualquier cuenta de entrada.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios elementos de cuenta Elementos de cuenta disponibles y orden determinados por la opción Utilizar tratamiento de cuenta de libro mayor en las propiedades de la hoja de cubo.

elemento de cuenta
Nombre de etiqueta		cuenta
Descripción		Una de las cuentas definidas para esta hoja de cubo. Los metadatos de la cuenta, incluida su estructura jerárquica, se pueden obtener mediante una llamada a exportAccounts.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Identificador numérico interno de la cuenta.	23
código Disponible en API v22+	No	El código de cuenta de la cuenta.	SalesCubeWithAttribute.Unit_Price
Contenido del elemento
(ninguno)

elemento de periodo
Nombre de etiqueta		time
Descripción		Dimensión temporal aplicada.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
initialBalance	Sí	Verdadero si la dimensión temporal tiene un valor de saldo inicial.	"verdadero"
visibleTimeStratumCodes	No	Lista de códigos de estrato temporal seleccionados por dimensión temporal.	"trimestre,mes,año"
(ninguno)
Contenido del elemento
(ninguno)

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Una de las dimensiones definidas para esta hoja de cubo.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El identificador numérico interno de la dimensión.	34
sin categorizar	Sí	Verdadero significa que el elemento sin categorizar de la propia dimensión está disponible como selección en el cubo.	verdadero
agrupación	Sí	Verdadero significa que el elemento de agrupación de la propia dimensión (la agrupación de todos los elementos) está disponible como selección en el cubo.	verdadero
nombre	Sí	Nombre de esta dimensión.	"Ítem de producto"
newValueBehavior	Sí	Comportamiento esperado para la disponibilidad del nuevo valor de dimensión, ya sea disponible, no disponible o principal.	principal
isEditableOnSheet	No	Marca que indica si esta dimensión se puede editar en la hoja.	verdadero
(ninguno)
Contenido del elemento
Uno o varios elementos de valor

elemento de usuarios
Nombre de etiqueta		usuarios
Descripción		Contenedor de hojas asignadas al usuario que indican las propiedades de accesibilidad de una hoja de cubo. El usuario que llama necesita el permiso Modelo para ver este elemento y todos los elementos secundarios de este elemento.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
isExcludedFromWorkflow	Sí	Marca que indica si una hoja se excluye o no del flujo de trabajo.	verdadero
Contenido del elemento
Uno o varios elementos de usuario

elemento de usuario
Nombre de etiqueta		usuario
Descripción		Uno de los usuarios asignados a la hoja.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Valor entero que indica el ID exclusivo de un usuario asignado.	11
Contenido del elemento
(ninguno)

Categoría	Metadata retrieval
Descripción	Devuelve la definición de la hoja modelada o de cubo determinada.
Permisos obligatorios para invocar	IMP (importar datos) o MOD (crear, editar y eliminar hojas)
Parámetros obligatorios bajo petición	Credenciales y una especificación de la hoja que se solicita.