Overview

Skill Level: Intermediate

Prerequisites

Use this REST API to retrieve rows of relational table data that is joined to a specific database contact.

Step-by-step

  1. Access the Swagger User Interface for the Associated Relational Table REST API

    1. Create a database.
    2. Import a relational table.
    3. Associate the relational table with the database.
    4. Set up the App in the Application Account Access area located under Settings. This setup provides a client_token, client_secret and a refresh_token.
    5. Use the client_token, client_secret and refresh_token to access the REST API.

    Example call for associated relational table REST API

    Example of an Associated Relational Table REST API call.

    POST

    /databases/{lid}/relationaltables/{rtid}/rows{lid} = Database Id{rtid} = Relational Table Id

    Example of a call

    In Post

    {

    “joinedFields”: [

    {

    “name”: “emailaddress”,

    “value”: “carol@acme.com”

    }

    ],

    “fields”: [

    ]
    }

    Sample output

    Note: Order ID is a key column in the table.

    <keys>

    <string>orderId</string>

    <string>LastModified</string>

    <string>orderDate</string>

    </keys>

    <values>

    <string>4</string>

    <string>2016-09-20T16:32:26Z</string>

    <string>2016-04-12 00:00:00.0</string>

    </values>

    </com.google.common.collect.RegularImmutableMap>

    </elements>

    </data>

    </response>

Join The Discussion

Your email address will not be published. Required fields are marked *