Definición de hoja modelada

Punto final de URL

VERB HTTP admitidos

PARCHE

URI de solicitud

/sheet/modeled/definition

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

Solicitud de muestra por nombre

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/modeled/definition?name=Capital Model

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
procedaWithWarnings	Si upsert debe ignorar cualquier validación de aviso, que normalmente se devuelve cuando una propiedad de hoja modificada podría eliminar datos 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 modelada como carga útil de JSON para ambos puntos finales.

Formato de solicitud

{ "properties": { "description": "Capital Model", "prefix": "Capital" }, "columns": [ { "properties": { "code": "Base Pay", "name": "Base Pay", "type": "TEXT_SELECTOR", "values": ["value1", "value2"], "lookupTables": [ { "name": "valueLookup1", "type": "VALUE", "decimalPrecision": 1, "displayAs": "CURRENCY" }, { "name": "spreadLookup1", "type": "SPREAD", "decimalPrecision": 0, "displayAs": "NUMBER" } ] }, "availability": [ { "name": "100k", "code": "100k", "available": true } ], "defaultAvailability": false, "defaultActionIfDataIsPresent": "delete" }, { "properties": { "code": "Label", "name": "Label", "type": "TEXT" }, "delete": true } ], "accounts": [ { "name": "AccountName", "code": "AccountCode" } ], "accessibility": { "usernames": [ "test@greenco.com" ], "excludedFromWorkflow": true } }

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 modelada. Se crearán nuevas columnas al final de la definición de hoja y se respetará el orden relativo de las nuevas columnas. Las columnas existentes solo se actualizarán in situ; no se reordenarán.	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
código	Código de hoja utilizado para anteponer códigos de cuenta y un identificador exclusivo secundario. Obligatorio al crear una nueva hoja.	No	cadena
prefijo	Prefijo de hoja utilizado para el código de cuenta. Obligatorio al crear una nueva hoja. En desuso a favor del código.	No	cadena
userAssigned	Si la hoja es una hoja asignada al usuario o (por defecto) una hoja asignada a nivel.	No	booleano	falso
salaryDetail	Si la hoja contiene detalles salariales.	No	booleano	falso
frozenColumnCount		No	número entero	0
allowSplits	Si la hoja permite dividir filas.	No	booleano	falso
allowRollupModelEdits	Si la hoja permite ediciones al consultar los niveles de agrupación.	No	booleano	falso
allowActuals	Si la hoja está disponible en versiones de cifras reales.	No	booleano	falso
recalculateOnDemand	Si el recálculo bajo demanda está activado para la hoja.	No	booleano	falso
timeStratumCode	El código de estrato temporal asociado a los datos de la hoja.	No	cadena	Estrato temporal de libro mayor

Objeto de columna de hoja

Nombre	Descripción	Obligatorias	Tipo	Valor por defecto
propiedades	Objeto que contiene propiedades de columna de hoja.	Sí	objeto
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	lista
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. En el caso de las columnas de dimensión, si no se especifica la disponibilidad o la disponibilidad por defecto, la disponibilidad por defecto se establecerá en verdadero para las nuevas columnas. Por defecto, este valor estará vacío, lo que significa que la disponibilidad existente se conserva a menos que se cambie específicamente mediante la disponibilidad.	No	booleano
defaultActionIfDataIsPresent	La acción por defecto si hay datos presentes al eliminar un valor, a menos que se especifique lo contrario en la disponibilidad. Válido para columnas de dimensión. Obligatorio cuando la Disponibilidad por defecto es falsa para las columnas existentes.	No	cadena
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	booleano

Objeto de propiedades de columnas de hoja

Nombre	Descripción	Obligatorias	Tipo	Valor por defecto
nombre	Nombre de columna	No	cadena
código	El código de columna. Obligatorio para todas las columnas excepto para las columnas de nivel y de moneda de nivel.	Sí	cadena
tipo	El tipo de columna. Valores posibles: LEVEL, DIMENSION, LEVEL_ATTRIBUTE, DIMENSION_ATTRIBUTE, TIMESPAN, NUMBER, DATE, TEXT, TEXT_SELECTOR, LEVEL_CURRENCY, DISPLAY, INITIAL_BALANCE, CHECKBOX	Sí	cadena
readOnly	Si la columna actual es de solo lectura o no. En las columnas de atributos de dimensión, defina readOnly como falso para utilizar el atributo como filtro en la dimensión. Es obligatorio que sea verdadero (y el valor por defecto es verdadero) para los atributos de nivel y las columnas de visualización.	No	booleano	falso
allowSplits	Si la columna actual es divisible. Solo es válido para hojas cuando la propiedad general allowSplits es verdadera.	No	booleano	falso
showTotalsAtBottom	Si se muestran los totales en la parte inferior de la hoja para esta columna.	No	booleano	falso
allowHidden	Si esta columna se puede ocultar del visor de hojas en Opciones de visualización. Válido para todas las columnas excepto el selector de texto y las columnas de marco temporal.	No	booleano	verdadero
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
obligatorio	Si es obligatorio que cada fila tenga un valor en esta columna. Solo es válido para columnas de dimensión en las que allowHidden es falso.	No	booleano	falso
recalculateOnMatch	Si se deben volver a calcular los valores al coincidir. Solo columnas de selector de texto y dimensión válidas para hojas donde recalculateOnDemand es verdadero.	No	booleano	falso
lookupTables	Lista de objetos LookupTable para definir búsquedas de valor y distribución. Solo es válido para columnas de selector de dimensión y texto.	No	LookupTable	nulo
valores	Lista de cadenas para añadir como valores de selector de texto. Solo es válido para columnas de selector de texto.	No	matriz de cadenas	nulo
rowKey	Si esta columna se puede utilizar como clave de fila. Solo es válido para columnas de controlador de texto.	No	booleano	falso
displayAs	El formato Mostrar como de la columna. Solo es válido para columnas de controlador numérico. Valores posibles: NUMBER, PERCENT, CURRENCY	No	Mostrar como	falso
decimalPrecision	La precisión decimal que se va a mostrar. Solo es válido para columnas de controlador numérico. Valores posibles: del 0 al 9 o -1 para utilizar la precisión de moneda cuando se muestre como MONEDA.	No	número entero	0
showToggle	Si se muestra una columna de casilla de selección como un conmutador. Solo es válido para columnas de casillas.	No	booleano	falso
showInEditMode	Si se debe mostrar la columna en las filas editables de la hoja modelada. Solo es válido para columnas de moneda de nivel.	No	booleano	falso
referenceTimePeriod	Indica el periodo temporal de referencia de una columna de visualización. Solo es válido para columnas de visualización de cuenta. Valores posibles: FIRST_NON_ACTUALS_PERIOD, START_OF_PLAN	No	cadena	FIRST_NON_ACTUALS_PERIOD
startOfRollupRange	Indica dónde iniciar un rango de agrupación de periodos para una columna de visualización. Solo es válido para columnas de visualización de cuenta. Valores posibles: CONTAINING_REFERENCE_PERIOD, BEFORE_REFERENCE_PERIOD, AFTER_REFERENCE_PERIOD	No	cadena	CONTAINING_REFERENCE_PERIOD
timePeriodsInRollupRange	Número de periodos que se incluirán en el rango de agrupación de una columna de visualización. Solo es válido para columnas de visualización de cuenta.	No	número entero	1
startOfRollupRangeTimeStratumCode	Código del periodo temporal para determinar el inicio del rango de agrupación de una columna de visualización. Solo es válido para columnas de visualización de cuenta. Los valores posibles incluyen estratos temporales iguales o superiores al estrato temporal de la hoja.	No	cadena	Estrato temporal de hoja
accountCode	El código de la cuenta para determinar la cuenta modelada de una columna de visualización. Solo es válido para columnas de visualización. Solo los valores válidos son cuentas en la hoja modelada dada	No	cadena

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
descripción	La descripción de la cuenta.	No
isCumulative	Devuelve si la cuenta es acumulativa.	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
ponderadoAverageTranslationsEnabled	Muestra si la cuenta tiene activadas las conversiones de promedio ponderado.	No
weightedAverageTranslationResetStratum	El estrato WAT Rest para esta cuenta.	No
weightedAverageTranslationTransferAccount	La cuenta de transferencia WAT para esta 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
hasSalaryDetail	Muestra si la cuenta tiene o no detalles salariales.	No
isBreakbackEligible	Muestra si la retrotracción es elegible para esta cuenta.	No
isSystemAccount	Muestra si esta cuenta es una cuenta de sistema o no.	No
isIntercompany	Muestra si se trata de una cuenta interempresa o no.	No
esAsunción	Devuelve si la cuenta es un supuesto o no.	No
isMetric	Muestra si la cuenta es una cuenta de métrica o no.	No
modeledSheetSpreadCode	El código de distribución de hoja modelada para la distribución modelo asociada.	No
spreadTargetAccount	El objeto de cuenta de destino de la cuenta de distribución.	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/modeled/definition

Elimine la definición de hoja modelada 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/modeled/definition?name=Capital Model

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 modelada.	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 está en blanco con el código de estado 204.

POST

URI de solicitud

/sheet/modeled/definition/validate

Valide una solicitud de definición de hoja modelada.

Solicitud de muestra por nombre

https://api.adaptiveplanning.com/api/rest/modeling/v1/default/sheet/modeled/definition/validate?name=My Sheet

Cabecera de solicitud de muestra

Accept-Language: es

Cuerpo de solicitud de muestra

<Documentado a continuación>

Parámetros de consulta

Ver el punto final relativo que se está validando (es decir, PATCH).

Cuerpo de solicitud

Cuerpo de solicitud de muestra

Se utiliza el mismo formato de definición de hoja modelada que la carga útil de JSON para el punto final que se valida. Sin embargo, el objeto

validationOptions

es obligatorio en la carga útil al enviar una solicitud de validación.

Formato de solicitud

{

  "validationOptions": {
      "httpMethod": "Patch",
      "dependentDimensions": [
          "MyTestDim1", "MyTestDim2"
      ],
      "dependentAttributes": [
          {
              "attributeName": "MyTestAttr1",
              "attributeType": "DIMENSION_ATTRIBUTE",
              "dimensionName": "MyTestDim2"
          },
          {
              "attributeName": "MyTestAttr2",
              "attributeType": "LEVEL_ATTRIBUTE"
          }
      ]
  },

  "properties": {
      "description": "Capital Model",
      "prefix": "Capital"
  },
  "columns": [
      {
          "properties": {
              "code": "Base Pay",
              "name": "Base Pay",
              "type": "TEXT_SELECTOR",

...

Objeto de opciones de validación

Nombre	Descripción	Obligatorias
httpMethod	Especifica qué punto final de API de hoja modelada se está validando. Actualmente admite los siguientes puntos finales: PARCHE	Sí
dependentDimensions	Lista de nombres de dimensión que se supone que existen para la validación. Las dimensiones no se conservan como resultado de la solicitud de validación. Se supone que todas las dimensiones personalizadas dependientes son planas.	No
dependentAttributes	Lista de objetos de atributo dependientes. Los atributos no se conservan como resultado de la solicitud de validación.	No

Objeto de atributo dependiente

Nombre	Descripción	Obligatorias
attributeName	Nombre del atributo dependiente.	Sí
attributeType	Tipo de atributo dependiente. Los tipos admitidos son: LEVEL_ATTRIBUTE DIMENSION_ATTRIBUTE	Sí
dimensionName	Nombre de la dimensión para el atributo dependiente. Solo se aplica y es obligatorio para los atributos de dimensión. No se permite para atributos de nivel.	No