PrincipalObjectAttributeAccess Entity Reference

Defines CRM security principals (users and teams) access rights to secured field for an entity instance.

Messages

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

Entity Properties

Property Value
CollectionSchemaName PrincipalObjectAttributeAccesses
DisplayCollectionName Field Sharing
DisplayName Field Sharing
EntitySetName principalobjectattributeaccessset
IsBPFEntity False
LogicalCollectionName principalobjectattributeaccesses
LogicalName principalobjectattributeaccess
OwnershipType OrganizationOwned
PrimaryIdAttribute principalobjectattributeaccessid
PrimaryNameAttribute
SchemaName PrincipalObjectAttributeAccess

Writable attributes

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

AttributeId

Property Value
Description Unique identifier of the shared secured field
DisplayName Secured field
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName attributeid
RequiredLevel SystemRequired
Type Uniqueidentifier

ObjectId

Property Value
Description Unique identifier of the entity instance with shared secured field
DisplayName Entity instance
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName objectid
RequiredLevel SystemRequired
Targets account,appointment,businessunit,channelaccessprofile,connection,contact,customeraddress,email,fax,feedback,goal,holidaywrapper,kbarticle,knowledgearticle,knowledgearticleviews,knowledgebaserecord,letter,mailmergetemplate,msdyn_connector,phonecall,position,queue,queueitem,recurringappointmentmaster,reportcategory,sharepointdocumentlocation,sharepointsite,socialactivity,socialprofile,systemuser,task,team,territory
Type Lookup

ObjectTypeCode

Property Value
Description Type of the record with shared secured field
DisplayName Entity object type
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName objecttypecode
RequiredLevel SystemRequired
Type EntityName

PrincipalId

Property Value
Description Unique identifier of the principal to which secured field is shared
DisplayName Principal
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName principalid
RequiredLevel SystemRequired
Targets systemuser,team
Type Lookup

PrincipalIdType

Property Value
Description Type of the principal to which secured field is shared
DisplayName Principal type
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName principalidtype
RequiredLevel SystemRequired
Type EntityName

PrincipalObjectAttributeAccessId

Property Value
Description Unique identifier of the shared secured field instance
DisplayName Shared secured field
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName principalobjectattributeaccessid
RequiredLevel SystemRequired
Type Uniqueidentifier

ReadAccess

Property Value
Description Read permission for secured field instance
DisplayName Read permission
IsValidForForm False
IsValidForRead True
LogicalName readaccess
RequiredLevel SystemRequired
Type Boolean

ReadAccess Options

Value Label
1 Yes
0 No

DefaultValue: False

UpdateAccess

Property Value
Description Update permission for secured field instance
DisplayName Update permission
IsValidForForm False
IsValidForRead True
LogicalName updateaccess
RequiredLevel SystemRequired
Type Boolean

UpdateAccess Options

Value Label
1 Yes
0 No

DefaultValue: False

Read-only attributes

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

OrganizationId

Property Value
Description Unique identifier of the associated organization.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 160
RequiredLevel SystemRequired
Type String

PrincipalIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName principalidname
MaxLength 160
RequiredLevel SystemRequired
Type String

VersionNumber

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

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.

territory_principalobjectattributeaccess

Added by: Application Common Solution

See territory Entity territory_principalobjectattributeaccess One-To-Many relationship.

msdyn_connector_PrincipalObjectAttributeAccesses

Added by: Power Connector Solution Solution

See msdyn_connector Entity msdyn_connector_PrincipalObjectAttributeAccesses One-To-Many relationship.

account_principalobjectattributeaccess

See account Entity account_principalobjectattributeaccess One-To-Many relationship.

contact_principalobjectattributeaccess

See contact Entity contact_principalobjectattributeaccess One-To-Many relationship.

lk_principalobjectattributeaccess_organizationid

See organization Entity lk_principalobjectattributeaccess_organizationid One-To-Many relationship.

team_principalobjectattributeaccess_principalid

See team Entity team_principalobjectattributeaccess_principalid One-To-Many relationship.

systemuser_principalobjectattributeaccess_principalid

See systemuser Entity systemuser_principalobjectattributeaccess_principalid One-To-Many relationship.

knowledgearticle_PrincipalObjectAttributeAccess

See knowledgearticle Entity knowledgearticle_PrincipalObjectAttributeAccess One-To-Many relationship.

KnowledgeBaseRecord_PrincipalObjectAttributeAccess

See knowledgebaserecord Entity KnowledgeBaseRecord_PrincipalObjectAttributeAccess One-To-Many relationship.

team_principalobjectattributeaccess

See team Entity team_principalobjectattributeaccess One-To-Many relationship.

reportcategory_principalobjectattributeaccess

See reportcategory Entity reportcategory_principalobjectattributeaccess One-To-Many relationship.

mailmergetemplate_principalobjectattributeaccess

See mailmergetemplate Entity mailmergetemplate_principalobjectattributeaccess One-To-Many relationship.

fax_principalobjectattributeaccess

See fax Entity fax_principalobjectattributeaccess One-To-Many relationship.

socialactivity_principalobjectattributeaccess

See socialactivity Entity socialactivity_principalobjectattributeaccess One-To-Many relationship.

kbarticle_principalobjectattributeaccess

See kbarticle Entity kbarticle_principalobjectattributeaccess One-To-Many relationship.

phonecall_principalobjectattributeaccess

See phonecall Entity phonecall_principalobjectattributeaccess One-To-Many relationship.

position_principalobjectattributeaccess

See position Entity position_principalobjectattributeaccess One-To-Many relationship.

customeraddress_principalobjectattributeaccess

See customeraddress Entity customeraddress_principalobjectattributeaccess One-To-Many relationship.

sharepointsite_principalobjectattributeaccess

See sharepointsite Entity sharepointsite_principalobjectattributeaccess One-To-Many relationship.

systemuser_principalobjectattributeaccess

See systemuser Entity systemuser_principalobjectattributeaccess One-To-Many relationship.

connection_principalobjectattributeaccess

See connection Entity connection_principalobjectattributeaccess One-To-Many relationship.

appointment_principalobjectattributeaccess

See appointment Entity appointment_principalobjectattributeaccess One-To-Many relationship.

goal_principalobjectattributeaccess

See goal Entity goal_principalobjectattributeaccess One-To-Many relationship.

email_principalobjectattributeaccess

See email Entity email_principalobjectattributeaccess One-To-Many relationship.

knowledgearticleview_principalobjectattributeaccess

See knowledgearticleviews Entity knowledgearticleview_principalobjectattributeaccess One-To-Many relationship.

feedback_principalobjectattributeaccess

See feedback Entity feedback_principalobjectattributeaccess One-To-Many relationship.

businessunit_principalobjectattributeaccess

See businessunit Entity businessunit_principalobjectattributeaccess One-To-Many relationship.

sharepointdocumentlocation_principalobjectattributeaccess

See sharepointdocumentlocation Entity sharepointdocumentlocation_principalobjectattributeaccess One-To-Many relationship.

queueitem_principalobjectattributeaccess

See queueitem Entity queueitem_principalobjectattributeaccess One-To-Many relationship.

queue_principalobjectattributeaccess

See queue Entity queue_principalobjectattributeaccess One-To-Many relationship.

recurringappointmentmaster_principalobjectattributeaccess

See recurringappointmentmaster Entity recurringappointmentmaster_principalobjectattributeaccess One-To-Many relationship.

task_principalobjectattributeaccess

See task Entity task_principalobjectattributeaccess One-To-Many relationship.

letter_principalobjectattributeaccess

See letter Entity letter_principalobjectattributeaccess One-To-Many relationship.

socialprofile_principalobjectattributeaccess

See socialprofile Entity socialprofile_principalobjectattributeaccess One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
principalobjectattributeaccess EntityType