Altova RaptorXML+XBRL Server 2024

RaptorXML+XBRL Server prend en charge plusieurs versions d'API Python. Toute version d'API Python précédente est aussi prise en charge par la version actuelle de RaptorXML+XBRL Server. La version d'API Python est sélectionnée par le flag de ligne de commande --script-api-version=MAJOR_VERSION. Le défaut de l’argument de MAJOR_VERSION est toujours la version actuelle. Un nouvel API Python MAJOR_VERSION de RaptorXML+XBRL Server est introduit lorsque des changements incompatibles ou des améliorations importantes sont introduites. Les utilisateurs de l'API ne doivent pas mettre à niveau leurs scripts existants lorsqu'une nouvelle version majeure est publiée.

Il est recommandé de :

•utiliser le flag --script-api-version=MAJOR_VERSION pour invoquer des scripts utilitaires depuis la ligne de commande RaptorXML+XBRL Server (ou l'API Web). Cela vous garantit que les scripts fonctionnent toujours comme prévu après les mises à jour de RaptorXML+XBRL Server, même si une nouvelle MAJOR_VERSION d'API a été publiée.

•Vous utilisez la dernière version de l’API pour de nouveaux projets, même si des versions précédentes seront prises en charge par des releases futures de RaptorXML+XBRL Server.

Les versions API Python recensées ci-dessous sont disponibles actuellement. La documentation des différents API est disponible en ligne dans les emplacements indiqués ci-dessous.

Exemples de fichiers

Pour des exemples de script qui utilisent les API Python de Raptor, allez à https://github.com/altova.

API Python version 1

Introduit avec la version v2014 de RaptorXML+XBRL Server

Voici l'API Python de RaptorXML+XBRL Server original. Il couvre la prise en charge pour accéder au modèle interne de RaptorXML+XBRL Server pour :

•XML 1.0 et XML 1.1 (module API xml)

•Schéma XML 1.0 et Schéma XML 1.1 (module API xsd)

•XBRL 2.1 (module API xbrl)

L'API peut être utilisé par le biais de fonctions de callback qui sont mises en place dans un fichier de script Python.

•on_xsi_valid

•on_xsd_valid

•on_dts_valid

•on_xbrl_valid

Un script est spécifié avec l'option --script sur la ligne de commande. Les fonctions de callback sont invoquées uniquement si la validation réussit. Les détails concernant les fonctions de rappel et l'API sont décrits dans la référence "Python API version 1" de RaptorXML+XBRL Server.

API Python version 2

Introduit avec la version v2015r3 de RaptorXML+XBRL Server. La dernière version API est 2.9.0.

Cette version API introduit plus de 300 nouvelles classes et réorganise les modules depuis l'API Python version 1 de RaptorXML+XBRL Server de manière à ce que des informations utilisées fréquemment (par exemple des données PSVI) peuvent être accédées plus simplement et des API liés sont regroupés logiquement (par exemple, xbrl.taxonomy, xbrl.formula, xbrl.table). Dans cette version, les fonctions de callback sont invoquées non seulement si la validation réussit, mais aussi si la validation échoue. Pour illustrer ce comportement, le nom des fonctions de callback a été changé en :

•on_xsi_finished

•on_xsd_finished

•on_dts_finished

•on_xbrl_finished

Pour activer la modularisation, RaptorXML+XBRL Server prend maintenant en charge plusieurs options --script. Les callbacks implémentés dans ces fichiers script Python sont exécutés dans l'ordre spécifié dans la ligne de commande.