GET /api/v1/dataGraph/metadata

Retrieves metadata for all accessible data graph objects in your Data Cloud instance. This endpoint returns detailed information about primary data model objects, related objects, and their fields.

  • HTTP Method: GET
  • Availability: Data Cloud v1.0, Salesforce v51.0
  • format: REST
  • URI: /api/v1/dataGraph/metadata
ParameterTypeDescription
dataGraphNamestringOptional. The name of a specific data graph to retrieve metadata for. Example: UnifiedIndividual_DG

The response includes an array of metadata objects, each containing:

  • developerName: The unique identifier of the data graph
  • description: Description of the data graph
  • dataspaceName: The dataspace where the data graph is located
  • primaryObjectName: The name of the primary data model object
  • valuesDmoName: The name of the values data model object
  • idDmoName: The name of the ID data model object
  • version: The version of the data graph
  • primaryObjectType: The type of the primary object
  • status: The current status of the data graph
  • object: Object containing field definitions and relationships
  • The response includes all data graphs available to the authenticated user
  • Each data graph's metadata includes all available fields and relationships
  • The primaryObjectName field indicates the main entity in the data graph
  • RelatedObjects show other entities that are connected to the primary entity
  • Field types include STRING, NUMBER, DATE, boolean, and more