Projects.TypeWorkElements Entity

Namespace: Projects

The work elements of the work breakdown structure of each project type. Entity: Prj_Type_Work_Elements

Default Visualization

Default Display Text Format:
{WorkElementName}
Default Search Members:
WorkElementCode; WorkElementName
Code Data Member:
WorkElementCode
Name Data Member:
WorkElementName
Category: Definitions
Show in UI: CannotBeShown

Aggregate

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

Aggregate Parent:
Projects.ProjectTypes
Aggregate Root:
Projects.ProjectTypes

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FullPath	string (25) nullable	The full path of the node in the format of dot-delimited, dot-terminated codes of the parents. `Filter(eq;like)` `ReadOnly`
Id	guid
Notes	string (max) nullable	Notes for this TypeWorkElement.
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.
ParentFullPath	string (25) nullable	The full path of the parent work element in this project type. null when this is root element. `Filter(eq;like)`
WorkElementCode	string (3)	The code of the work element, unique among the sibling elements within the parent work element. `Required` `Filter(eq)`
WorkElementName	string (254)	The name of the work element, unique among the sibling elements within the parent work element. `Required` `Filter(eq)`

References

Name	Type	Description
ProjectType	ProjectTypes	The to which this TypeWorkElement belongs. `Required` `Filter(multi eq)` `Owner`

Attribute Details

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

FullPath

The full path of the node in the format of dot-delimited, dot-terminated codes of the parents. Filter(eq;like) ReadOnly

Type: string (25) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 25
Show in UI: ShownByDefault

Id

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

Notes

Notes for this TypeWorkElement.

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

ParentFullPath

The full path of the parent work element in this project type. null when this is root element. Filter(eq;like)

Type: string (25) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 25
Show in UI: ShownByDefault

WorkElementCode

The code of the work element, unique among the sibling elements within the parent work element. Required Filter(eq)

Type: string (3)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 3
Show in UI: ShownByDefault

WorkElementName

The name of the work element, unique among the sibling elements within the parent work element. Required Filter(eq)

Type: string (254)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Reference Details

ProjectType

The to which this TypeWorkElement belongs. Required Filter(multi eq) Owner

Type: ProjectTypes
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST