Documentation Center

Create or Update an XForm Template Configuration

Creates or updates an XForm template configuration.

Request

URI: /v2/xforms/config/{id}

HTTP Method: PUT

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 create or update.
Request Body:
  • XML: <xform id="xform.comment" type="doc" public="true" allow_edits="0" allow_replies="1" allow_status="1" 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|"/>
  • JSON: {"id":"xform.comment", "type":"doc", "public":"true", "allow_edits":"0", "allow_replies":"1", "allow_status":"1", "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|"}

Response

Success
  • XML: <result statusCode="0" status="SUCCESS" messageKey="Successfully created/updated XForm template configuration." message="Successfully created/updated XForm template configuration."/>
  • JSON: {"statusCode":0,"messageKey":"Successfully created/updated XForm template configuration.", "message":"Successfully created/updated XForm template configuration.", "status":"SUCCESS", "info":[]}
Failed
  • XML: <result statusCode="500" status="FAIL" messageKey="Failed to create/update XForm template id: xform.comment" message="Failed to create/update XForm template id: xform.comment" />
  • JSON: {"statusCode":500,"messageKey":"Failed to create/update XForm template id: xform.comment" ,"message":"Failed to create/update XForm template id: xform.comment" ,"status":"FAIL", "info":[]}

Permissions

"Develop application"

Example

Request:

PUT http://example.corp:8080/LiveContent/v2/xforms/config/xform.comment

Accept: applicaton/xml

Content-Type: applicaton/xml

Request Body: <xform allow_edits="1" allow_replies="1" allow_status="1" id="xform.comment" icon="comment.png" public="true" status_options="xform.status.accepted|xform.status.rejected|xform.status.completed|" type="doc" xformfile="xform.comment.html"/>

Response:

<result statusCode="0" status="SUCCESS" messageKey="Successfully created/updated XForm template configuration." message="Successfully created/updated XForm template configuration."/>