Service | Data Federation API Developer Guide

Use the Service resource to request information about the top-level entities that can be queried. The resource returns an OData service document listing the CIM entities that have mappings in your Customer 360 Data Manager environment.

Any attributes you want to query must be mapped in all connected data sources. Attributes that are not mapped are not returned by the Metadata resource. If an entity or attribute you want to query is not available, ask your Customer 360 Data Manager admin to map it.

Syntax

Resource

v4.0

1/dfs/apiVersion/MetadataRepository/repositoryVersion/queryableSchema/odata

v2.0 and v3.0

1/dfs/apiVersion/MetadataRepository/repositoryVersion

Availability

2.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 a component.

Request body

N/A

Request parameters

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`
odata	This is the only available query dialect in v4.0.

Example

This gets the queryable entities for a specific version of the mappings in your environment. The results are the same, but the requests differ by the syntax of the API version.

v4.0 example

1/dfs/v3.0/core%2fstmfpba44ice1%2f00DRM000000D1or2BC/1.2.0/org1connection/

v2.0 and 3.0 example

1/dfs/v3.0/core%2fstmfpba44ice1%2f00DRM000000D1or2BC/1.2.0/

Usage

This is used to identify if there are any entities you can query. If you don't see the entity you want to query, contact the Customer 360 Data Manager and let them know they need to add mappings.