Create Ticket My Tickets Post Discussion
Welcome
Login  Sign up

GET Repository API (Search Installations)

TABLE OF CONTENTS

ADDITIONAL INFO


This request method lets you find all installations of a given Repository item.  

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


/api/v2/repository/install/search?format=xml/json


You may use either JSON or XML formats in your GET 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 GET verb allows you to search installations of a given repository item by specifying its RepositoryItemId.
The required and optional parameters for a GET call to the DataSource API are outlined below.

NameTypeDescriptionRequired
RepositoryItemIdStringRepository item to find installations for.
IntegrationKeyStringYour unique Integration Key found on the Organisation Setup page of the secure website.
VendorIdIntegerYour unique Vendor account identifier.

*Required if the account resides under a Master Vendor account.
*
MasterIdIntegerYour unique Enterprise Toolkit account identifier.

*Required if the account resides under a Master Enterprise account with EntToolKit enabled. 
*
PageNoIntegerThe page number from which to start reading results (0 based).

PageSizeInteger

The page size (number of rows) to return. Maximum allowable value is 250.



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

https://secure.formsonfire.com:443/api/v2/repository/install/search?RepositoryItemId=9cfXXXXXXXXXXXXXXXXXXXXXXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXX&VendorId=6XXXX

Response Body (no results, repository item specified is not installed anywhere)

{
  "Items": [
    {
      "Id": "c785XXXXXXXXXXXXXXXXXXXXXXXX",
      "CompanyId": 6XXXX,
      "ContentType": "Screen",
      "ContentId": "475XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "Name": "Facility Inspection - Checklist",
      "Description": "Facility Inspection - Checklist",
      "Category": "RealEstate"
    }
  ],
  "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.