Table of Contents

Projects.Agile.CaseDevelopments Entity

Namespace: Projects.Agile

Case Development. Entity: Apm_Case_Developments (Introduced in version 24.1.3.81)

Default Visualization

Default Display Text Format:
{Case.Number}: {ActionDescription} by {CreationUser} {CreationTimeUtc}
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

Attributes

Name Type Description
ActionDescription string Specifies the latest action, dependent on DevelopmentType.
CreationTimeUtc datetime The exact date and time (in UTC) when the development was created. Required Default(NowUtc) Filter(ge;le) ORD ReadOnly
Description string (max) nullable Detailed description of the development. Filter(like)
DevelopmentType DevelopmentType Type of the development - Edit, Assignment, Resolve, etc. Required Default("EDT") Filter(multi eq) ReadOnly
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
NewSystemState SystemState nullable When the development incurred changing the state of the case, contains the new state. Filter(multi eq)
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.

References

Name Type Description
AssignedToUser Users (nullable) When the development incurred re-assignment, specifies the new user, to which the case is assigned. Filter(multi eq)
Case Cases The case of the case development. Required Filter(multi eq)
CreationUser Users The user, who created the development. Required Filter(multi eq) ReadOnly

Attribute Details

ActionDescription

Specifies the latest action, dependent on DevelopmentType.

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

CreationTimeUtc

The exact date and time (in UTC) when the development was created. Required Default(NowUtc) Filter(ge;le) ORD ReadOnly

Type: datetime
Indexed: True
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

Description

Detailed description of the development. Filter(like)

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

DevelopmentType

Type of the development - Edit, Assignment, Resolve, etc. Required Default("EDT") Filter(multi eq) ReadOnly

Type: DevelopmentType
Category: System
Allowed values for the DevelopmentType(Projects.Agile.CaseDevelopments.md#developmenttype) data attribute
Allowed Values (Projects.Agile.CaseDevelopmentsRepository.DevelopmentType Enum Members)

Value Description
Edit Edit. Stored as 'EDT'.
Database Value: 'EDT'
Model Value: 0
Domain API Value: 'Edit'
Assignment Assignment . Stored as 'ASN'.
Database Value: 'ASN'
Model Value: 1
Domain API Value: 'Assignment'
ChangeState Change state. Stored as 'STA'.
Database Value: 'STA'
Model Value: 2
Domain API Value: 'ChangeState'
AssignmentH Assignment. Stored as 'ASH'.
Database Value: 'ASH'
Model Value: 3
Domain API Value: 'AssignmentH'
ChangeStateH Change state. Stored as 'STH'.
Database Value: 'STH'
Model Value: 4
Domain API Value: 'ChangeStateH'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: Edit
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

NewSystemState

When the development incurred changing the state of the case, contains the new state. Filter(multi eq)

Type: SystemState nullable
Category: System
Allowed values for the SystemState(Projects.Agile.Cases.md#systemstate) data attribute
Allowed Values (Projects.Agile.CasesRepository.SystemState Enum Members)

Value Description
BACKLOG BACKLOG. Stored as '1'.
Database Value: '1'
Model Value: 0
Domain API Value: 'BACKLOG'
CONSIDER CONSIDER. Stored as '2'.
Database Value: '2'
Model Value: 1
Domain API Value: 'CONSIDER'
READY READY. Stored as '3'.
Database Value: '3'
Model Value: 2
Domain API Value: 'READY'
INPROGRESS IN PROGRESS. Stored as '4'.
Database Value: '4'
Model Value: 3
Domain API Value: 'INPROGRESS'
WAITING WAITING. Stored as '5'.
Database Value: '5'
Model Value: 4
Domain API Value: 'WAITING'
RESOLVED RESOLVED. Stored as '6'.
Database Value: '6'
Model Value: 5
Domain API Value: 'RESOLVED'
CLOSED CLOSED. Stored as '7'.
Database Value: '7'
Model Value: 6
Domain API Value: 'CLOSED'

Supported Filters: Equals, EqualsIn
Supports Order By: False
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

Reference Details

AssignedToUser

When the development incurred re-assignment, specifies the new user, to which the case is assigned. Filter(multi eq)

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

Case

The case of the case development. Required Filter(multi eq)

Type: Cases
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

CreationUser

The user, who created the development. Required Filter(multi eq) ReadOnly

Type: Users
Indexed: True
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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    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

Front-End Business Rules

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Projects_Agile_CaseDevelopments?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Projects_Agile_CaseDevelopments?$top=10