Quick API Question

For requests or help with our API
Post Reply
mandmdiet
Posts: 113
Joined: Tue Aug 17, 2021 9:37 am

Quick API Question

Post by mandmdiet » Tue May 02, 2023 2:22 pm

For doing reads from Open Dental, we've been primarily using Queries PUT ShortQuery but we recently came across a use case where we will need a large amount of records from Open Dental and paging 100 records at a time would not be a workable solution. Given that, we were looking at implementing an SFTP server and Queries POST but wanted to check to make sure we're not missing another option for reading large data sets with custom queries in the OD API. For example, is there an option where we can request the file and avoid the need for the SFTP server?

Thank you!

SLeon
Posts: 476
Joined: Mon Mar 01, 2021 10:00 am

Re: Quick API Question

Post by SLeon » Tue May 02, 2023 2:43 pm

Good afternoon,

You are correct that there are two ways to run custom queries via the API:
  1. Queries PUT ShortQuery - As you mentioned, limits results to 100 rows (or 1000 rows in Local and Service API modes)
  2. Queries POST - Does not limit the rows returned. However this does require you setup an SFTP site to receive this data
Out of curiosity, what is your use case that paging with the ShortQuery endpoint is not a workable solution?

mandmdiet
Posts: 113
Joined: Tue Aug 17, 2021 9:37 am

Re: Quick API Question

Post by mandmdiet » Tue May 02, 2023 2:57 pm

SLeon, we can page with ShortQuery but some of our clients have very large databases and some of the tables could cause us to have to page dozens of times. Technically feasible and not an issue on our end but we wouldn't want to overwhelm the customer instance of Open Dental and we also have to plan for the worst-case scenario where a customer's internet or computer may not be very powerful.

Post Reply