Versões

Ponto de extremidade de URL

VERBOS HTTP com suporte

GET

Solicitar URI

/api/rest/modeling/v1/{tenant}/versions: recupera todas as versões do locatário.

Recupera todas as versões do locatário em uma lista. As propriedades não mostradas na UI para versões específicas não são incluídas nos objetos de versão correspondentes na resposta. Por exemplo, startOfVersion para subversões de valores reais. Capaz de usar paginação por meio dos parâmetros "limite" e "deslocamento". No momento, as seguintes propriedades de versão não têm suporte/não são exibidas em GET: Versão base (para versões virtuais), habilitar relatórios constantes de moeda (para versões virtuais), Calcular valores de fórmulas, acesso de administrador, acesso de usuário, acesso a planilhas editáveis, acesso a valores reais privilegiados, grupo, nível de acesso de grupo.

Exemplo de URI de solicitação:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?limit=25&offset=1

Corpo da solicitação de amostra:

<Deixar em branco>

Parâmetros de consulta:

Nome	Descrição	Obrigatório
limit	O número máximo de objetos em uma única resposta.	N
compensação	O índice de base zero do primeiro objeto em uma coleção de respostas. O valor por padrão é 0. Use o deslocamento com o parâmetro de limite para controlar a paginação de uma coleção de respostas.	N

Parâmetros do roteiro:

Nome	Descrição	Obrigatório
tenant	O locatário para operar, por exemplo, GREENCO	S

Exemplo de resposta

200 OK

Observação: o Início da versão para versões de valores reais e o Limite de rolagem à esquerda para versões de plano são exibidos na propriedade startOfVersion (ponteiro A).

Da mesma forma, o Fim da versão para versões de valores reais e o Fim do plano para versões de plano são exibidos na propriedade endOfVersion (ponteiro D).

O Local de rolagem inicial para versões de valores reais e o Início do plano para versões de plano são exibidos na propriedade BeginningScrollLocation (ponteiro C).

Resposta bem-sucedida.

Exemplo de resposta

{ "data": [ { "name": "Test-Actuals-Version", "shortName": "Test-Actuals-Version-Shortname", "versionType": "ACTUALS", ... "lockLeadingCompletion": true }, { "name": "JE Sub under Actuals", "shortName": "JE01", "parent": "Actuals", ... "journalEntryVersion": true, "journalEntryVersionProperties": { "journalEntryNumbering": "N", "startingNumber": 0 }, ... }, ... ], "limit": 12, "offset": 4, "total": 12 }

DELETE

Solicitação

/api/rest/modeling/v1/{tenant}/versions: exclui uma versão existente

Exclui a versão com o nome de versão especificado. A versão de valores reais raiz e a versão por padrão não podem ser excluídas.

Exemplo de URI de solicitação:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}

Corpo da solicitação de amostra:

<Deixar em branco>

Parâmetros de consulta

Nome	Descrição	Obrigatório
versionName	Nome da versão existente a ser excluída.	S
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

Parâmetros de roteiro

Nome	Descrição	Obrigatório
tenant	O locatário para operar, por exemplo, GREENCO	S

Exemplo de resposta

204 NO_CONTENT

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

PATCH

Solicitação:

/api/rest/modeling/v1/{tenant}/versions: cria/atualiza versões de valores reais ou atualiza versões de plano.

Se o identificador de versão especificado existir, atualiza a versão de valores reais/plano existente. Caso contrário, cria uma nova versão de valores reais usando esse identificador. Atualmente, há dois conjuntos de IDs de versão com suporte por meio de parâmetros de consulta: -version name Somente um dos parâmetros de consulta acima deve ser especificado no URL de cada chamada.

Exemplo de URI de solicitação:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}

Corpo da solicitação

-JSON contendo as propriedades da versão a serem atualizadas para a versão existente ou a serem especificadas para a nova versão a ser criada.

Atualização:

- Para atualizações, nenhuma propriedade específica é obrigatória no corpo da solicitação (exceto para versionType), mas ainda é necessário um corpo da solicitação. A seção do corpo da solicitação do

POST

descreve a lista de propriedades para diferentes tipos de versões de plano.

- As propriedades do indicador (por exemplo, JournalEntryVersion) não podem ser atualizadas; no entanto, eles ainda podem permanecer no corpo da solicitação, desde que tenham o valor inalterado correto.

- No momento, não há suporte para a atualização de dados pai.

- Na atualização de versões não folha (versões com filhos), os grupos de usuários dessas versões só podem ter tipos de acesso "FULL_ACCESS" ou "HIDDEN". "FULL_ACCESS" aparece como e é equivalente a "VISIBLE" na interface de usuário.

Os detalhes de acesso ao grupo (ID de grupo e nível de acesso do grupo) podem ser removidos especificando-se groupId=0 no corpo da solicitação de uma chamada de atualização.

Crie:

- Para criações, as seguintes propriedades estão disponíveis para especificação no corpo da solicitação:

Propriedades	Descrição	Obrigatório (para valores reais)	Obrigatório (para lançamento)	Nome da propriedade no corpo da solicitação	Tipo de valor	Valor por padrão
Nome curto	Nome curto da versão.	N	N	shortName	Cadeia de caracteres	cadeia de caracteres vazia
Pai	Pai desta versão.	N	N	principal	Cadeia de caracteres (nome da versão)	versão de valores reais raiz
Tipo de versão	Tipo de versão (valores reais ou PLANNING)	S, VALORES REAIS	S, VALORES REAIS	versionType	Cadeia de caracteres
Descrição	Descrição	N	N	descrição	Cadeia de caracteres	cadeia de caracteres vazia
Acesso de administradores	Nível de acesso à versão para administradores.	N	N	administratorsAccess	VersionAccessControl	herdado do pai
Acesso de usuário	o nível de acesso à versão dos usuários.	N	N	userAccess	VersionAccessControl	herdado do pai
Acesso privilegiado a valores reais	Nível de acesso à versão para qualquer pessoa com a permissão Acesso privilegiado a valores reais.	N	N	privilegedActualsAccess	VersionAccessControl	herdado do pai
ID do grupo	Uma ID de grupo de usuários especificada	N	N	groupId	Número inteiro	herdado do pai
Nível de acesso do grupo	O nível de acesso à versão do grupo de usuários especificado.	S se a ID de grupo é especificada.	S se a ID de grupo é especificada.	groupAccessLevel	VersionAccessControl	herdado do pai
Trilha de auditoria	Manter/excluir informações da trilha de auditoria.	N	N	auditTrail	Booliano	falso (herdado do pai para versões de lançamento)
Versão de lançamento	Se a versão a ser criada é um lançamento.	N	S, verdadeiro	journalEntryVersion	Booliano
returnId	Retorna uma ID de versão se definida como verdadeira. Nova ID de versão se a operação criou uma nova versão. Caso contrário, retorna a ID da versão existente que foi atualizada.	N	N	returnId	Booliano	false (retorna 204 No Content com false, retorna 200 OK with version na resposta se for definida como true)

- O tipo de valor VersionAccessControl pode assumir os seguintes valores de cadeia de caracteres: "HIDDEN", "LOCKED", "LOCKED_EXCEPT_NOTES", "IMPORT_AND_NOTES", "FULL_ACCESS"

-As IDs de grupo podem ser obtidas por meio da API pública exportGroups.

- As versões de lançamento não têm suporte para empresas com consolidação desabilitada.

Propriedades da versão de lançamento:

As propriedades a seguir existem no objeto aninhado JournalEntryVersionProperties (consulte o corpo da solicitação de amostra) e são usadas somente para versões JE:

Propriedades	Descrição	Obrigatório (para valores reais)	Obrigatório (para lançamentos)	Nome da propriedade no corpo da solicitação	Tipo de valor	Valor por padrão
Numeração do lançamento	Especifique como os lançamentos serão numerados. Pode ser automática (A), manual (M) ou nenhuma (N).	Não usado	N	journalEntryNumbering	Cadeia de caracteres	nenhum (N)
Prefixo	Prefixo da numeração JE	Não usado	S se a numeração do lançamento for automática (A) ou manual (M)	prefixo	Cadeia de caracteres
Número inicial	Número inicial da numeração JE	Não usado	S se Numeração do lançamento (A)	startingNumber	Número inteiro

Propriedades específicas de valores reais raiz:

As propriedades a seguir são usadas somente na atualização de valores reais raiz:

Propriedades	Descrição	Obrigatório	Nome da propriedade no corpo da solicitação	Tipo de valor
Início da versão	Início da versão	N	startOfVersion	Cadeia de caracteres (código do período)
Término da versão	Término da versão	N	endOfVersion	Cadeia de caracteres (código do período)
Localização inicial de rolagem	Localização inicial de rolagem da versão	N	startingScrollLocation	Cadeia de caracteres (código do período)
Valores concluídos até	Quando a sobreposição de valores reais na versão de plano é interrompida	N	completedValuesThrough	Cadeia de caracteres (código do período)
Habilitar fluxo de trabalho	Permite enviar valores reais por nível no Fluxo de trabalho.	N	endableWorkflow	Booliano

Corpo da solicitação de amostra:

Corpo da solicitação
{ "parent": "Parent Version", "versionType": "ACTUALS", ... "administratorsAccess": "FULL_ACCESS", "usersAccess": "IMPORT_AND_NOTES", ... ... "auditTrail": true }

Corpo da solicitação de amostra para versões com propriedades aninhadas (versões de lançamento e versões virtuais):

Corpo da solicitação
{ "parent": "Actuals", "versionType": "ACTUALS", "shortName": "test JE version", "journalEntryVersion": "true", "journalEntryVersionProperties": { "journalEntryNumbering": "A", "prefix": "JE-Prefix", "startingNumber": "25" }, ... "auditTrail": true }

Parâmetros de consulta:

Nome	Descrição	Obrigatório
versionName	Nome da nova versão a ser criada ou da versão existente a ser atualizada.	S
proceedWithWarnings	Um parâmetro de consulta opcional usado para ignorar mensagens de aviso. Se não for definida como verdadeira, avisos potenciais serão retornados antes da execução da chamada. Ignore-os especificando esse parâmetro como verdadeiro no URL.	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

Parâmetros do roteiro:

Nome	Descrição	Obrigatório
tenant	O locatário para operar, por exemplo, GREENCO	S

Propriedades de acesso à publicação:

As seguintes propriedades do corpo da solicitação são usadas somente quando a WD está habilitada:

Exemplo de resposta

204 NO_CONTENT

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

POST

Solicitação:

/api/rest/modeling/v1/{tenant}/cloneVersion: cria uma nova versão de plano.

Cria um novo plano ou versão de predição clonando uma versão de origem/por padrão ou cria uma versão virtual. Atualmente, há dois conjuntos de IDs de versão com suporte por meio de parâmetros de consulta: -new version name Apenas uma das opções acima deve ser especificada no URL de cada chamada

Exemplo de URI de solicitação:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/cloneVersion?newVersionName=Budget 2012& sourceVersionName=Budget 2011& copyAllData=true& copySharedFormulasAndRules=true& copyAllOverrideFormulas=false

Corpo da solicitação:

JSON que contém as propriedades da versão a serem especificadas para a nova versão a ser criada.

Nome	Descrição	Obrigatório (para o plano)	Obrigatório (para preditivo)	Obrigatório (para virtual)	Nome da propriedade no corpo da solicitação	Tipo de valor	Valor por padrão
Nome curto	Nome curto da versão.	N	N	N	shortName	Cadeia de caracteres	cadeia de caracteres vazia
Pai	Pasta pai desta versão.	N	N	N	principal	Cadeia de caracteres (nome da pasta)
Tipo de versão	Tipo de versão (valores reais ou PLANNING)	Y, PLANNING	Y, PLANNING	Y, PLANNING	versionType	Cadeia de caracteres
Descrição	Descrição	N	N	N	descrição	Cadeia de caracteres	cadeia de caracteres vazia
Versão bloqueada	Bloqueia a versão inteira para todos os usuários, incluindo fórmulas mestre e outras fórmulas de conta.	N	Não usado	Não usado	lockedVersion	Booliano	herdado da versão de origem
Calcular valores da fórmula	Disponível para versões de plano com a opção Versão bloqueada marcada. Usada para preservar os resultados calculados de fórmulas e referências na maioria das contas e para aumentar o desempenho de versões bloqueadas.	N	Não usado	Não usado	calculateFormulaValues	Booliano	false
Acesso de administradores	Nível de acesso à versão para administradores.	N	N	N	administratorsAccess	VersionAccessControl	herdado da versão de origem (plano); IMPORT_AND_NOTES (preditivo); BLOQUEADO (Virtual)
Acesso de usuário	Nível de acesso à versão para usuários.	N	N	N	usersAccess	VersionAccessControl	herdado da versão de origem (plano); IMPORT_AND_NOTES (preditivo); BLOQUEADO (Virtual)
Acesso à planilha editável	O nível de acesso à versão para qualquer pessoa com a permissão Acesso à planilha editável.	N	N	N	editableSheetAccess	VersionAccessControl	herdado da versão de origem (plano, preditivo)
ID do grupo	A ID de um grupo de usuários especificado.	N	N	N	groupId	Número inteiro	herdado da versão de origem (plano, preditivo)
Nível de acesso	O nível de acesso à versão do grupo de usuários especificado.	N	N	N	groupAccessLevel	VersionAccessControl	herdado da versão de origem (plano, preditivo)
Limite de rolagem à esquerda	Limite de rolagem à esquerda da versão.	N	N	Não usado	startOfVersion	Cadeia de caracteres (código do período)	herdado da versão de origem
Término do plano	Término do plano	N	N	Não usado	endOfPlan	Cadeia de caracteres (código do período)	herdado da versão de origem
Início do plano	Início do plano	N	N	Não usado	startOfPlan	Cadeia de caracteres (código do período)	herdado da versão de origem
Bloquear período anterior	Bloqueia na versão, a edição dos períodos especificados de dados. Mostrado como "Bloquear {leaf stratum} inicial até" na interface de usuário.	N	Não usado	Não usado	lockLeadingTimePeriod	Cadeia de caracteres (código do período)	herdado da versão de origem
Bloquear conclusão anterior	A opção "Conclusão {leaf stratum}" da propriedade acima. Esta propriedade e "Bloquear período anterior" não podem ser especificadas no corpo da solicitação.	N	Não usado	Não usado	lockLeadingCompletion	Booliano	herdado da versão de origem
Valor por padrão	Torna a versão como o valor por padrão para todos os usuários.	N	Não usado	Não usado	valor por padrão	Booliano	false
Trilha de auditoria	Manter/excluir informações da trilha de auditoria.	N	N	Não usado	auditTrail	Booliano	herdado da versão de origem
Sobreposição de valores reais inclui níveis indisponíveis	Nas sobreposições de valores reais, exibe todos os níveis, mesmo os que não são mais usados.	N	N	Não usado	actualsOverlayIncludesUnavailableLevels	Booliano	false
Versão de valores reais para sobreposição	Sobrepõe os dados do plano aos dados da versão de valores reais especificada.	N	N	Não usado	actualsVersionOverlay	Cadeia de caracteres (nome da versão)	versão de valores reais raiz
Detalhar ID de transações	Habilita o recurso de detalhamento de transações para a versão.	N	N	Não usado	drillIntoTransactionId	Número inteiro	relatório por padrão
Versão preditiva	Se a versão a ser criada é uma versão preditiva.	Não usado	S, verdadeiro	Não usado	predictiveVersion	Booliano
Versão virtual	Se a versão a ser criada é uma versão virtual.	Não usado	Não usado	S, verdadeiro	virtualVersion	Booliano
returnId	Retorna uma ID de versão se for definida como verdadeira. Nova ID de versão se a operação criou uma nova versão. Caso contrário, retorna a ID da versão existente que foi atualizada.	N	N	N	returnId	Booliano	false (retorna 204 No Content com false, retorna 200 OK with version in na resposta se for definida como true)

- O tipo de valor VersionAccessControl pode assumir os seguintes valores de cadeia de caracteres: "HIDDEN", "LOCKED", "LOCKED_EXCEPT_NOTES", "IMPORT_AND_NOTES", "FULL_ACCESS"

- Versões de plano bloqueadas não podem ter "IMPORT_AND_NOTES" ou "FULL_ACCESS" definidas para nenhum grupo de usuários.

- As versões preditivas não podem ter "FULL_ACCESS" definido para nenhum grupo de usuários.

- As versões virtuais só podem ter a definição "OCULTADO" ou "BLOQUEADO" para qualquer grupo de usuários.

- Versões de plano e preditivas não podem ser criadas para empresas com consolidação habilitada sem o Planning.

Propriedades virtuais da versão

As propriedades a seguir existem no objeto aninhado virtualVersionProperties e são usadas somente para versões virtuais:

Nome	Descrição	Obrigatório (para o plano)	Obrigatório (para preditivo)	Obrigatório (para virtual)	Nome da propriedade no corpo da solicitação	Tipo de valor	Valor por padrão
Versão básica	A versão que fornecerá os dados de base para a versão virtual. Não pode ser uma versão virtual ou uma subversão de valores reais.	Não usado	Não usado	N	baseVersion	Cadeia de caracteres (nome da versão)	versão por padrão
Versão da taxa cambial	A versão que disponibilizará a taxa cambial para a versão virtual usada para relatórios de moeda constante. Não pode ser uma versão virtual ou uma subversão de valores reais.	Não usado	Não usado	N	exchangeRateVersion	Cadeia de caracteres (nome da versão)	versão de valores reais raiz
Habilitar relatórios constantes de moeda	Habilitar/desabilitar relatórios constantes de moeda.	Não usado	Não usado	N	enableConstantCurrencyReporting	Booliano	false
Deslocamento	Valor de deslocamento para trás (número inteiro positivo) ou para a frente (número inteiro negativo).	Não usado	Não usado	N	offset	Número inteiro	0

Propriedades de acesso à publicação

As seguintes propriedades do corpo da solicitação são usadas somente quando a WD está habilitada:

Nome	Descrição	Obrigatório (para o plano)	Obrigatório (para preditivo)	Obrigatório (para virtual)	Nome da propriedade no corpo da solicitação	Tipo de valor	Valor por padrão
Planos financeiros	Habilitar/desabilitar planos financeiros para esta versão. Usado somente quando o Adaptive Planning for Financial Plans está habilitado.	N	Não usado	Não usado	financialPlans	Booliano	false
Planos de headcount	Habilita/Desabilita planos de headcount para esta versão. Usado somente quando o Adaptive Planning for Financial Plans ou o Adaptive Planning for the Workforce está habilitado.	N	Não usado	Não usado	headcountPlans	Booliano	false
Planos de ação de pessoal	Habilite/desabilite os planos de ação do pessoal para esta versão. Usada somente quando o Adaptive Planning para o Workforce está habilitado.	N	Não usado	Não usado	workforceActionPlans	Booliano	false

Corpo da solicitação de amostra

Corpo da solicitação
{ "parent": "Parent Folder", "versionType": "PLANNING", "description": "Test Plan Version", ... ... "usersAccess": "LOCKED_EXCEPT_NOTES", "editableSheetAccess": "LOCKED", ... "startOfVersion": "2012", "endOfVersion": "2013", "startingScrollLocation": "01/2012", "lockLeadingTimePeriod": "02/2012", "actualsOverlayIncludesUnavailableLevels": true }

Parâmetros de consulta

Nome	Descrição	Obrigatório (para o plano)	Obrigatório (para preditivo)	Obrigatório (para virtual)	Nome do parâmetro no URL	Valor por padrão
Nome da versão de origem	O nome da versão a ser clonada. Se não é especificada, clona a partir da versão por padrão.	N	N	Não usado	sourceVersionName
Nome da nova versão	Nome da nova versão a ser criada.	S	S	S	newVersionName
Copiar todos os dados	Se verdadeira, copia todos os dados.	N	Não usado	Não usado	copyAllData	false
Copiar fórmulas e regras compartilhadas	Se verdadeira, copia fórmulas e regras compartilhadas.	N	Não usado	Não usado	copySharedFormulasAndRules	false
Copiar todas as fórmulas de substituição	Se verdadeira, copia todas as fórmulas de substituição.	N	N	Não usado	copyAllOverrideFormulas	false
Copiar divisões em contas LR e personalizadas	Se verdadeira, copia as divisões em contas LR e personalizadas.	N	Não usado	Não usado	copySplitsInGLAndCustomAccounts	false
Copiar linhas modeladas	Se verdadeira, copia as linhas modeladas.	N	Não usado	Não usado	copyModeledRows	false
Copiar observações de célula, planilha e fluxo de trabalho	Se verdadeira, copia observações de célula, planilha e fluxo de trabalho (se aplicável).	N	Não usado	Não usado	copyAllNotes	false
Redefinir o status do fluxo de trabalho como Em andamento	Se verdadeira, redefine o status do fluxo de trabalho como Em andamento.	N	Não usado	Não usado	resetWorkflowStatusToInProgress	false
Copiar histórico de trilhas de auditoria	Se verdadeira, adiciona como opção de parâmetro de relatório a todos os relatórios.		Não usado	Não usado	copyAuditTrailHistory	false
Adicionar como opção de parâmetro de relatório para todos os relatórios	Se verdadeira, adiciona como opção de parâmetro de relatório a todos os relatórios.	N	Não usado	Não usado	addAsReportParameterChoiceToAllReports	false
Copiar valores recalculados das planilhas	Se verdadeira, copia os valores recalculados das planilhas.	N	Não usado	Não usado	copyRecalculatedValuesOfSheets	false
Prosseguir com avisos	Um parâmetro de consulta opcional usado para ignorar mensagens de aviso. Se não for definida como verdadeira, avisos potenciais serão retornados antes que a chamada seja executada. Ignore-os especificando esse parâmetro como verdadeiro no URL.	N	N	N	proceedWithWarnings	false
código da instância	O instanceCode do qual recuperar valores. Por exemplo, GLOBO. Se nenhum instanceCode é especificado, a instância por padrão do usuário é usada.	N	N	N	instanceCode	Instância por padrão do usuário

A opção "Redefinir status do fluxo de trabalho como Em andamento" não tem suporte para empresas com o Fluxo de trabalho desabilitado.

- A opção "Copiar valores recalculados de planilhas" não tem suporte se o indicador da funcionalidade ISOLAMENTO DE Modelo está desativado.

Parâmetros do roteiro:

Nome	Descrição	Obrigatório
tenant	O locatário para operar, por exemplo, GREENCO	S

Exemplo de resposta:

204 NO_CONTENT

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