FieldPermission Entity Reference

Article
02/16/2022
3 minutes de lecture

Group of privileges used to categorize users to provide appropriate access to secured columns.

Messages

Message	Web API Operation	SDK Assembly
Create	POST [org URI]/api/data/v9.0/fieldpermissions See Create	CreateRequest or Create
Delete	DELETE [org URI]/api/data/v9.0/fieldpermissions(fieldpermissionid) See Delete	DeleteRequest or Delete
Retrieve	GET [org URI]/api/data/v9.0/fieldpermissions(fieldpermissionid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET [org URI]/api/data/v9.0/fieldpermissions See Query Data	RetrieveMultipleRequest or RetrieveMultiple
Update	PATCH [org URI]/api/data/v9.0/fieldpermissions(fieldpermissionid) See Update	UpdateRequest or Update

Entity Properties

Property	Value
CollectionSchemaName	FieldPermissions
DisplayCollectionName	Field Permissions
DisplayName	Field Permission
EntitySetName	fieldpermissions
IsBPFEntity	False
LogicalCollectionName	fieldpermissions
LogicalName	fieldpermission
OwnershipType	None
PrimaryIdAttribute	fieldpermissionid
PrimaryNameAttribute
SchemaName	FieldPermission

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

AttributeLogicalName
CanCreate
CanRead
CanUpdate
EntityName
FieldPermissionId
FieldSecurityProfileId

AttributeLogicalName

Property	Value
Description	Attribute Name.
DisplayName	Name of the attribute for which this privilege is defined
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	attributelogicalname
MaxLength	50
RequiredLevel	SystemRequired
Type	String

CanCreate

Property	Value
Description	Can this Profile create the attribute
DisplayName	Can create the attribute
IsValidForForm	True
IsValidForRead	True
LogicalName	cancreate
RequiredLevel	SystemRequired
Type	Picklist

CanCreate Options

Value	Label
0	Not Allowed
4	Allowed

CanRead

Property	Value
Description	Can this Profile read the attribute
DisplayName	Can Read the attribute
IsValidForForm	True
IsValidForRead	True
LogicalName	canread
RequiredLevel	SystemRequired
Type	Picklist

CanRead Options

Value	Label
0	Not Allowed
4	Allowed

CanUpdate

Property	Value
Description	Can this Profile update the attribute
DisplayName	Can Update the attribute
IsValidForForm	True
IsValidForRead	True
LogicalName	canupdate
RequiredLevel	SystemRequired
Type	Picklist

CanUpdate Options

Value	Label
0	Not Allowed
4	Allowed

EntityName

Property	Value
Description	Entity name.
DisplayName	Name of the Entity for which this privilege is defined
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	entityname
RequiredLevel	SystemRequired
Type	EntityName

FieldPermissionId

Property	Value
Description	Unique identifier of the Field Permission.
DisplayName	Field Permission
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	fieldpermissionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

FieldSecurityProfileId

Property	Value
Description	Unique identifier of profile to which this privilege belongs.
DisplayName	Profile
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	fieldsecurityprofileid
RequiredLevel	SystemRequired
Targets	fieldsecurityprofile
Type	Lookup

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ComponentState
FieldPermissionIdUnique
IsManaged
OrganizationId
OverwriteTime
SolutionId
SupportingSolutionId
VersionNumber

ComponentState

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist

ComponentState Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

FieldPermissionIdUnique

Property	Value
Description	For internal use only.
DisplayName	Field Permission
IsValidForForm	False
IsValidForRead	True
LogicalName	fieldpermissionidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

IsManaged

Property	Value
Description	Indicates whether the solution component is part of a managed solution.
DisplayName	Is Managed
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean

IsManaged Options

Value	Label
1	Managed
0	Unmanaged

DefaultValue: False

OrganizationId

Property	Value
Description	Unique identifier for the organization
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationid
RequiredLevel	None
Targets
Type	Lookup

OverwriteTime

Property	Value
DateTimeBehavior	UserLocal
Description	For internal use only.
DisplayName	Record Overwrite Time
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime

SolutionId

Property	Value
Description	Unique identifier of the associated solution.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	True
LogicalName	solutionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SupportingSolutionId

Property	Value
Description	For internal use only.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	supportingsolutionid
RequiredLevel	None
Type	Uniqueidentifier

VersionNumber

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

One-To-Many Relationships

Listed by SchemaName.

FieldPermission_SyncErrors

Same as syncerror entity FieldPermission_SyncErrors Many-To-One relationship.

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
IsHierarchical	False
IsCustomizable	True
ReferencedEntityNavigationPropertyName	FieldPermission_SyncErrors
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order:
CascadeConfiguration	Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_fieldpermission_fieldsecurityprofileid
solution_fieldpermission

lk_fieldpermission_fieldsecurityprofileid

See fieldsecurityprofile Entity lk_fieldpermission_fieldsecurityprofileid One-To-Many relationship.

solution_fieldpermission

See solution Entity solution_fieldpermission One-To-Many relationship.