This request method allows you to update Data Sources on the platform.
Enables scenarios where data sets maintained in other systems (e.g. SAP, Salesforce) can be updated into apps automatically.
Updates to a Data Source will be automatically synchronized to mobile devices by the platform. Thus if a Data Source is used in a Form or other Screen type, that Data Source can be kept continuously up to date via this API.
Currently, Data Sources cannot be deleted nor can they be created by this API – this is to protect existing Screens that use these Data Sources .
Thus, the Data Source must already exist on our platform and be referenced by its unique ExternalId for an API update to succeed.
Data Sources have a maximum limit of 50,000 rows. If more rows are required please contact our support team.
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/datasource?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"
ADDITIONAL INFO
CONTENTS
Endpoints & API Explorer
Parameters
The required parameters for a PUT request to the Data Sources API are outlined below.
DataSource (<DataSource>)
Name | Type | Description | Required |
Id |
GUID | The unique identifier of the Data Source that this request relates to. Required if ExternalId is not specified. |
✓ |
Name |
String |
The name of the Data Source. The value specified will overwrite the existing Data Source name. |
|
ExternalId |
String |
The external Id of the Data Source that this request relates to. |
✓ |
Headers | Collection |
A collection of Header Items. If not specified then the Headers of the Data Source will not be updated. |
|
Rows | Collection |
A collection of Row Items that will completely replace your current Data Source rows. |
|
NewRows | Collection |
A collection of Row Items that should be added/updated onto the existing Data Source rows. |
|
DeletedRows | Collection |
A collection of Row Items that should be deleted from the existing Data Source rows. |
|
CompanyId | Integer |
Your unique Company Id found on the Company Setup page of the secure website |
✓ |
IntegrationKey | String | Your unique Integration Key found on the Company Setup page of the secure website |
✓ |
Header (<Header>)
Name | Type | Description | Required |
Name | String |
Name of this Header |
|
DisplayAt | String | Specifies the desired app display position of this column’s values in each Data Source row. Options available are: Title – The main title area of the row SubLeft – Appears below the Title in smaller text Thumb – Displays the column value as an image thumbnail to the left of the Title. Only applicable if your column values are HTTP URLs pointing at PNG or JPG files. |
<p class="p1" style="box-sizing: border-box; margin-top: 1.4em; margin-bottom: 1.4em; font-family: Helvetica, sans-serif; line-h