TABLE OF CONTENTS

• Parameters
• Example

The DELETE Screen Form API allows you to delete an existing form screen.

This allows you to delete specific screens from the platform as required, from various 3rd party systems, for whatever reason.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST DELETE verb.
The format query string parameter controls the desired response format.  Specify either XML or JSON.

/api/v2/screen/form?format=xml/json

You may use either JSON or XML formats in your DELETE request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".

If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters

The required parameters for a DELETE request to the Screens API are outlined below.

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.

Request URL

443/api/v2/screen/form?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Request Body

{
    "Id": "28fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "ExternalId": "",
    "Status": "",
    "TrashAllVersions": true,
    "CompanyId": 6XXXX,
    "IntegrationKey": "995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }