How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Description
Invoke this operation get information about the specified running AutoTask instance.
API Details
- Status:
- The required privilege level to invoke this method is
guest
- The supported database role for this method is
none
System Rights | Database Rights | Mail Rights | Calendar Rights |
---|---|---|---|
--- |
--- |
--- |
--- |
Request Parameters
The autoTaskGetState method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.
Name | Type | Attributes | Description |
---|---|---|---|
identifier |
xs:string |
Required | The unique identifier of the spawned AutoTasks. |
returnRuntimeContext |
xs:boolean |
Optional Default= false |
Set this to true if you would like to return the runtime context. |
waitSequence |
xs:unsignedInt |
Optional Default= 0 |
Wait for sequence change for up to 10 seconds. If 0 or not defined then return immediately. |
waitTime |
xs:unsignedInt |
Optional Default= 10 |
The amount of time to wait, in seconds, for a status change. Default is 10 seconds. |
Response Parameters
Name | Type | Attributes | Description |
---|---|---|---|
application |
appNameType |
Required | Name of the application that the AutoTask belongs to |
name |
xs:string |
Required | The name of the AutoTask process |
reference |
xs:anyURI |
Optional | An application defined reference, such as a URN to an entity record or any other application-definable meaningful (to the application spawning the AutoTask) reference. |
processState |
bpmStateType |
Required | The state of the AutoTask process. |
inputParam |
Array<typedInputParameterType> |
Optional | The input parameters for this AutoTask. |
outputParam |
Array<typedOutputParameterType> |
Optional | The output parameters from this AutoTask. |
currentNode |
xs:string |
Optional | The node identifier of the currently executed node. |
failureMessage |
xs:string |
Optional | The error message in the case of AutoTask failure. |
runtimeContext |
xs:string |
Optional | Returns a JSON formatted object that represents the AutoTask runtime variables. |
lastUpdated |
xs:dateTime |
Required | Returns the date/time the AutoTask process was last updated |
waitSequence |
xs:unsignedInt |
Required | You can use this value to call this operation again to wait for status changes |
waitTimeout |
xs:boolean |
Required | The wait timeout |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document