This request method lets you find all repository items matching the parameters.
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/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”
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | /api/v2/repository/search | Model Description/Schema & Parameters |
Parameters
The GET verb allows you to retrieve repository items by specifying name, content type (folder, screen, etc…) or category.
The required and optional parameters for a GET call to the Repository API are outlined below.
| Name | Type | Description | Required |
|---|---|---|---|
| CompanyId | Integer | Your unique Company Id is found on the Organisation Setup page of the secure website. | ✓ |
| IntegrationKey | String | Your unique Integration Key is found on the Organisation Setup page of the secure website. | ✓ |
| VendorId* | Integer | Your unique Vendor account identifier. *Required if the account resides under a Master Vendor account. | ✓* |
| ContentType | String | Search by the type of content linked to Repository items. | |
| Name | String | Repository item name (or part thereof) to search for. | |
| Keyword | String | Repository item keyword (or part thereof) to search for. | |
| Category | String | Category of Repository items to search for. | |
| PageNo | Integer | The page number from which to start reading results (0-based). | |
| HasInstalls | Boolean | Search for Repository items that have/have not been installed into other Company accounts. | |
| MasterId | Integer | Your unique Enterprise Toolkit account identifier. *Required if the account resides under a Master Enterprise account with EntToolKit enabled. | ✓* |
| PageSize | Integer | 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://eforms.mobileform.net:443/api/v2/repository/search?CompanyId=6XXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXX&&&&&&VendorId=6XXXXResponse Body
{
"Items": [
{
"Id": "e88XXXXXXXXXXXXXXXXXXXXXXXXXXX",
"CompanyId": 6XXXX,
"ContentType": "Screen",
"ContentId": "726XXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Add/Edit Asset",
"Description": "Add assets to a comprehensive asset register\r\nIncludes ability to print asset tags to a suitable connected printer\r\nProduces an asset checkout report with a QR code for each asset for easy asset maintenance in future.",
"Category": "Administration",
"Keywords": "asset,manager,add,register"
},
{
"Id": "9cfXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"CompanyId": 6XXXX,
"ContentType": "Screen",
"ContentId": "563XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Facility Inspection Checklist",
"Description": "- Produce a professional facility inspection report.\r\n- Includes a comprehensive checklist, ability to generate a unique submission ID & include multiple photos as part of report.",
"Category": "RealEstate",
"Keywords": "facilities, facility management, building inspection"
}
],
"TotalRows": 2
}