Query Dialects

Get a list of available query dialects for a queryable schema.

Use the Query Dialects resource to return the available query dialects.

Syntax

Resource

/dfs/api_version/metadataRepository/repositoryVersion/queryableSchema/

Available since release

v4.0

Formats

OData 4.0

HTTP methods

GET

Authentication

Provided by Salesforce via Cloud to Cloud authentication. This means that the named credential cannot be called directly and must be called via Salesforce. For example, via the developer console, an Apex resource, or component.

Request body

N/A

Request parameters

URI Parameter	Description
apiVersion	Version of API syntax to use. For example: v`4.0`
metadataRepository	Optional. Specify a condition to narrow the results returned. Only the EQ operator is supported. However, other operators might work depending on the type of data source you are querying. For example: `core%2fstmfana44ice1%2f00DRM000000F1or2AC`
repositoryVersion	The mapping version to use. For example: `2.0.1`
queryableSchema	The queryable schema to use. There are two possible values for queryableSchema: the schema of the org issuing the query or the Cloud Information Model (CIM). The value for the org issuing the query is the data source API name that was supplied when the org was connected to Customer 360 Data Manager. The CIM value is automatically created for your environment and must be retrieved through the Queryable Schema resource. For example: `Org1Connection`

Query parameters

Parameter	Description
$select	Required. Selects data to return. The query selects entities and attributes in the Cloud Information Model (CIM). Data from all data sources that are mapped to those entities and attributes are returned. For example: `$select=Id,ExternalRecordId,OrderNumber,GrandTotalAmount`
$filter	Optional. Specify a condition to narrow the results returned. Only the EQ operator is supported. However, other operators might work depending on the type of data source you are querying. For example: `$filter=ExternalRecordId`. The ExternalRecordID is used to filter on the global party ID.
$orderby	Optional. Orders returned results. This uses the ODATA orderby operators and syntax. If there are more than the maximum 25 results to return, this returns 25 results and then orders them, rather than ordering the full data set and then returning 25 results. Note For example: `$orderby=OrderNumber asc`
$top	Limits the maximum number of records returned. This must be an integer over 0. For example: `$top=5`
$expand	Only `$select` is supported as a query parameter in an `$expand` query. The depth of a nested `$expand` query that is allowed depends on the data source you are querying. For example: `$expand=BillToAddressId($select=AddressLine1,CityName,PostalCodeText,StateProvinceName),SalesOrderProducts($select=OrderedQuantity,Description,ListPriceAmount,LineAdjustmentSubTotalAmount,TotalTaxAmount,TotalLineAmount;`

Example

This example queries the available query dialects.

Request

1dfs/v4.0/core%2fstmfana44ice1%2f00DRM000000F1or2AC/v2.3/org1connection/

Response

1{
2  "dialects" : [ {
3    "id" : "odata"
4  } ]
5}

Data Federation API Developer Guide

Query Dialects

Syntax

Example