Applications.PersonalData.DataSubjectRightRequests Entity

Namespace: Applications.PersonalData

Contains user requests for application of user rights. Entity: Pdm_Data_Subject_Right_Requests (Introduced in version 18.2)

Default Visualization

Default Display Text Format:
{Id}: {EnterpriseCompanyId}
Default Search Members:
__
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Applications.PersonalData.DataSubjectRightRequests

Attributes

Name	Type	Description
CompletedOnUtc	datetime nullable	Date and time (in UTC), when the requested right was implemented by the responsible entity. Null if the request is still not implemented. `Filter(ge;le)`
CreatedOnUtc	datetime	The date and time (in UTC), when the request was created. `Required` `Default(Now)` `Filter(ge;le)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Notes	string (max) nullable	This should usually contain detailed implementation notes.
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
RequestedRight	RequestedRight	The requested right, according to GDPR and other personal data regulations. REC=Rectify; ERA=Erasure; RES=Restrict; POR=Portability; OBJ=Object; OTH=Other. `Required` `Filter(eq)`
Status	Status	The status of the request. 1=Requested; 2=Reviewing; 3=Executing; 4=Implemented; 5=Denied. `Required`

References

Name	Type	Description
CompletedByUser	Users (nullable)	The internal user account, which marked the request as implemented. Null when the request is still not implemented, or when the user is unknown. `Filter(multi eq)` `ReadOnly`
CreatedByUser	Users (nullable)	The user account, which was used to create the request. Null when the request was created internally, on behalf of the external person. `Filter(multi eq)` `ReadOnly`
EnterpriseCompany	EnterpriseCompanies	The enterprise company, to which the request was made. `Required` `Filter(multi eq)`
Person	Persons	The person, whose data will be corrected with the request. . `Required` `Filter(multi eq)`

Attribute Details

CompletedOnUtc

Date and time (in UTC), when the requested right was implemented by the responsible entity. Null if the request is still not implemented. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

CreatedOnUtc

The date and time (in UTC), when the request was created. Required Default(Now) Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Notes

This should usually contain detailed implementation notes.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

RequestedRight

The requested right, according to GDPR and other personal data regulations. REC=Rectify; ERA=Erasure; RES=Restrict; POR=Portability; OBJ=Object; OTH=Other. Required Filter(eq)

Type: RequestedRight
Category: System
Allowed values for the RequestedRight(Applications.PersonalData.DataSubjectRightRequests.md#requestedright) data attribute
Allowed Values (Applications.PersonalData.DataSubjectRightRequestsRepository.RequestedRight Enum Members)

Value	Description
Rectify	Rectify value. Stored as 'REC'. Database Value: 'REC' Model Value: 0 Domain API Value: 'Rectify'
Erasure	Erasure value. Stored as 'ERA'. Database Value: 'ERA' Model Value: 1 Domain API Value: 'Erasure'
Restrict	Restrict value. Stored as 'RES'. Database Value: 'RES' Model Value: 2 Domain API Value: 'Restrict'
Portability	Portability value. Stored as 'POR'. Database Value: 'POR' Model Value: 3 Domain API Value: 'Portability'
Object	Object value. Stored as 'OBJ'. Database Value: 'OBJ' Model Value: 4 Domain API Value: 'Object'
Other	Other value. Stored as 'OTH'. Database Value: 'OTH' Model Value: 5 Domain API Value: 'Other'

Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault

Status

The status of the request. 1=Requested; 2=Reviewing; 3=Executing; 4=Implemented; 5=Denied. Required

Type: Status
Category: System
Allowed values for the Status(Applications.PersonalData.DataSubjectRightRequests.md#status) data attribute
Allowed Values (Applications.PersonalData.DataSubjectRightRequestsRepository.Status Enum Members)

Value	Description
Requested	Requested value. Stored as '1'. Database Value: '1' Model Value: 0 Domain API Value: 'Requested'
Reviewing	Reviewing value. Stored as '2'. Database Value: '2' Model Value: 1 Domain API Value: 'Reviewing'
Executing	Executing value. Stored as '3'. Database Value: '3' Model Value: 2 Domain API Value: 'Executing'
Implemented	Implemented value. Stored as '4'. Database Value: '4' Model Value: 3 Domain API Value: 'Implemented'
Denied	Denied value. Stored as '5'. Database Value: '5' Model Value: 4 Domain API Value: 'Denied'

Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

CompletedByUser

The internal user account, which marked the request as implemented. Null when the request is still not implemented, or when the user is unknown. Filter(multi eq) ReadOnly

Type: Users (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

CreatedByUser

The user account, which was used to create the request. Null when the request was created internally, on behalf of the external person. Filter(multi eq) ReadOnly

Type: Users (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

EnterpriseCompany

The enterprise company, to which the request was made. Required Filter(multi eq)

Type: EnterpriseCompanies
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Person

The person, whose data will be corrected with the request. . Required Filter(multi eq)

Type: Persons
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST