Objects
Custom attributes
This is possible to get custom attributes names and values, simply use the get(customAttributeId) method, for example:
- get(“CUSTOM_ATTRIBUTE_Actor_0”).name
- get(“CUSTOM_ATTRIBUTE_Actor_0”).value
User
Attribute/Method | Description | Type | Example |
---|---|---|---|
getAccountType() | The account type, could be STANDARD or VIEWER. | String | “STANDARD” |
getPreferredLanguage() | The 2-letters ISO code of the User's preferred language. | String | “en” |
getSystemLevelRoleTypeNames() | The Roles associated to the User. | Array of Strings | [“SUPER_USER_ROLE”, “PMO_ROLE”] |
getSystemPermissionNames() | The Permissions associated to the User (from the Roles). | Array of Strings | [“ACTOR_EDIT_ALL_PERMISSION”, “ACTOR_VIEW_ALL_PERMISSION” ] |
SystemLevelRoleType
Attribute/Method | Description | Type | Example |
---|---|---|---|
name | The Role name. | String | “SUPER_USER_ROLE” |
description | The i18n key of the Role description | String | “role.super_user_role.description” |
systemPermissions | The Permissions associated to the Role. | Array of SystemPermissions | - |
SystemPermission
Attribute/Method | Description | Type | Example |
---|---|---|---|
name | The Permission name. | String | “ROADMAP_DISPLAY_PERMISSION” |
description | The i18n key of the Permission description | String | “permission.roadmap_display_permission.description” |
Actor
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Employee. | Long | 123 |
isActive | True if the Employee is still active, else false. | Boolean | true |
refId | A reference ID for the Employee. | String | “JB123” |
erpRefId | An ERP reference ID for the Employee. | String | “ER458” |
firstName | The first name of the Employee. | String | “James” |
lastName | The last name of the Employee | String | “Bond” |
title | The Employee title. | String | “Mr.” |
The email address of the Employee. | String | “james.bond@mi6.uk” | |
mobilePhone | The mobile phone number of the Employee. | String | “+4179 123 45 67” |
fixPhone | The direct fix phone number of the Employee. | String | “+4121 123 45 67” |
employeeId | An Employee ID. | String | “E336” |
uid | The username of the BizDock User associated to the Employee. | String | “jbond” |
orgUnit | The Org unit of the Employee. | OrgUnit | - |
actorType | The Actor Type of the Employee. | ActorType | - |
manager | The manager of the Employee. | Actor | - |
defaultCompetency | The principal Competency of the Employee. | Competency | - |
competencies | The Competencies of the Employee. | Array of Competencies | - |
subordinates | The direct subordinates of the Employee. | Array of Actors | - |
ActorType
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Type. | Long | 647 |
selectable | True if the Type is active (could be assigned). | Boolean | true |
getName() | The name of the Type. | String | “Employee” |
getDescription() | The description of the Type. | String | “A company employee.” |
refId | The reference ID of the type. | String | “EMP” |
Competency
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Competency. | Long | 514 |
isActive | True if the Competency is active (could be assigned). | Boolean | true |
getName() | The name of the Competency. | String | “Java” |
getDescription() | The description of the Competency. | String | “A Java developer.” |
TimesheetActivityAllocatedActor
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the allocation. | Long | 674 |
days | The number of days of the allocation. | Number | 2.5 |
startDate | The start date of the allocation. | Date | 1450194968 |
endDate | The end date of the allocation. | Date | 1458057368 |
actor | The concerned actor. | Actor | - |
timesheetActivity | The concerned activity. | TimesheetActivity | - |
TimesheetActivity
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Activity. | Long | 368 |
timesheetActivityType | The Type of the Activity | TimesheetActivityType | - |
getName() | The name of the Activity. | String | “Holidays” |
getDescription() | The description of the Activity. | String | “Paid holidays.” |
TimesheetActivityType
id | The unique ID of the Type. | Long | 445 |
getName() | The name of the Type. | String | “Absence” |
getDescription() | The description of the Type. | String | “Paid absence.” |
ApplicationBlock
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Application Block. | Long | 774 |
archived | True if the Application Block has been archived, else false. | Boolean | false |
refId | The reference ID of the Application Block. | String | “FO442” |
name | The name of the Application Block. | String | “CRM” |
description | The description of the Application Block. | String | “This application block encompasses the Customer Relationship Management” |
parent | The parent of the Application Block. | ApplicationBlock | - |
children | The children of the Application Block. | Array of ApplicationBlocks | - |
BudgetBucket
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Budget Bucket. | Long | 139 |
isActive | True if the Budget Bucket is active, else false. | Boolean | true |
refId | The reference ID of the Budget Bucket. | String | “BB1123” |
name | The name of the Budget Bucket. | String | “Server budget for 2015” |
isApproved | True if the Budget Bucket has been approved, else false. | Boolean | false |
owner | The owner of the Budget Bucket. | Actor | - |
BudgetBucketLine
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Line. | Long | 932 |
refId | The reference ID of the Line. | String | “BBL698” |
name | The name of the Line. | String | “Additional RAM” |
isOpex | True for OPEX, false for CAPEX. | Boolean | true |
amount | The amount of the Line | Number | 10000 |
currency | The Currency of the Line. | Currency | - |
budgetBucket | The Budget Bucket of the Line. | BudgetBucket | - |
Currency
Attribute/Method | Description | Type | Example |
---|---|---|---|
isActive | True if the Currency is active, else false. | Boolean | true |
code | The 3-letters ISO code of the Currency. | String | “EUR” |
isDefault | True if the Currency is the default one, else false. | Boolean | false |
conversionRate | The conversion rate comparing to the default Currency. | Number | 0.95 |
symbol | The official symbol of the Currency. | String | “€” |
OrgUnit
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Org Unit. | Long | 547 |
name | The name of the Org Unit. | String | “IT” |
refId | The reference ID of the Org Unit. | String | “OU13” |
canSponsor | True if the Org Unit can be a Sponsoring Unit, else false. | Boolean | true |
canDeliver | True if the Org Unit can be a Delivery Unit, else false. | Boolean | false |
isActive | True if the Org Unit is active, else false. | Boolean | true |
orgUnitType | The type of the Org Unit. | OrgUnitType | - |
parent | The parent of the Org Unit. | OrgUnit | - |
childs | The children of the Org Unit. | Array of OrgUnits | - |
actors | The Employees of the Org Unit. | Array of Actors | - |
manager | The manager of the Org Unit. | Actor | - |
OrgUnitType
id | The unique ID of the Type. | Long | 647 |
selectable | True if the Type is active (could be assigned). | Boolean | true |
getName() | The name of the Type. | String | “Team” |
getDescription() | The description of the Type. | String | “Small unit.” |
refId | The reference ID of the type. | String | “TEAM” |
Portfolio
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Portfolio. | Long | 122 |
isActive | True if the Portfolio is active (could be selected). | Boolean | true |
refId | The reference ID of the Portfolio. | String | “MARK” |
name | The name of the Portfolio. | String | “Marketing” |
manager | The manager of the Portfolio. | Actor | - |
portfolioEntries | The portfolio entries of the Portfolio. | Array of PortfolioEntries | - |
stakeholders | The Stakeholders of the Portfolio. | Array of Stakeholders | - |
portfolioType | The type of the Portfolio. | PortfolioType | - |
PortfolioType
id | The unique ID of the Type. | Long | 774 |
selectable | True if the Type is active (could be assigned). | Boolean | true |
getName() | The name of the Type. | String | “Program” |
getDescription() | The description of the Type. | String | “A group of projects which aims at a common goal.” |
Requirement
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Requirement. | Long | 635 |
isDefect | True if the Requirement is a defect, else a need. | Boolean | false |
externalRefId | The external reference ID, if the Requirement is provided externally. | String | “4556” |
externalLink | The link to the provisioning resource. | String | “http://myredmine.com/issue?id=4556” |
name | The name of the Requirement. | String | “New CRM form” |
description | The description of the Requirement. | String | “Create a new form to catch the first and last name of a customer.” |
category | The category of the Requirement. | String | “CRM” |
storyPoints | The number of points of the Requirement. | Integer | 4 |
initialEstimation | The initial estimation in days to accomplish the Requirement. | Number | 2 |
effort | The done effort on the Requirement. | Number | 0.5 |
remainingEffort | The remaining effort on the Requirement. | Number | 1.75 |
isScoped | True if the Requirement is scopes, else false. | Boolean | true |
requirementStatus | The status of the Requirement. | RequirementStatus | - |
requirementPriority | The priority of the Requirement. | RequirementPriority | - |
requirementSeverity | The severity of the Requirement. | RequirementSeverity | - |
portfolioEntry | The Portfolio Entry of the Requirement. | PortfolioEntry | - |
author | The author of the Requirement. | Actor | - |
iteration | The Iteration of the Requirement. | Iteration | - |
RequirementStatus
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Status. | Long | 987 |
type | The type of the Status, could be: NEW, OPEN, CLOSED, DEPLOYED. | String | “OPEN” |
getName() | The name of the Status. | String | “In progress” |
getDescription() | The description of the Status. | String | “The requirement is under development.” |
RequirementPriority
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Priority. | Long | 224 |
isMust | True if the Priority describes a mandatory Requirement, else false. | Boolean | false |
getName() | The name of the Priority. | String | “Must” |
getDescription() | The description of the Priority. | String | “Very high priority.” |
RequirementSeverity
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Severity. | Long | 671 |
isBlocker | True if the Severity describes a blocking Requirement, else false. | Boolean | false |
getName() | The name of the Severity. | String | “Minor” |
getDescription() | The description of the Severity. | String | “A minor requirement.” |
PurchaseOrder
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Purchase Order. | Long | 268 |
refId | The reference ID of the Purchase Order. | String | “PO446” |
description | The description of the Purchase Order. | String | “PO for testing.” |
isCancelled | True if the Purchase Order has been cancelled, else false. | Boolean | false |
purchaseOrderLineItems | The lines (items) of the Purchase Order. | Array of PurchaseOrderLineItems | - |
portfolioEntry | The Portfolio Entry of the Purchase Order. | PortfolioEntry | - |
PurchaseOrderLineItem
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Item. | Long | 547 |
isCancelled | True if the Item has been cancelled, else false. | Boolean | false |
refId | The reference ID of the Item. | String | “PO446I4” |
description | The description of the Item. | String | “External testing.” |
lineId | The number of the Item (versus the others Item of the Purchase Order). | Integer | 4 |
quantity | The quantity of the Item. | Number | 2 |
quantityTotalReceived | The received quantity of the Item. | Number | 1 |
quantityBilled | The billed quantity of the Item. | Number | 0 |
amount | The total amount of the Item (for the quantity). | Number | 50000 |
amountReceived | The amount received of the Item. | Number | 20000 |
amountBilled | The billed amount of the Item. | Number | 10000 |
unitPrice | The unit price. | Number | 25000 |
materialCode | The code of the materiel. | String | “NONE” |
glAccount | The concerned GL account of the Item. | String | “3200” |
isOpex | True for OPEX, false for CAPEX. | Boolean | true |
creationDate | The creation date of the Item. | Date | 1450194968 |
dueDate | The due date of the Item. | Date | 1450254968 |
purchaseOrder | The Purchase Order of the Item. | PurchaseOrder | - |
supplier | The Supplier of the Item. | Supplier | - |
currency | The currency of the Item. | Currency | - |
requester | The requester of the Purchase Order. | Actor | - |
shipmentType | The Shipment Type of the Purchase Order. | PurchaseOrderLineShipmentStatusType | - |
costCenter | The Cost center of the Item. | CostCenter | - |
Supplier
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Supplier. | Long | 336 |
name | The name of the Supplier. | String | “Apple” |
refId | The reference ID of the Supplier. | String | “44677” |
PurchaseOrderLineShipmentStatusType
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Type. | Long | 485 |
name | The name of the Type. | String | “Standard” |
description | The description of the Type. | String | “Standard shipment.” |
refId | The reference ID of the Type. | String | “STD” |
isAmountExpanded | True if the amount is expanded. | String | false |
CostCenter
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Cost Center. | Long | 227 |
refId | The reference ID of the Cost Center. | String | “CC44” |
name | The name of the Cost Center. | String | “Main cost center” |
owner | The owner of the Cost Center. | Actor | - |
PortfolioEntry
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Portfolio Entry. | Long | 769 |
refId | The reference ID of the Portfolio Entry. | String | “44668” |
governanceId | The governance ID of the Portfolio Entry. | String | “CRMUP” |
erpRefId | The ERP ID of the Portfolio Entry. | String | “ER96478” |
name | The name of the Portfolio Entry. | String | “CRM Upgrade” |
description | The description of the Portfolio Entry. | String | “Upgrade of the Company CRM system” |
creationDate | The creation date of the Portfolio Entry. | Date | 1450254968 |
isPublic | True if the Portfolio Entry is public, false if it is confidential. | Boolean | true |
archived | True if the Portfolio Entry is archived, false if it is active. | Boolean | false |
manager | The manager of the Portfolio Entry. | Actor | - |
sponsoringUnit | The sponsoring unit of the Portfolio Entry. | OrgUnit | - |
deliveryUnits | The delivery units of the Portfolio Entry. | Array of OrgUnits | - |
portfolioEntryType | The type of the Portfolio Entry. | PortfolioEntryType | - |
portfolios | The Portfolios of the Portfolio Entry. | Array of Portfolios | - |
stakeholders | The Stakeholders of the Portfolio Entry. | Array of Stakeholders | - |
activeLifeCycleInstance | The active instance of Life Cycle Process. | LifeCycleInstance | - |
lastApprovedLifeCycleMilestoneInstance | The instance of the last approved Milestone. | LifeCycleMilestoneInstance | - |
lastPortfolioEntryReport | The last created Report. | PortfolioEntryReport | - |
PortfolioEntryType
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Type. | Long | 774 |
selectable | True if the Type is active (could be assigned). | Boolean | true |
isRelease | True if the Type is for the Releases, false for Initiatives. | Boolean | false |
getName() | The name of the Type. | String | “Project” |
getDescription() | The description of the Type. | String | “A company project.” |
LifeCycleProcess
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Process. | Long | 149 |
isActive | True if the Process is active (could be assigned). | Boolean | true |
isRelease | True if the Process is for the Releases, false for Initiatives. | Boolean | false |
getShortName() | The short name name of the Process. | String | “TTM” |
getName() | The name of the Process. | String | “Marketing board” |
getDescription() | The description of the Process. | String | “Marketing board Governance life cycle.” |
lifeCycleMilestones | The Milestones of the Process. | Array of LifeCycleMilestones | - |
LifeCycleInstance
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Instance. | Long | 259 |
isActive | True if the Instance is the current Process of the Portfolio Entry, else false. | Boolean | true |
isConcept | True if the associated Portfolio Entry is a concept, else false. | Boolean | false |
lifeCycleProcess | The corresponding Life Cycle Process | LifeCycleProcess | - |
portfolioEntry | The associated Portfolio Entry. | PortfolioEntry | - |
LifeCycleMilestone
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Milestone. | Long | 452 |
isActive | True if the Milestone is active. | Boolean | true |
isReviewRequired | True if the Milestone should be reviewed before the creation of an instance, else false. | Boolean | true |
type | The type of the Milestone, could be IMPLEMENTATION_START_DATE, IMPLEMENTATION_END_DATE | String | “IMPLEMENTATION_START_DATE” |
order | The order of the Milestone. | Integer | 4 |
getShortName() | The short name name of the Milestone. | String | “T2” |
getName() | The name of the Milestone. | String | “Start implementation” |
getDescription() | The description of the Milestone. | String | “Start date of the implementation.” |
lifeCycleProcess | The Process of the Milestone. | LifeCycleProcess | - |
defaultLifeCycleMilestoneInstanceStatusType | The default status type (automatically settled when the Milestone hasn't approvers). | LifeCycleMilestoneInstanceStatusType | - |
approvers | Th default approvers of the Milestone. | Array of Actors | - |
LifeCycleMilestoneInstanceStatusType
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Status. | Long | 169 |
selectable | True if the Status is active (could be assigned). | Boolean | true |
isApproved | True if the Status means that the Milestone is approved, false for rejected. | Boolean | true |
getName() | The name of the Status. | String | “Approved” |
getDescription() | The description of the Status. | String | “Fully approved Milestone.” |
LifeCycleMilestoneInstance
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Milestone Instance. | Long | 259 |
isPassed | True if the Milestone Instance is passed (meaning not pending). | Boolean | true |
passedDate | The date when the Milestone Instance has been passed. | Date | 1450194968 |
gateComments | Some comments about the the Milestone Instance. | String | “No problem detected.” |
lifeCycleMilestone | The corresponding Milestone. | LifeCycleMilestone | - |
lifeCycleInstance | The corresponding Process instance. | LifeCycleInstance | - |
lifeCycleMilestoneInstanceStatusType | The Milestone instance status, only if it is passed. | LifeCycleMilestoneInstanceStatusType | - |
PortfolioEntryBudget
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Budget. | Long | 864 |
allocationDate | The allocation date | Date | 1450194968 |
portfolioEntryBudgetLines | The lines of the Budget. | Array of PortfolioEntryBudgetLines | - |
PortfolioEntryBudgetLine
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Line. | Long | 647 |
refId | The reference ID of the Line. | String | “BBL698” |
name | The name of the Line. | String | “Additional RAM” |
isOpex | True for OPEX, false for CAPEX. | Boolean | true |
amount | The amount of the Line | Number | 10000 |
glAccount | The concerned GL account of the Item. | String | “2200” |
currency | The Currency of the Line. | Currency | - |
portfolioEntryBudget | The Budget of the Line. | PortfolioEntryBudget | - |
budgetBucket | The Budget Bucket of the Line. | BudgetBucket | - |
PortfolioEntryEvent
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Event. | Long | 347 |
creationDate | The creation date of the Event. | Date | 1450194968 |
message | The content of the Event. | String | “General review is announced.” |
portfolioEntry | The Portfolio Entry of the Event. | PortfolioEntry | - |
portfolioEntryEventType | The Type of the Event. | PortfolioEntryEventType | - |
actor | The author of the Event. | Actor | - |
PortfolioEntryEventType
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Type. | Long | 441 |
selectable | True if the Type is active (could be assigned). | Boolean | true |
isRelease | True if the Type is for the Releases, false for Initiatives. | Boolean | false |
getName() | The name of the Type. | String | “Project” |
bootstrapGlyphicon | The icon of the Type. | String | “glyphicons glyphicons-circle-info” |
PortfolioEntryPlanningPackage
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Package. | Long | 344 |
name | The name of the Package. | String | “Business Requirements” |
description | The description of the Package. | String | “The requirements of the business. |
startDate | The start date of the Package. | Date | 1450194968 |
endDate | The end date of the Package. | Date | 1455894968 |
order | The order of the Package (used when it belongs to a Group). | Integer | 2 |
status | The status of the Package, could be: NOT_STARTED, ON_GOING, CLOSED. | String | “ON_GOING” |
portfolioEntry | The Portfolio Entry of the Package. | PortfolioEntry | - |
portfolioEntryPlanningPackageGroup | The Group of the Package. | PortfolioEntryPlanningPackageGroup | - |
PortfolioEntryPlanningPackageType
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Type. | Long | 684 |
isActive | True if the Type is active (could be assigned). | Boolean | true |
getName() | The name of the Type. | String | “Key milestone” |
cssClass | The CSS class that defines the color of the Type. | String | “primary” |
PortfolioEntryPlanningPackageGroup
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Group. | Long | 982 |
isActive | True if the Group is active (could be assigned). | Boolean | true |
getName() | The name of the Group. | String | “Initiation” |
getDescription() | The description of the Group. | String | “Initiation related planning packages like business requirements.” |
PortfolioEntryReport
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Report. | Long | 853 |
creationDate | The creation date of the Report. | Date | 1450194968 |
publicationDate | The publication date of the Report. | Date | 1450194968 |
comments | The content of the Report. | String | “Everything is OK.” |
isPublished | True if the Report is published, else false. | Boolean | true |
portfolioEntry | The Portfolio Entry of the Report. | PortfolioEntry | - |
portfolioEntryReportStatusType | The status of the Report. | PortfolioEntryReportStatusType | - |
author | The author of the Report. | Actor | - |
PortfolioEntryReportStatusType
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Status. | Long | 723 |
selectable | True if the Status is active (could be assigned). | Boolean | true |
cssClass | The CSS class that defines the color of the Status. | String | “primary” |
getName() | The name of the Status. | String | “Amber” |
getDescription() | The description of the Status. | String | “Some problems, but not critical.” |
PortfolioEntryRisk
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Risk. | Long | 473 |
creationDate | The creation date of the Risk. | Date | 1450194968 |
targetDate | The target date of the Risk. | Date | 1450194968 |
closureDate | The closure date of the Risk. | Date | 1456594968 |
name | The name of the Risk. | String | “Issues” |
description | the description of the Risk. | String | “Some issues take times to be fixed.” |
hasOccured | True if the Risk has occurred (means it is an issue), else false. | Boolean | false |
isActive | True if the Risk is still active. | Boolean | true |
isMitigated | True if the Risk has been mitigated. | Boolean | true |
mitigationComment | The description of the mitigation action. | Boolean | “New external resources are now available.” |
portfolioEntryRiskType | The Type of the Risk. | PortfolioEntryRiskType | - |
portfolioEntry | The Portfolio Entry of the Risk. | PortfolioEntry | - |
owner | The owner of the Risk. | Actor | - |
PortfolioEntryRiskType
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Type. | Long | 698 |
selectable | True if the Type is active (could be assigned). | Boolean | true |
getName() | The name of the Type. | String | “Budget” |
getDescription() | The description of the Type. | String | “The risk is associated with the budget.” |
PortfolioEntryResourcePlanAllocatedActor
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the allocation. | Long | 320 |
days | The number of days of the allocation. | Number | 2.5 |
startDate | The start date of the allocation. | Date | 1450194968 |
endDate | The end date of the allocation. | Date | 1458057368 |
isConfirmed | True if the allocation is confirmed, else false. | Boolean | true |
followPackageDates | True if the allocation follows the dates of the associated Package, else false. | Boolean | false |
actor | The concerned Actor. | Actor | - |
portfolioEntryPlanningPackage | The concerned Package. | PortfolioEntryPlanningPackage | - |
PortfolioEntryResourcePlanAllocatedOrgUnit
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the allocation. | Long | 236 |
days | The number of days of the allocation. | Number | 2.5 |
startDate | The start date of the allocation. | Date | 1450194968 |
endDate | The end date of the allocation. | Date | 1458057368 |
isConfirmed | True if the allocation is confirmed, else false. | Boolean | true |
followPackageDates | True if the allocation follows the dates of the associated Package, else false. | Boolean | false |
orgUnit | The concerned Org Unit. | OrgUnit | - |
portfolioEntryPlanningPackage | The concerned Package. | PortfolioEntryPlanningPackage | - |
PortfolioEntryResourcePlanAllocatedCompetency
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the allocation. | Long | 899 |
days | The number of days of the allocation. | Number | 2.5 |
startDate | The start date of the allocation. | Date | 1450194968 |
endDate | The end date of the allocation. | Date | 1458057368 |
isConfirmed | True if the allocation is confirmed, else false. | Boolean | true |
followPackageDates | True if the allocation follows the dates of the associated Package, else false. | Boolean | false |
competency | The concerned Competency. | Competency | - |
portfolioEntryPlanningPackage | The concerned Package. | PortfolioEntryPlanningPackage | - |
Stakeholder
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Stakeholder. | Long | 347 |
portfolio | The concerned Portfolio (in this case Portfolio Entry is empty). | Portfolio | - |
portfolioEntry | The concerned Portfolio Entry (in this case Portfolio is empty). | PortfolioEntry | - |
actor | The concerned actor. | Actor | - |
stakeholderType | The Type of the Stakeholder. | StakeholderType | - |
StakeholderType
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Type. | Long | 112 |
selectable | True if the Type is active (could be assigned). | Boolean | true |
getName() | The name of the Type. | String | “IT responsible” |
getDescription() | The description of the Type. | String | “IT responsible of the program.” |
WorkOrder
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Work Order. | Long | 602 |
name | The name of the Work Order. | String | “Test” |
description | The description of the Work Order. | String | “All tests, including UAT” |
amount | The amount of the Work Order. | Number | 25000 |
amountReceived | The received amount of the Work Order. | Number | 5000 |
isOpex | True for OPEX, false for CAPEX. | Boolean | true |
isEngaged | True if the Work Order is engaged. | Boolean | false |
shared | True if the Work Order could be shared with many Purchase Order, else false. | Boolean | true |
creationDate | The creation date of the Work Order. | Date | 1458057368 |
dueDate | The due date of the Work Order. | Date | 1458057368 |
startDate | The start date for the Work Order. | Date | 1458057368 |
followPackageDates | True if the Work Order follows the dates of the associated Package, else false. | Boolean | false |
currency | The Currency of the Work Order. | Currency | - |
portfolioEntry | The concerned Portfolio Entry. | PortfolioEntry | - |
purchaseOrderLineItem | The Purchase Order Item for which the Work Order is engaged. | PurchaseOrderLineItem | - |
portfolioEntryPlanningPackage | The Package of the Work Order. | PortfolioEntryPlanningPackage | - |
Iteration
Attribute/Method | Description | Type | Example |
---|---|---|---|
id | The unique ID of the Iteration. | Long | 685 |
name | The name of the Iteration. | String | “CRM V2” |
description | The description of the Iteration | String | “Evolution of the CRM: second part.” |
isClosed | True if the Iteration is closed (finished), else false. | Boolean | false |
storyPoints | The number of points of the Iteration. | Integer | 500 |
startDate | The start date of the Iteration. | Date | 1458057368 |
endDate | The end date of the Iteration. | Date | 1458060368 |
portfolioEntry | The concerned Portfolio Entry. | PortfolioEntry | - |