You are here:
Partner Cloud | Get Object Metadata
Retrieves comprehensive field metadata for a Salesforce object, including required fields, optional fields, field-level security, picklist values, and user permissions. Use this action after determining which object type to work with (for example, after selecting a lead) to understand the information to collect from the user and the validation constraints that apply to each field.
Action Details
| API Name | GetObjectMetadata |
| Loading Text | Fetching lead fields |
Inputs
| Label | API Name | Description |
|---|---|---|
| Object Name | objectName | The API name of the object to retrieve metadata. |
Outputs
| Label | API Name | Description |
|---|---|---|
| Required Fields | requiredFields | List of required field API names that are populated when an object is created. These fields can't be null and don't have default values. |
| Optional Fields | optionalFields | List of optional field API names that are populated when an object is created. These fields are accessible to the user based on field-level security. |
| Field Metadata | fieldMetadata | Detailed metadata for each accessible field in JSON format. Each field includes apiName (field API name), label (user-facing label), type (field data type), required (boolean), custom (whether it's a custom field), createable (can be set on create), updateable (can be modified), length (max length for text fields), picklistValues (for picklist fields), and precision/scale (for numeric fields). Use this to understand field constraints, types, and available picklist values when collecting information from the user. |
| User Permissions | userPermission | User's object-level CRUD permissions in JSON format. It includes canCreate (can create new records), canRead (can query records), canUpdate (can modify records), and canDelete (can delete records). Use this to verify that the user has necessary permissions before attempting operations. |
| Summary Message | summaryMessage | A summary of the field metadata check results. It describes the required fields and the total number of accessible fields. Use this message for logging or debugging, but don't show it to the user. |
Did this article solve your issue?
Let us know so we can improve!
