Actualización masiva de metadatos
Compatible con API v17 +
La principal ventaja de las API de actualización masiva de metadatos es que permiten sincronizar niveles, dimensiones y cuentas de libro mayor dentro de
Adaptive Planning
con sus homólogos en un sistema externo de forma periódica y programada. En lugar de llamar a los elementos individuales uno por uno, estas API le permiten enviar un archivo XML sin formato o XML comprimido (comprimido) para actualizar, reordenar y crear elementos.Con las API masivas de metadatos, la nueva versión del árbol de elementos existentes se importa a
Adaptive Planning
.API de actualización masiva de metadatos:
- No eliminar nunca. Los elementos que faltan en la versión cargada permanecen intactos.
- Cree todos los elementos nuevos que se encuentren en la carga, si es posible.
- Actualice las propiedades de los elementos que se están cargando, incluidas sus propiedades de parentesco.
- Actualice las asignaciones de atributos que se están cargando.
- Permiten específicamente la carga parcial de árboles (dado que la eliminación nunca se realiza, las cargas parciales no son destructivas).
- Permiten identificar los elementos existentes en un árbol por su número de ID interno o por su campo de identificador exclusivo "original" (anterior a la actualización).
- Detener en caso de errores catastróficos y retrotraer. Los errores catastróficos incluyen:
- Intenta crear un ciclo en una jerarquía
- Intenta crear un nuevo elemento cuyo campo de identificación coincida con uno que ya está en el sistema (por ejemplo, creando una nueva cuenta con un código que está en uso)
- Intenta actualizar el campo de identificación de un elemento para que entre en conflicto con uno que ya está en el sistema.
- Continuar con los errores que se puedan ignorar que no detengan la importación y notificarlos en la respuesta de resultado como avisos. Los errores que se pueden ignorar incluyen aquellos que es poco probable que produzcan un efecto en cascada, como los siguientes:
- Intenta cambiar una asignación de atributo a un valor que no existe.
- Intenta definir un nombre de nivel demasiado largo para el campo.
Carga masiva mediante XML comprimido (en zip)
Para cargas útiles grandes, puede cargar contenido comprimido como un archivo ZIP que contenga solo el xml de las actualizaciones sin subdirectorios, carpetas u otro contenido. Si se detectan carpetas o subdirectorios en el ZIP en la publicación, se rechaza la solicitud.
Ejemplo de vinculación de un archivo XML comprimido (en zip)
curl -i -X POST -H "Content-Type: multipart/form-data" -F "request=<C:/temp/requestUpdateDimVal.xml" -F "content=@C:/temp/updateDimensions.zip" https://api.adaptiveplanning.com/api/v20
requestUpdateDimVal.xml content
<?xml version='1.0' encoding='UTF-8'?> <call method="updateDimensions" callerName="Steve C"> <credentials login="sampleuser@company.com" password="my_password"/> </call>
updateDimVal.zip/content.xml
<?xml version='1.0' encoding='UTF-8'?> <dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0"> <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" /> </dimension> </dimensions>
Todavía puede realizar solicitudes de API en el cuerpo de una llamada de API sin utilizar archivos adjuntos.
<?xml version='1.0' encoding='UTF-8'?> <call method="updateDimensions" callerName="Steve C"> <credentials login="sampleuser@company.com" password="my_password"/> <dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0"> <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" /> </dimension> </dimensions> </call>