Ir para o conteúdo principal
Documentação
Documentação
Adaptive Planning
Última atualização: 2023-06-23
Definição de planilha de cubo

Definição de planilha de cubo

Ponto de extremidade de URL

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/cube/definition
Versão: v1
Categoria
Envio de dados
Descrição
Modificação de metadados
Permissões obrigatórias para invocar
Gerenciamento de modelos
O modelo inclui: planilhas, contas, dimensões e fórmulas
Parâmetros obrigatórios na solicitação
nome

VERBOS HTTP com suporte

Verbo HTTP
Recurso único
Descrição
PATCH
Com suporte
Inserir ou atualizar uma definição de planilha de cubo
DELETE
Com suporte
Excluir uma definição de planilha de cubo
OPÇÕES
Com suporte
Retorna a lista de verbos HTTP com suporte para este recurso de coleção.

PATCH

Solicitar URI
/sheet/cube/definition
Atualize a definição da planilha de cubo que corresponde ao parâmetro de consulta fornecido.
Se não houver uma planilha com o nome correspondente, uma nova planilha de cubo será criada com as propriedades fornecidas.
Solicitação de amostra por nome
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
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
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 de cubo é usado como a carga JSON para ambos os pontos de extremidade.
Formato da solicitação
 
{
   "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
   }
}
Solicitação de exemplo:
Exemplo de solicitação para criação de planilha
 
{
   "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 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 de cubo.
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
prefixo
Prefixo da planilha usado para o código da conta.
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
timeStratumCode
O código do estrato de tempo associado aos dados na planilha.
N
cadeia de caracteres
Estrato de tempo de livro-razão
recalculateOnDemand
Se o recálculo sob demanda está habilitado para a planilha.
N
booliano
false
rearrangeGLAndCustomAccounts
Se os usuários têm permissão para reorganizar contas com entrada de dados no cubo com outras contas de cubo. Isso só pode ser habilitado quando contas de cubo padrão existem ou estão sendo criadas na solicitação.
N
booliano
false
hideRollupTotals
Se os totais consolidados devem ser ocultados para melhorar o desempenho da planilha.
N
booliano
false
horizontalAxis
Objeto de referência de coluna que identifica a coluna no eixo horizontal.
N
objeto de coluna
Tempo
verticalAxis
Lista de objetos de referência de coluna que identificam as colunas no eixo vertical. Se fornecido, o eixo vertical substituirá todas as seleções anteriores.
N
matriz de objetos de coluna
Conta
maxColumnWidth
A largura máxima deles em pixels para cada coluna. Deve estar entre 10 e 1000 ou 0 se a largura não for especificada.
N
número inteiro
0
suppressZeroRows
Se zero linhas são suprimidas.
N
booliano
false
Objeto de referência de coluna da planilha
Nome
Descrição
Obrigatório
Nome
Nome da coluna. Obrigatório para dimensão personalizada e atributos.
S
type
Tipo de coluna.
S
Objeto de coluna da planilha
Nome
Descrição
Obrigatório
propriedades
Objeto que contém propriedades de coluna da planilha.
S
disponibilidade
Lista de objetos de disponibilidade da planilha para a coluna atual. Consulte Sheet Availability para obter detalhes sobre o formato da lista.
N
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.
N
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
Objeto de propriedades de colunas da planilha
Nome
Descrição
Obrigatório
Tipo
Valor por padrão
nome
Nome da coluna. Para dimensões personalizadas e colunas de atributos, o nome corresponderá ao nome da respectiva dimensão personalizada ou atributo.
S
cadeia de caracteres
type
O tipo de coluna.
Valores possíveis: LEVEL, ACCOUNT, TIME, DIMENSION, LEVEL_ATTRIBUTE, ACCOUNT_ATTRIBUTE, DIMENSION_ATTRIBUTE
S
cadeia de caracteres
InitialBalance
Se o saldo inicial estará visível na planilha. Válido somente para colunas de tempo.
N
booliano
verdadeiro
visibleTimeStratumCodes
Define a lista de estratos de tempo visíveis na planilha. Válido somente para colunas de tempo.
N
matriz de cadeia de caracteres
Todos os estratos de tempo
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
newValueBehavior
Define se novos valores devem ser habilitados ou desabilitados quando são adicionados à dimensão subjacente. Válido somente para colunas de dimensão. Valores com suporte: DISPONÍVEL, INDISPONÍVEL ou PRINCIPAL
N
cadeia de caracteres
DISPONÍVEL
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
Tipo
O tipo de conta.
S
descrição
A descrição da conta.
N
shortName
O nome curto da conta.
N
isCumulative
Retorna se a conta é cumulativa.
N
isPlanByDelta
Retorna se a conta é planejada por delta.
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
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
linkedAccountMappings
List of LinkedAccountMapping.
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/cube/definition
Exclua a definição da planilha de cubo 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/cube/definition?name=Sales Cube
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 de cubo.
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 é marcada com o código de status 204.