new ArchActionUpdateWorkitem(coreUpdateWorkitemActionViewModel)
The Architect Scripting class that represents the Update Workitem action.
Instances of this action should be created by calling ArchFactoryActions#addActionUpdateWorkitem
Parameters:
| Name | Type | Description |
|---|---|---|
coreUpdateWorkitemActionViewModel |
Object | ( Internal ) an Architect core Update Workitem action view model. |
Extends
Members
-
readonly displayTypeName :string
-
Returns the display type name string 'ArchActionUpdateWorkitem'.
-
readonly isArchActionUpdateWorkitem :boolean
-
Returns true indicating that this is an ArchActionUpdateWorkitem instance.
-
readonly outputSuccess :ArchActionOutput
-
The success output for this action
- Inherited From:
-
readonly statements :Array.<ArchBaseVariableValuePair>
-
Returns an array of update statements currently configured on this update workitem action. If there are no update statements configured, an empty array will be returned.
-
readonly updateWorkitemOutputsFailure :ArchNamedValueList
-
The contents of this named value list come from the Failure Outputs schema. It will contain two values: errorType and errorMessage. These values will be returned by the server if the action takes the Failure path. If no error is present, this will return null.
Methods
-
addUpdateWorkitemStatement(archDataType, variableToAssignTo, valueExpressionToAssignopt) → {ArchBaseVariableValuePair}
-
This adds an update data statement to an update data action.
Parameters:
Name Type Attributes Description archDataTypeArchDataType the data type for this update statement. The data type must be script creatable.
variableToAssignTostring | ArchBaseVariable the variable to which the value should be assigned.
valueExpressionToAssignstring <optional>
the expression text for the value to assign in the update statement.
Returns:
ArchBaseVariableValuePair