@datafire/signl4
v3.0.0
Published
DataFire integration for SIGNL4
Downloads
6
Readme
@datafire/signl4
Client library for SIGNL4
Installation and Usage
npm install --save @datafire/signl4
let signl4 = require('@datafire/signl4').create();
.then(data => {
console.log(data);
});
Description
With our API, you can easily access many SIGNL4 functions via HTTP requests. It is based on REST and fulfills a similar purpose for which SDKs were used very often in the past. Example usage scenarios are the integration in third party systems for triggering alarms to your team or on-call duty based on shift planning systems. The API is always used in the context of your SIGNL4 team, i. e. you must log in with your SIGNL4 account and give your API client the authorization to access your team programmatically on your behalf (constent grant). At the moment there are several certified API clients, e.g. Microsoft Flow or Amazon Alexa. Registration of your personal API client is currently possible on request. Don't hesitate to contact us and you'll get your client_id and client_secret required for accessing the SIGNL4 API after user login and consent grant. Authentication is based on OpenID Connect and the Authorization Code Flow. The base URL of the API is https://connect.signl4.com/api/. Copyright © Derdack GmbH
Actions
AcceptSubscriptionAdoption
Accept an existing subscription adoption.
signl4.AcceptSubscriptionAdoption({
"acceptCode": ""
}, context)
Input
- input
object
- acceptCode required
string
- acceptCode required
Output
- output SubscriptionInfo
RaiseAlert
Triggers a new alert for your team. All team members on duty will receive alert notifications.
signl4.RaiseAlert({}, context)
Input
- input
object
- alertInfo RaiseAlertInfo
Output
- output AlertInfo
AcknowledgeAll
This method confirms all unhandled alerts your team currently has.
signl4.AcknowledgeAll({}, context)
Input
- input
object
- filterInfo ChangeAlertStatusFilterInfo
Output
Output schema unknown
AcknowledgeMultiple
This method confirms all alerts provided.
signl4.AcknowledgeMultiple({}, context)
Input
- input
object
- acknowledgeInfo ChangeAlertStatusMultipleInfo
Output
Output schema unknown
CloseAll
This method closes all acknowledged alerts your team currently has.
signl4.CloseAll({}, context)
Input
- input
object
- filterInfo ChangeAlertStatusFilterInfo
Output
Output schema unknown
CloseMultiple
This method closes all alerts provided.
signl4.CloseMultiple({}, context)
Input
- input
object
- statusChangeInfo ChangeAlertStatusMultipleInfo
Output
Output schema unknown
GetAlertsPaged
Gets alerts paged
signl4.GetAlertsPaged({}, context)
Input
- input
object
- maxResults
integer
: Defines the limit of retrieved alert details per request. 1 to 100 are allowed per request. - filter AlertFilterPublic
- maxResults
Output
GetAlertReport
Returns information about the occurred alert volume in different time periods as well as information about the response behaviour (amount of confirmed and unhandled alerts) of your team members.
signl4.GetAlertReport(null, context)
Input
This action has no parameters
Output
- output AlertReport
GetAlert
Gets an alert by id.
signl4.GetAlert({
"alertId": ""
}, context)
Input
- input
object
- alertId required
string
: Id of the requested Alert.
- alertId required
Output
- output AlertInfo
AnnotateAlert
Annotates an alert by given Annotation Info.
signl4.AnnotateAlert({
"alertId": ""
}, context)
Input
- input
object
- alertId required
string
: Id of the alert to annotate. - annotationInfo AlertAnnotationInfo
- alertId required
Output
- output AlertAnnotationInfo
GetAlertAnnotations
Get annotations of an alert by id.
signl4.GetAlertAnnotations({
"alertId": ""
}, context)
Input
- input
object
- alertId required
string
: Id of the requested Alert.
- alertId required
Output
- output
array
- items AlertAnnotationInfo
GetAlertAttachmentsInfo
Get attachments of an alert by id.
signl4.GetAlertAttachmentsInfo({
"alertId": ""
}, context)
Input
- input
object
- alertId required
string
: Id of the requested Alert.
- alertId required
Output
- output
array
- items AlertAttachmentInfo
GetAttachment
Gets a specified attachment of a specified alert.
signl4.GetAttachment({
"alertId": "",
"attachmentId": ""
}, context)
Input
- input
object
- alertId required
string
: Id of the alert that contains the wanted attachment. - attachmentId required
string
: Id of the attachment, that you want to retrieve. - width
integer
: Optional parameter defining the wanted width of the picture that is retrieved. - height
integer
: Optional parameter defining the wanted height of the picture that is retrieved. - scale
boolean
: Optional parameter defining whether it's wanted to scale the retrieved image. Default is set to
- alertId required
Output
- output FileContentResult
GetAlertNotifications
Get notifications of all users by alert id.
signl4.GetAlertNotifications({
"alertId": ""
}, context)
Input
- input
object
- alertId required
string
: Id of the requested Alert.
- alertId required
Output
- output
array
- items AlertNotificationInfo
GetOverviewAlert
Get overview alert by id.
signl4.GetOverviewAlert({
"alertId": ""
}, context)
Input
- input
object
- alertId required
string
: Id of the requested Alert.
- alertId required
Output
- output OverviewAlert
GetAvailableCountries
Gets supported countries.
signl4.GetAvailableCountries(null, context)
Input
This action has no parameters
Output
- output
array
- items
string
- items
GetPreferredCurrency
Gets supported countries.
signl4.GetPreferredCurrency({}, context)
Input
- input
object
- countryCode
string
- countryCode
Output
- output
string
CreateBranch
Creates a branch with the user's subscription.
signl4.CreateBranch(null, context)
Input
This action has no parameters
Output
- output BranchInfo
AcceptManagerInvite
Accepts a pending manager invite
signl4.AcceptManagerInvite({
"inviteAcceptCode": ""
}, context)
Input
- input
object
- inviteAcceptCode required
string
- inviteAcceptCode required
Output
- output BranchManagerInformation
GetBranch
Returns information of the branch with the specified Id.
signl4.GetBranch({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
: Id of the branch thats needed to be retrieved.
- branchId required
Output
- output BranchInfo
DeleteSubscriptionAdoption
Deletes an existing subscription adoption in the user's branch.
signl4.DeleteSubscriptionAdoption({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
- adoptionInfo SubscriptionAdoptionInfo
- branchId required
Output
Output schema unknown
AdoptSubscriptionForBranch
Adopts an existing subscription in the user's branch.
signl4.AdoptSubscriptionForBranch({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
- adoptionInfo SubscriptionAdoptionInfo
- branchId required
Output
- output SubscriptionInfo
GetBranchFeatures
Returns the features of a specified branch.
signl4.GetBranchFeatures({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
: Id of the branch from which the features need to be retrieved.
- branchId required
Output
- output
array
- items SubscriptionFeature
GetBranchManagers
Gets the managers of a branch
signl4.GetBranchManagers({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
: ID of the branch to get the managers for
- branchId required
Output
- output
array
- items BranchManagerInformation
InviteBranchManager
Gets the managers of a branch
signl4.InviteBranchManager({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
- inviteInfos BranchManagerInviteInfos
- branchId required
Output
- output BranchManagerInformation
DeleteBranchManager
Deletes a specific manager of the branch
signl4.DeleteBranchManager({
"branchId": "",
"managerId": ""
}, context)
Input
- input
object
- branchId required
string
- managerId required
string
- branchId required
Output
Output schema unknown
GetBranchSubscriptions
Returns subscription information of the branch with the specified Id.
signl4.GetBranchSubscriptions({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
: ID of the branch the subscriptions will be retrieved for.
- branchId required
Output
- output
array
- items SubscriptionInfo
CreateBranchSubscription
Creates a new subscription in the user's branch.
signl4.CreateBranchSubscription({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
- creationInfo SubscriptionCreationInfo
- branchId required
Output
- output SubscriptionInfo
RemoveSubscriptionFromBranch
Removes a subscription from the user's branch.
signl4.RemoveSubscriptionFromBranch({
"branchId": "",
"subscriptionId": ""
}, context)
Input
- input
object
- branchId required
string
- subscriptionId required
string
- branchId required
Output
Output schema unknown
GetBranchUserLicenses
Gets user license information of a branch
signl4.GetBranchUserLicenses({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
: ID of the branch to get user license information for
- branchId required
Output
- output
array
- items UserLicenseInfo
UpdateBranchUserLicenses
Updates user license information of a branch
signl4.UpdateBranchUserLicenses({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
: ID of the branch to update user license information for - licenseUpdate UserLicenseUpdate
- branchId required
Output
- output UserLicenseInfo
ValidateAdoptionRequirements
Check if there are enough user licenses to adopt an existing subscription in the user's branch.
signl4.ValidateAdoptionRequirements({
"branchId": ""
}, context)
Input
- input
object
- branchId required
string
- adoptionInfo SubscriptionAdoptionInfo
- branchId required
Output
- output AdoptionValidationResult
SetPersonalCategorySettings
signl4.SetPersonalCategorySettings({}, context)
Input
- input
object
- categoryUpdates CategoryUpdates
Output
- output
array
- items PersonalCategorySettings
GetCategories
Returns information about all categories that belong to the team.
signl4.GetCategories({
"teamId": ""
}, context)
Input
- input
object
- teamId required
string
: Id of the team the categories belong to
- teamId required
Output
- output
array
- items CategoryInfo
GetEventsPaged
Get overview event paged. If there are more results, you also get a continuation token which you can add to the event filter.
signl4.GetEventsPaged({}, context)
Input
- input
object
- maxResults
integer
: Defines the limit of retrieved alert details per request. 1 to 100 are allowed per request. - eventFilter EventFilter
- maxResults
Output
GetOverviewEvent
Get overview event by id.
signl4.GetOverviewEvent({
"eventId": ""
}, context)
Input
- input
object
- eventId required
string
: Id of event to get.
- eventId required
Output
- output OverviewEvent
GetEventParameters
Get parameters of an event by id.
signl4.GetEventParameters({
"eventId": ""
}, context)
Input
- input
object
- eventId required
string
: Event Id of the requested Alert.
- eventId required
Output
- output
array
- items EventParameterInfo
ConfirmDeliveries
Confirm delivery of messages by message id, channel id and subscription Id.
signl4.ConfirmDeliveries({}, context)
Input
- input
object
- confirmation MessageDeliveryConfirmation
Output
Output schema unknown
GetPlans
Returns information about all available plans.
signl4.GetPlans({}, context)
Input
- input
object
- language
string
: Language of the plan infos. For example "en" or "de"
- language
Output
- output PlanInfo
GetPlan
Returns information of the plan with the specified Id.
signl4.GetPlan({
"planId": ""
}, context)
Input
- input
object
- planId required
string
: Id of the plan thats needed to be retrieved. - language
string
: Language of the plan infos. For example "en" or "de"
- planId required
Output
- output PlanInfo
GetPlanChannelPrices
Returns the plan's channel price information.
signl4.GetPlanChannelPrices({
"planId": ""
}, context)
Input
- input
object
- planId required
string
: Id of the plan thats needed to be retrieved.
- planId required
Output
- output ChannelPriceInfo
GetPlanUserPrices
Returns the plan's user price information.
signl4.GetPlanUserPrices({
"planId": ""
}, context)
Input
- input
object
- planId required
string
: Id of the plan thats needed to be retrieved. - annual
boolean
: Gets annual user prices if set to TRUE, otherwise the prices are monthly.
- planId required
Output
- output
array
- items PriceInfo
GetPrepaidPackages
Returns information about all avialable prepaid packages.
signl4.GetPrepaidPackages({}, context)
Input
- input
object
- language
string
: Language of the package infos. For example "en" or "de"
- language
Output
- output PrepaidPackageInfo
GetPrepaidBalance
Get your subscription's current prepaid balance.
signl4.GetPrepaidBalance(null, context)
Input
This action has no parameters
Output
- output PrepaidBalanceInfo
GetPrepaidSettings
Get your subscription's current prepaid settings.
signl4.GetPrepaidSettings(null, context)
Input
This action has no parameters
Output
- output PrepaidSettingsInfo
UpdatePrepaidSettings
Update your subscription's current prepaid settings.
signl4.UpdatePrepaidSettings({}, context)
Input
- input
object
- settings PrepaidSettingsInfo
Output
- output PrepaidSettingsInfo
GetPrepaidTransactions
Get your subscription's prepaid transactions.
signl4.GetPrepaidTransactions(null, context)
Input
This action has no parameters
Output
- output PrepaidSettingsInfo
CreatePrepaidTransaction
Creates a prepaid transaction for your subscription.
signl4.CreatePrepaidTransaction({}, context)
Input
- input
object
- creationInfo PrepaidTransactionCreationInfo
Output
- output PrepaidTransactionInfo
GetPrepaidTransaction
Get your subscription's prepaid transaction.
signl4.GetPrepaidTransaction({
"transactionId": ""
}, context)
Input
- input
object
- transactionId required
string
: ID of the transaction to get
- transactionId required
Output
- output PrepaidSettingsInfo
GetScriptInstances
Returns all script instances in the subscription.
signl4.GetScriptInstances(null, context)
Input
This action has no parameters
Output
- output
array
- items ScriptInstanceDetails
CreateScriptInstance
Creates a new script instance of the script specified in the request body.
signl4.CreateScriptInstance({}, context)
Input
- input
object
- instanceInfo ScriptInstanceDetails
Output
- output ScriptInstanceDetails
DeleteScriptInstance
Gets the script instance specified by the passed instance id.
signl4.DeleteScriptInstance({
"instanceId": ""
}, context)
Input
- input
object
- instanceId required
string
: Instance Id of script instance to be returned.
- instanceId required
Output
Output schema unknown
GetScriptInstance
Gets the script instance specified by the passed instance id.
signl4.GetScriptInstance({
"instanceId": ""
}, context)
Input
- input
object
- instanceId required
string
: Instance Id of script instance to be returned.
- instanceId required
Output
- output ScriptInstanceDetails
UpdateScriptInstance
Updates the specified script instance.
signl4.UpdateScriptInstance({
"instanceId": ""
}, context)
Input
- input
object
- instanceInfo ScriptInstanceDetails
- instanceId required
string
: InstanceId of the script to be updated.
Output
- output ScriptInstanceDetails
UpdateScriptInstanceCustomData
Updates the specified script instance.
signl4.UpdateScriptInstanceCustomData({
"instanceId": ""
}, context)
Input
- input
object
- instanceData ScriptInstanceCustomUserData
- instanceId required
string
: InstanceId of the script to be updated.
Output
- output ScriptInstanceDetails
DisableInstance
signl4.DisableInstance({
"instanceId": ""
}, context)
Input
- input
object
- instanceId required
string
- instanceId required
Output
- output ScriptInstanceDetails
EnableInstance
signl4.EnableInstance({
"instanceId": ""
}, context)
Input
- input
object
- instanceId required
string
- instanceId required
Output
- output ScriptInstanceDetails
GetInventoryScripts
Returns all script instances in the subscription.
signl4.GetInventoryScripts(null, context)
Input
This action has no parameters
Output
- output
array
- items InventoryScriptInfo
GetParsedInventoryScripts
signl4.GetParsedInventoryScripts({}, context)
Input
- input
object
- language
string
- language
Output
- output
array
- items InventoryScriptInfo
GetParsedInventoryScript
Gets the script specified by the passed script id.
signl4.GetParsedInventoryScript({
"scriptId": ""
}, context)
Input
- input
object
- scriptId required
string
: script Id of script to be returned. - language
string
- scriptId required
Output
- output ScriptInstanceDetails
GetSubscriptions
Get infos of all available/managed subscriptions.
signl4.GetSubscriptions(null, context)
Input
This action has no parameters
Output
- output
array
- items SubscriptionInfo
DeleteSubscription
Delete a specific subscription.
signl4.DeleteSubscription({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: ID of the subscription to be deleted.
- subscriptionId required
Output
Output schema unknown
GetSubscription
Get infos of a specific subscription.
signl4.GetSubscription({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Id of the subscription thats to be retrieved.
- subscriptionId required
Output
- output SubscriptionInfo
GetChannelPrices
Returns the subscription's channel price information.
signl4.GetChannelPrices({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Id of the subscription that needs to be retrieved.
- subscriptionId required
Output
- output ChannelPriceInfo
GetSubscriptionFeatures
Returns the features of a specified subscription.
signl4.GetSubscriptionFeatures({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Id of the subscription from which the features need to be retrieved.
- subscriptionId required
Output
- output
array
- items SubscriptionFeature
GetPrepaidBalanceForSubscription
Get a subscription's current prepaid balance.
signl4.GetPrepaidBalanceForSubscription({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
- subscriptionId required
Output
- output PrepaidBalanceInfo
GetPrepaidSettingsForSubscription
Get a subscription's current prepaid settings.
signl4.GetPrepaidSettingsForSubscription({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
- subscriptionId required
Output
- output PrepaidSettingsInfo
UpdatePrepaidSettingsForSubscription
Update a subscription's current prepaid settings.
signl4.UpdatePrepaidSettingsForSubscription({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: ID of the subscription - settings PrepaidSettingsInfo
- subscriptionId required
Output
- output PrepaidSettingsInfo
subscriptions.subscriptionId.prepaidTransactions.get
Get a subscription's prepaid transactions.
signl4.subscriptions.subscriptionId.prepaidTransactions.get({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: ID of the subscription to get transactions for
- subscriptionId required
Output
- output PrepaidSettingsInfo
subscriptions.subscriptionId.prepaidTransactions.post
Creates a prepaid transaction for a subscription.
signl4.subscriptions.subscriptionId.prepaidTransactions.post({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: ID of the subscription to create transaction for - creationInfo PrepaidTransactionCreationInfo
- subscriptionId required
Output
- output PrepaidTransactionInfo
GetPrepaidTransactionForSubscription
Get a subscription's prepaid transaction.
signl4.GetPrepaidTransactionForSubscription({
"subscriptionId": "",
"transactionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: ID of the subscription to get transactions for - transactionId required
string
: ID of the transaction to get
- subscriptionId required
Output
- output PrepaidSettingsInfo
UpdateSubscriptionProfile
Updates a subscriptions profile.
signl4.UpdateSubscriptionProfile({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: ID of the subscription to be updated - profile SubscriptionProfile
- subscriptionId required
Output
- output SubscriptionInfo
GetSubscriptionTeams
Get infos for all teams of the subscription.
signl4.GetSubscriptionTeams({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
- subscriptionId required
Output
- output
array
- items TeamInfo
GetSubscriptionUserLicenses
Gets a subscription's user licences.
signl4.GetSubscriptionUserLicenses({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: ID of the subscription
- subscriptionId required
Output
- output UserLicenseInfo
UpdateSubscriptionUserLicenses
Updates a subscription's user licences.
signl4.UpdateSubscriptionUserLicenses({
"subscriptionId": ""
}, context)
Input
- input
object
- subscriptionId required
string
: ID of the subscription to be updated - licenseUpdate UserLicenseUpdate
- subscriptionId required
Output
- output UserLicenseInfo
GetTeams
Get infos of all teams.
signl4.GetTeams(null, context)
Input
This action has no parameters
Output
- output
array
- items TeamInfo
GetTeam
Gets infos of a specific team.
signl4.GetTeam({
"teamId": ""
}, context)
Input
- input
object
- teamId required
string
: ID of the team that should be retrieved.
- teamId required
Output
- output TeamInfo
GetAlertSettings
Gets alert settings of a specific team.
signl4.GetAlertSettings({
"teamId": ""
}, context)
Input
- input
object
- teamId required
string
: ID of the team the settings should be retrieved for.
- teamId required
Output
- output AlertSettings
SetAlertSettings
Sets alert settings of a specific team.
signl4.SetAlertSettings({
"teamId": ""
}, context)
Input
- input
object
- teamId required
string
: ID of the team the settings should be set for. - settings AlertSettings
- teamId required
Output
- output AlertSettings
GetTeamDutySummary
Get duty assistent info for a team
signl4.GetTeamDutySummary({
"teamId": ""
}, context)
Input
- input
object
- teamId required
string
: ID of the team the duty belongs to. - lastTwoDuties
boolean
- teamId required
Output
- output TeamDutySummaryInfo
GetDutySchedules
Returns information about all duties that belong to the team.
signl4.GetDutySchedules({
"teamId": ""
}, context)
Input
- input
object
- teamId required
string
: Id of the team the schedules user belongs to - UserId
string
- MinDate
string
- Limit
integer
- teamId required
Output
- output
array
- items ScheduleInfo
SetDutySchedule
Create/Update given duty schedule.
signl4.SetDutySchedule({
"teamId": ""
}, context)
Input
- input
object
- teamId required
string
: Id of the team the duty is to be assigned to. - schedule ScheduleInfo
- teamId required
Output
- output ScheduleInfo
DeleteDutySchedule
Delete a specific duty.
signl4.DeleteDutySchedule({
"teamId": "",
"dutyId": ""
}, context)
Input
- input
object
- teamId required
string
: ID of the team the duty belongs to. - dutyId required
string
: ID of the duty to be deleted.
- teamId required
Output
Output schema unknown
GetDutySchedule
Returns information of the duty schedule with the specified Id.
signl4.GetDutySchedule({
"teamId": "",
"scheduleId": ""
}, context)
Input
- input
object
- teamId required
string
: Id of the team the duty belongs to - scheduleId required
string
: Id of the duty schedule thats needed to be retrieved.
- teamId required
Output
- output ScheduleInfo
teams.teamId.setupProgress.get
Gets setup progress of a specific team.
signl4.teams.teamId.setupProgress.get({
"teamId": ""
}, context)
Input
- input
object
- teamId required
string
: ID of the team the progress should be retrieved for.
- teamId required
Output
- output TeamSetupProgress
GetUsers
Returns a list of user objects with details such as their email address and duty information. Only users who are part of your team will be returned.
signl4.GetUsers(null, context)
Input
This action has no parameters
Output
- output
array
- items UserInfo
GetUser
Returns a user object with details such as his email address and duty information.
signl4.GetUser({
"userId": ""
}, context)
Input
- input
object
- userId required
string
: Identifier of the user to get. Use 'Me' to get information about the currently logged in user. Can
- userId required
Output
- output UserInfo
GetBranchInfosByUser
Returns information of the branch that is managed by user with the specified Id.
signl4.GetBranchInfosByUser({
"userId": ""
}, context)
Input
- input
object
- userId required
string
: Id of branch manager.
- userId required
Output
- output UserBranchInfo
CheckPermissions
Checks if a user has the provided permission.
signl4.CheckPermissions({
"userId": ""
}, context)
Input
- input
object
- userId required
string
: ID of the user to check permissions for. - teamId
string
- permissions ItemsWrapper[String]
- userId required
Output
- output UserImage
GetUserDutyInfo
Returns a object with duty information.
signl4.GetUserDutyInfo({
"userId": ""
}, context)
Input
- input
object
- userId required
string
: Identifier of the user to get. Use 'Me' to get information about the currently logged in user. Can
- userId required
Output
- output UserInfo
GetUserImage
signl4.GetUserImage({
"userId": ""
}, context)
Input
- input
object
- userId required
string
- height
integer
- width
integer
- userId required
Output
- output UserImage
PunchInUser
The specified user will be punched in to duty.
signl4.PunchInUser({
"userId": ""
}, context)
Input
- input
object
- userId required
string
: Identifier of the user to punch in. Use 'Me' to get information about the currently logged in
- userId required
Output
- output UserDutyInfo
PunchInUserAsManager
The specified user will be punched in to duty as a manager.
signl4.PunchInUserAsManager({
"userId": ""
}, context)
Input
- input
object
- userId required
string
: Identifier of the user to punch in. Use 'Me' to get information about the currently logged in
- userId required
Output
- output UserDutyInfo
PunchOutUser
The specified user will be punched out from duty.
signl4.PunchOutUser({
"userId": ""
}, context)
Input
- input
object
- userId required
string
: Identifier of the user to punch out. Use 'Me' to get information about the currently logged in
- userId required
Output
- output UserDutyInfo
users.userId.setupProgress.get
Gets setup progress of a specific user.
signl4.users.userId.setupProgress.get({
"userId": ""
}, context)
Input
- input
object
- userId required
string
: ID of the user the progress should be retrieved for.
- userId required
Output
- output UserSetupProgress
Get
Returns a collection of defined outbound webhooks in the system.
signl4.Get(null, context)
Input
This action has no parameters
Output
- output
array
- items WebhookInfo
Create
Creates a new outbound webhook that will be notified when certain events occur.
signl4.Create({}, context)
Input
- input
object
- webhookBaseInfo WebhookBaseInfo
Output
- output
string
Delete
Deletes the specified webhook so that it will no longer be notified.
signl4.Delete({
"webhookId": ""
}, context)
Input
- input
object
- webhookId required
string
: Id of the outbound webhook that will be deleted.
- webhookId required
Output
Output schema unknown
GetWebhookById
Returns information of the webhook specified by the passed id.
signl4.GetWebhookById({
"webhookId": ""
}, context)
Input
- input
object
- webhookId required
string
: Id of the outbound webhook to be retrieved.
- webhookId required
Output
- output
string
Update
Updates the specified webhook.
signl4.Update({
"webhookId": ""
}, context)
Input
- input
object
- webhookId required
string
: Id of the outbound webhook to be updated. - webhookUpdateInfo WebhookBaseInfo
- webhookId required
Output
- output WebhookInfo
Definitions
AdoptionValidationResult
- AdoptionValidationResult
object
- availableLicenses
integer
- isValid
boolean
- planCode
string
- requiredLicenses
integer
- availableLicenses
AlertAnnotationInfo
- AlertAnnotationInfo
object
- text
string
- timestamp
string
- type
integer
- userId
string
- text
AlertAttachment
- AlertAttachment
object
- content
string
- contentType
string
- encoding
integer
(values: 0, 1) - id
string
- name
string
- content
AlertAttachmentInfo
- AlertAttachmentInfo
object
- contentType
string
- id
string
- name
string
- contentType
AlertCounts
- AlertCounts
object
- acknowledged required
integer
- closed
integer
- end
string
- lastModified
string
- start
string
- unhandled required
integer
- acknowledged required
AlertDeliveryStatusInfo
- AlertDeliveryStatusInfo
object
- alertDeliveryStatusCode
integer
(values: 0, 1, 2, 4, 6, 8, 22, 24, 26, 30, 31) - userDeliveryStatusInfos
array
- items UserDeliveryStatusInfo
- alertDeliveryStatusCode
AlertFilterPublic
- AlertFilterPublic
object
- afterid
string
- alertStatuscodes
integer
(values: 0, 1, 2, 4, 8, 16, 32) - alertids
array
- items
string
- items
- categoryids
array
- items
string
- items
- continuationtoken PagedResultsPublicContinuationToken
- maxcreated
string
- mincreated
string
- modsince
string
- showpersonalhiddencategories
boolean
- textToSearch
string
- afterid
AlertHistoryInfo
- AlertHistoryInfo
object
- acknowledged
string
- acknowledgedgements
array
- items
string
- items
- closed
string
- closedBy
string
- created
string
- acknowledged
AlertHistoryInfoDetailed
- AlertHistoryInfoDetailed
object
- acknowledged
string
- alertHistoryEntries
array
- items AlertHistoryInfoEntry
- created
string
- acknowledged
AlertHistoryInfoEntry
- AlertHistoryInfoEntry
object
- timestamp
string
- type
integer
(values: 2, 3) - userId
string
- timestamp
AlertInfo
- AlertInfo
object
- annotations
array
- items AlertAnnotationInfo
- attachments
array
- items AlertAttachment
- category
string
- categoryId
string
- eventSourceId
string
- eventSourceType
integer
(values: 0, 1, 2) - externalId
string
- flags
integer
- history AlertHistoryInfo
- id
string
- lastModified
string
- parameters
array
- items EventParameterInfo
- severity
integer
(values: 0, 1, 2) - status
integer
(values: 0, 1, 2, 4, 8, 16, 32) - subscriptionId
string
- teamId
string
- text
string
- title
string
- annotations
AlertNotificationInfo
- AlertNotificationInfo
object
- address
string
- deviceName
string
- lastUpdate
string
- messageStatus
integer
(values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10) - notificationChannelType
integer
(values: 0, 1, 2, 4, 8, 16) - userId
string
- userStatus
integer
(values: 0, 1, 2, 3, 4, 5, 6)
- address
AlertReport
- AlertReport
object
- last24Hours required AlertCounts
- subscriptionId required
string
- teamCurrentDuty AlertCounts
- teamId required
string
- teamLastDuty AlertCounts
- userId
string
- userLastDutyChange AlertCounts
AlertSettings
- AlertSettings
object
- filterAction
integer
(values: 0, 1, 2) - filterMode
integer
(values: 0, 1) - optOut
integer
(values: 0, 1, 2) - persNotMode
integer
(values: 0, 1) - responseMode
integer
(values: 2, 4) - responseTime
integer
- filterAction
BranchInfo
- BranchInfo
object
- billingInterval
integer
(values: 0, 1, 4) - country
string
- created
string
- currency
string
- externalAccountId
string
- externalSubscriptionId
string
- id
string
- managerIds
array
- items
string
- items
- options
integer
- ownerId
string
- subscriptionIds
array
- items
string
- items
- billingInterval
BranchManagerInformation
- BranchManagerInformation
object
- displayName
string
- isPending
boolean
- mailAddress
string
- managerId
string
- subscriptionId
string
- displayName
BranchManagerInviteInfos
- BranchManagerInviteInfos
object
- displayName required
string
- mailAddress required
string
- displayName required
CategoryInfo
- CategoryInfo
object
- color
string
- id
string
- imageName
string
- isDefault
boolean
- keywords
array
- items
string
- items
- name
string
- color
CategoryUpdates
- CategoryUpdates
object
- settings
array
- items PersonalCategorySettings
- teamId
string
- userId
string
- settings
ChangeAlertStatusFilterInfo
- ChangeAlertStatusFilterInfo
object
- categoryIds
array
- items
string
- items
- maxDate
string
- minDate
string
- categoryIds
ChangeAlertStatusMultipleInfo
- ChangeAlertStatusMultipleInfo
object
- alertIds required
array
- items
string
- items
- descr
string
- uid required
string
- alertIds required
ChannelPriceInfo
- ChannelPriceInfo
object
- sms
integer
- voicePerMinute
integer
- sms
DutySummaryInfo
- DutySummaryInfo
object
- dutyEnd
string
- dutyId
string
- dutyStart
string
- dutyEnd
EntityTagHeaderValue
- EntityTagHeaderValue
object
- isWeak
boolean
- tag StringSegment
- isWeak
ErrorResponseContent
- ErrorResponseContent
object
- code required
integer
- details
string
- errors
array
- items ErrorResponseContentBase
- message required
string
- requestId
string
- code required
ErrorResponseContentBase
- ErrorResponseContentBase
object
- details
string
- message required
string
- details
EventFilter
- EventFilter
object
- continuationToken PagedResultsPublicContinuationToken
- eventStatusCode
integer
(values: 0, 1, 2, 3, 1000) - maxCreationDate
string
- minCreationDate
string
- modifiedSince
string
- textToSearch
string
EventParameterInfo
- EventParameterInfo
object
- name
string
- type
integer
(values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 100) - value
string
- name
FileContentResult
- FileContentResult
object
- contentType
string
- enableRangeProcessing
boolean
- entityTag EntityTagHeaderValue
- fileContents
string
- fileDownloadName
string
- lastModified
string
- contentType
InventoryScriptInfo
- InventoryScriptInfo
object
- config
object
- data ScriptDescriptionData
- eventPattern
object
- localizationDetails
array
- items ScriptLocalizationDetail
- scriptId
string
- scriptName
string
- visibility
string
- config
ItemsWrapper[String]
- ItemsWrapper[String]
object
- items
array
- items
string
- items
- items
MessageDelivery
- MessageDelivery
object
- channelId
string
- messageId
string
- channelId
MessageDeliveryConfirmation
- MessageDeliveryConfirmation
object
- deliveries
array
- items MessageDelivery
- subscriptionId
string
- deliveries
OverviewAlert
- OverviewAlert
object
- alertDeliveryStatus AlertDeliveryStatusInfo
- categoryId
string
- detailedHistory AlertHistoryInfoDetailed
- externalId
string
- flags
integer
- id
string
- lastModified
string
- requiredAcknowledgements
integer
- status
integer
(values: 0, 1, 2, 4, 8, 16, 32) - subscriptionId
string
- teamId
string
- text
string
- title
string
OverviewEvent
- OverviewEvent
object
- alertId
string
- categoryId
string
- creationTime
string
- eventSourceType
integer
(values: 0, 1, 2, 3, 4, 5) - eventStatus
integer
(values: 0, 1, 2, 3, 1000) - id
string
- lastModified
string
- severity
integer
(values: 0, 1, 2) - text
string
- title
string
- alertId
PagedResultsPublicContinuationToken
- PagedResultsPublicContinuationToken
object
- nextPartitionKey
string
- nextRowKey
string
- nextTableName
string
- nextPartitionKey
PagedResultsPublic[OverviewAlert]
- PagedResultsPublic[OverviewAlert]
object
- continuationToken PagedResultsPublicContinuationToken
- hasMore
boolean
- results
array
- items OverviewAlert
PagedResultsPublic[OverviewEvent]
- PagedResultsPublic[OverviewEvent]
object
- continuationToken PagedResultsPublicContinuationToken
- hasMore
boolean
- results
array
- items OverviewEvent
PersonalCategorySettings
- PersonalCategorySettings
object
- categoryId
string
- hidden
boolean
- mute
boolean
- ringtone
string
- categoryId
PlanFeature
- PlanFeature
object
- name
string
- value
string
- name
PlanInfo
- PlanInfo
object
- description
string
- display
string
- featureDescription
string
- features
array
- items PlanFeature
- id
string
- name
string
- upgradeDescription
string
- userAddonKey
string
- description
PrepaidBalanceInfo
- PrepaidBalanceInfo
object
- balance
integer
- latestTopUp
string
- pendingTransactions
boolean
- balance
PrepaidPackageInfo
- PrepaidPackageInfo
object
- code
string
- description
string
- name
string
- prices
array
- items PriceInfo
- code
PrepaidSettingsInfo
- PrepaidSettingsInfo
object
- topUpAmount
integer
- topUpEnabled
boolean
- topUpLimit
integer
- topUpAmount
PrepaidTransactionCreationInfo
- PrepaidTransactionCreationInfo
object
- packageCode
string
- packageCode
PrepaidTransactionInfo
- PrepaidTransactionInfo
object
- amount
integer
- autoTopUpId
string
- created
string
- createdBy
string
- currency
string
- modified
string
- packageCode
string
- status
string
- statusCode
integer
- subscriptionId
string
- transactionId
string
- amount
PriceInfo
- PriceInfo
object
- currency
string
- price
integer
- currency
RaiseAlertInfo
- RaiseAlertInfo
object
- attachments
array
- items AlertAttachment
- category
string
- externalId
string
- flags
integer
- parameters
array
- items EventParameterInfo
- severity
integer
(values: 0, 1, 2) - text required
string
- title required
string
- attachments
ScheduleInfo
- ScheduleInfo
object
- end
string
- id
string
- options
integer
- start
string
- userId
string
- end
ScriptDescriptionData
- ScriptDescriptionData
object
- description
string
- name
string
- scriptType
string
- shortDescription
string
- description
ScriptInstanceCustomUserData
- ScriptInstanceCustomUserData
object
- customScriptDescription
string
- customScriptName
string
- instanceId
string
- scriptName
string
- customScriptDescription
ScriptInstanceDetails
- ScriptInstanceDetails
object
- config
object
- customScriptDescription
string
- customScriptName
string
- enabled
boolean
- eventPattern
object
- instanceId
string
- lastModified
string
- runtimeInformation ScriptInstanceInfoRuntimeInformationModel
- scriptId
string
- scriptName
string
- subscriptionId
string
- config
ScriptInstanceInfoRuntimeInformationModel
- ScriptInstanceInfoRuntimeInformationModel
object
- runtimeStatus
integer
(values: 0, 1, 2, 3, -1) - runtimeStatusMessage
string
- runtimeStatus
ScriptLocalizationDetail
- ScriptLocalizationDetail
object
- config
object
- data ScriptDescriptionData
- language
string
- config
StringSegment
- StringSegment
object
- buffer
string
- hasValue
boolean
- length
integer
- offset
integer
- value
string
- buffer
SubscriptionAdoptionInfo
- SubscriptionAdoptionInfo
object
- ownerEmail required
string
- ownerEmail required
SubscriptionCreationInfo
- SubscriptionCreationInfo
object
- language
string
- name required
string
- ownerEmail required
string
- timezone
string
- language
SubscriptionEndpointInfo
- SubscriptionEndpointInfo
object
- address
string
- lastEvent
string
- type
integer
(values: 0, 1, 2, 3)
- address
SubscriptionFeature
- SubscriptionFeature
object
- name
string
- type
integer
- value
string
- name
SubscriptionInfo
- SubscriptionInfo
object
- branchId
string
- country
string
- currency
string
- endpoints
array
- items SubscriptionEndpointInfo
- externalAccountId
string
- id
string
- name
string
- nextBilling
string
- ownerId
string
- planCode
string
- planState
integer
- referralEnabled
boolean
- status
integer
- teamIds
array
- items
string
- items
- branchId
SubscriptionProfile
- SubscriptionProfile
object
- name
string
- name
TeamDutySummaryInfo
- TeamDutySummaryInfo
object
- dutyAssistEnabled
boolean
- dutySummaries
array
- items DutySummaryInfo
- dutyAssistEnabled
TeamInfo
- TeamInfo
object
- id
string
- memberIds
array
- items
string
- items
- name
string
- subscriptionId
string
- timezone
string
- id
TeamSetupProgress
- TeamSetupProgress
object
- completedSteps
array
- items
string
- items
- teamId
string
- timestamp
string
- completedSteps
UserBranchInfo
- UserBranchInfo
object
- branchId
string
- isBranchManager
boolean
- isBranchMember
boolean
- branchId
UserDeliveryStatusInfo
- UserDeliveryStatusInfo
object
- statusCode
integer
(values: 0, 1, 2, 4, 6, 8, 24, 26, 30, 31, 32) - userId
string
- statusCode
UserDutyInfo
- UserDutyInfo
object
- lastChange
string
- onDuty
boolean
- onManagerDuty
boolean
- overdue
boolean
- lastChange
UserImage
- UserImage
object
- content
string
- contentDispostion
string
- contentEncoding
string
- contentType
string
- lastModified
string
- name
string
- content
UserInfo
- UserInfo
object
- colorIndex
integer
- dutyInfos UserDutyInfo
- id
string
- isDeactivated
boolean
- isInvite
boolean
- mail
string
- name
string
- subscriptionId
string
- colorIndex
UserLicenseInfo
- UserLicenseInfo
object
- currentUsers
integer
- isFree
boolean
- isTrial
boolean
- licensedUsers
integer
- planCode
string
- currentUsers
UserLicenseUpdate
- UserLicenseUpdate
object
- currency
string
- interval required
integer
(values: 0, 1, 4) - licensedUsers required
integer
- planId required
string
- currency
UserSetupProgress
- UserSetupProgress
object
- completedSteps
array
- items
string
- items
- timestamp
string
- userId
string
- completedSteps
WebhookBaseInfo
- WebhookBaseInfo
object
: Basic external webhook model for update/creation.- extUrl required
string
: Url to the external webhook. It will receive all outgoing events.
- extUrl required
WebhookInfo
- WebhookInfo
object
: Basic information about an external webhook.- extUrl required
string
: Url to the external webhook. It will receive all outgoing events. - id
string
: Id of the webhook in SIGNL4. - subId
string
: Id of the subscription that is owning the webhook.
- extUrl required