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 for all data sources in your Customer 360 Data Manager Environment.

These entities can include:

account
contact
lead
order
case

Syntax

Resource

1/dfs/apiVersion/MetadataRepository/repositoryVersion/

Available since release

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	Required. Version of the DF API to use. The current version is v3.0. This value is taken from the named credential configuration. For example: `v3.0`
MetadataRepository	Required. Contact Customer Support for this value. This is unique per Customer 360 Data Manager environment. This identifies the repository that stores the mappings for your environment. For example: `core%2fstmfpba44ice1%2f00DRM000000D1or2BC`
repositoryVersion	Mapping version activated in Customer 360 Data Manager. Salesforce recommends taking this from the configuration of the DFS External Data Source. This allows your code to use whatever version they have most recently configured. For example: `1.2.0`

Parameter

Description

apiVersion

Required. Version of the DF API to use. The current version is v3.0. This value is taken from the named credential configuration.

For example: v3.0

MetadataRepository

Required. Contact Customer Support for this value. This is unique per Customer 360 Data Manager environment. This identifies the repository that stores the mappings for your environment.

For example: core%2fstmfpba44ice1%2f00DRM000000D1or2BC

repositoryVersion

Mapping version activated in Customer 360 Data Manager. Salesforce recommends taking this from the configuration of the DFS External Data Source. This allows your code to use whatever version they have most recently configured.

For example: 1.2.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.