Table of Contents

Projects.Agile.Cases Entity

Namespace: Projects.Agile

Case in a project. Used to track work progress. Entity: Apm_Cases (Introduced in version 24.1.1.86)

Default Visualization

Default Display Text Format:
{Number}: {Title:T}
Default Search Members:
__
Category: Definitions
Show in UI: ShownByDefault
Layout category attribute: CaseCategoryId

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
ClosedTimeUTC datetime nullable Indicates the time (in UTC) when the case was closed. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93
ConsiderTimeUTC datetime nullable Indicates the time (in UTC) when the case has changed to consider state. Filter(ge;le) ReadOnly Introduced in version 25.1.1.39
CreationTimeUtc datetime The exact date and time (in UTC) when the case was created. Required Default(NowUtc) Filter(ge;le) ReadOnly Introduced in version 25.1.0.93
Description string (max) nullable Description of the required work. Filter(like)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DueDate date nullable Specified when the case has specific due date. Filter(ge;le)
DueTime time nullable Specified when the case has specific due time. Filter(ge;le)
EstimatedTimeHours decimal (8, 2) nullable Estimation of the required work effort in hours.
FullState string Full state of the case based on its system and user state. [ReadOnly]
Id guid
InProgressTimeUTC datetime nullable Indicates the time (in UTC) when the case has changed to in-progress state. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93
Number int32 The unique number of the Case. Required Filter(eq) ReadOnly Introduced in version 24.1.3.86
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.
Priority Priority Priority of the case, on a scale from 1 (highest) to 7 (lowest). Required Default(7) Filter(eq)
ReadyTimeUTC datetime nullable Indicates the time (in UTC) when the case has become ready for execution. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93
ResolvedTimeUTC datetime nullable Indicates the time (in UTC) when the case was resolved. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93
SystemState SystemState The base state of the case. Required Default("1") Filter(eq) ReadOnly
Title string (128) Case short title. Required Filter(like)
WaitingTimeUTC datetime nullable Indicates the time (in UTC) when the case has changed to waiting state. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93

References

Name Type Description
AssignedToUser Users (nullable) The internal user to which the case is assigned. Filter(multi eq)
CaseCategory CaseCategories The category of the case. This also determines the workflow for the case. Required Filter(multi eq)
Parent Cases (nullable) Specified when this is a sub-case to another case. Filter(multi eq)
Project Projects The project to which the case is assigned. Required Filter(multi eq)
ProjectArea ProjectAreas (nullable) The are to which the case is assigned. Filter(multi eq)
ProjectMilestone ProjectMilestones (nullable) Determines the milestone for which the case must be resolved. Filter(multi eq)
SocialGroup Groups (nullable) Specified, when the case is assigned to a group of users. Filter(multi eq)
UserState UserStates (nullable) The user-defined sub-state of the case. Filter(multi eq) ReadOnly Introduced in version 25.1.0.97

Attribute Details

ClosedTimeUTC

Indicates the time (in UTC) when the case was closed. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93

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

ConsiderTimeUTC

Indicates the time (in UTC) when the case has changed to consider state. Filter(ge;le) ReadOnly Introduced in version 25.1.1.39

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

CreationTimeUtc

The exact date and time (in UTC) when the case was created. Required Default(NowUtc) Filter(ge;le) ReadOnly Introduced in version 25.1.0.93

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

Description

Description of the required work. 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

DueDate

Specified when the case has specific due date. Filter(ge;le)

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

DueTime

Specified when the case has specific due time. Filter(ge;le)

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

EstimatedTimeHours

Estimation of the required work effort in hours.

Type: decimal (8, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

FullState

Full state of the case based on its system and user state. [ReadOnly]

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

InProgressTimeUTC

Indicates the time (in UTC) when the case has changed to in-progress state. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93

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

Number

The unique number of the Case. Required Filter(eq) ReadOnly Introduced in version 24.1.3.86

Type: int32
Category: System
Supported Filters: Equals
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

Priority

Priority of the case, on a scale from 1 (highest) to 7 (lowest). Required Default(7) Filter(eq)

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

Value Description
Highest Highest value. Stored as 1.
Database Value: 1
Model Value: 1
Domain API Value: 'Highest'
Two Two value. Stored as 2.
Database Value: 2
Model Value: 2
Domain API Value: 'Two'
Three Three value. Stored as 3.
Database Value: 3
Model Value: 3
Domain API Value: 'Three'
Four Four value. Stored as 4.
Database Value: 4
Model Value: 4
Domain API Value: 'Four'
Five Five value. Stored as 5.
Database Value: 5
Model Value: 5
Domain API Value: 'Five'
Six Six value. Stored as 6.
Database Value: 6
Model Value: 6
Domain API Value: 'Six'
Lowest Lowest value. Stored as 7.
Database Value: 7
Model Value: 7
Domain API Value: 'Lowest'

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

ReadyTimeUTC

Indicates the time (in UTC) when the case has become ready for execution. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93

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

ResolvedTimeUTC

Indicates the time (in UTC) when the case was resolved. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93

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

SystemState

The base state of the case. Required Default("1") Filter(eq) ReadOnly

Type: SystemState
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
Supports Order By: False
Default Value: BACKLOG
Show in UI: HiddenByDefault

Title

Case short title. Required Filter(like)

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

WaitingTimeUTC

Indicates the time (in UTC) when the case has changed to waiting state. Filter(ge;le) ReadOnly Introduced in version 25.1.0.93

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

Reference Details

AssignedToUser

The internal 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

CaseCategory

The category of the case. This also determines the workflow for the case. Required Filter(multi eq)

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

Parent

Specified when this is a sub-case to another case. Filter(multi eq)

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

Project

The project to which the case is assigned. Required Filter(multi eq)

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

ProjectArea

The are to which the case is assigned. Filter(multi eq)

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

ProjectMilestone

Determines the milestone for which the case must be resolved. Filter(multi eq)

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

SocialGroup

Specified, when the case is assigned to a group of users. Filter(multi eq)

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

UserState

The user-defined sub-state of the case. Filter(multi eq) ReadOnly Introduced in version 25.1.0.97

Type: UserStates (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

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

None

API

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

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

Suggest improvement to this page