POST Repository API (Create Installations)

POST Repository API (Create Installations)

TABLE OF CONTENTS

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.
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 POST 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 POST submission to create a Repository installation into a company account are outlined below: 


NameTypeDescriptionRequired
RepositoryItemId
String
The Repository item's unique identifier.
✓
ToCompanyId
IntegerThe unique identifier of the single target Company to which the Repository item should be installed.
 ✓
ToCompanyIds
Array[integer]
The unique identifiers of the multiple target Companies to which the Repository item should be installed.

MasterIds
BooleanThe Environments account's unique identifier to determine whether the client accounts are eligible to have the item installed.

KeepInSync
Boolean
Whether or not this Repository item's content should be locked in the target Company account.

ReplaceRows
Boolean

Whether or not any Data Source rows associated with this Repository item in the target Company should be replaced with the rowset from the owning Company.

Force
Boolean
Whether or not to ignore errors and force the operation, warning this may lead to broken screens, and data loss as items may be removed/replaced regardless of any issues it may cause.

VendorId
Integer
Your unique Vendor account identifier.

*Required if the account resides under a Master Vendor account.
✓*
MasterId
Integer
Your unique Enterprise Toolkit account identifier.

*Required if the account resides under a Master Enterprise account with EntToolKit enabled.
✓*
IntegrationKey
StringYour unique Integration Key found on the Organization 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.


Below is an example of a typical POST Body in JSON.


Request URL

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


Request Body

{
  "RepositoryItemId": "c78XXXXXXXXXXXXXXXXXXXXXXXX",
  "ToCompanyId": 7XXXX,
  "MasterIds": false,
  "KeepInSync": false,
  "ReplaceRows": false,
  "Force": false,
  "VendorId": 6XXXX,
  "IntegrationKey": "995XXXXXXXXXXXXXXXXXXXXXXXX"
}
JavaScript

Response Body

{
  "Message": "Content successfully scheduled for install"
}

Response Code

200


    • Related Articles

    • POST Repository API (Create)

      TABLE OF CONTENTS Parameters Example The POST Repository API registers new content from a company account into the Repository. This API is available via SSL-secured HTTPS connection on the Cloud using the REST POST verb. The format query string ...

    • POST Screen

      TABLE OF CONTENTS Parameters Example The POST Screen Form API allows you to create a form programmatically rather than in the designer. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query ...

    • POST User

      TABLE OF CONTENTS POST Request POST Response User Response () User () Response Fields API Usage Example POST Request You may use either JSON or XML formats in your request. You indicate this by setting the ContentType HTTP header as ...

    • POST Folder

      The POST Folder API creates a new folder in the company's account. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response format. Specify either ...

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