Data Cloud Reference Guide
jGET /api/v1/dataGraph/metadata?entityName={dataGraphName}
Request the metadata for a single
data
graph
object. Returned data includes the object's
primary
data
model
object,
related objects, and fields.
Syntax
- HTTP method
- GET
- Availability
- Data Cloud v1.0, Salesforce v51.0
- Formats
- REST
- URI
- /api/v1/dataGraph/metadata?entityName={dataGraphName}
Request Parameters
| 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. |
Examples
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
-
1https://{TSE}.360a.salesforce.com/api/v1/dataGraph/metadata?entityName=UnifiedIndividual_DG - Response
-
1{ 2 "metadata": [ 3 { 4 "developerName": "UnifiedIndividual_DG", 5 "description": "", 6 "dataspaceName": "default", 7 "primaryObjectName": "UnifiedssotIndividualIr1__dlm", 8 "valuesDmoName": "Individual_DG_VALUE__dlm", 9 "idDmoName": "Individual_DG_ID__dlm", 10 "version": "1", 11 "primaryObjectType": "DMO", 12 "status": "READY", 13 "object": { 14 "developerName": "UnifiedssotIndividualIr1__dlm", 15 "type": "DMO", 16 "memberDmoName": "ssotIndividualIr1_FRAGMENT15__dlm", 17 "fields": [ 18 { 19 "developerName": "ssot__Id__c", 20 "lookupCol": "false", 21 "length": "1", 22 "dataType": "STRING", 23 "keyCol": "true" 24 } 25 ], 26 "relatedObjects": [ 27 { 28 "developerName": "UnifiedLinkssotIndividualIr1__dlm", 29 "type": "DMO", 30 "memberDmoName": "LinkssotIndividual_FRAGMENT7__dlm", 31 "fields": [ 32 { 33 "developerName": "SourceRecordId__c", 34 "lookupCol": "false", 35 "length": "1", 36 "dataType": "STRING", 37 "keyCol": "true" 38 }, 39 { 40 "developerName": "UnifiedRecordId__c", 41 "lookupCol": "false", 42 "length": "1", 43 "dataType": "STRING", 44 "keyCol": "false" 45 } 46 ], 47 "paths": [ 48 { 49 "fieldName": "UnifiedRecordId__c", 50 "parentFieldName": "ssot__Id__c", 51 "cardinality": "NTOONE" 52 } 53 ], 54 "relatedObjects": [ 55 { 56 "developerName": "ssot__Individual__dlm", 57 "type": "DMO", 58 "memberDmoName": "Individual_FRAGMENT32__dlm", 59 "fields": [ 60 { 61 "developerName": "ssot__FirstName__c", 62 "lookupCol": "false", 63 "length": "1", 64 "dataType": "STRING", 65 "keyCol": "false" 66 }, 67 { 68 "developerName": "ssot__Id__c", 69 "lookupCol": "false", 70 "length": "1", 71 "dataType": "STRING", 72 "keyCol": "true" 73 }, 74 { 75 "developerName": "ssot__LastName__c", 76 "lookupCol": "false", 77 "length": "1", 78 "dataType": "STRING", 79 "keyCol": "false" 80 } 81 ], 82 "paths": [ 83 { 84 "fieldName": "UnifiedRecordId__c", 85 "parentFieldName": "ssot__Id__c", 86 "cardinality": "NTOONE" 87 }, 88 { 89 "fieldName": "ssot__Id__c", 90 "parentFieldName": "SourceRecordId__c", 91 "cardinality": "ONETOONE" 92 } 93 ], 94 "relatedObjects": [ 95 { 96 "developerName": "ssot__SalesOrder__dlm", 97 "type": "DMO", 98 "memberDmoName": "SalesOrder_FRAGMENT16__dlm", 99 "fields": [ 100 { 101 "developerName": "ssot__PurchaseOrderDate__c", 102 "lookupCol": "false", 103 "length": "1", 104 "dataType": "DATE_TIME", 105 "keyCol": "false" 106 }, 107 { 108 "developerName": "ssot__Id__c", 109 "lookupCol": "false", 110 "length": "1", 111 "dataType": "STRING", 112 "keyCol": "true" 113 }, 114 { 115 "developerName": "ssot__SoldToCustomerId__c", 116 "lookupCol": "false", 117 "length": "1", 118 "dataType": "STRING", 119 "keyCol": "false" 120 }, 121 { 122 "developerName": "ssot__TotalProductAmount__c", 123 "lookupCol": "false", 124 "length": "1", 125 "dataType": "NUMBER", 126 "keyCol": "false" 127 } 128 ], 129 "paths": [ 130 { 131 "fieldName": "UnifiedRecordId__c", 132 "parentFieldName": "ssot__Id__c", 133 "cardinality": "NTOONE" 134 }, 135 { 136 "fieldName": "ssot__Id__c", 137 "parentFieldName": "SourceRecordId__c", 138 "cardinality": "ONETOONE" 139 }, 140 { 141 "fieldName": "ssot__SoldToCustomerId__c", 142 "parentFieldName": "ssot__Id__c", 143 "cardinality": "NTOONE" 144 } 145 ] 146 } 147 ] 148 } 149 ] 150 } 151 ] 152 } 153 } 154 ] 155}