Edit

Share via


Plan interface

Data contract for the plan definition

Properties

createdByIdentity

Identity that created this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.

createdDate

Date when the plan was created

description

Description of the plan

id

Id of the plan

lastAccessed

Date when the plan was last accessed. Default is null.

modifiedByIdentity

Identity that last modified this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.

modifiedDate

Date when the plan was last modified. Default to CreatedDate when the plan is first created.

name

Name of the plan

properties

The PlanPropertyCollection instance associated with the plan. These are dependent on the type of the plan. For example, DeliveryTimelineView, it would be of type DeliveryViewPropertyCollection.

revision

Revision of the plan. Used to safeguard users from overwriting each other's changes.

type

Type of the plan

url

The resource url to locate the plan via rest api

userPermissions

Bit flag indicating set of permissions a user has to the plan.

Property Details

createdByIdentity

Identity that created this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.

createdByIdentity: IdentityRef

Property Value

createdDate

Date when the plan was created

createdDate: Date

Property Value

Date

description

Description of the plan

description: string

Property Value

string

id

Id of the plan

id: string

Property Value

string

lastAccessed

Date when the plan was last accessed. Default is null.

lastAccessed: Date

Property Value

Date

modifiedByIdentity

Identity that last modified this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.

modifiedByIdentity: IdentityRef

Property Value

modifiedDate

Date when the plan was last modified. Default to CreatedDate when the plan is first created.

modifiedDate: Date

Property Value

Date

name

Name of the plan

name: string

Property Value

string

properties

The PlanPropertyCollection instance associated with the plan. These are dependent on the type of the plan. For example, DeliveryTimelineView, it would be of type DeliveryViewPropertyCollection.

properties: any

Property Value

any

revision

Revision of the plan. Used to safeguard users from overwriting each other's changes.

revision: number

Property Value

number

type

Type of the plan

type: DeliveryTimelineView

Property Value

url

The resource url to locate the plan via rest api

url: string

Property Value

string

userPermissions

Bit flag indicating set of permissions a user has to the plan.

userPermissions: PlanUserPermissions

Property Value