Definición de hoja de cubo

Punto final de URL

VERB HTTP admitidos

PARCHE

URI de solicitud

/sheet/cube/definition

Actualice la definición de hoja de cubo que coincida con el parámetro de consulta proporcionado. Si no existe una hoja con el nombre coincidente, se creará una nueva hoja de cubo con las propiedades proporcionadas.

Solicitud de muestra por nombre

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube

Cabecera de solicitud de muestra

Accept-Language: es

Cuerpo de solicitud de muestra

Consulte la sección Cuerpo de solicitud

Parámetros de consulta

Nombre	Descripción	Obligatorias
instanceCode	El instanceCode de donde se van a recuperar los valores. Por ejemplo, GLOBO. Si no se especifica instanceCode, se utiliza la instancia por defecto del usuario.	No
nombre	El nombre de la hoja.	No
reorderColumns	Si se establece este parámetro de consulta como verdadero, se cambiará el orden de la lista de columnas para reflejar el orden de las columnas que se indica en el cuerpo de la solicitud de la API. Por defecto, se establece en falso. Consulte Reference: Re-ordering Columns for Modeled and Cube Sheet Definition JSON APIs.	No

Cuerpo de solicitud

Cuerpo de solicitud de muestra

Se utiliza el mismo formato de definición de hoja de cubo como carga útil JSON para ambos puntos finales.

Formato de solicitud

{ "properties": { "description": "Expense Cube", "prefix": "Expense", "horizontalAxis": { "type": "level" }, "verticalAxis": [ { "type": "account" }, { "type": "dimension", "name": "ProductFurniture" } ] }, "columns": [ { "properties": { "name": "Base Pay", "type": "dimension" }, "availability":List<SheetAvaliabilityDTO>, "defaultAvailability": false } ], "accounts": [ { "name": "AccountName", "code": "AccountCode" } ], "accessibility": { "usernames": [ "test@greenco.com" ], "excludedFromWorkflow": true } }

Solicitud de ejemplo:

Ejemplo de solicitud de creación de hoja

{ "properties": { "description": "Test description", "prefix": "TestPrefix", "horizontalAxis": { "type": "level" }, "verticalAxis": [ { "type": "account" }, { "type": "dimension", "name": "Base Pay" } ] }, "columns": [ { "properties": { "type": "Account" }, "defaultAvailability": true }, { "properties": { "type": "Level" }, "defaultAvailability": true }, { "properties": { "type": "Time" } }, { "properties": { "name": "Base Pay", "type": "dimension" }, "defaultAvailability": true } ], "accounts": [ { "name": "AccountName", "code": "AccountCode", "type": "Standard" } ] }

Objeto de definición de hoja

Nombre	Descripción	Obligatorias
propiedades	Objeto que contiene propiedades generales de hoja	No
columnas	Lista de objetos de columna de hoja de cubo.	No
cuentas	Lista de objetos de cuenta	No
accesibilidad	Objeto que contiene la definición de accesibilidad de la hoja asignada al usuario.	No

Objeto de propiedades de hoja

Nombre	Descripción	Obligatorias	Tipo	Valor por defecto
descripción	Descripción de hoja	No	cadena	Cadena vacía
prefijo	Prefijo de hoja utilizado para el código de cuenta.	No	cadena
userAssigned	Si la hoja es una hoja asignada al usuario o (por defecto) una hoja asignada a nivel.	No	booleano	falso
timeStratumCode	El código de estrato temporal asociado a los datos de la hoja.	No	cadena	Estrato temporal de libro mayor
recalculateOnDemand	Si el recálculo bajo demanda está activado para la hoja.	No	booleano	falso
rerangeGLAndCustomAccounts	Si los usuarios pueden reorganizar las cuentas de cubo introducidas con otras cuentas de cubo. Esta opción solo se puede activar cuando existen cuentas estándar de cubo o se están creando en la solicitud.	No	booleano	falso
hideRollupTotals	Si se deben ocultar los totales de agrupación para mejorar el rendimiento de la hoja.	No	booleano	falso
horizontalAxis	Objeto de referencia de columna que identifica la columna en el eje horizontal.	No	objeto de columna	Periodo
verticalAxis	Lista de objetos de referencia de columna que identifican las columnas en el eje vertical. Si se proporciona, el eje vertical sobrescribirá cualquier selección anterior.	No	matriz de objetos de columna	Cuenta
maxColumnWidth	El ancho máximo en píxeles para cada columna. Debe estar entre 10 y 1000, o 0 si no se especifica el ancho.	No	número entero	0
suppressZeroRows	Si se suprimen las filas cero.	No	booleano	falso

Objeto de referencia de columna de hoja

Nombre	Descripción	Obligatorias
Nombre	Nombre de columna Obligatorio para la dimensión y los atributos personalizados.	Sí
tipo	Tipo de columna	Sí

Objeto de columna de hoja

Nombre	Descripción	Obligatorias
propiedades	Objeto que contiene propiedades de columna de hoja.	Sí
disponibilidad	Lista de objetos de disponibilidad de hoja para la columna actual. Consulte Sheet Availability para obtener más información sobre el formato de la lista.	No
defaultAvailability	La disponibilidad por defecto que se aplicará a todos los valores, a menos que se especifique lo contrario en la disponibilidad. Válido para columnas de nivel y dimensión.	No
eliminar	Solicitud de eliminación de columna de la hoja dada. No es válido para columnas que dependen de columnas existentes que no están marcadas para su eliminación (como los atributos de dimensión).	No

Objeto de propiedades de columnas de hoja

Nombre	Descripción	Obligatorias	Tipo	Valor por defecto
nombre	Nombre de columna En el caso de las columnas de atributos y dimensiones personalizadas, el nombre coincidirá con el nombre de la dimensión o el atributo personalizados correspondientes.	Sí	cadena
tipo	El tipo de columna. Valores posibles: LEVEL, ACCOUNT, TIME, DIMENSION, LEVEL_ATTRIBUTE, ACCOUNT_ATTRIBUTE, DIMENSION_ATTRIBUTE	Sí	cadena
initialBalance	Si el saldo inicial será visible en la hoja. Solo es válido para columnas de periodos.	No	booleano	verdadero
visibleTimeStratumCodes	Define la lista de estratos temporales visibles en la hoja. Solo es válido para columnas de periodos.	No	matriz de cadenas	Todos los estratos temporales
editableOnSheet	Si se pueden añadir nuevos valores a la columna de dimensión desde la hoja. Solo es válido para columnas de selector de dimensión y texto.	No	booleano	falso
newValueBehavior	Define si se activan o desactivan los nuevos valores cuando se añaden a la dimensión subyacente. Solo es válido para columnas de dimensión. Valores admitidos: AVAILABLE, UNAVAILABLE o PARENT	No	cadena	DISPONIBLE

Objeto de tabla de consulta de columna de hoja

Nombre	Descripción	Obligatorias	Tipo	Valor por defecto
nombre	Nombre de tabla de consulta	Sí	cadena
displayAs	El formato Mostrar como para esta tabla de consulta. Valores posibles: NUMBER y PERCENT. Solo es válido para tablas de consulta de valores.	No	cadena	NUMBER
decimalPrecision	La precisión decimal de los valores de esta tabla de consulta. Valores posibles: del 0 al 9.	No	número entero	0
tipo	El tipo de tabla de consulta. Valores posibles: VALUE, SPREAD.	Sí	cadena

Objeto de cuenta de hoja

Para obtener más detalles, consulte Reference: Properties in Account JSON Import Payload

Nombre	Descripción	Obligatorias
nombre	El nombre de la cuenta.	Sí
código	El código de cuenta	Sí
principal	La cuenta principal	No
Tipo	El tipo de cuenta	Sí
descripción	La descripción de la cuenta.	No
shortName	El nombre corto de la cuenta.	No
isCumulative	Devuelve si la cuenta es acumulativa.	No
isPlanByDelta	Devuelve si la cuenta es un plan por delta.	No
isActualsByDelta	Devuelve si la cuenta son cifras reales por delta.	No
isLink	Muestra si la cuenta es una cuenta vinculada o no.	No
timeRollupType	El tipo de agrupación que se va a realizar para las agrupaciones de periodos.	No
timeWeightAccount	La cuenta de ponderación utilizada para las agrupaciones de periodos.	No
levelDimRollupType	El tipo de agrupación que se va a realizar para las agrupaciones de nivel/dimensión personalizada.	No
levelDimWeightAccount	La cuenta de ponderación utilizada para las agrupaciones de nivel/dimensión personalizada.	No
levelDimRollupText	El valor de texto de agrupación utilizado en agrupaciones de niveles/dimensiones personalizadas.	No
actualsOverlay	La configuración de superposición de cifras reales de la cuenta.	No
attributeValues	Lista de objetos de valor de atributo de cuenta para esta cuenta.	No
displayAs	La configuración Mostrar como de la cuenta.	No
formula	La fórmula de cuenta.	No
decimalPrecision	La precisión decimal por defecto de la cuenta.	No
exchangeRateType	La clase de tipo de cambio de esta cuenta	No
suprimirCeros	Muestra si las filas cero deben suprimirse para la cuenta en las hojas.	No
startExpanded	Devuelve si la cuenta comienza expandida en la hoja.	No
dataEntryType	La configuración del tipo de entrada de datos para esta cuenta.	No
dataPrivacy	La configuración de privacidad de datos de esta cuenta.	No
linkedAccountMappings	Lista de LinkedAccountMapping.	No

Objeto de accesibilidad de hoja

Nombre	Descripción	Obligatorias	Tipo	Valor por defecto
nombres de usuario	Lista de nombres de usuario para añadir a la hoja. Deben presentarse en forma de direcciones de correo electrónico válidas.	No	matriz de cadenas
excluidoFromWorkflow	Actualiza la casilla "Excluido de flujo de trabajo" en la configuración de accesibilidad de la hoja.	No	booleano	falso

Respuesta de muestra

204

La respuesta correcta está en blanco con el código de estado 204.

ELIMINAR

URI de solicitud

/sheet/cube/definition

Elimine la definición de hoja de cubo que coincida con el parámetro de consulta especificado. Si no existe una hoja con el identificador coincidente, se producirá el error de no encontrado.

Solicitud de muestra por nombre

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube

Cabecera de solicitud de muestra

Accept-Language: es

Cuerpo de solicitud de muestra

<None>

Parámetros de consulta

Nombre	Descripción	Obligatorias
nombre	El nombre de la hoja de cubo.	No
instanceCode	El instanceCode de donde se van a recuperar los valores. Por ejemplo, GLOBO. Si no se especifica instanceCode, se utiliza la instancia por defecto del usuario.	No

Respuesta de muestra

204

La respuesta correcta es blane con el código de estado 204.