Interface Plan

Data contract for the plan definition

interface Plan {
    createdByIdentity?: IdentityRef;
    createdDate?: Date;
    description?: string;
    id?: string;
    lastAccessed?: Date;
    modifiedByIdentity?: IdentityRef;
    modifiedDate?: Date;
    name?: string;
    properties?: any;
    revision?: number;
    type?: DeliveryTimelineView;
    url?: string;
    userPermissions?: PlanUserPermissions;
}

Properties

createdByIdentity? createdDate? description? id? lastAccessed? modifiedByIdentity? modifiedDate? name? properties? revision? type? url? userPermissions?

Properties

OptionalcreatedByIdentity

createdByIdentity?: IdentityRef

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

OptionalcreatedDate

createdDate?: Date

Date when the plan was created

Optionaldescription

description?: string

Description of the plan

Optionalid

id?: string

Id of the plan

OptionallastAccessed

lastAccessed?: Date

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

OptionalmodifiedByIdentity

modifiedByIdentity?: IdentityRef

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

OptionalmodifiedDate

modifiedDate?: Date

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

Optionalname

name?: string

Name of the plan

Optionalproperties

properties?: any

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.

Optionalrevision

revision?: number

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

Optionaltype

type?: DeliveryTimelineView

Type of the plan

Optionalurl

url?: string

The resource url to locate the plan via rest api

OptionaluserPermissions

userPermissions?: PlanUserPermissions

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

Settings

Member Visibility

On This Page

Properties