UpdateChangeOrder Method
Updates a Change Order.
Required Permissions
ChangeOrderEditSyntax
public override ChangeOrder UpdateChangeOrder(
System.long changeOrderId,
System.string changeOrderNumber,
System.string title,
System.string description,
System.DateTime approveDeadline,
System.long[] addItemMasterIds,
System.long[] delItemMasterIds,
System.long[] addAttmtMasterIds,
System.long[] delAttmtMasterIds,
System.long[] addFileMasterIds,
System.long[] delFileMasterIds,
PropInst[] addProperties,
System.long[] delPropDefIds,
MsgGroup[] addComments,
Email[] notifyEmails,
AssocPropItem[] addAssocProperties,
System.long[] delAssocPropIds,
System.long routingId,
RoutingUserRoles[] addMembers,
RoutingUserRoles[] delMembers
)Public Overrides NotOverridable Function UpdateChangeOrder( _
ByVal changeOrderId As System.Long, _
ByVal changeOrderNumber As System.String, _
ByVal title As System.String, _
ByVal description As System.String, _
ByVal approveDeadline As System.Date, _
ByVal addItemMasterIds() As System.Long, _
ByVal delItemMasterIds() As System.Long, _
ByVal addAttmtMasterIds() As System.Long, _
ByVal delAttmtMasterIds() As System.Long, _
ByVal addFileMasterIds() As System.Long, _
ByVal delFileMasterIds() As System.Long, _
ByVal addProperties() As PropInst, _
ByVal delPropDefIds() As System.Long, _
ByVal addComments() As MsgGroup, _
ByVal notifyEmails() As Email, _
ByVal addAssocProperties() As AssocPropItem, _
ByVal delAssocPropIds() As System.Long, _
ByVal routingId As System.Long, _
ByVal addMembers() As RoutingUserRoles, _
ByVal delMembers() As RoutingUserRoles _
) As ChangeOrderParameters
| Name | Description |
|---|---|
| changeOrderId | The ID of the Change Order object to update. |
| changeOrderNumber | The new change order number. Pass in null to continue using the existing number. |
| title | The title of the Change Order. |
| description | The descrition of the Change Order. |
| approveDeadline | The date and time the Change Order needs to be approved by. |
| addItemMasterIds | A list of additional Items to associate with the Change Order. Set this to null if there are no new associations. |
| delItemMasterIds | A list of Items to disassociate with the Change Order. Set this to null if no assocaitions need to be deleted. |
| addAttmtMasterIds | A list of additional Files to attach with the Change Order. Set this to null if there are no new attachments. |
| delAttmtMasterIds | A list of File attachments to disassociate with the Change Order. Set this to null if no attachments need to be deleted. |
| addFileMasterIds | A list of additional Files to be tracked by the Change Order. Set this to null if there are no new associations. |
| delFileMasterIds | A list of Files to no longer be tracked by the Change Order. Set this to null if no assocaitions need to be deleted. |
| addProperties | A list of additional property instances to associate with the Change Order. Set this to null if there are no new properties or values. |
| delPropDefIds | A list of Property Definitions to disassociate with the Change Order. Set this to null if no assocaitions need to be deleted. |
| addComments | An array of comments to add to the Change Order. |
| notifyEmails | An array of emails to send out upon completion. |
| addAssocProperties | Properties to add to the Change Order. The 'From ID' is the Change Order ID and the 'To ID' is the Item or File ID. |
| delAssocPropIds | The IDs of properties to delete from the Change Order. |
| routingId | The ID of the Routing that is associated with the Change Order. Pass in -1 to keep the same Routing. Note: This association is for meta-data reasons only. Changing this value alone does not update the users or roles for this Change Order. |
| addMembers | Members to add to the Routing for this Change Order. |
| delMembers | Members to delete from the Routing for this Change Order. |
Return Value
The updated Change Order object.
Remarks
Only Change Orders in an editable state can be updated. Call EditChangeOrder to create an editable Change Order object.