GET /api/v1/dataGraph/metadata
Requests the metadata for all accessible data graph objects. The metadata response includes the primary data model object, related objects, and their fields. You can also retrieve the metadata for a specific data graph, by providing its name in the request parameters.
- HTTP method
GET
- Availability
Data Cloud v1.0, Salesforce v51.0
- Formats
REST
- URI
/api/v1/dataGraph/metadata?entityName={dataGraphName}
| Field Name | Field Type | Description |
|---|---|---|
| entityName | string | API name of the data graph for which metadata is being requested. When a data graph is created, the API name is the value set in the DataGraphApiName field. When this field isn't specified, it returns the metadata values of all the data graphs. This parameter is optional. It's passed as a query parameter. |
In this example, metadata for the data graph UnifiedIndividual_DG is requested. The response returns metadata values for the primary data model object, related objects, and each field included in the data graph.
- Request
- Response