DELETE - AppDaddy-Software-Solutions-Inc/framework-markup-language GitHub Wiki

<DELETE/> : Http

The DELETE datasource widget is used to delete data via an API endpoint using the standard HTTP DELETE method. Like all HTTP methods, DELETE can also return bindable response data upon succeeding. Response can be returned as JSON or XML(default).

Table of Contents

Usage

The DELETE widget is used to send an HTTP DELETE message to the specified url. DELETE upon succeeding can return data that can be bound using curly braces {}.

Ideals:

  • To remove data in its entirety from an API endpoint.
  • To execute and HTTP Delete on a remote URL.

Restrictions:

  • Data returned from a DELETE call must be valid xml or json.
  • DELETE removes both the tag and the value of data, up to the entire document depending on the configuration of the API. If removing the values of a data package is desired, a POST or PUT can be used.

Attributes :: HttpDataSource (inherited attributes)

Name Type Default Description Req
body string null The outer wrapper of the posting document tags. Used as an XML tag when defining a document manually, or attribute when creating the body automatically via a FORM

Methods :: HttpDataSource (inherited attributes)

Name Type Default Description Req

Examples

<DELETE id="D1" url="api/users/delete?key={KEY.value}"/>
<INPUT id="KEY" text="Enter User Key"/>
<BUTTON text="Submit" onclick="D1.start()"/>

Other Widgets You May Find Useful: