Click or drag to resize

Itempromote Method

Promote item to the specified state.

Namespace:  Aras.IOM
Assembly:  IOM (in IOM.dll) Version: 14.0.20.39432
Syntax
public Item promote(
	string state,
	string comments
)

Parameters

state
Type: SystemString
State to promote.
comments
Type: SystemString
If ItemType of the item is configured to log "history" records when items of the ItemType are created\promoted\etc., (i.e. if the ItemType's property "save_history" is set to "1") then the comments will be used as a comment for the "history" record about the promote event.

Return Value

Type: Item
"Result" item with inner text "Ok" in case of success. Otherwise "error" item (if promote failed).
Exceptions
ExceptionCondition
ExceptionThe instance doesn't represent a single item.
ArgumentExceptionArgument 'state' is either 'null' or an empty string.
Remarks
The method sends a request to the server to promote item and returns the response. Note that this item is not modified by the method.
See Also