Documentation

{{docApp.title}}

{{docApp.description}}

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!

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Status - Get Service Status

Operation Information

Retrieves the status of a specified service.

Extra Credentials

This operation requires an extra credential to be provided, stored in KeySafe, to the following specification

  • Credential Reference: credential1
  • Credential Keysafe Key Type: API Key

Input Parameters

Name Type Description Required Sensitive
HostName string Host Name Yes No
ServiceName string Service Name Yes No

Output Parameters

Name Type Description Required Sensitive
outcome string Outcome of the operation. Can be OK or FAIL Yes No
errors string Any errors returned by the operation No No
statusUpdateTime string Status Update Time No No
statusText string Status Text No No
currentState string Current State No No
lastStateChange string Last State Change No No
In This Document