Projects.Classic.ProjectRisks Entity
Namespace: Projects.Classic
Contains risks, associated to projects. Entity: Prj_Project_Risks
Default Visualization
Default Display Text Format:
{RiskName}
Default Search Members:
RiskName
Name Data Member:
RiskName
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 Parent:
Projects.Classic.Projects
Aggregate Root:
Projects.Classic.Projects
Attributes
Name | Type | Description |
---|---|---|
CreateDate | date | The creation date of the project risk. Required Default(Now) Filter(eq;ge;le) |
Description | string (max) nullable | The description of this ProjectRisk. Filter(like) |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
Id | guid | |
ImpactPercent | decimal (3, 2) | The impact of the risk to the project, expressed as percentage of the total project value. Required Default(0) |
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. |
ProbabilityPercent | decimal (3, 2) | The probability of the risk occurring. Required Default(0) |
ResolutionStrategy | string (max) nullable | The strategy chosen to handle the risk. Filter(eq) |
Resolved | boolean | True if the risk is resolved. Required Default(false) Filter(eq) |
ResolveDate | date nullable | The date on which the risk is resolved. Filter(eq;ge;le) |
RiskName | string (254) | The short name of the risk. Required Filter(multi eq) |
References
Name | Type | Description |
---|---|---|
Project | Projects | The project for which this risk applies. Required Filter(multi eq) Owner |
ResponsiblePerson | Persons (nullable) | The person who is responsible for handling the risk. Filter(multi eq) |
Child Collections
Name | Type | Description |
---|---|---|
Discussion | ProjectRiskDiscussion | List of ProjectRiskDiscussion (Projects.Classic.ProjectRiskDiscussion.md) child objects, based on the Projects.Classic.ProjectRiskDiscussion.ProjectRisk (Projects.Classic.ProjectRiskDiscussion.md#projectrisk) back reference |
Attribute Details
CreateDate
The creation date of the project risk. Required
Default(Now)
Filter(eq;ge;le)
Type: date
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: ShownByDefault
Description
The description of this ProjectRisk. Filter(like)
Type: string (max) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 2147483647
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
ImpactPercent
The impact of the risk to the project, expressed as percentage of the total project value. Required
Default(0)
Type: decimal (3, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
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
ProbabilityPercent
The probability of the risk occurring. Required
Default(0)
Type: decimal (3, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault
ResolutionStrategy
The strategy chosen to handle the risk. Filter(eq)
Type: string (max) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault
Resolved
True if the risk is resolved. Required
Default(false)
Filter(eq)
Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault
ResolveDate
The date on which the risk is resolved. Filter(eq;ge;le)
Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault
RiskName
The short name of the risk. Required
Filter(multi eq)
Type: string (254)
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault
Reference Details
Project
The project for which this risk applies. Required
Filter(multi eq)
Owner
Type: Projects
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault
ResponsiblePerson
The person who is responsible for handling the risk. Filter(multi eq)
Type: Persons (nullable)
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: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
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
Parameters
user
The user.
Type: UsersnotificationClass
The notification class.
Type: stringsubject
The notification subject.
Type: string
CreateCopy
Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST
Business Rules
None
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Projects_Classic_ProjectRisks?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Projects_Classic_ProjectRisks?$top=10