Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

/ automation / runbookRun

  • Article
  • 1 minutes to read

Description

Invoke this operation to execute a runbook 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 runbookRun 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
name xs:string Required The name of the orchestration to spawn.
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 orchestration) reference.
inputParam Array<inputParameterType> Optional The input parameters for the runbook.

Response Parameters

Name Type Attributes Description
runbookId xs:string Required The unique identifier of the running runbook instance.
version xs:unsignedInt Required The version of the runbook that was executed.
state bpmStateType Required This can be InProgress, Succeeded or Failed.
failureMessage xs:string Optional The error message in the case of a runbook runtime failure.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document