Create Ticket My Tickets Post Discussion
Welcome
Login  Sign up

DELETE Repositorys API (Remove Installations)

TABLE OF CONTENTS

The DELETE Repository Install API lets you uninstall Repository item content from a target company account.


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/install?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 remove an installation through the Repository API are outlined below:


NameTypeDescriptionRequired
RepositoryItemIdStringThe Repository item's unique identifier (GUID).
IntegrationKeyStringYour Enterprise Toolkit or Vendor account's unique integration key.

VendorIdIntegerYour unique Integration Key found on the Organisation Setup page of the secure website.
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

443/api/v2/repository/install?RepositoryItemId=c78XXXXXXXXXXXXXXXXXXXXXXXXXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&VendorId=6XXXX


Response Body

{
  "Installs": [
    {
      "RepositoryItemId": "c78XXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "ToCompanyId": 7XXXX
    }
  ],
  "TotalRows": 1
}




Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.