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 / runbookGetState

  • Article
  • 2 minutes to read

Description

Invoke this operation get information about the specified runbook instance.

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
--- --- --- ---

Request Parameters

The runbookGetState 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
runbookId xs:string Required The unique identifier of the spawned runbook process.
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		 Provide the last value returned in the waitSequence response parameter to wait for a status change
waitTime xs:unsignedInt Optional
Default=10		 The amount of time to wait (in seconds) for a staus change. Default is 10

Response Parameters

Name Type Attributes Description
name xs:string Required The name of the runbooks 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 initiating the runbook) reference.
processState bpmStateType Required The state of the runbook process.
currentNode xs:string Optional The node identifier of the currently executed node in the runbook.
failureMessage xs:string Optional The error message in the case of process failure.
inputParam Array<inputParameterType> Optional The input parameters for the runbook.
outputParam Array<outputParameterType> Optional The output parameters from this runbook.
runtimeContext xs:string Optional Returns a JSON formatted object that represents the BPM runtime variables.
lastUpdated xs:dateTime Required Returns the date/time the 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