Versiones
Punto final de URL
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/versions
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/cloneVersion
(solo POST)
Versión: v1
Categoría | Envío, modificación y recuperación de metadatos |
Descripción | Modificación de metadatos |
Permisos obligatorios para invocar | |
Parámetros obligatorios en solicitud | Varía para el punto final:
PATCH, POST, DELETE: nombre de versión. ninguno para GET |
VERB HTTP admitidos
(Nota: las carpetas de versión no son compatibles con ninguno de los siguientes puntos finales)
Verbo HTTP | Recurso único | Recurso de recopilación | Descripción |
|---|---|---|---|
GET | No admitido | Compatible | Recuperar todas las versiones del entorno de cliente. |
ELIMINAR | Compatible | No admitido | Eliminar la versión eliminable existente. |
PARCHE | Compatible | No admitido | Cree/actualice versiones de cifras reales o actualice versiones de plan. |
POST | Compatible | No admitido | Cree una nueva versión de plan. |
GET
- URI de solicitud
- /api/rest/modeling/v1/{tenant}/versions:recupera todas las versiones del entorno de cliente.Recupera todas las versiones del entorno de cliente en una lista.Las propiedades que no se muestran en la interfaz de usuario para versiones específicas no se incluyen en sus objetos de versión correspondientes en la respuesta. Por ejemplo, startOfVersion para versiones de subvalores de cifras reales.Capaz de usar la paginación a través de los parámetros "límite" y "compensación".Actualmente, las siguientes propiedades de versión no se admiten/no se muestran en GET:Versión base (para versiones virtuales), activar informes de moneda constante (para versiones virtuales),Calcular valores de fórmula, acceso de administrador, acceso de usuario, acceso a hojas editables, acceso a cifras reales con privilegios, grupo, nivel de acceso de grupo.URI de solicitud de muestra:HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?limit=25&offset=1Cuerpo de solicitud de muestra:<Dejar en blanco>Parámetros de consulta:NombreDescripciónObligatoriaslimitEl número máximo de objetos en una sola respuesta.NocompensaciónEl índice de base cero del primer objeto de una recopilación de respuestas. El valor por defecto es 0.Utilice la compensación con el parámetro limit para controlar la paginación de una recopilación de respuestas.NoParámetros de ruta:NombreDescripciónObligatoriasentorno de clienteEl entorno de cliente en el que operar, por ejemplo, GREENCOSí
- Ejemplo de respuesta
- 200 ACEPTARNota: el Inicio de versión para las versiones de cifras reales y el Límite de desplazamiento a la izquierda para las versiones de plan se muestran en la propiedad startOfVersion (puntero A).Del mismo modo, el Fin de versión para las versiones de cifras reales y el Fin de plan para las versiones de plan se muestran en la propiedad endOfVersion (puntero D).La Ubicación inicial de desplazamiento para las versiones de cifras reales y el Inicio de plan para las versiones de plan se muestran en la propiedad StartingScrollLocation (puntero C).Respuesta correcta.Respuesta de muestra{ "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 }
ELIMINAR
- Solicitud
- /api/rest/modeling/v1/{tenant}/versions:eliminación de una versión existenteElimina la versión con el nombre de versión especificado.La versión raíz de cifras reales y la versión por defecto no se pueden eliminar.URI de solicitud de muestra:HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}Cuerpo de solicitud de muestra:<Dejar en blanco>Parámetros de consultaNombreDescripciónObligatoriasversionNameNombre de la versión existente que se va a eliminar.SíinstanceCodeEl 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.NoParámetros de rutaNombreDescripciónObligatoriasentorno de clienteEl entorno de cliente en el que operar, por ejemplo, GREENCOSí
- Respuesta de muestra
- 204 NO_CONTENT
- La respuesta correcta está en blanco con el código de estado 204.
PARCHE
- Solicitud:
- /api/rest/modeling/v1/{tenant}/versions:cree/actualice versiones de cifras reales o actualice versiones de plan.Si existe un identificador de versión especificado, actualiza la versión de plan/cifras reales existente. De lo contrario, crea una nueva versión de cifras reales con ese identificador.Actualmente, se admiten dos conjuntos de identificadores de versión a través de parámetros de consulta:-nombre de versiónEs obligatorio especificar uno y solo uno de los parámetros de consulta anteriores en la URL de cada llamada.URI de solicitud de muestra:HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}Cuerpo de solicitud-JSON que contiene las propiedades de versión que se actualizarán para la versión existente o que se especificarán para la nueva versión que se creará.Actualizar:-Para las actualizaciones, no se requiere ninguna propiedad específica en el cuerpo de la solicitud (excepto versionType), pero sigue siendo necesario un cuerpo de solicitud. La sección del cuerpo de la solicitud dePOSTdescribe la lista de propiedades para los distintos tipos de versiones de plan.- Las propiedades del indicador (por ejemplo, journalEntryVersion) no se pueden actualizar; sin embargo, pueden permanecer en el cuerpo de la solicitud siempre que tengan el valor correcto sin cambios.-Actualmente no se admite la actualización principal.-Al actualizar versiones que no son de hoja (versiones que tienen elementos secundarios), los grupos de usuarios de estas versiones solo pueden tener tipos de acceso "FULL_ACCESS" o "HIDDEN". "FULL_ACCESS" se muestra como "VISIBLE" en la interfaz de usuario y es equivalente a "VISIBLE".-Los detalles de acceso de grupo (ID de grupo y nivel de acceso de grupo) se pueden eliminar especificando groupId=0 en el cuerpo de la solicitud de una llamada de actualización.Puede crear lo siguiente:-Para las creaciones, las siguientes propiedades están disponibles para su especificación en el cuerpo de la solicitud:PropiedadesDescripciónObligatorio (para cifras reales)Obligatorio (para asiento)Nombre de propiedad en cuerpo de solicitudTipo de valorValor por defectoNombre cortoNombre corto de versión.NoNoshortNameCadenacadena vacíaPrincipalPrincipal de esta versión.NoNoprincipalCadena (nombre de versión)versión raíz de cifras realesTipo de versiónTipo de versión (ACTUALS o PLANNING)Y, ACTUALSY, ACTUALSversionTypeCadenaDescripciónDescripciónNoNodescripciónCadenacadena vacíaAcceso de administradoresNivel de acceso a la versión para administradores.NoNoAdministratorsAccessVersionAccessControlheredado de principalAcceso de usuarioel nivel de acceso a la versión para los usuarios.NoNouserAccessVersionAccessControlheredado de principalAcceso con privilegios a cifras realesNivel de acceso a versión para cualquier persona con el permiso Acceso a cifras reales con privilegios.NoNoprivilegedActualsAccessVersionAccessControlheredado de principalID de grupoUn ID de grupo de usuarios especificadoNoNogroupIdValor enteroheredado de principalNivel de acceso de grupoNivel de acceso a versión del grupo de usuarios especificado.Y si se especifica el ID de grupo.Y si se especifica el ID de grupo.groupAccessLevelVersionAccessControlheredado de principalTraza de auditoríaMantener/eliminar información de trazas de auditoría.NoNoauditTrailBooleanofalse (se hereda del elemento principal para las versiones de asiento)Versión de asientoSi la versión que se va a crear es un asiento.NoY, verdaderojournalEntryVersionBooleanoreturnIdDevuelve un ID de versión si se establece como verdadero. ID de nueva versión si la operación ha creado una nueva versión. De lo contrario, devuelve el ID de la versión existente que se ha actualizado.NoNoreturnIdBooleanofalse (devuelve 204 Sin contenido como falso, devuelve 200 OK con versión en la respuesta si se establece como verdadero)-El tipo de valor VersionAccessControl puede adoptar los siguientes valores de cadena: "HIDDEN", "LOCKED", "LOCKED_EXCEPT_NOTES", "IMPORT_AND_NOTES", "FULL_ACCESS".-Los ID de grupo se pueden obtener a través de la API pública de exportGroups.- Las versiones de asiento no son compatibles con las empresas que tienen la consolidación desactivada.Propiedades de versión de asiento:Las siguientes propiedades existen en el objeto anidado journalEntryVersionProperties (consulte el cuerpo de solicitud de muestra) y solo se utilizan para las versiones de JE:PropiedadesDescripciónObligatorio (para cifras reales)Obligatorio (para asientos)Nombre de propiedad en el cuerpo de la solicitudTipo de valorValor por defectoNumeración de asientoEspecifique cómo se numerarán los asientos. Puede ser automático (A), manual (M) o ninguno (N).Sin utilizarNojournalEntryNumberingCadenaninguno (N)PrefijoPrefijo de numeración JESin utilizarY si la numeración de asiento es automática (A) o manual (M)prefijoCadenaNúmero inicialNúmero inicial de numeración JESin utilizarY si la numeración de asiento (A)númeroInicialValor enteroPropiedades específicas de cifras reales raíz:Las siguientes propiedades solo se utilizan al actualizar las cifras reales de raíz:PropiedadesDescripciónObligatoriasNombre de propiedad en cuerpo de solicitudTipo de valorInicio de versiónInicio de versiónNostartOfVersionCadena (código de periodo)Fin de versiónFin de versiónNoendOfVersionCadena (código de periodo)Inicio de ubicación de desplazamientoInicio de ubicación de desplazamiento de versiónNoStartingScrollLocationCadena (código de periodo)Valores finalizados hastaCuando se detiene la superposición de cifras reales en la versión de planNocompleteValuesThroughCadena (código de periodo)Activar flujo de trabajoLe permite enviar cifras reales por nivel en Flujo de trabajo.NoendableWorkflowBooleanoCuerpo de solicitud de muestra:Cuerpo de solicitud{ "parent": "Parent Version", "versionType": "ACTUALS", ... "administratorsAccess": "FULL_ACCESS", "usersAccess": "IMPORT_AND_NOTES", ... ... "auditTrail": true }Cuerpo de solicitud de muestra para versiones con propiedades anidadas (versiones de asiento y versiones virtuales):Cuerpo de solicitud{ "parent": "Actuals", "versionType": "ACTUALS", "shortName": "test JE version", "journalEntryVersion": "true", "journalEntryVersionProperties": { "journalEntryNumbering": "A", "prefix": "JE-Prefix", "startingNumber": "25" }, ... "auditTrail": true }Parámetros de consulta:NombreDescripciónObligatoriasversionNameNombre de la nueva versión que se creará o de la versión existente que se actualizará.SíprocedaWithWarningsUn parámetro de consulta opcional que se utiliza para descartar mensajes de aviso. Si no se establece en verdadero, se devolverán posibles avisos antes de que se ejecute la llamada. Para descartarlos, especifique este parámetro como verdadero en la URL.NoinstanceCodeEl 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.NoParámetros de ruta:NombreDescripciónObligatoriasentorno de clienteEl entorno de cliente en el que operar, por ejemplo, GREENCOSíPublicación de propiedades de acceso:Las siguientes propiedades de cuerpo de solicitud solo se utilizan cuando WD está activado:
- Respuesta de muestra
- 204 NO_CONTENTLa respuesta correcta está en blanco con el código de estado 204.
POST
- Solicitud:
- /api/rest/modeling/v1/{tenant}/cloneVersion:creación de una nueva versión de planCrea una nueva versión de plan o predicción mediante la clonación de una versión de origen/por defecto, o crea una versión virtual.Actualmente, se admiten dos conjuntos de identificadores de versión a través de parámetros de consulta:-nuevo nombre de versiónEs obligatorio especificar uno y solo uno de los anteriores en la URL de cada llamada.URI de solicitud de muestra:HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/cloneVersion?newVersionName=Budget 2012& sourceVersionName=Budget 2011& copyAllData=true& copySharedFormulasAndRules=true& copyAllOverrideFormulas=falseCuerpo de solicitud:JSON que contiene las propiedades de versión que se especificarán para la nueva versión que se creará.NombreDescripciónObligatorio (para plan)Obligatorio (para predictivo)Obligatorio (para virtual)Nombre de propiedad en cuerpo de solicitudTipo de valorValor por defectoNombre cortoNombre corto de versión.NoNoNoshortNameCadenacadena vacíaPrincipalCarpeta principal de esta versión.NoNoNoprincipalCadena (nombre de carpeta)Tipo de versiónTipo de versión (ACTUALS o PLANNING)Y, PLANNINGY, PLANNINGY, PLANNINGversionTypeCadenaDescripciónDescripción.NoNoNodescripciónCadenacadena vacíaVersión bloqueadaBloquea la versión completa para todos los usuarios, incluidas las fórmulas maestras y otras fórmulas de cuenta.NoSin utilizarSin utilizarversiónbloqueadaBooleanoheredado de la versión de origenCalcular valores de fórmulaEsta opción está disponible para las versiones de plan que tienen seleccionada la opción Versión bloqueada. Se utiliza para conservar los resultados calculados de fórmulas y referencias en la mayoría de las cuentas y para aumentar el rendimiento de las versiones bloqueadas.NoSin utilizarSin utilizarcalculateFormulaValuesBooleanofalsoAcceso de administradoresNivel de acceso a la versión para administradores.NoNoNoAdministratorsAccessVersionAccessControlheredado de la versión de origen (plan); IMPORT_AND_NOTES (predictivo); BLOQUEADO (virtual)Acceso de usuariosNivel de acceso a la versión para los usuarios.NoNoNousersAccessVersionAccessControlheredado de la versión de origen (plan); IMPORT_AND_NOTES (predictivo); BLOQUEADO (virtual)Acceso a hojas editablesNivel de acceso a la versión para cualquier persona con el permiso Acceso a hojas editables.NoNoNoeditableSheetAccessVersionAccessControlheredado de la versión de origen (plan, predictivo)ID de grupoEl ID de un grupo de usuarios especificado.NoNoNogroupIdValor enteroheredado de la versión de origen (plan, predictivo)Nivel de accesoNivel de acceso a versión del grupo de usuarios especificado.NoNoNogroupAccessLevelVersionAccessControlheredado de la versión de origen (plan, predictivo)Límite de desplazamiento a la izquierdaLímite de desplazamiento a la izquierda de la versión.NoNoSin utilizarstartOfVersionCadena (código de periodo)heredado de la versión de origenFin de planFin de planNoNoSin utilizarendOfPlanCadena (código de periodo)heredado de la versión de origenInicio de planInicio de planNoNoSin utilizarstartOfPlanCadena (código de periodo)heredado de la versión de origenBloquear periodo anteriorHace que los periodos de datos especificados no se puedan editar en la versión. Se muestra como "Bloquear {leaf stratum} en" en la interfaz de usuario.NoSin utilizarSin utilizarlockLeadingTimePeriodCadena (código de periodo)heredado de la versión de origenBloquear finalización inicialLa opción "Finalización {leaf stratum}" para la propiedad anterior. Esta propiedad y "Bloquear periodo anterior" no se pueden especificar en el cuerpo de la solicitud.NoSin utilizarSin utilizarlockLeadingCompletionBooleanoheredado de la versión de origenValor por defectoHace que la versión sea la versión por defecto para todos los usuarios.NoSin utilizarSin utilizarvalor por defectoBooleanofalsoTraza de auditoríaMantener/eliminar información de trazas de auditoría.NoNoSin utilizarauditTrailBooleanoheredado de la versión de origenSuperposición de cifras reales incluye niveles no disponiblesMuestra todos los niveles, incluso los que ya no se utilizan, en superposiciones de cifras reales.NoNoSin utilizaractualsOverlayIncludesUnavailableLevelsBooleanofalsoVersión de cifras reales para superposiciónSuperpone los datos del plan con los datos de la versión de cifras reales especificada.NoNoSin utilizaractualsVersionOverlayCadena (nombre de versión)versión raíz de cifras realesProfundizar en ID de transaccionesPermite profundizar en las transacciones de la versión.NoNoSin utilizardrillIntoTransactionIdValor enteroinforme por defectoVersión predictivaSi la versión que se va a crear es una versión predictiva.Sin utilizarY, verdaderoSin utilizarpredictiveVersionBooleanoVersión virtualSi la versión que se va a crear es una versión virtual.Sin utilizarSin utilizarY, verdaderovirtualVersionBooleanoreturnIdDevuelve un ID de versión si se establece como verdadero. ID de nueva versión si la operación ha creado una nueva versión. De lo contrario, devuelve el ID de la versión existente que se ha actualizado.NoNoNoreturnIdBooleanofalse (devuelve 204 Sin contenido como falso, devuelve 200 OK con versión en en la respuesta si se establece como verdadero)-El tipo de valor VersionAccessControl puede adoptar los siguientes valores de cadena: "HIDDEN", "LOCKED", "LOCKED_EXCEPT_NOTES", "IMPORT_AND_NOTES", "FULL_ACCESS".- Las versiones de plan bloqueadas no pueden tener "IMPORT_AND_NOTES" o "FULL_ACCESS" definidos para ningún grupo de usuarios.- Las versiones predictivas no pueden tener definido "FULL_ACCESS" para ningún grupo de usuarios.-Las versiones virtuales solo pueden tener definido "HIDDEN" o "LOCKED" para cualquier grupo de usuarios.-No se pueden crear versiones de plan ni predictivas para empresas que tengan activada la consolidación sin planificación.Propiedades virtuales de versiónLas siguientes propiedades existen en el objeto anidado virtualVersionProperties y solo se utilizan para las versiones virtuales:NombreDescripciónObligatorio (para plan)Obligatorio (para predictivo)Obligatorio (para virtual)Nombre de propiedad en cuerpo de solicitudTipo de valorValor por defectoVersión baseLa versión que proporcionará los datos base para la versión virtual. No puede ser una versión virtual ni una subversión de cifras reales.Sin utilizarSin utilizarNobaseVersionCadena (nombre de versión)versión por defectoVersión de tipo de cambioLa versión que proporcionará el tipo de cambio para la versión virtual utilizada en los informes de moneda constantes. No puede ser una versión virtual ni una subversión de cifras reales.Sin utilizarSin utilizarNoexchangeRateVersionCadena (nombre de versión)versión raíz de cifras realesActivar informes de moneda constantesActive/desactive los informes de moneda constante.Sin utilizarSin utilizarNoenableConstantCurrencyReportingBooleanofalsoCompensaciónImporte de compensación hacia atrás (entero positivo) o hacia adelante (entero negativo).Sin utilizarSin utilizarNooffsetValor entero0Publicación de propiedades de accesoLas siguientes propiedades de cuerpo de solicitud solo se utilizan cuando WD está activado:NombreDescripciónObligatorio (para plan)Obligatorio (para predictivo)Obligatorio (para virtual)Nombre de propiedad en cuerpo de solicitudTipo de valorValor por defectoPlanes financierosActivar/desactivar planes financieros para esta versión.Solo se utiliza cuando Adaptive Planning for Financial Plans está activado.NoSin utilizarSin utilizarfinancialPlansBooleanofalsoPlanes de headcountActivar/desactivar planes de headcount para esta versión.Solo se utiliza cuando Adaptive Planning for Financial Plans o Adaptive Planning for the Workforce están activados.NoSin utilizarSin utilizarheadcountPlansBooleanofalsoPlanes de acción de personalActivar/desactivar planes de acción de personal para esta versión.Solo se utiliza cuando Adaptive Planning for the Workforce está activado.NoSin utilizarSin utilizarworkforceActionPlansBooleanofalso
- Cuerpo de solicitud de muestraCuerpo de solicitud{ "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 consultaNombreDescripciónObligatorio (para plan)Obligatorio (para predictivo)Obligatorio (para virtual)Nombre de parámetro en URLValor por defectoNombre de versión de origenEl nombre de la versión desde la que se clonará. Si no se especifica, clona la versión por defecto.NoNoSin utilizarsourceVersionNameNombre de nueva versiónNombre de la nueva versión que se va a crear.SíSíSínewVersionNameCopiar todos los datosSi es verdadero, copia todos los datos.NoSin utilizarSin utilizarcopyAllDatafalsoCopiar reglas y fórmulas compartidasSi es verdadero, copia las fórmulas y reglas compartidas.NoSin utilizarSin utilizarcopySharedFormulasAndRulesfalsoCopiar todas las fórmulas de sustituciónSi es verdadero, copia todas las fórmulas de sustitución.NoNoSin utilizarcopyAllOverrideFormulasfalsoCopiar divisiones en libro mayor y cuentas personalizadasSi es verdadero, copia las divisiones en el libro mayor y en las cuentas personalizadas.NoSin utilizarSin utilizarcopySplitsInGLAndCustomAccountsfalsoCopiar filas modeladasSi es verdadero, copia las filas modeladas.NoSin utilizarSin utilizarcopyModeledRowsfalsoCopiar notas de celda, hoja y flujo de trabajoSi es verdadero, copia las notas de celda, hoja y flujo de trabajo (si procede).NoSin utilizarSin utilizarcopyAllNotesfalsoRestablecer estado de flujo de trabajo a En cursoSi es verdadero, restablece el estado del flujo de trabajo a En curso.NoSin utilizarSin utilizarresetWorkflowStatusToInProgressfalsoCopiar historial de traza de auditoríaSi es verdadero, se añade como opción de parámetro de informe a todos los informes.Sin utilizarSin utilizarcopyAuditTrailHistoryfalsoAñadir como opción de parámetro de informe a todos los informesSi es verdadero, se añade como opción de parámetro de informe a todos los informes.NoSin utilizarSin utilizaraddAsReportParameterChoiceToAllReportsfalsoCopiar valores recalculados de hojasSi es verdadero, copia los valores recalculados de las hojas.NoSin utilizarSin utilizarcopyRecalculatedValuesOfSheetsfalsoContinuar con avisosUn parámetro de consulta opcional que se utiliza para descartar mensajes de aviso. Si no se establece en verdadero, se devolverán posibles avisos antes de que se ejecute la llamada. Para descartarlos, especifique este parámetro como verdadero en la URL.NoNoNoprocedaWithWarningsfalsoCódigo de instanciaEl 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.NoNoNoinstanceCodeInstancia por defecto del usuario-"Restablecer estado de flujo de trabajo a en curso" no es compatible con las empresas que tienen el flujo de trabajo desactivado.- "Copiar valores recalculados de hojas" no se admite si el indicador de función MODEL ISOLATION está desactivado.Parámetros de ruta:NombreDescripciónObligatoriasentorno de clienteEl entorno de cliente en el que operar, por ejemplo, GREENCOSí
- Ejemplo de respuesta:
- 204 NO_CONTENTLa respuesta correcta está en blanco con el código de estado 204.