POST Repository API (Create)

POST Repository API (Create)

TABLE OF CONTENTS


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 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 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 POST verb for the Repository API allows you to register new content from a company account. 
The required and optional parameters for a POST call to the Repository API are outlined below. 


NameTypeDescriptionRequired
CompanyId
IntegerYour unique Company ID is found on the Organization Setup page of the secure website.
✓
ContentType
StringThe type of content for this Repository item.
✓
ContentId
String
The unique identifier of the content for this Repository item. For Screen and Doc content, this identifier tracks the current Published version.
✓
Name
String
The Repository item's name.
✓
Description
String
The Repository item's description.
✓
Category
String
The Repository item's category type.
✓
Keywords
String
The Repository item's keywords.

VendorId
IntegerYour 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
String
Your unique Integration Key is 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 the Postman API Platform.


Below is an example of a typical POST submission to this API endpoint in JSON.


Request URL

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

Request Body

{
  "CompanyId": 6XXXX,
  "ContentType": "Screen",
  "ContentId": "36cXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "Name": "Job Order TEST",
  "Description": "TEST Description text",
  "Category": "General",
  "Keywords": "",
  "VendorId": 6XXXX,
  "IntegrationKey": "995XXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Response Body

{
  "RepositoryItem": {
    "Id": "f31XXXXXXXXXXXXXXXXXXXXXXXXX",
    "CompanyId": 6XXXX,
    "ContentType": "Screen",
    "ContentId": "36cXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "Name": "Job Order TEST",
    "Description": "TEST Description text",
    "Category": "General",
    "Keywords": ""
  }
}

Response Code

200


    • Related Articles

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

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