Table of Contents

Projects.Agile.ProjectAreas Entity

Namespace: Projects.Agile

Area of a project. Can be applicable to a single project or all projects. Entity: Apm_Project_Areas (Introduced in version 24.1.1.68)

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Name
Name Data Member:
Name
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
ConsiderWipLimit int32 nullable When set, specifies the work-in-progress (WIP) limit. The limit is for number of cases, which can progress to CONSIDER state. Filter(eq;ge;le) Introduced in version 25.1.1.38
Description MultilanguageString (254) nullable Description of the project area. Filter(like) Introduced in version 25.1.1.48
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
InProgressWipLimit int32 nullable When set, specifies the work-in-progress (WIP) limit. The limit is for number of cases, which can progress to IN PROGRESS state. Filter(eq;ge;le) Introduced in version 25.1.1.38
IsActive boolean Specifies whether the project area is active for new projects. Required Default(true) Filter(eq)
Name MultilanguageString (256) Multi-language name of the project area. Required Filter(like)
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.
ReadyWipLimit int32 nullable When set, specifies the work-in-progress (WIP) limit. The limit is for number of cases, which can progress to READY state. Filter(eq;ge;le) Introduced in version 25.1.1.38

References

Name Type Description
PrimaryUser Users (nullable) Specified, when there is a primary user for the area. Filter(multi eq)
Project Projects (nullable) Specified for local project areas. null means that the area is global and assignable for all projects. Filter(multi eq)

Attribute Details

ConsiderWipLimit

When set, specifies the work-in-progress (WIP) limit. The limit is for number of cases, which can progress to CONSIDER state. Filter(eq;ge;le) Introduced in version 25.1.1.38

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

Description

Description of the project area. Filter(like) Introduced in version 25.1.1.48

Type: MultilanguageString (254) nullable
Category: System
Supported Filters: Like
Supports Order By: False
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

InProgressWipLimit

When set, specifies the work-in-progress (WIP) limit. The limit is for number of cases, which can progress to IN PROGRESS state. Filter(eq;ge;le) Introduced in version 25.1.1.38

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

IsActive

Specifies whether the project area is active for new projects. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Name

Multi-language name of the project area. Required Filter(like)

Type: MultilanguageString (256)
Category: System
Supported Filters: Like
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

ReadyWipLimit

When set, specifies the work-in-progress (WIP) limit. The limit is for number of cases, which can progress to READY state. Filter(eq;ge;le) Introduced in version 25.1.1.38

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

Reference Details

PrimaryUser

Specified, when there is a primary user for the area. Filter(multi eq)

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

Project

Specified for local project areas. null means that the area is global and assignable for all projects. Filter(multi eq)

Type: Projects (nullable)
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

None

Front-End Business Rules

None

API

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

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

Suggest improvement to this page