REST best practice

6min
Working with REST IDs
When a REST service returns an id, the 
﻿ local data provider can automatically be synced with this id, eliminating the need to add a sync-entities action to the 
﻿. 
The id property must be added in the outputTransform of the REST data provider function. 
This is useful on a POST (create) as a temp_id is created in the local data provider for the record when it is created. If the id is in the POST function outputTransform, the temp_id is automatically updated with the REST id once it is created on the REST side. 
The image shows how the local data provider creates a temp_id when a new customer is added. Then, it is automatically synced with the REST ID because the ID is in the function's outputTransform.
Syncing temp_Id
﻿
function.jigx
provider: DATA_PROVIDER_REST
method: POST # Create new record in the backend
url: https://jigx-training.azurewebsites.net/api/customers
useLocalCall: true

parameters:
  x-functions-key:
      location: header
      required: false
      type: string
      value: Y-8E9-PCmft4PXxfrr-RlFCcWszQnZf9gpJDq4XoAJAbAzFuvlRstA==
  firstName:
    type: string
    location: body
    required: true
  lastName:
    type: string
    location: body
    required: true
  companyName:
    type: string
    location: body
    required: true
  address:
    type: string
    location: body
    required: false
  phone:
    type: string
    location: body
    required: false
  email:
    type: string
    location: body
    required: false
   
inputTransform: |
  {
    "firstName": firstName,
    "lastName": lastName,
    "companyName": companyName,
    "address": address,
    "phone": phone,
    "email": email
  }
# add the id to the output which ensures the local table,
# is automatically updated with the REST id once it is created. 
outputTransform: |
  {
    "id": custId,
    "status": status
  }
provider: DATA_PROVIDER_REST
method: POST # Create new record in the backend
url: https://jigx-training.azurewebsites.net/api/customers
useLocalCall: true

parameters:
  x-functions-key:
      location: header
      required: false
      type: string
      value: Y-8E9-PCmft4PXxfrr-RlFCcWszQnZf9gpJDq4XoAJAbAzFuvlRstA==
  firstName:
    type: string
    location: body
    required: true
  lastName:
    type: string
    location: body
    required: true
  companyName:
    type: string
    location: body
    required: true
  address:
    type: string
    location: body
    required: false
  phone:
    type: string
    location: body
    required: false
  email:
    type: string
    location: body
    required: false
   
inputTransform: |
  {
    "firstName": firstName,
    "lastName": lastName,
    "companyName": companyName,
    "address": address,
    "phone": phone,
    "email": email
  }
# add the id to the output which ensures the local table,
# is automatically updated with the REST id once it is created. 
outputTransform: |
  {
    "id": custId,
    "status": status
  }
﻿
Where and when to sync and load data 
Knowing when to load and sync data is important as it can impact the apps performance and functionality when the device is offline.
Load data in the Index.jigx file by adding an onFocus, and onLoad for performance. This also ensures that all data is available if the device goes offline.
Add the sync-entity or sync-entities action to a global action﻿, to sync the data with the onFocus or onRefresh events ensuring effiecieny and reusablity throughout the solution. The global action is referenced in the solution's  
﻿s to sync data from the REST server. 
See REST syncing & loading local Data﻿ for an indepth explanation.
Working with complex REST structures
Working with complex REST objects can be tricky, as they include arrays, nested objects, and other complex data structures. When integrating and manipulating these JSON structures from the REST data provider configure the following:
JsonProperties in the SQLite query
jsonProperties:
        - addresses
In the expression used to retrieve the value, specify the exact property in the array or nested object that you require by referencing the JsonProperty followed by the property.
description: [email protected][0].city
   leftElement:
      element: avatar
      text: [email protected][0].state
Complex JSON
YAML
"customers": [
        {
            "custId": 1,
            "firstName": "Merilyn",
            "lastName": "Bayless",
            "companyName": "20 20 Printing Inc",
            "addresses": [
                {
                    "address": "195 13n N",
                    "city": "Santa Clara",
                    "county": null,
                    "state": "CA",
                    "zip": "95054"
                }
            ],
            "phones": [
                {
                    "mobile": "408-758-5015",
                    "office": "408-758-5015"
                }
            ],
            "email": "[email protected]",
            "web": "http://www.printinginc.com",
            "region": "US West",
            "customerType": "Silver",
            "jobTitle": "Project Manager",
            "logo": null
        },
"customers": [
        {
            "custId": 1,
            "firstName": "Merilyn",
            "lastName": "Bayless",
            "companyName": "20 20 Printing Inc",
            "addresses": [
                {
                    "address": "195 13n N",
                    "city": "Santa Clara",
                    "county": null,
                    "state": "CA",
                    "zip": "95054"
                }
            ],
            "phones": [
                {
                    "mobile": "408-758-5015",
                    "office": "408-758-5015"
                }
            ],
            "email": "merilyn_bayless@cox.net",
            "web": "http://www.printinginc.com",
            "region": "US West",
            "customerType": "Silver",
            "jobTitle": "Project Manager",
            "logo": null
        },
﻿
Data handling when a device is offline
Dealing with offline remote data is fundamental to ensuring data synchronization and consistency between the mobile app and the remote data source, allowing users to continue using the app and performing actions without interruption. Offline remote data handling﻿ explains how to configure solutions to deal with data when the device is offline.
See Also
﻿REST examples﻿﻿
﻿
﻿
Updated 20 Aug 2024
Did this page help you?
REST syncing & loading local Data
Salesforce
Docs powered by Archbee
TABLE OF CONTENTS
Working with REST IDs
Where and when to sync and load data
Working with complex REST structures
Data handling when a device is offline