Querying multiple tables with joins

Revision as of 17:32, 9 October 2015

1. 1. 1. Tutorial

Query a SQL database for records in different tables joined by key. Try these examples in the 'API Docs' tab of the DreamFactory Admin Console or from the command line with cURL.

Note that passing * as the 'related' parameter will return data for all related tables.

1. 1. 1. API Endpoint

GET https://{url}/api/v2/{api_name}/_table/{table_name}?related={foreign_key_field}

1. 1. 1. API Docs Screenshot

1. 1. 1. Example - Fetch contact and contact_info_by_contact_id records in one API call.

• Table name: contact
• Related parameter in API call:

  contact_info_by_contact_id

• Request URL:

  https://foo.com/api/v2/db/_table/contact?related=contact_info_by_contact_id

1. 1. 1. Example - Fetch contact, contact_info_by_contact_id, and contact_group_relationship_by_contact_id records in one API call.

• Table name: contact
• Related parameter in API call:

  contact_info_by_contact_id, contact_group_relationship_by_contact_id

• Request URL:

  https://foo.com/api/v2/db/_table/contact?related=contact_info_by_contact_id%2C%20contact_group_relationship_by_contact_id

1. 1. 1. Example - Fetch contact and all related records by foreign key in one API call.

• Table name: contact
• Related parameter in API call:

  *

• Request URL:

  https://foo.com/api/v2/db/_table/contact?related=*