PTC Change Management Domain
 |
Starting with Windchill REST Services 2.6, the domain the API versions 1, 2, 3, 4, and 5 and their endpoints are deprecated and will be removed in a future release of Windchill REST Services.
|
The PTC Change Management domain provides access to the change management capabilities of Windchill. The domain includes entities that represent business objects such as problem report, variance, change request, change notice, and so on. The domain provides navigation to associated process objects and associated reference objects.
The following table lists the significant OData entities available in the PTC Change Management domain. To see all the OData entities available in the PTC Change Management domain, refer to the EDM of the domain. The domain EDM is available at the metadata URL.
|
Items
|
OData Entities
|
Description
|
||
|---|---|---|---|---|
|
Problem report
|
ProblemReport
|
The ProblemReport entity represents the version of a problem report. In Windchill, the WTChangeIssue and WTChangeIssueMaster classes are used to work with versions of a problem report.
|
||
|
Variance
|
Variance
|
The Variance entity represents the version of a variance. In Windchill, the WTVariance and WTVarianceMaster classes are used to work with versions of a variance.
|
||
|
Change request
|
ChangeRequest
|
The ChangeRequest entity represents the version of a change request. In Windchill, the WTChangeRequest2 and WTChangeRequest2Master classes are used to work with versions of a change request.
|
||
|
Change notice
|
ChangeNotice
|
The ChangeNotice entity represents the version of a change notice. In Windchill, the WTChangeOrder2 and WTChangeOrder2Master classes are used to work with versions of a problem report.
Use the navigation property ImplementationPlan to retrieve implementation plans associated with the change notice.
The estimated start date and actual start date attributes are included in the change notice entity. You can sort (using $orderby) or filter (using $filter) on either of these attributes.
|
||
|
Change task
|
ChangeTask
|
The ChangeTask entity represents a version of the change task.
Change tasks are work instructions that are associated with change notices.
In Windchill, the WTChangeActivity2 and WTChangeActivity2Master classes are used to work with versions of a change task.
|
||
|
Associated process links
|
ProcessLinks
|
The ProcessLinks entity represents process links between a change object and its associated change objects.
A process link contains only the description attribute and provides information about the attribute.
|
||
|
Associated reference links
|
ReferenceLinks
|
The ReferenceLinks entity represents reference links between a change object and its associated change objects.
A reference link contains only the description attribute and provides information about the attribute.
|
||
|
Associated Process Objects
|
ProcessObjects
|
The ProcessObjects entity represents associated change objects with parent and child relationships for the given change object.
|
||
|
Associated reference objects
|
ReferenceObjects
|
The ReferenceObjects entity represents associated reference objects with parent and child relationships for the given change object. These are references to other change objects.
|
||
|
Pending Effectivity
|
PendingEffectivity
|
The PendingEffectivity entity represents the set of pending effectivities that are assigned to resulting objects for the given change task.
|
The following navigation properties are available:
• AffectedLinks—Links between change objects and their affected objects.
• CIAffectLinks—Navigates the links associated with a change issue (Problem Report or Variance). Includes the model and soft attributes in the navigation response. This navigation returns ReportedAgainstLink. From this link you can navigate to affected objects(Changeable Objects).
• CNAffectLinks—Navigates change notices to changeable objects (Affected Objects) through the affected links. Specific "model" and "soft" attributes on the Affected Object link are populated by this navigation. This navigation is also used to navigate changeable.
UnincorporatedLinks navigates unincorporated (hanging link) links associated with a change task.
• CRAffectLinks—Navigates change requests to changeable objects (Affected Objects) through the affects links. Specific "model" and "soft" attributes on the Affected Object link are populated by this navigation. This navigation is also used to navigate changeable.
• AffectedObjects—Affected objects that are associated with the change objects.
• AffectedByLinks—Links between change objects and their affected objects.
• AffectedByObjects—Change objects that have affected the specified object.
• Attachments—Attachments associated with the change objects. You can read, create, update or delete an attachment associated with a change object.
• ResultingObjects—Resulting objects that are associated with change notices either through resulting links or unincorporated links.
• ResultedByObjects—Change task information for the specified resulting objects, resulting links and unincorporated links.
• ResultedByChangeObjects—Navigation from a changeable to the change objects that have resulted from the change.
• ResultingLinks—Resulting links information for the specified change notice.
• ResultingByLinks—Resulting links information for the specified resulting object.
• UnincorporatedByLinks—Unincorporated (hanging change) links information for the specified resulting object.
• ChangeAdministratorI—User details about change administrator I.
|
|
The navigation property type for ChangeAdministratorI on the ChangeNotice, ChangeRequest, ProblemReport, and Variance entity types is changed from Collection(PTC.PrincipalMgmt.User) to Collection(PTC.PrincipalMgmt.Principal).
|
• ChangeAdministratorII—User details about change administrator II.
|
|
The navigation property type for ChangeAdministratorII on the ChangeNotice, ChangeRequest, ProblemReport, and Variance entity types is changed from Collection(PTC.PrincipalMgmt.User) to Collection(PTC.PrincipalMgmt.Principal).
|
• VarianceOwners—User details about variance owner.
• PendingEffectivities—Pending effectivity information of the resulting objects for the specified change tasks.
When you update a Pending Effectivity with the Effectivity Range, the specified effectivity record ranges are updated with the updated range value.
The following navigation properties support multiple objects:
• ProcessLinks—Process links for all the change objects.
|
|
The ProcessLinks navigation property is removed from the ChangeItem entity type; the navigation property is added to the ChangeIssue, ChangeOrder, and GenericChangeRequest entity types.
|
• ProcessObjects—Process objects for all the change objects.
• ReferenceLinks—Reference links for all the change objects.
|
|
The ReferenceLinks navigation property is removed from the ChangeItem entity type; the navigation property is added to the ChangeIssue, ChangeOrder, and GenericChangeRequest entity types.
|
• ReferenceObjects—Reference objects for all the change objects.
Actions
The following are some of the important actions defined for the Change Management domain:
• Reserve—Reserve action is used to reserve a change object before carrying out any update action on it.
• UndoReservation—Unreserve action is used to unreserve a reserved change object.
• Submit—Used to submit a change object which is in an “open” state.
POST /windchill/servlet/odata/ChangeMgmt/ProblemReports('OR:wt.change2.WTChangeIssue:261140')/PTC.ChangeMgmt.Submit
Functions
The following are some of the important functions defined for the Change Management domain:
• IsSubmitted—Used to check whether a particular change issue has been submitted.
GET /windchill/servlet/odata/ChangeMgmt/ProblemReports('OR:wt.change2.WTChangeIssue:261140')/PTC.ChangeMgmt.IsSubmitted
• IsReservedByMe—Used to check if a change object is reserved by the user performing the operation. It will return a value of false if the change object is not reserved by the user. For example:
GET /Windchill/servlet/odata/ChangeIssues('{ChangeIssueId}')/PTC.ChangeMgmt.IsReservedByMe()
Response:
{
"@odata.context": "http://<host>:<port>/Windchill/servlet/odata/v5/ChangeMgmt/$metadata#Edm.Boolean",
"@PTC.AppliedContainerContext.LocalTimeZone": "Asia/Kolkata",
"value": false
}
"@odata.context": "http://<host>:<port>/Windchill/servlet/odata/v5/ChangeMgmt/$metadata#Edm.Boolean",
"@PTC.AppliedContainerContext.LocalTimeZone": "Asia/Kolkata",
"value": false
}