List form data attachments API


Since Orbeon Forms 4.7.

Internal uses



The purpose of the attachments API is to return information about form data attachments.


  • URL: /fr/service/$app/$form/attachments?document=$document

  • Method: GET


  • $app is the form definition's application name

  • $form is the form definition's form name

  • $document is the form data's document id

Request parameters:

  • document: the id of the document (form data) to retrieve

Request body:

  • none

Response body:

  • Content-Type: application/xml

  • each child element contains

    • as text data the path to the attachment

    • name attribute: the associated control name

    • filename, mediatype, size: attachment metadata

Example response body:

<?xml version="1.0" encoding="UTF-8"?>
    <attachment name="my-image" filename="sunset.png" mediatype="image/png" size="19354">
    <attachment name="other-image" filename="africa.jpg" mediatype="image/jpeg" size="169202">


The caller must either call the service internally or have proper credentials to access the data (username, group, roles).

See also

Last updated