Definição de planilha modelada

Ponto de extremidade de URL

VERBOS HTTP com suporte

PATCH

Solicitar URI

/sheet/modeled/definition

Atualize a definição da planilha modelada que corresponde ao parâmetro de consulta fornecido. Se não houver uma planilha com o identificador correspondente, uma nova planilha modelada será criada com as propriedades fornecidas.

Solicitação de amostra por nome

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

Cabeçalho de solicitação de amostra

Accept-Language: en

Corpo da solicitação de amostra

Consulte a seção Corpo da solicitação

Parâmetros de consulta

Nome	Descrição	Obrigatório
instanceCode	O instanceCode do qual recuperar valores. Por exemplo, GLOBO. Se nenhum instanceCode é especificado, a instância por padrão do usuário é usada.	N
nome	O nome da planilha.	N
proceedWithWarnings	Se o upsert deve ignorar qualquer validação de aviso, geralmente retornada quando uma propriedade de planilha alterada pode excluir dados da planilha.	N
reorderColumns	Definir esse parâmetro de consulta como verdadeiro alterará a ordem da lista de colunas para refletir a ordem das colunas fornecida no corpo da solicitação de API. Por padrão, ele é definido como falso. Consulte Reference: Re-ordering Columns for Modeled and Cube Sheet Definition JSON APIs.	N

Corpo da solicitação

Corpo da solicitação de amostra

O mesmo formato de definição de planilha modelada é usado como a carga JSON para os dois pontos de extremidade.

Formato da solicitação

{ "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 definição de planilha

Nome	Descrição	Obrigatório
propriedades	Objeto que contém propriedades gerais da planilha	N
colunas	Lista de objetos de coluna de planilha modelada. Novas colunas serão criadas no final da definição da planilha, e a ordem relativa das novas colunas será respeitada. As colunas existentes só serão atualizadas no local. eles não serão reordenados.	N
contas	Lista de objetos de conta	N
acessibilidade	Objeto que contém a definição de acessibilidade de planilha atribuída a usuário.	N

Objeto de propriedades da planilha

Nome	Descrição	Obrigatório	Tipo	Valor por padrão
descrição	Descrição da planilha	N	cadeia de caracteres	Texto vazio
código	Código de planilha usado para prefixar códigos de conta e um identificador exclusivo secundário. Obrigatório na criação de uma nova planilha.	N	cadeia de caracteres
prefixo	Prefixo da planilha usado para o código da conta. Obrigatório na criação de uma nova planilha. Obsoleto em favor do código.	N	cadeia de caracteres
userAssigned	Se a planilha é uma planilha atribuída a usuário ou (por padrão) uma planilha atribuída a nível.	N	booliano	false
salaryDetail	Se a planilha contém detalhes de salário.	N	booliano	false
frozenColumnCount		N	número inteiro	0
allowSplits	Se a planilha permite linhas divididas.	N	booliano	false
allowRollupModelEdits	Se a planilha permite edições durante a visualização dos níveis de consolidação.	N	booliano	false
allowActuals	Se a planilha está disponível em versões de valores reais.	N	booliano	false
recalculateOnDemand	Se o recálculo sob demanda está habilitado para a planilha.	N	booliano	false
timeStratumCode	O código do estrato de tempo associado aos dados na planilha.	N	cadeia de caracteres	Estrato de tempo de livro-razão

Objeto de coluna da planilha

Nome	Descrição	Obrigatório	Tipo	Valor por padrão
propriedades	Objeto que contém propriedades de coluna da planilha.	S	objeto
disponibilidade	Lista de objetos de disponibilidade da planilha para a coluna atual. Consulte Sheet Availability para obter detalhes sobre o formato da lista.	N	lista
defaultAvailability	A disponibilidade por padrão a ser aplicada a todos os valores, a menos que especificado de outra forma em disponibilidade. Válido para colunas de nível e dimensão. Para colunas de dimensão, se nenhuma disponibilidade ou o valor por padrãoAvailability é especificado, o valor por padrãoAvailability é definido como verdadeiro para as novas colunas. Por padrão, esse valor fica vazio, o que significa que a disponibilidade existente é preservada, a menos que seja especificamente alterada por meio da disponibilidade.	N	booliano
defaultActionIfDataIsPresent	A ação por padrão se houver dados presentes ao excluir um valor, a menos que especificado de outra forma na disponibilidade. Válido para colunas de dimensão. Obrigatório quando a Disponibilidade por padrão é falsa para as colunas existentes.	N	cadeia de caracteres
excluir	Solicitação para excluir coluna da planilha especificada. Não é válido para colunas dependentes de colunas existentes que não estão marcadas para exclusão (como atributos de dimensão).	N	booliano

Objeto de propriedades de colunas da planilha

Nome	Descrição	Obrigatório	Tipo	Valor por padrão
nome	Nome da coluna.	N	cadeia de caracteres
código	O código da coluna. Obrigatório para todas as colunas, exceto as colunas de nível e de moeda de nível.	S	cadeia de caracteres
type	O tipo de coluna. Valores possíveis: LEVEL, DIMENSION, LEVEL_ATTRIBUTE, DIMENSION_ATTRIBUTE, TIMESPAN, NUMBER, DATE, TEXT, TEXT_SELECTOR, LEVEL_CURRENCY, DISPLAY, INITIAL_BALANCE, CHECKBOX	S	cadeia de caracteres
readOnly	Se a coluna atual é somente leitura ou não. Para colunas de atributo de dimensão, defina readOnly como falso para usar o atributo como um filtro na dimensão. Obrigatório ser verdadeiro (e o valor por padrão é verdadeiro) para atributos de nível e colunas de exibição.	N	booliano	false
allowSplits	Se a coluna atual é divisível. Válido somente para planilhas quando a propriedade geral allowedSplits é verdadeira.	N	booliano	false
showTotalsAtBottom	Se os totais devem ser mostrados na parte inferior da planilha para esta coluna.	N	booliano	false
allowHidden	Se essa coluna pode ser ocultada do visualizador de planilhas em Opções de exibição. Válido para todas as colunas, exceto as colunas de seletor de texto e de período temporal.	N	booliano	verdadeiro
editableOnSheet	Se novos valores podem ser adicionados à coluna de dimensão da planilha. Válido somente para colunas de dimensão e de seletor de texto.	N	booliano	false
obrigatório	Se cada linha deve ter um valor nesta coluna. Válido somente para colunas de dimensão em que allowedHidden é falso.	N	booliano	false
recalculateOnMatch	Se os valores correspondentes devem ser recalculados. Somente colunas de dimensão e de seletor de texto válidas para planilhas em que recalculateOnDemand é verdadeiro.	N	booliano	false
lookupTables	Lista de objetos LookupTable para definir consultas de valores e de difusão. Válido somente para colunas de dimensão e de seletor de texto.	N	LookupTable	nulo
valores	Lista de cadeias de caracteres a serem adicionadas como valores de seletor de texto. Válido somente para colunas de seletor de texto.	N	matriz de cadeia de caracteres	nulo
rowKey	Se essa coluna pode ser usada como uma chave de linha. Válido somente para colunas de driver de texto.	N	booliano	false
displayAs	O formato Exibir como da coluna. Válido somente para colunas de driver numéricas. Valores possíveis: NUMBER, PERCENT, CURRENCY	N	DisplayAs	false
decimalPrecision	A precisão decimal a ser exibida. Válido somente para colunas de driver numéricas. Valores possíveis: 0 a 9 ou -1 para usar a precisão da moeda quando exibido como MOEDA.	N	número inteiro	0
showToggle	Se uma coluna de caixa de seleção deve ser mostrada como um comutador. Válido somente para colunas de caixa de seleção.	N	booliano	false
showInEditMode	Se a coluna deve ser mostrada em linhas editáveis da planilha modelada. Válido somente para colunas de moeda de nível.	N	booliano	false
referenceTimePeriod	Indica o período de referência para uma coluna de exibição. Válido somente para colunas de exibição de conta. Valores possíveis: FIRST_NON_ACTUALS_PERIOD, START_OF_PLAN	N	cadeia de caracteres	FIRST_NON_ACTUALS_PERIOD
startOfRollupRange	Indica onde iniciar um intervalo de consolidação por período para uma coluna de exibição. Válido somente para colunas de exibição de conta. Valores possíveis: CONTAINING_REFERENCE_PERIOD, BEFORE_REFERENCE_PERIOD, AFTER_REFERENCE_PERIOD	N	cadeia de caracteres	CONTAINING_REFERENCE_PERIOD
timePeriodsInRollupRange	Número de períodos a serem incluídos no intervalo de consolidação de uma coluna de exibição. Válido somente para colunas de exibição de conta.	N	número inteiro	1
startOfRollupRangeTimeStratumCode	Código do período para determinar o início do intervalo de consolidação de uma coluna de exibição. Válido somente para colunas de exibição de conta. Os valores possíveis incluem estratos de tempo iguais ou superiores ao estrato de tempo da planilha.	N	cadeia de caracteres	Estrato de tempo da planilha
accountCode	Código da conta para determinar a conta modelada para uma coluna de exibição. Válido somente para colunas de exibição. Somente valores válidos são contas na planilha modelada especificada	N	cadeia de caracteres

Objeto de tabela de consulta de colunas da planilha

Nome	Descrição	Obrigatório	Tipo	Valor por padrão
nome	Nome da tabela de consulta.	S	cadeia de caracteres
displayAs	O formato Exibir como para esta tabela de consulta. Valores possíveis: NUMBER e PERCENT. Válido somente para tabelas de consulta de valores.	N	cadeia de caracteres	NUMBER
decimalPrecision	A precisão decimal dos valores nesta tabela de consulta. Valores possíveis: 0 a 9.	N	número inteiro	0
type	O tipo de tabela de consulta. Valores possíveis: VALUE, SPREAD.	S	cadeia de caracteres

Objeto de conta de planilha

Para obter mais detalhes, consulte Reference: Properties in Account JSON Import Payload

Nome	Descrição	Obrigatório
nome	O nome da conta.	S
código	O código da conta.	S
principal	A conta pai.	N
descrição	A descrição da conta.	N
isCumulative	Retorna se a conta é cumulativa.	N
isActualsByDelta	Retorna se a conta é de valores reais por delta.	N
isLink	Retorna se a conta é uma conta vinculada ou não.	N
timeRollupType	O tipo de consolidação a ser executada para consolidações por tempo.	N
timeWeightAccount	A conta de ponderação usada para consolidações por tempo.	N
levelDimRollupType	O tipo de consolidação a ser executada para consolidações por nível/dimensão personalizada.	N
levelDimWeightAccount	A conta de ponderação usada para consolidações por nível/dimensão personalizada.	N
levelDimRollupText	O valor de texto de consolidação usado em consolidações por nível/dimensão personalizada.	N
actualsOverlay	A configuração de sobreposição de valores reais da conta.	N
attributeValues	Lista de objetos de valor de atributo de conta para esta conta.	N
displayAs	A exibição como configuração para a conta.	N
formula	A fórmula da conta.	N
weightedAverageTranslationsEnabled	Retorna se a conta tem conversões por média ponderada habilitadas.	N
weightedAverageTranslationResetStratum	O estrato de REST WAT para esta conta.	N
weightedAverageTranslationTransferAccount	A conta de transferência WAT para esta conta.	N
decimalPrecision	A precisão decimal por padrão da conta.	N
exchangeRateType	O tipo de taxa cambial para esta conta.	N
suppressZeros	Retorna se as linhas com zeros devem ser suprimidas para a conta nas planilhas.	N
startExpanded	Retorna se a conta começa expandida na planilha.	N
dataEntryType	A configuração do tipo de entrada de dados para esta conta.	N
dataPrivacy	A configuração de privacidade de dados para esta conta.	N
hasSalaryDetail	Retorna se a conta tem detalhes de salário ou não.	N
isBreakbackEligible	Retorna se a redistribuição é elegível para esta conta.	N
isSystemAccount	Retorna se esta conta é uma conta do sistema ou não.	N
isIntercompany	Retorna se esta é uma conta intercompanhias ou não.	N
isAssunção	Retorna se a conta é uma suposição ou não.	N
isMetric	Retorna se a conta é uma conta de métrica ou não.	N
modeledSheetSpreadCode	O código de difusão da planilha modelada para a difusão modelo associada.	N
spreadTargetAccount	O objeto de conta de destino da conta de difusão.	N

Objeto de acessibilidade da planilha

Nome	Descrição	Obrigatório	Tipo	Valor por padrão
nomes de usuário	Lista de nomes de usuário a serem adicionados à planilha. Devem vir na forma de endereços de e-mail válidos.	N	matriz de cadeia de caracteres
excludedFromWorkflow	atualiza a caixa de seleção Excluído do fluxo de trabalho nas configurações de acessibilidade da planilha	N	booliano	false

Exemplo de resposta

204

A resposta bem-sucedida está em branco com o código de status 204.

DELETE

Solicitar URI

/sheet/modeled/definition

Exclua a definição da planilha modelada que corresponde ao parâmetro de consulta fornecido. Se não houver uma planilha com o identificador correspondente, ocorrerá um erro não encontrado.

Solicitação de amostra por nome

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

Cabeçalho de solicitação de amostra

Accept-Language: en

Corpo da solicitação de amostra

<None>

Parâmetros de consulta

Nome	Descrição	Obrigatório
nome	O nome da planilha modelada.	N
instanceCode	O instanceCode do qual recuperar valores. Por exemplo, GLOBO. Se nenhum instanceCode é especificado, a instância por padrão do usuário é usada.	N

Exemplo de resposta

204

A resposta bem-sucedida está em branco com o código de status 204.

POST

Solicitar URI

/sheet/modeled/definition/validate

Validar uma solicitação de definição de planilha modelada.

Solicitação de amostra por nome

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

Cabeçalho de solicitação de amostra

Accept-Language: en

Corpo da solicitação de amostra

<Documentado abaixo>

Parâmetros de consulta

Consulte o ponto de extremidade relativo que está sendo validado (ou seja, PATCH).

Corpo da solicitação

Corpo da solicitação de amostra

O mesmo formato de definição de planilha modelada é usado como a carga JSON para o ponto de extremidade que está sendo validado. No entanto, o objeto

validationOptions

é obrigatório na carga quando uma solicitação de validação é enviada.

Formato da solicitação

{

  "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 opções de validação

Nome	Descrição	Obrigatório
httpMethod	Especifica qual ponto de extremidade da API de planilha modelada está sendo validado. Atualmente, oferece suporte aos seguintes pontos de extremidade: PATCH	S
dependentDimensions	Lista de nomes de dimensões que devem ser considerados existentes para validação. As dimensões não são mantidas como resultado da solicitação de validação. Presume-se que todas as dimensões personalizadas dependentes são simples.	N
dependentAttributes	Lista de objetos de atributo dependentes. Os atributos não são persistentes como resultado da solicitação de validação.	N

Objeto de atributo dependente

Nome	Descrição	Obrigatório
attributeName	Nome do atributo dependente.	S
attributeType	Tipo do atributo dependente. Os tipos com suporte são: LEVEL_ATTRIBUTE DIMENSION_ATTRIBUTE	S
dimensionName	Nome da dimensão do atributo dependente. Aplica-se e é obrigatório somente para atributos de dimensão. Não permitido para atributos de nível.	N