CustomFieldMember

Represents the working copy of a field for editing or saving in a MetadataContainer.

Version 

Introduced in API version 33.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• To access CustomFieldMember, you must have both the View All Data and Customize Application user permissions.

Fields 

Content 

• Type: textarea

• Required: No

• Properties: Update

• Description: A string representation of CustomField that contains the field’s metadata.

ContentEntityId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort

• Description: A reference to a custom field.

There can be only one ContentEntityId per CustomField, otherwise, an error is reported.

• Relationship name: ContentEntity
• Relationship type: relationship
• Refers to: CustomFieldDefinition

FullName 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Introduced: API version 31.0

• Description: The full name of the associated object in the Metadata API. Use to avoid race conditions on create, before you have IDs.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

LastSyncDate 

• Type: datetime

• Required: No

• Properties: Filter, Nillable, Sort

• Description: The date that this CustomField was replicated from the underlying entity.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Description: An object that describes the version, status, and packaged versions of the corresponding CustomField.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

MetadataContainerId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort

• Relationship name: MetadataContainer

• Relationship type: polymorphic

• Refers to: MetadataContainer, ContainerAsyncRequest