6 Query API

Warning: Ignore this page and refer to the following topic if you plan to use the query API without username and password and log-in using federated authentication instead.

6.1 Making an API Call

The Query API works with POST HTTP requests. A server call should follow the template:

Request parameter Description Example
{dataCloudURL} The URL of the Data Cloud server {node}.dc.coresuite.com
{accountName} The account name used during the account registration myAccountName
{userAccountName} The user account name (received by email during the account registration) myUserName
{userAccountPassword} The user account password (please read the observation below) myPassword
{companyName} The company name used during the account registration myCompanyName
{clientIdentifier} The application's identifier that is doing the API call COR_CONNECTOR
{dtoVersions} The version of the resources that we will query for.

Please note how this text is constructed:
Resource1.Version;Resource2.Version;....;ResourceN.Version

Please check the Data Model section.
BusinessPartner.17;ServiceCall.17
{selectStatement} The Sql-Like statement we want to execute. SELECT bp.id, bp.name, sc.id FROM BusinessPartner bp JOIN ServiceCall sc ON bp=sc.businessPartner LIMIT 3

https://{dataCloudURL}/api/query/v1?
....
userAccountPasswordHash=d4decdde939c78532cbcf1948465bd4dfb338901fb83fb615773b3b630ff45e2209083249995c5c1e720a1c71649a6c53672dc8f52ebc01d352ffc949a4bfe87 &
....

Example

We want to get the first three pairs of (Business Partner , Service Call). In each pair there is this relation:

The Service Call is connected to its Business Partner by bp=sc.businessPartner


Request

POST https://et.dev.coresuite.com/api/query/v1?&account=scribe&company=Ambit%20AG&clientIdentifier=COR_CON_NONE?dtos=BusinessPartner.17;ServiceCall.17

POST request body (application/json)

{"query":"SELECT bp.id, bp.name, sc.id FROM BusinessPartner bp JOIN ServiceCall sc ON bp=sc.businessPartner LIMIT 3"}


6.2 Query API Guide

For information on supported clauses and functions, please refer to the following guide:

Writing Queries