Metadata | Data Federation API Developer Guide

Use the metadata resource to request detailed information about the data model to use for queries. The resource returns an EDMX document that contains the entities and attributes that you can query. You can query the following top-level CIM entities:

account
contact
lead
order
case

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

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 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.
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.

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

Usage

If a CIM entity or attribute is not mapped for all data sources, it isn't returned as a part of the queryable data model. This means it must be mapped for both the querying org and all other orgs.