DELETE Repository API (Remove)
TABLE OF CONTENTS
This DELETE Repository API call allows you to remove an existing repository item from the repository.
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/repository?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 PUT request to the Screens API are outlined below:
| Name | Type | Description | Required |
| Id | String | The Repository item's unique identifier. | ✓ |
| CompanyId | Integer | Your unique Company Id found on the Organisation Setup page of the secure website. | ✓ |
| IntegrationKey | String | Your unique Integration Key found on the Organisation Setup page of the secure website. | ✓ |
| VendorId | Integer | Your Vendor account unique identifier. | |
| MasterId | Integer | Your Enterprise Toolkit account unique identifier. |
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
Response Body
Related Articles
POST Repository API (Create Installations)
TABLE OF CONTENTS Parameters Example Using this API endpoint and the POST verb, you can install/update repository item content in a target company account. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. ...POST Repository API (Create)
ADDITIONAL INFO API Explorer General Information The POST Repository API registers new content from a company account into the Repository. This API is available via SSL-secured HTTPS connection on the Cloud using the REST POST verb. The format query ...POST Repository API (Create)
TABLE OF CONTENTS Parameters Example The POST Repository API registers new content from a company account into the Repository. This API is available via SSL-secured HTTPS connection on the Cloud using the REST POST verb. The format query string ...PUT Repository API (Update)
TABLE OF CONTENTS Parameters Example This API call allows you to update a repository item. Enables scenarios where items in your repository can be updated by 3rd party systems quickly and easily. On the Cloud, this API is available via SSL-secured ...DELETE User
DELETE Request The DELETE verb allows you to delete a single User. Our platform will immediately remove the User from the platform. You may use either JSON or XML formats in your request. You indicate this by setting the ContentType HTTP header as ...