ItemService Class
Autodesk.Connectivity.WebServices›Autodesk.Connectivity.WebServices
Contains methods for manipulating items.
Syntax
public sealed class ItemService : ItemServiceBase, IWebService Public NotInheritable Class ItemService
Inherits ItemServiceBase
Implements IWebService Properties
| Name | Description |
|---|---|
| AddItemEvents | A collection of Web Service Command Events for add Item 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. |
| CommitItemEvents | A collection of Web Service Command Events for commit Item operations. |
| CurrentlySetSession | This is information about the current session of the signed-in user. |
| DeleteItemEvents | A collection of Web Service Command Events for delete Item operations. |
| EditItemEvents | A collection of Web Service Command Events for edit Item operations. |
| ItemRollbackLifeCycleStatesEvents | A collection of Web Service Command Events for item rollback operations. |
| PromoteItemEvents | A collection of Web Service Command Events for promote Item 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. |
| UpdateItemLifecycleStateEvents | A collection of Web Service Command Events for change Item lifecycle state operations. |
| WebServiceManager | A reference to the WebServiceManager that created this object. Value may be null. |
Methods
| Name | Description |
|---|---|
| AddComponentsToPromote | Assign item for specific BOM components |
| AddFilesToPromote | Assign item for specific files |
| AddItemNumbers | Creates new item numbers. |
| AddItemRevision | Creates a new Item. |
| AddItemRevisionWithScheme | |
| AddUnitOfMeasure | Creates a Unit of Measure object. |
| AssignComponentToItem | Assign a component to an item revision |
| AssignFileToItem | Assign a file to an item revision |
| CheckRolePermissions | Check if the current logged in user has permission to execute specific web service APIs |
| CommitItemNumbers | Commits the specified Item Number changes to Items |
| CompareItemBOMs | Compare the BOMs of two Versions of an Item. |
| DeleteItems | Deletes a set of items. All associated revisions and versions are also deleted. |
| DeleteItemsUnconditional | Deletes a set of Items regardless of server restrictions. |
| DeleteItemVersionsByMasterItemId | Deletes/purges the item iteration history of the specified item |
| DeleteItemVersionsByMasterItemIds | Deletes/Purges the item iteration history of the specified items |
| DeleteUncommittedItems | Deletes all the uncommitted items for this user. |
| DeleteUnitOfMeasure | Deletes a unit of measure. |
| DeleteUnusedItemNumbers | Deletes unused item numbers for a set of item master IDs. |
| EditItems | Creates new, editable Items used to modify the existing revision. |
| FindItemRevisionsBySearchConditions | Gets a set of Item revisions based on a property search. |
| FindLatestItemRevisionIdsByComponentIds | Finds the latest revision ids of items based on component ids |
| GetAllBaseUnitsOfMeasure | Returns all Units of Measure which are not derived from another Unit of Measure. |
| GetAllUnitsOfMeasure | Gets all Units of Measure. |
| GetAllWatermarks | Gets all Watermark objects. |
| GetAttachmentsByItemIds | Gets the File attachments for a set of Items. |
| GetComponentProperties | Retrieves the list of writeback properties and their associated values for the specified item and Content Source |
| GetContentSourcePropertyDefinitionsByFileMasterId | Gets the property definitions from the file's BOM data. |
| GetEnablementConfiguration | Gets the setting that controls if Items and Change Orders are enabled. |
| GetEnableWatermarking | Tells if the watermark feature has been enabled. |
| GetItemAssignmentBehavior | Retrieve the default item assignment behavior from the server |
| GetItemAssignmentRestrictions | Gets the current Item Assign Restrictions Options |
| GetItemAutogroupBehavior | Gets the value of the administrator option for controlling BOM autogroup behavior |
| GetItemAutounlinkEnabled | Gets the current setting for enable/disable Automatically Breaking Links during Assign Item when the Equivalence value of the Component no longer matches that of the actual assigned Item |
| GetItemBOMAssociationProperties | Gets values for properties on BOM associations. |
| GetItemBOMAssociationsByItemIds | Gets child Item links. |
| GetItemBOMByItemIdAndDate | Gets the Item BOM for a given Item by its effective date. |
| GetItemBOMFileAssociationsByDate | Gets Files associated with an Item BOM. |
| GetItemByItemNumberAndRevisionNumber | Gets an Item object based on the item number and revision number. |
| GetItemDeleteRestrictionsByIds | Gets the restrictions for deleting a set of Items. |
| GetItemFileAssociationsByItemIds | Gets all File associations on a given Item. Does not include attachments. |
| GetItemHistoryByItemMasterId | Gets the item history for the specific item master based on history type |
| GetItemsByAttachmentFileId | Gets the items that a file is attached to. Only finds items if the file is attached to the tip revision. |
| GetItemsByFileId | Gets all of the Items assigned to a File. |
| GetItemsByFileIdAndLinkTypeOptions | Gets a set of Items that are associated in specific ways to a given File. |
| GetItemsByIds | Gets a set of Items based on their IDs |
| GetItemsByRevisionIds | Gets a set of Item objects based on a set of Item revision IDs. |
| GetLatestItemByItemMasterId | Gets the latest version of an Item. |
| GetLatestItemByItemNumber | Gets the latest Revision for an Item. |
| GetLatestItemsByItemMasterIds | Gets the latest versions for a set of Item Master IDs. |
| GetLifecycleRollbackTargetItem | Gets the target item for rolling back an item's lifecycle state |
| GetPrimaryComponentsByItemIds | Gets the BOMComponents that form the primary link between the specified items and the components’ files. |
| GetPromoteComponentOrder | Gets the order that components should be promoted. |
| GetPromoteComponentsResults | Gets the resulting Item objects generated from PromoteComponent calls. |
| GetPropertyConstraintFailuresByItemMasterIds | Gets all properties that violate a constraint for a given Item. |
| GetReferenceDesignatorProperties | Gets the properties for a set of Reference Designators |
| GetRestrictLifeCycleStateChangeToChangeOrder | Gets the value indicating if all life cycle changes must occur within the context of a Change Order. |
| GetSubComponentLinkTypeForAssignItem | Gets the value for the vault setting controlling the type of link to be created for subcomponents during assign/update item |
| GetUnitOfMeasureById | Gets a Unit of Measure object. |
| GetUnitOfMeasureFamilyByUnitOfMeasureId | Gets all Units of Measure that share a common base. |
| GetWatermarkByItemIdAndFileId | Gets the watermark for an item and file. |
| ItemRollbackLifeCycleState | Executes an item rollback to the specified target item iteration |
| PromoteComponentLinks | Creates secondary links without creating a new item iteration for BOM components |
| PromoteComponents | Creates items on a component-by-component basis. |
| ReassignComponentsToDifferentItems | Assigns a Component to a different Item. |
| SetEnablementConfiguration | Sets the setting that controls if Items and Change Orders are enabled |
| SetEnableWatermarking | Turns the watermark feature on or off. |
| SetItemAssignmentBehavior | Sets the server's default item assignment behavior (Admin setting for items) |
| SetItemAssignmentRestrictions | Sets the current Item Assign Restrictions Options |
| SetItemAutogroupBehavior | Sets the value of the administrator option for BOM autogrouping behavior |
| SetItemAutounlinkEnabled | Sets the current setting to enable/disable Automatically Breaking Links during Assign Item when the Equivalence value of the Component no longer matches that of the actual assigned Item |
| SetRestrictLifeCycleStateChangeToChangeOrder | Sets a value indicating if all life cycle changes must occur within the context of a Change Order. |
| SetSubComponentLinkTypeForAssignItem | Sets the vlaue for the vault setting controlling which type of links are created for subcomponents during an assign/update item |
| UndoEditItems | Removes changes to an uncommitted Item. |
| UpdateAndCommitItems | Commits the changes to a set of Items. |
| UpdateAttachments | Updates the attachments associated with the specified Item Revision |
| UpdateItemBOMAssociationProperties | Update the property values on an BOM association. |
| UpdateItemBOMAssociations | Updates the associations for an Item's BOM. |
| UpdateItemCategories | update the category assigned to items |
| UpdateItemFileAssociations | Updates which files are associated with the specified Item Revision |
| UpdateItemLifeCycleDefinitions | updates the item life cycle definitions assigned to items |
| UpdateItemLifeCycleStates | updates the life cycle state of an item |
| UpdateItemProperties | Updates the property values for a set of Items and commits the changes. |
| UpdateItemPropertyDefinitions | Updates the property definitions associated with a set of Items. |
| UpdateItemRevisionNumbers | Updates the revision numbers for a set of items. |
| UpdatePromoteComponents | Begins an "update items from files" operation on a component-by-component basis. |
| UpdateRevisionDefinitionAndNumbers | Updates the revision number and switches to a new revision definition for a set of items. |
| UpdateUnitOfMeasure | Updates the data for a Unit of Measure. |
| UpdateWatermarkDefinitions | Updates a set of Watermarks. |
Returned By
Where you get a ItemService — members that return one.
Inheritance Hierarchy
- System.Object
- Autodesk.Connectivity.WebServices.ServiceBase
- Autodesk.Connectivity.WebServices.ServiceBase<T>
- Autodesk.Connectivity.WebServices.ItemServiceBase
- Autodesk.Connectivity.WebServices.ItemService