Documentation Center

Fetch XForm Template Configurations

Fetches the list of all XForm template configurations.

Request

URI: /v2/xforms/config

HTTP Method: GET

Header params:
  • Accept: [application/json] OR [application/xml]
  • Content-Type: [application/json] OR [application/xml]

Response

Success
  • XML: <configuration><xform xformfile="xform.issue_report.html" type="floating" status_options="" public="false" icon="issue_report.png" id="xform.issue_report" allow_status="0" allow_replies="0" allow_edits="1"/><xform xformfile="xform.comment.html" type="doc" status_options="xform.status.accepted|xform.status.rejected|xform.status.completed|" public="true" icon="comment.png" id="xform.comment" allow_status="1" allow_replies="1" allow_edits="1"/></configuration>
  • JSON: {"xform":[{"id":"xform.issue_report", "type":"floating", "public":false, "allow_edits":1, "allow_replies":0, "allow_status":0, "icon":"issue_report.png", "reply_status_options":null, "status_options":"", "xformfile":"xform.issue_report.html"},{"id":"xform.comment", "type":"doc", "public":true,"allow_edits":1,"allow_replies":1,"allow_status":1,"icon":"comment.png", "reply_status_options":null,"status_options":"xform.status.accepted|xform.status.rejected|xform.status.completed|", "xformfile":"xform.comment.html"}]}
Failed
  • XML: <result statusCode="404" status="FAIL" messageKey="Config resource was not found.", message="Config resource was not found."/>
  • JSON: {"statusCode":404,"messageKey":"Config resource was not found.", "message":"Config resource was not found.", "status":"FAIL", "info":[]}

Permissions

"Use application"

Example

Request:

GET http://example.corp:8080/LiveContent/v2/xforms/config

Response:

<configuration><xform xformfile="xform.issue_report.html" type="floating" status_options="" public="false" icon="issue_report.png" id="xform.issue_report" allow_status="0" allow_replies="0" allow_edits="1"/><xform xformfile="xform.comment.html" type="doc" status_options="xform.status.accepted|xform.status.rejected|xform.status.completed|" public="true" icon="comment.png" id="xform.comment" allow_status="1" allow_replies="1" allow_edits="1"/></configuration>