Omnichannel agent assignment custom api privilege (msdyn_ocagentassignedcustomapiprivilege) table/entity reference (Microsoft Dynamics 365)
Entity for creating privilege for agent assignment private custom apis. The privileges for this entity will be used to restrict custom api access only for FPA app user.
Messages
The following table lists the messages for the Omnichannel agent assignment custom api privilege (msdyn_ocagentassignedcustomapiprivilege) table. Messages represent operations that can be performed on the table. They may also be events.
Name Is Event? |
Web API Operation | SDK for .NET |
---|---|---|
Assign Event: True |
PATCH /msdyn_ocagentassignedcustomapiprivileges(msdyn_ocagentassignedcustomapiprivilegeid)Update the ownerid property. |
AssignRequest |
Associate Event: True |
Associate records | Associate records |
BulkRetain Event: True |
BulkRetain | Learn to use messages with the SDK for .NET |
Create Event: True |
POST /msdyn_ocagentassignedcustomapiprivilegesSee Create |
Create records |
CreateMultiple Event: True |
CreateMultiple | CreateMultipleRequest |
Delete Event: True |
DELETE /msdyn_ocagentassignedcustomapiprivileges(msdyn_ocagentassignedcustomapiprivilegeid)See Delete |
Delete records |
Disassociate Event: True |
Disassociate records | Disassociate records |
GrantAccess Event: True |
GrantAccess | GrantAccessRequest |
IsValidStateTransition Event: False |
IsValidStateTransition | IsValidStateTransitionRequest |
ModifyAccess Event: True |
ModifyAccess | ModifyAccessRequest |
PurgeRetainedContent Event: True |
PurgeRetainedContent | Learn to use messages with the SDK for .NET |
Restore Event: True |
Restore | Learn to use messages with the SDK for .NET |
Retain Event: True |
Retain | Learn to use messages with the SDK for .NET |
Retrieve Event: True |
GET /msdyn_ocagentassignedcustomapiprivileges(msdyn_ocagentassignedcustomapiprivilegeid)See Retrieve |
Retrieve records |
RetrieveMultiple Event: True |
GET /msdyn_ocagentassignedcustomapiprivilegesSee Query data |
Query data |
RetrievePrincipalAccess Event: True |
RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
RetrieveSharedPrincipalsAndAccess Event: True |
RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
RevokeAccess Event: True |
RevokeAccess | RevokeAccessRequest |
RollbackRetain Event: True |
RollbackRetain | Learn to use messages with the SDK for .NET |
SetState Event: True |
PATCH /msdyn_ocagentassignedcustomapiprivileges(msdyn_ocagentassignedcustomapiprivilegeid)Update the statecode and statuscode properties. |
SetStateRequest |
Update Event: True |
PATCH /msdyn_ocagentassignedcustomapiprivileges(msdyn_ocagentassignedcustomapiprivilegeid)See Update |
Update records |
UpdateMultiple Event: True |
UpdateMultiple | UpdateMultipleRequest |
Upsert Event: False |
PATCH /msdyn_ocagentassignedcustomapiprivileges(msdyn_ocagentassignedcustomapiprivilegeid)See Upsert a table row |
UpsertRequest |
UpsertMultiple Event: False |
UpsertMultiple | UpsertMultipleRequest |
ValidateRetentionConfig Event: True |
ValidateRetentionConfig | Learn to use messages with the SDK for .NET |
Properties
The following table lists selected properties for the Omnichannel agent assignment custom api privilege (msdyn_ocagentassignedcustomapiprivilege) table.
Property | Value |
---|---|
DisplayName | Omnichannel agent assignment custom api privilege |
DisplayCollectionName | Omnichannel agent assignment custom api privileges |
SchemaName | msdyn_ocagentassignedcustomapiprivilege |
CollectionSchemaName | msdyn_ocagentassignedcustomapiprivileges |
EntitySetName | msdyn_ocagentassignedcustomapiprivileges |
LogicalName | msdyn_ocagentassignedcustomapiprivilege |
LogicalCollectionName | msdyn_ocagentassignedcustomapiprivileges |
PrimaryIdAttribute | msdyn_ocagentassignedcustomapiprivilegeid |
PrimaryNameAttribute | msdyn_name |
TableType | Standard |
OwnershipType | UserOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- msdyn_name
- msdyn_ocagentassignedcustomapiprivilegeId
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
ImportSequenceNumber
Property | Value |
---|---|
Description | Sequence number of the import that created this record. |
DisplayName | Import Sequence Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | importsequencenumber |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -2147483648 |
msdyn_name
Property | Value |
---|---|
Description | The name of the custom entity. |
DisplayName | Name |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_name |
RequiredLevel | ApplicationRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
msdyn_ocagentassignedcustomapiprivilegeId
Property | Value |
---|---|
Description | Unique identifier for entity instances |
DisplayName | Omnichannel agent assignment custom api privilege |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | msdyn_ocagentassignedcustomapiprivilegeid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
OverriddenCreatedOn
Property | Value |
---|---|
Description | Date and time that the record was migrated. |
DisplayName | Record Created On |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overriddencreatedon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateOnly |
ImeMode | Inactive |
SourceTypeMask | 0 |
OwnerId
Property | Value |
---|---|
Description | Owner Id |
DisplayName | Owner |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | ownerid |
RequiredLevel | SystemRequired |
Type | Owner |
Targets | systemuser, team |
OwnerIdType
Property | Value |
---|---|
Description | Owner Id Type |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridtype |
RequiredLevel | SystemRequired |
Type | EntityName |
statecode
Property | Value |
---|---|
Description | Status of the Omnichannel agent assignment custom api privilege |
DisplayName | Status |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statecode |
RequiredLevel | SystemRequired |
Type | State |
DefaultFormValue | |
GlobalChoiceName | msdyn_ocagentassignedcustomapiprivilege_statecode |
statecode Choices/Options
Value | Details |
---|---|
0 | Label: Active DefaultStatus: 1 InvariantName: Active |
1 | Label: Inactive DefaultStatus: 2 InvariantName: Inactive |
statuscode
Property | Value |
---|---|
Description | Reason for the status of the Omnichannel agent assignment custom api privilege |
DisplayName | Status Reason |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statuscode |
RequiredLevel | None |
Type | Status |
DefaultFormValue | |
GlobalChoiceName | msdyn_ocagentassignedcustomapiprivilege_statuscode |
statuscode Choices/Options
Value | Details |
---|---|
1 | Label: Active State:0 TransitionData: None |
2 | Label: Inactive State:1 TransitionData: None |
TimeZoneRuleVersionNumber
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Time Zone Rule Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | timezoneruleversionnumber |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -1 |
UTCConversionTimeZoneCode
Property | Value |
---|---|
Description | Time zone code that was in use when the record was created. |
DisplayName | UTC Conversion Time Zone Code |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | utcconversiontimezonecode |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -1 |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- VersionNumber
CreatedBy
Property | Value |
---|---|
Description | Unique identifier of the user who created the record. |
DisplayName | Created By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
CreatedOn
Property | Value |
---|---|
Description | Date and time when the record was created. |
DisplayName | Created On |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Inactive |
SourceTypeMask | 0 |
CreatedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who created the record. |
DisplayName | Created By (Delegate) |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdonbehalfby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
ModifiedBy
Property | Value |
---|---|
Description | Unique identifier of the user who modified the record. |
DisplayName | Modified By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
ModifiedOn
Property | Value |
---|---|
Description | Date and time when the record was modified. |
DisplayName | Modified On |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Inactive |
SourceTypeMask | 0 |
ModifiedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who modified the record. |
DisplayName | Modified By (Delegate) |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedonbehalfby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
OwnerIdName
Property | Value |
---|---|
Description | Name of the owner |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridname |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
OwnerIdYomiName
Property | Value |
---|---|
Description | Yomi name of the owner |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridyominame |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
OwningBusinessUnit
Property | Value |
---|---|
Description | Unique identifier for the business unit that owns the record |
DisplayName | Owning Business Unit |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | owningbusinessunit |
RequiredLevel | None |
Type | Lookup |
Targets | businessunit |
OwningTeam
Property | Value |
---|---|
Description | Unique identifier for the team that owns the record. |
DisplayName | Owning Team |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owningteam |
RequiredLevel | None |
Type | Lookup |
Targets | team |
OwningUser
Property | Value |
---|---|
Description | Unique identifier for the user that owns the record. |
DisplayName | Owning User |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owninguser |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
VersionNumber
Property | Value |
---|---|
Description | Version Number |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
RequiredLevel | None |
Type | BigInt |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
- business_unit_msdyn_ocagentassignedcustomapiprivilege
- lk_msdyn_ocagentassignedcustomapiprivilege_createdby
- lk_msdyn_ocagentassignedcustomapiprivilege_createdonbehalfby
- lk_msdyn_ocagentassignedcustomapiprivilege_modifiedby
- lk_msdyn_ocagentassignedcustomapiprivilege_modifiedonbehalfby
- owner_msdyn_ocagentassignedcustomapiprivilege
- team_msdyn_ocagentassignedcustomapiprivilege
- user_msdyn_ocagentassignedcustomapiprivilege
business_unit_msdyn_ocagentassignedcustomapiprivilege
One-To-Many Relationship: businessunit business_unit_msdyn_ocagentassignedcustomapiprivilege
Property | Value |
---|---|
ReferencedEntity | businessunit |
ReferencedAttribute | businessunitid |
ReferencingAttribute | owningbusinessunit |
ReferencingEntityNavigationPropertyName | owningbusinessunit |
IsHierarchical | |
CascadeConfiguration | Archive: Restrict Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_msdyn_ocagentassignedcustomapiprivilege_createdby
One-To-Many Relationship: systemuser lk_msdyn_ocagentassignedcustomapiprivilege_createdby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | createdby |
ReferencingEntityNavigationPropertyName | createdby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_msdyn_ocagentassignedcustomapiprivilege_createdonbehalfby
One-To-Many Relationship: systemuser lk_msdyn_ocagentassignedcustomapiprivilege_createdonbehalfby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | createdonbehalfby |
ReferencingEntityNavigationPropertyName | createdonbehalfby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_msdyn_ocagentassignedcustomapiprivilege_modifiedby
One-To-Many Relationship: systemuser lk_msdyn_ocagentassignedcustomapiprivilege_modifiedby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | modifiedby |
ReferencingEntityNavigationPropertyName | modifiedby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_msdyn_ocagentassignedcustomapiprivilege_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_msdyn_ocagentassignedcustomapiprivilege_modifiedonbehalfby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | modifiedonbehalfby |
ReferencingEntityNavigationPropertyName | modifiedonbehalfby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
owner_msdyn_ocagentassignedcustomapiprivilege
One-To-Many Relationship: owner owner_msdyn_ocagentassignedcustomapiprivilege
Property | Value |
---|---|
ReferencedEntity | owner |
ReferencedAttribute | ownerid |
ReferencingAttribute | ownerid |
ReferencingEntityNavigationPropertyName | ownerid |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
team_msdyn_ocagentassignedcustomapiprivilege
One-To-Many Relationship: team team_msdyn_ocagentassignedcustomapiprivilege
Property | Value |
---|---|
ReferencedEntity | team |
ReferencedAttribute | teamid |
ReferencingAttribute | owningteam |
ReferencingEntityNavigationPropertyName | owningteam |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
user_msdyn_ocagentassignedcustomapiprivilege
One-To-Many Relationship: systemuser user_msdyn_ocagentassignedcustomapiprivilege
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | owninguser |
ReferencingEntityNavigationPropertyName | owninguser |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
- msdyn_ocagentassignedcustomapiprivilege_AsyncOperations
- msdyn_ocagentassignedcustomapiprivilege_BulkDeleteFailures
- msdyn_ocagentassignedcustomapiprivilege_DuplicateBaseRecord
- msdyn_ocagentassignedcustomapiprivilege_DuplicateMatchingRecord
- msdyn_ocagentassignedcustomapiprivilege_MailboxTrackingFolders
- msdyn_ocagentassignedcustomapiprivilege_PrincipalObjectAttributeAccesses
- msdyn_ocagentassignedcustomapiprivilege_ProcessSession
- msdyn_ocagentassignedcustomapiprivilege_SyncErrors
msdyn_ocagentassignedcustomapiprivilege_AsyncOperations
Many-To-One Relationship: asyncoperation msdyn_ocagentassignedcustomapiprivilege_AsyncOperations
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | msdyn_ocagentassignedcustomapiprivilege_AsyncOperations |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_ocagentassignedcustomapiprivilege_BulkDeleteFailures
Many-To-One Relationship: bulkdeletefailure msdyn_ocagentassignedcustomapiprivilege_BulkDeleteFailures
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | msdyn_ocagentassignedcustomapiprivilege_BulkDeleteFailures |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_ocagentassignedcustomapiprivilege_DuplicateBaseRecord
Many-To-One Relationship: duplicaterecord msdyn_ocagentassignedcustomapiprivilege_DuplicateBaseRecord
Property | Value |
---|---|
ReferencingEntity | duplicaterecord |
ReferencingAttribute | baserecordid |
ReferencedEntityNavigationPropertyName | msdyn_ocagentassignedcustomapiprivilege_DuplicateBaseRecord |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_ocagentassignedcustomapiprivilege_DuplicateMatchingRecord
Many-To-One Relationship: duplicaterecord msdyn_ocagentassignedcustomapiprivilege_DuplicateMatchingRecord
Property | Value |
---|---|
ReferencingEntity | duplicaterecord |
ReferencingAttribute | duplicaterecordid |
ReferencedEntityNavigationPropertyName | msdyn_ocagentassignedcustomapiprivilege_DuplicateMatchingRecord |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_ocagentassignedcustomapiprivilege_MailboxTrackingFolders
Many-To-One Relationship: mailboxtrackingfolder msdyn_ocagentassignedcustomapiprivilege_MailboxTrackingFolders
Property | Value |
---|---|
ReferencingEntity | mailboxtrackingfolder |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | msdyn_ocagentassignedcustomapiprivilege_MailboxTrackingFolders |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_ocagentassignedcustomapiprivilege_PrincipalObjectAttributeAccesses
Many-To-One Relationship: principalobjectattributeaccess msdyn_ocagentassignedcustomapiprivilege_PrincipalObjectAttributeAccesses
Property | Value |
---|---|
ReferencingEntity | principalobjectattributeaccess |
ReferencingAttribute | objectid |
ReferencedEntityNavigationPropertyName | msdyn_ocagentassignedcustomapiprivilege_PrincipalObjectAttributeAccesses |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_ocagentassignedcustomapiprivilege_ProcessSession
Many-To-One Relationship: processsession msdyn_ocagentassignedcustomapiprivilege_ProcessSession
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | msdyn_ocagentassignedcustomapiprivilege_ProcessSession |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_ocagentassignedcustomapiprivilege_SyncErrors
Many-To-One Relationship: syncerror msdyn_ocagentassignedcustomapiprivilege_SyncErrors
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | msdyn_ocagentassignedcustomapiprivilege_SyncErrors |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference