API to access DITA maps/files

Post here questions and problems related to oXygen frameworks/document types.
supportuser
Posts: 2
Joined: Tue Oct 21, 2025 8:48 pm

API to access DITA maps/files

Post by supportuser »

Is there an available API to pull all DITA maps and files out of Oxygen into another system? As well as an API to push DITA maps/files back into Oxygen?
Radu
Posts: 9544
Joined: Fri Jul 09, 2004 5:18 pm

Re: API to access DITA maps/files

Post by Radu »

Hi,
Are you working with Oxygen's Project view (local files) or with files from a CMS integrated with Oxygen via an installed plugin?
Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
supportuser
Posts: 2
Joined: Tue Oct 21, 2025 8:48 pm

Re: API to access DITA maps/files

Post by supportuser »

Working within the DITA Maps Manager view.
Radu
Posts: 9544
Joined: Fri Jul 09, 2004 5:18 pm

Re: API to access DITA maps/files

Post by Radu »

Hi,

A java-based Oxygen plugin could for example use this APi to export a DITA Map with all its resources to a target folder or a zip archive:
https://www.oxygenxml.com/InstData/Edit ... ssUpdater)

There is an example here about how this Java APi can be used from an Oxygen Javascript plugin:
https://github.com/oxygenxml/wsaccess-j ... ipToServer

We do not have specific APis for the other way around, for overwriting a DITA Map with an external zip for example. A Java based Oxygen plugin can use the regular Java methods to copy files, folders.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
Post Reply