FRAMES NO FRAMES |
com.ibm.rpm.framework.RPMObjectcom.ibm.rpm.scopemanagement.containers.ScopeElement
com.ibm.rpm.scopemanagement.containers.AggregateScope
com.ibm.rpm.scopemanagement.containers.AbstractAggregateScope
com.ibm.rpm.scopemanagement.containers.AbstractScope
com.ibm.rpm.scopemanagement.containers.AbstractRequest
com.ibm.rpm.scopemanagement.containers.ChangeRequest
Related scope: com.ibm.rpm.scopemanagement.scope.ScopeElementScope
A change request represents a request to change some aspect of the project, project plan, activity definition or document.
Parent is mandatory, allowed parent types are ScopeFolder, Action, Issue, ChangeRequest, Defect, Requirement, Risk and ServiceRequest.
The checkout mode type is: Self
Supported API Calls:Related code samples :
Java
C#
Inherited Field Summary | |
xsd:dateTime
|
approvedByDate
The date a scope element was approved |
xsd:string
|
approvedByName
FullName of the Resource that approved this scope element. |
ApprovedCostBenefits
|
approvedCostBenefits
The approved costs and benefits of the request, which are used to identify the approved schedule impact, effort required, as well as the costs and benefits. |
ScopeScheduleDate
|
approvedDate
The scheduled dates that have been approved for the scope element. This field is read-only. |
Asset
|
asset
The asset to which the scope element is attributed. |
AssetFinancialCategory
|
assetCode
The asset's financial category. |
AssignedScorecard
|
assignedScorecard
The scorecards that have been assigned to this scope element. |
AttributeAssignment[]
|
attributeAssignments
Each instance of |
ScopeElement[]
|
children
The children of the scope element. |
ClientCostCenter
|
clientCostCenter
The scope element's client / cost center |
xsd:dateTime
|
closedByDate
The date on which the scope element was closed. |
xsd:string
|
closedByName
FullName of the Resource that closed the scope element |
xsd:string
|
contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject. |
CustomFieldAssignment[]
|
customFieldAssignments
The custom fields assigned to the scope element. |
xsd:boolean
|
defaultScope
Indicates whether or not the current scope element is the default |
xsd:boolean
|
deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save. |
DocumentFolder
|
documentFolder
This folder contains the documents associated to the scope element. It is created automatically when the scope element is created. |
xsd:string
|
duplicateNumber
The unique duplicate key for the group of scope elements that are duplicates of each other. If two scope elements have the same value of This field is read-only. |
Duplicate[]
|
duplicates
The duplicate scope elements. Each instance of |
ScopeElementSecurityType
|
elementSecurityType
Indicates the type of security applied to this element. |
xsd:int
|
estimatedDurationInMinutes
The estimated duration in minutes when the scope element should be completed. |
xsd:dateTime
|
estimatedFinishDate
The estimated date when the scope element should be completed. When the field is set to null, it is calculated from the estimatedStartDate and the estimatedDurationInMinutes. |
xsd:dateTime
|
estimatedStartDate
The estimated start date for the scope element. |
xsd:string
|
externalReferenceNumber
The external reference number of the scope element. |
xsd:string
|
ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject. |
Impact
|
impact
The Quantification / Impact of the scope element. |
xsd:string
|
name
The name of the scope element. |
xsd:int
|
numberTimesReassigned
The number of times the scope element has been reassigned. |
xsd:dateTime
|
occuredDateTime
The date and time at which the request occurred. |
OrderOfMagnitudeCostBenefits
|
orderOfMagnitudeCostBenefits
The order of magnitude of the scope element's preliminary costs and benefits. |
RPMObject
|
parent
The parent of the RPMObject. |
xsd:string
|
parentSortingRank
The rank of this item's parent, currently used for sorting. |
xsd:int
|
priority
The priority of the scope element. |
GenericProject
|
project
The related project from the WBS section. |
xsd:dateTime
|
proposedByDate
The date a scope element was proposed. |
xsd:string
|
proposedByName
FullName of the Resource that proposed this scope element. |
ScopeScheduleDate
|
proposedDate
The scheduled dates that have been proposed for the scope element. This field is read-only. |
PublishedType
|
published
: The type of publishing of the scope element. |
xsd:int
|
rank
Rank of the scope element. |
xsd:string
|
referenceNumber
The reference number of the scope element. This field is read-only. |
ResourceTaskAssignment[]
|
resourceTaskAssignments
Used to identify and assign resources to the scope element. |
RtfAssignment[]
|
rtfAssignments
Each instance of |
DatafieldState
|
state
The current state of the scope element. |
StatusUpdate[]
|
statusUpdates
The list of status updates for this scope element. |
xsd:dateTime
|
targetDate
The target date of the scope element. |
xsd:boolean
|
task
This flag indicates if the scope element is a task or not. If a scope element has child elements either in Scope or WBS, then the task flag is false and may not be changed. If this flag is set to true, then no children may be added under this scope element in both WBS and Scope Management. |
xsd:string
|
templateSortingRank
The rank of the associated template. |
xsd:boolean
|
transferedUnderWbsRoot
If this field's value is This field is read-only. |
WbsFinancial[]
|
wbsFinancials
This array is used to track WBS financials from the project tasks or activities as team members enter time in the timesheets and expenses in the Project Expenses module. |
WorkElement
|
wbsParent
A reference to the WBS element which owns this scopeElement. The wbsParent needs to be saved first, in order to make sure that both ScopeElement and WorkElement are to be stored in the same project. |
xsd:string
|
wbsSortingRank
The rank of this scope item. |
WorkElement
|
workElement
The corresponding work element from the WBS section. A scope element has a corresponding work element if it has been transferred under WBS root, or if it is a ScopeFolder that was created automatically upon the creation of a WorkElement. |
AvailableWorkflowProcess[]
|
workflowProcessesAvailable
List of available |
RunningWorkflowProcess[]
|
workflowProcessesRunning
List of running |
WorksheetFinancial[]
|
worksheetFinancials
This array is used to estimate labor and non-labor budgets, as well as to manually enter track labor and non-labor |
Inherited Field Detail |
Validation: The year, month and day values will be used by this field.
Scoping: This field will be used by the API if the scope field approvedCostBenefits is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
This field is read-only.
Scoping: This field will be used by the API if the scope field scheduleDates is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field asset is enabled.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field assetCode is enabled.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field assignedScorecard is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field attributeAssignments is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field children is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field clientCostCenter is enabled.
Relationship: This field is a reference relationship.
Read-only behavior: The value of this field is read only.
Validation: The year, month and day values will be used by this field.
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Scoping: This field will be used by the API if the scope field customFieldAssignments is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Scoping: This field will be used by the API if the scope field documentFolder is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
This field is read-only.
Read-only behavior: The value of this field is read only.
Scoping: This field will be used by the API if the scope field duplicates is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Relationship: This field is a reference relationship.
Validation: The year, month and day values will be used by this field.
Validation: The year, month and day values will be used by this field.
Maximum: The maximum length for this field is 32 characters.
Read-only behavior: The value of this field is read only.
Scoping: This field will be used by the API if the scope field impact is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Maximum: The maximum length for this field is 255 characters.
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 9999.
Scoping: This field will be used by the API if the scope field orderOfMagnitudeCostBenefits is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field parent is enabled.
Read-only behavior: The value of this field is read only after the object was created.
Relationship: This field is a reference relationship.
X-Path availability: This field doesn't support X-Path queries.
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 10000.
Scoping: This field will be used by the API if the scope field project is enabled.
Relationship: This field is a reference relationship.
Validation: The year, month and day values will be used by this field.
This field is read-only.
Scoping: This field will be used by the API if the scope field scheduleDates is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Relationship: This field is a reference relationship.
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 1000.
This field is read-only.
Read-only behavior: The value of this field is read only.
Scoping: This field will be used by the API if the scope field resourceTaskAssignments is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field rtfAssignments is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field state is enabled.
Relationship: This field is a reference relationship.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Validation: The year, month and day values will be used by this field.
This field is read-only.
Read-only behavior: The value of this field is read only.
Scoping: This field will be used by the API if the scope field wbsFinancials is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field wbsParent is enabled.
Read-only behavior: The value of this field is read only after the object was created.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field workElement is enabled.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field workflowProcessesAvailable is enabled.
Read-only behavior: The value of this field is read only.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field workflowProcessesRunning is enabled.
Read-only behavior: The value of this field is read only.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field worksheetFinancials is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.