Plan interface
Data contract for the plan definition
Properties
| created |
Identity that created this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4. |
| created |
Date when the plan was created |
| description | Description of the plan |
| id | Id of the plan |
| last |
Date when the plan was last accessed. Default is null. |
| modified |
Identity that last modified this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4. |
| modified |
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 |
| user |
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: IdentityRefProperty Value
createdDate
Date when the plan was created
createdDate: DateProperty Value
Date
description
Description of the plan
description: stringProperty Value
string
id
Id of the plan
id: stringProperty Value
string
lastAccessed
Date when the plan was last accessed. Default is null.
lastAccessed: DateProperty Value
Date
modifiedByIdentity
Identity that last modified this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.
modifiedByIdentity: IdentityRefProperty Value
modifiedDate
Date when the plan was last modified. Default to CreatedDate when the plan is first created.
modifiedDate: DateProperty Value
Date
name
Name of the plan
name: stringProperty 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: anyProperty Value
any
revision
Revision of the plan. Used to safeguard users from overwriting each other's changes.
revision: numberProperty Value
number
type
url
The resource url to locate the plan via rest api
url: stringProperty Value
string
userPermissions
Bit flag indicating set of permissions a user has to the plan.
userPermissions: PlanUserPermissions