Fetch an XForm Template Configuration
Fetches a single XForm template configuration identified by its ID.
Request
URI: /v2/xforms/config/{id}
HTTP Method: GET
Header params:
- Accept:
[application/json] OR [application/xml] - Content-Type:
[application/json] OR [application/xml]
PATH Parameter(s):
- id: The ID of the XForm template configuration to fetch.
Response
Success
- XML:
<xform type="doc" status_options="xform.status.accepted|xform.status.rejected|xform.status.completed|" reply_status_options="xform.status.new|xform.status.accepted|xform.status.rejected|xform.status.completed|" public="true" id="xform.comment" allow_status="1" allow_replies="1" allow_edits="0"/> - JSON:
{"id":"xform.comment", "type":"doc", "public":true,"allow_edits":0,"allow_replies":1,"allow_status":1,"icon":null,"reply_status_options":"xform.status.new|xform.status.accepted|xform.status.rejected|xform.status.completed|", "status_options":"xform.status.accepted|xform.status.rejected|xform.status.completed|", "xformfile":null}
Failed
- XML:
<result statusCode="404" status="FAIL" messageKey="XForm template configuration was not found." message="XForm template configuration was not found."/> - JSON:
{"statusCode":404,"messageKey":"XForm template configuration was not found.", "message":"XForm template configuration was not found.", "status":"FAIL", "info":[]}
Permissions
"Use application"
Example
Request:
GET http://example.corp:8080/LiveContent/v2/xforms/config/xform.comment
Response:
<xform type="doc" status_options="xform.status.accepted|xform.status.rejected|xform.status.completed|" reply_status_options="xform.status.new|xform.status.accepted|xform.status.rejected|xform.status.completed|" public="true" id="xform.comment" allow_status="1" allow_replies="1" allow_edits="0"/>