Documentation Center

Delete an XForm Template Configuration

Deletes the XForm template configuration identified by its ID.

If you delete an XForm template configuration, all instances of that form (comments, for example) will also be deleted.

Request

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

HTTP Method: DELETE

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 delete.

Response

Success
  • XML: <result statusCode="0" status="SUCCESS" messageKey="Successfully deleted XForm template configuration." message="Successfully deleted XForm template configuration."/>
  • JSON: {"statusCode":0,"messageKey":"Successfully deleted XForm template configuration.", "message":"Successfully deleted XForm template configuration.", "status":"SUCCESS", "info":[]}
Failed
  • XML: <result statusCode="500" status="FAIL" messageKey="msg.delete.fail" message="Failed to delete these items."/>
  • JSON: {"statusCode":500,"messageKey":"msg.delete.fail", "message":"Failed to delete these items.", "status":"FAIL", "info":[]}

Permissions

"Develop application"

Example

Request:

DELETE http://example.corp:8080/LiveContent/v2/xforms/config/xform.custom

Response:

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