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

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

{{book.title}}
More...

Scheduled Maintenance / Get

  • Article
  • 2 minutes to read

Operation Information

Retrieve details about the requested scheduled maitenance from Freshstatus.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Freshstatus.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Freshstatus in the Type pick list;
  • Give the Freshstatus KeySafe key a Title (this is the name / identifier for the Freshstatus account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Domain string The subdomain value for your Freshstatus account: https://subdomain.freshstatus.io
API Key string Freshstatus Account API Key

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Freshstatus account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Scheduled Maintenance ID id integer The Maintenance ID Yes None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Freshstatus API
Status Code status string The status of the operation: ok / failed
Maintenance ID id integer The ID of the scheduled maintenance record
Maintenance Title title string The maintenance title
Maintenance Desscription description string The description of the selected maintenance
Maintenance Start Time startTime string The time that the maintenance was logged
Maintenance End Time endTime string The time the maintenance was resolved
Is The Maintenance Privacy Enabled isPrivate string The privacy settings of the maintenance
Scheduled Maintenance Source source integer The notification settings of the maintenance
Send Scheduled Maintenance Notifications sendNotifications boolean The notification settings of the scheduled maintenance
Email On Start Of Scheduled Maintenance emailOnStart boolean The email notification settings of the scheduled maintenance
Email On Completion Of Scheduled Maintenance emailOnComplete boolean The email notification settings of the scheduled maintenance
Email The Day Before Scheduled Maintenance emailDayBefore boolean The email notification settings of the scheduled maintenance
Email The Hour Before Scheduled Maintenance emailHourBefore boolean The email notification settings of the scheduled maintenance
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document