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 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"

---

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

https://eforms.mobileform.net:443/api/v2/repository

HTML

Request 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"
  }
}

---

• Related Articles

• DELETE Repository API (Remove)

  TABLE OF CONTENTS Parameters Example 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 ...

• 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. ...

• PUT User

  TABLE OF CONTENTS PUT Request User Response () User () Response Fields API Usage Example PUT Request The PUT verb allows you to update a single, existing User on the platform. You may use either JSON or XML formats in your request. You indicate this ...

• PUT Company

  The Company API allows you to retrieve, create and delete client Companies on the platform. This enables scenarios where Companies created/maintained in other systems (e.g. SAP, Salesforce) can be replicated to the platform automatically. On our ...

• PUT Folder

  This API call allows you to update an existing Folder's properties. 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 ...