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 to execute an autoTask process.
API Details
- Status:
- The required privilege level to invoke this method is
user
- The supported database role for this method is
none
System Rights | Database Rights | Mail Rights | Calendar Rights |
---|---|---|---|
sys.a.canSpawnProcess |
--- |
--- |
--- |
Request Parameters
The autoTaskRun method takes the following input parameters.
Note
When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.
Name | Type | Attributes | Description |
---|---|---|---|
application |
appNameType |
Optional | Specify the name of the application this autoTask relates to. If not specified then “system” is assumed. |
name |
xs:string |
Required | The name of the autoTasl to run. |
reference |
xs:anyURI |
Optional | An application defined reference, such as a URN to an entity or any other application-definable meaningful (to the application running the autoTask) reference. |
inputParam |
Array<inputParameterType> |
Optional | The input parameters of the autoTask. |
Response Parameters
Name | Type | Attributes | Description |
---|---|---|---|
autoTaskId |
xs:string |
Required | The unique identifier of the autoTask. |
version |
xs:unsignedInt |
Required | The version of the autoTask that was spawned. |
state |
bpmStateType |
Required | This can be InProgress, Succeeded or Failed. |
failureMessage |
xs:string |
Optional | The error message in the case of an autoTask runtime failure. |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document