Retrieves detailed metadata for a specific profile data model object in your Data 360 instance. This endpoint returns information about fields, data types, and available indexes for the specified object.
Syntax
- HTTP Method: GET
- Availability: Data 360 v1.0, Salesforce v51.0
- format: REST
- URI:
/api/v1/profile/metadata/{dataModelName}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| dataModelName | string | Required. The unique identifier of the data model object. Example: Individual__dlm |
Response Structure
The response includes a data model object containing:
name: The unique identifier of the data model objectdisplayName: The human-readable name of the data model objectcategory: The category of the data model object (for example, PROFILE)fields: Array of field objects with name, type, and other propertiesindexes: Array of index objects showing available lookup fieldsrelationships: Array of relationship objects showing connections to other entities
Examples
Request
GET https://{TSE}.360a.salesforce.com/api/v1/profile/metadata/Individual__dlm
Response
{
"metadata": [
{
"indexes": [
{
"fields": [
{
"name": "FirstName__c",
"type": "STRING"
}
]
}
],
"name": "Individual__dlm",
"category": "Profile",
"displayName": "Individual",
"fields": [
{
"name": "BirthDate__c",
"displayName": "Birth Date",
"type": "DATE"
},
{
"name": "FirstName__c",
"displayName": "First Name",
"type": "STRING"
}
],
"relationships": [
{
"fromEntity": "ContactPointEmail__dlm",
"toEntity": "Individual__dlm",
"fromEntityAttribute": "PartyId__c",
"toEntityAttribute": "Id__c",
"cardinality": "NTOONE"
}
],
"primaryKeys": [
{
"name": "Id__c",
"displayName": "Individual Id",
"indexOrder": "1"
}
]
}
]
}
Notes
- The response includes detailed metadata for the specified data model object only
- All fields and indexes available for the object are included in the response
- The category field indicates the type of data model object
- Indexes show which fields can be used for efficient lookups
- Field types include STRING, NUMBER, DATE, boolean, and more