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 HTTPS connection using the REST PUT 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 PUT 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 | Model Description/Schema & Parameters |
Parameters
The required parameters for a PUT request to the Repository API are outlined below:
| Name | Type | Description | Required |
|---|---|---|---|
| Id | GUID | The unique identifier of the repository item to be updated. | ✓ |
CompanyId | Integer | Your unique Company Id found on the Company Setup page of the secure website. | ✓ |
Name | String | The repository item’s name. | |
| Description | String | The repository item’s description. | |
| Category | String | The repository item’s category type (if applicable). | |
| Keywords | String | The repository item’s keywords (comma-separated list). | |
| VendorId | Integer | Your unique vendor account identifier. | ✓ |
| MasterId | Integer | Your unique Enterprise Toolkit account identifier. | |
| IntegrationKey | String | Your unique Integration Key found on the Company Setup page of the secure website. | ✓ |
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
PUT https://eforms.mobileform.net:443/api/v2/repositoryResponse Body
{
"Id": "9cfXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"CompanyId": 6XXXX,
"Name": "Facility Inspection Checklist - TEST",
"Description": "",
"Category": "",
"Keywords": "",
"VendorId": 6XXXX,
"IntegrationKey": "995XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}Response Body
{
"RepositoryItem": {
"Id": "9cfXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"CompanyId": 6XXXX,
"ContentType": "Screen",
"ContentId": "563XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Facility Inspection Checklist - TEST",
"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"
}
}