ChangeOrderService Class
Autodesk.Connectivity.WebServices›Autodesk.Connectivity.WebServices
Contains methods for creating and manipulating change orders.
Syntax
public sealed class ChangeOrderService : ChangeOrderServiceBase, IWebService Public NotInheritable Class ChangeOrderService
Inherits ChangeOrderServiceBase
Implements IWebService Properties
| Name | Description |
|---|---|
| AddChangeOrderEvents | A collection of Web Service Command Events for add Change Order operations. |
| AllowInvokeEvents | Tells if invoke events should fire. This value is true by default. |
| ClientCertificate | Client certificate for making web service calls over an SSL connection. |
| CommitChangeOrderEvents | A collection of Web Service Command Events for commit Change Order operations. |
| CurrentlySetSession | This is information about the current session of the signed-in user. |
| DeleteChangeOrderEvents | A collection of Web Service Command Events for delete Change Order operations. |
| EditChangeOrderEvents | A collection of Web Service Command Events for edit Change Order operations. |
| QueryString | The query string. |
| RedirectedTo | Contains the ADMS that handled the replication redirect (if applicable). |
| Session | This is information about the session of the signed-in user. |
| UpdateChangeOrderLifecycleStateEvents | A collection of Web Service Command Events for Change Order lifecycle change operations. |
| WebServiceManager | A reference to the WebServiceManager that created this object. Value may be null. |
Methods
| Name | Description |
|---|---|
| AddChangeOrder | Create a new change order. |
| AddComment | Adds comments or replies to a change order |
| AddMarkup | Adds a markup to the specified Change Order. This function can also include additional file attachments, deleted file attachments and any comments added as part of the markup. |
| AddRouting | Adds a new Routing. |
| CancelChangeOrderActivity | Cancel a change order that has not been completed. |
| CheckMessageEmailEnabled | Gets the setting indicating if email events are enabled. |
| CheckRolePermissions | Check if the current logged in user has permission to execute specific web service APIs |
| CommitChangeOrderActivity | Finish a change order activity. |
| CommitChangeOrderCloseActivity | Finish a Change Order activity. To be used when closing a Change Order. |
| DeleteChangeOrder | Deletes a Change Order |
| DeleteChangeOrders | Deletes a set of change orders. |
| DeleteChangeOrdersUnconditional | Deletes a set of Change Orders, regardless of its state. |
| DeleteRouting | Deletes a Routing. |
| EditChangeOrder | Reserves the Change Order to the current user so that it can be edited. |
| FindChangeOrdersBySearchConditions | Find change orders based on a set of property search conditions. |
| GetActivityHistoryByChangeOrderId | Retrieves a list of all activities that have occurred for a Change Order. |
| GetAllActiveWorkflows | Gets all of the active Workflows. |
| GetAllChangeOrderParticipants | Gets all Users that can participate in Change Order activities. |
| GetAssociationsByChangeOrderIDs | Gets the Entities associated with a Change Order. |
| GetChangeOrderAssociationProperties | Gets the properties for a Change Order association. |
| GetChangeOrderByNumber | Retrieves a Change Order object when given a Change Order number. |
| GetChangeOrderFilesByFileMasterId | Gets the Change Orders which are driving a given file. |
| GetChangeOrderGroupByChangeOrderId | Retrieves a Change Order and its associations. |
| GetChangeOrderItemsByItemMasterId | Retrieves a list of Change Orders associated with an Item. |
| GetChangeOrderLiteWorklistForCurrentUser | Gets the worklist for the current user. |
| GetChangeOrderMarkupFolderConfiguration | Gets the configuration of the Change Order markup folder. |
| GetChangeOrderMarkupFolderId | Gets the ID of the Folder which stores markup data. |
| GetChangeOrderNumberBySchemeId | Creates a unique Change Order number based on a numbering scheme. |
| GetChangeOrdersByIds | Gets a set of change order objects by their IDs. |
| GetChangeOrderWorklistForCurrentUser | Retrieve a list of all change orders with an Activity that the logged in user can perform. |
| GetDefaultEmailTemplate | Get a system generated default email template for Change order notifications. |
| GetDefaultWorkflow | Gets the default Workflow. |
| GetDisallowedItemLifeCycleStatesForSubmitActivities | Gets the IDs of the lifecycle states that are configured to prevent change orders from moving out of work state |
| GetDisallowedLifeCycleStatesForSubmitActivitiesEnabled | Gets the value for the Change Order Vault Setting "Restrict Change Orders from moving out of Work state based on File and Item Lifecycle states" |
| GetEmailMessageByChangeOrderId | Gets Email Message object for a given change order ID. |
| GetEmailTemplate | Gets the customized email template for Change order notifications. |
| GetJobTypesByChangeOrderStateTransitionIds | Gets the custom jobs that get fired for a set of transitions. |
| GetLifecycleRollbackTargetFiles | Gets the the file for rolling back the specified files Lifecycle states within the context of a Change Order |
| GetLifecycleRollbackTargetItem | Gets the target item for rolling back an item's lifecycle state from within the context of a change order. |
| GetRoutingMembersByChangeOrderId | Retrieves Routing Members object for a given change order ID. |
| GetRoutingMembersByRoutingId | Retrieves Routing Members object for a given Routing ID. |
| GetRoutingRoleDefinitionsByWorkflowId | Gets the Routing Role Definitions for a given Workflow. |
| GetRoutingsByWorkflowId | Gets the Routings for a given Workflow. |
| GetUnreleasedChildMasterIDsByItemMasterIDs | Returns a list of child Item Master IDs which are the unreleased children of the specified Items with respect to the specified Change Order. |
| GetWorkflowInfo | Gets extended information about a Workflow. |
| IsUserAllowedInRole | Tells if there is at least one Requestor or Responsible Engineer with permissions to change item lifecycle states. |
| ItemRollbackLifeCycleState | Execute an item rollback to the specified target item iteration ID in rolling back the Item's Lifecycle state from within the context of a change order. |
| RollbackToTargetFiles | Executes a file rollback to the specified target files "MaxCkInVerNum" in rolling back Files Lifecycle states within the context of a Change Order. |
| SaveEmailTemplate | Save customized email template for Change order notifications. |
| SetChangeOrderMarkupFolderConfiguration | Sets the configuration of the Change Order markup folder. |
| SetChangeOrderMarkupFolderId | Sets the Change Order markup folder. |
| SetDefaultRouting | Sets the default Routing. |
| SetDefaultWorkflow | Sets the default Workflow. |
| SetDisallowedItemLifeCycleStatesForSubmitActivities | Sets which lifecycle states for items and file will restrict a change order from moving out of a work state when the restrict setting is enabled |
| SetDisallowedLifeCycleStatesForSubmitActivitiesEnabled | Sets the enabled value for the Change Order Vault setting "Restrict Change Orders from moving out of Work state based on File and Item lifecycle states" |
| StartChangeOrderActivity | Start a change order activity. |
| UndoEditChangeOrder | Cancels the edits for a Change Order. |
| UpdateChangeOrder | Updates a Change Order. |
| UpdateChangeOrderProperties | Update the property values on a Change Order. |
| UpdateChangeOrderRoutingMembers | Updates the users and roles for a Change Order Routing. |
| UpdateChangeOrderStateTransitionJobTypes | Updates the custom jobs fired for a lifecycle state transition. |
| UpdateFileLifeCycleDefinitions | Updates file lifecycle definitions from within the context of a change order |
| UpdateFileLifeCycleStates | Updates file lifecycle states from within the context of a change order |
| UpdateItemLifeCycleDefinitions | Updates item lifecycle definitions from within the context of a change order |
| UpdateItemLifeCycleStates | Sets the life cycle state for a set of Items. |
| UpdateRouting | Updates a Routing object. |
| UpdateRoutingMembers | Alters the users and roles for a Change Order Routing. |
Returned By
Where you get a ChangeOrderService — members that return one.
Inheritance Hierarchy
- System.Object
- Autodesk.Connectivity.WebServices.ServiceBase
- Autodesk.Connectivity.WebServices.ServiceBase<T>
- Autodesk.Connectivity.WebServices.ChangeOrderServiceBase
- Autodesk.Connectivity.WebServices.ChangeOrderService