Innovator .NET API Reference
Namespaces
Aras.IOM
Item Class
Item Methods
addRelationship Method
appendItem Method
apply Method
applyStylesheet Method
attachPhysicalFile Method
attachPhysicalFileViaStream Method
cancelWorkflow Method
checkout Method
clone Method
closeWorkflow Method
createPropertyItem Method
createRelatedItem Method
createRelationship Method
email Method
fetchDefaultPropertyValues Method
fetchFileProperty Method
fetchFilePropertyWithStream Method
fetchLockStatus Method
fetchRelationships Method
getAction Method
getAttribute Method
getErrorCode Method
getErrorDetail Method
getErrorSource Method
getErrorString Method
getErrorWho Method
getFileName Method
getID Method
getInnovator Method
getItemByIndex Method
getItemCount Method
getItemsByXPath Method
getLockStatus Method
getLogicalChildren Method
getLogicalItems Method
getNewID Method
getParentItem Method
getProperty Method
getPropertyAttribute Method
getPropertyCondition Method
getPropertyItem Method
getRelatedItem Method
getRelatedItemID Method
getRelationships Method
getResult Method
getType Method
instantiateWorkflow Method
isCollection Method
isEmpty Method
isError Method
isLocked Method
isLogical Method
isNew Method
isRoot Method
loadAML Method
lockItem Method
newAND Method
newInnovator Method
newItem Method
newNOT Method
newOR Method
newXMLDocument Method
promote Method
removeAttribute Method
removeItem Method
removeLogical Method
removeProperty Method
removePropertyAttribute Method
removeRelationship Method
setAction Method
setAttribute Method
setErrorCode Method
setErrorDetail Method
setErrorSource Method
setErrorString Method
setErrorWho Method
setFileName Method
setFileProperty Method
setFilePropertyViaStream Method
setID Method
setNewID Method
setProperty Method
setPropertyAttribute Method
setPropertyCondition Method
setPropertyItem Method
setRelatedItem Method
setType Method
startWorkflow Method
ToString Method
unlockItem Method
Click or drag to resize

IteminstantiateWorkflow Method

Instantiates workflow for the item using specified workflow map.

Namespace:  Aras.IOM
Assembly:  IOM (in IOM.dll) Version: 14.0.20.39432
Syntax
Copy
public Item instantiateWorkflow(
	string workflowMapID
)

Parameters

workflowMapID
Type: SystemString
ID of a WorkflowMap.

Return Value

Type: Item
Returns a Workflow Process item created by this method or an "error" item.
Exceptions
ExceptionCondition
Exception
  • The instance doesn't represent a single item.
  • Either 'id' or 'typeId' is not set on the item.
  • The item is a new item not saved in the database yet.
ArgumentExceptionWorkflowMap ID is either 'null' or empty string.
Remarks
The method does the following: a) sends a request to the server to instantiate the specified Workflow Map to a Workflow Process b) using ID of the WorkflowProcess item obtained from the server, sends another request to attach the Workflow Process to the controlled item via the "Workflow" relationship. Note, that the item itself is not modified by the method.
See Also