Connectors Reference

Derdack SIGNL4

Derdack SIGNL4 is a mobile notification app to reliably notify operations teams on duty and boost their productivity.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

AlertsAcknowledgeAllPost ()

Confirm all

AlertsPost (RaiseAlertInfo alertInfo)

Trigger Alert

GetAlertsReport ()

Get Alert Report

GetAllUsers ()

Get all Users

GetUserById (string userId)

Get user by id

PunchInUserById (string userId)

Punch user in

PunchOutUserById (string userId)

Punch user out

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AlertInfo

 

AlertReport

An object holding information about the occurred alert volume in different time periods

RaiseAlertInfo

 

UserDutyInfo

 

UserInfo

 

 

Actions:

AlertsAcknowledgeAllPost

Summary: Confirm all

Description: This method confirms all unhandled alerts your team currently has.

 

Syntax:

DerdackSIGNL4.AlertsAcknowledgeAllPost ()

 

Returns:

 

AlertsPost

Summary: Trigger Alert

Description: Triggers a new alert for your team. All team members on duty will receive alert notifications.

 

Syntax:

DerdackSIGNL4.AlertsPost (RaiseAlertInfo alertInfo)

 

Parameters:

Name

Type

Summary

Required

Related Action

alertInfo

RaiseAlertInfo

 

 

True

 

Returns:

          Type:AlertInfo

 

GetAlertsReport

Summary: Get Alert Report

Description: Returns information about the occurred alert volume in different time periods as well as information about the response behavior (amount of confirmed and unhandled alerts) of your team members.

 

Syntax:

DerdackSIGNL4.GetAlertsReport ()

 

Returns:

          Type:AlertReport

          Summary: An object holding information about the occurred alert volume in different time periods

          Description: An object holding 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.

 

GetAllUsers

Summary: Get all Users

Description: Returns a list of user objects with details such as their email address. Only users who are part of your team will be returned.

 

Syntax:

DerdackSIGNL4.GetAllUsers ()

 

Returns:

          Type:array of (UserInfo)

 

GetUserById

Summary: Get user by id

Description: Returns a user's details such as name, email address, etc.

 

Syntax:

DerdackSIGNL4.GetUserById (string userId)

 

Parameters:

Name

Type

Summary

Required

Related Action

userId

string

(User Id)

Identifier of the user to get. Use 'Me' to get information about the currently logged in user. Can also be an email address of a user in the team or the unique id of an according user object.

True

 

Returns:

          Type:UserInfo

          Description: Basic information about a user.

 

PunchInUserById

Summary: Punch user in

Description: Using this operation, the specified user will be punched in to duty.

 

Syntax:

DerdackSIGNL4.PunchInUserById (string userId)

 

Parameters:

Name

Type

Summary

Required

Related Action

userId

string

(User Id)

Identifier of the user to punch in. Use 'Me' to get information about the currently logged in user. Can also be an email address of a user in the team or the unique id of an according user object.

True

 

Returns:

          Type:UserDutyInfo

          Description: Information about a user's duty status.

 

PunchOutUserById

Summary: Punch user out

Description: Using this operation, the specified user will be punched out from duty.

 

Syntax:

DerdackSIGNL4.PunchOutUserById (string userId)

 

Parameters:

Name

Type

Summary

Required

Related Action

userId

string

(User Id)

Identifier of the user to punch out. Use 'Me' to get information about the currently logged in user. Can also be an email address of a user in the team or the unique id of an according user object.

True

 

Returns:

          Type:UserDutyInfo

          Description: Information about a user's duty status.

 


 

AlertInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Alert id

Unique id of the alert in SIGNL4.

externalId

string

External id

A unique id in your system for referencing this alert. You may use this field to match alerts that you have triggered with that id, e.g. when querying for an updated status of the alert later on.

subscriptionId

string

Subscription id

Unique id of your SIGNL4 subscription.

teamId

string

Team id

Unique id of your SIGNL4 team.

categoryId

string

Category id

Unique id of a system or device category in your SIGNL4 team to which this alert belongs.

category

string

System or device category

Name of a system or device category in your SIGNL4 team to which this alert belongs.

severity

integer(int32)

Alert severity

Severity of this alert in SIGNL4. This field is reserved for later use.  Values: [, , ]

eventSourceId

string

Unique id of the API or source through which this alert was triggered for your SIGNL4 team

Unique id of the API or source through which this alert was triggered for your SIGNL4 team.

eventSourceType

integer(int32)

Type of the API or source through which this alert was triggered for your SIGNL4 team

Type of the API or source through which this alert was triggered for your SIGNL4 team.  Values: [, , ]

lastModified

string(date-time)

Time at which this alert was last modified in SIGNL4

Time at which this alert was last modified in SIGNL4.

attachments

array of (AttachmentsItem)

Collection of attachmanets such as images that belong to this alert

Collection of attachmanets such as images that belong to this alert.

annotations

array of (AnnotationsItem)

A collection of annotations users have left on this alert

A collection of annotations users have left on this alert.

parameters

array of (ParametersItem)

A collection of of key/value pairs with additional device or system parameters that belong to this alert

A collection of of key/value pairs with additional device or system parameters that belong to this alert.

history

History

A collection that holds timeline entries which form an audit trial of this alert

A collection that holds timeline entries which form an audit trial of this alert.

status

integer(int32)

Alert status

Status of the alert in SIGNL4. 1 represents an unhandled alert while 2 represents a confirmed alert. All other values are reserved for later use and should never be a value of an instance of this object.  Values: [, , , , , , ]

title

string

Alter title

Title or subject of this alert.

text

string

Textual alert details

Textual alert details.

flags

integer(int32)

Internal property reserved for later use

Internal property reserved for later use.

 

AttachmentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Unique id of this attachments in SIGNL4

Unique id of this attachments in SIGNL4.

encoding

integer(int32)

Indicates if the content is Base64 or encoded (1) or not (0)

Indicates if the content is Base64 or encoded (1) or not (0).  Values: [, ]

name

string

Attachment name

Name of this attachment, e.g. an original image file name.

contentType

string

MIME content type

MIME content type of this attachment such as image/jpg.

content

string

Attachment content

The content of this attachment.

 

AnnotationsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

integer(int32)

Annotation type

Type of this annotation. This field is reserved for later use.

text

string

User annotation

The annotation that was left by a user.

userId

string

Unique id of the SIGNL4 user who has left the annotation

Unique id of the SIGNL4 user who has left the annotation.

 

ParametersItem

Summary: An object that represents a system or device parameter that belongs to this alert

Description: An object that represents a system or device parameter that belongs to this alert.

 

          Properties:

Name

Type

Summary

name

string

Parameter name

Name of this parameter, e.g. temperature.

type

integer(int32)

Parameter type

Type of this parameter. This field is reserved for later use and should always match 0 when setting it.  Values: [, , , , , , , , , , , , , , , , , , ]

value

string

Parameter value

The value of the parameter, e.g. 56F.

 

History

Summary: A collection that holds timeline entries which form an audit trial of this alert

Description: A collection that holds timeline entries which form an audit trial of this alert.

 

          Properties:

Name

Type

Summary

acknowledged

string(date-time)

Time at which this alert was confirmed

Time at which this alert was confirmed.

acknowledgedBy

string

Name of the team member who has confirmed the alert

Name of the team member who has confirmed the alert.

closed

string(date-time)

Time at which this alert was closed

Time at which this alert was closed.

closedBy

string

Name of the team member who has closed the alert

Name of the team member who has closed the alert.

created

string(date-time)

Time at which this alert was created in SIGNL4

Time at which this alert was created in SIGNL4.

 


 

AlertReport

Summary: An object holding information about the occurred alert volume in different time periods

Description: An object holding 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.

 

          Properties:

Name

Type

Summary

last24Hours

Last24Hours

An object holding information about the occurred alert volume in the last 24h

An object holding information about the occurred alert volume in the last 24h.

subscriptionId

string

Unique id of your SIGNL4 subscription

Unique id of your SIGNL4 subscription.

teamCurrentDuty

TeamCurrentDuty

An object holding information about the occurred alert volume and your teams response behavior in its current duty period. Will be empty if your team has switched off the SIGNL4 duty assistant

An object holding information about the occurred alert volume and your teams response behavior in its current duty period. Will be empty if your team has switched off the SIGNL4 duty assistant.

teamId

string

Unique id of the SIGNL4 team for which this alert report was created/requested. Will be empty if your team has switched off the SIGNL4 duty assistant

Unique id of the SIGNL4 team for which this alert report was created/requested. Will be empty if your team has switched off the SIGNL4 duty assistant.

teamLastDuty

TeamLastDuty

An object holding information about the occurred alert volume and your teams response behavior in its previous duty period. Will be empty if your team has switched off the SIGNL4 duty assistant

An object holding information about the occurred alert volume and your teams response behavior in its previous duty period. Will be empty if your team has switched off the SIGNL4 duty assistant.

userId

string

Unique id of the SIGNL4 user for which this alert report was created/requested. Will be empty if your team has switched on the SIGNL4 duty assistant

Unique id of the SIGNL4 user for which this alert report was created/requested. Will be empty if your team has switched on the SIGNL4 duty assistant.

userLastDutyChange

UserLastDutyChange

An object holding information about the occurred alert volume and the users response behavior since the duty status of the user changed last time. Will be empty if your team has switched on the SIGNL4 duty assistant

An object holding information about the occurred alert volume and the users response behavior since the duty status of the user changed last time. Will be empty if your team has switched on the SIGNL4 duty assistant.

 

Last24Hours

Summary: An object holding information about the occurred alert volume in the last 24h

Description: An object holding information about the occurred alert volume in the last 24h.

 

          Properties:

Name

Type

Summary

acknowledged

integer(int32)

Amount of alerts that occurred in the last 24h and your team has confirmed within that time

Amount of alerts that occurred in the last 24h and your team has confirmed within that time.

end

string(date-time)

Time at which this time period has ended or will end

Time at which this time period has ended or will end.

lastModified

string(date-time)

Last time this metric changed

Last time this metric changed.

start

string(date-time)

Time at which this time period has started or will start

Time at which this time period has started or will start.

unhandled

integer(int32)

Amount of alerts that occurred in the last 24h and your team has not confirmed within that time

Amount of alerts that occurred in the last 24h and your team has not confirmed within that time.

 

TeamCurrentDuty

Summary: An object holding information about the occurred alert volume and your teams response behavior in its current duty period. Will be empty if your team has switched off the SIGNL4 duty assistant

Description: An object holding information about the occurred alert volume and your teams response behavior in its current duty period. Will be empty if your team has switched off the SIGNL4 duty assistant.

 

          Properties:

Name

Type

Summary

acknowledged

integer(int32)

Amount of alerts that occurred in the current duty period and your team has confirmed within that time

Amount of alerts that occurred in the current duty period and your team has confirmed within that time.

end

string(date-time)

Time at which this duty period has ended or will end

Time at which this duty period has ended or will end.

lastModified

string(date-time)

Last time this metric changed

Last time this metric changed.

start

string(date-time)

Time at which this duty period has started or will start

Time at which this duty period has started or will start.

unhandled

integer(int32)

Amount of alerts that occurred in the current duty period and your team has not confirmed within that time

Amount of alerts that occurred in the current duty period and your team has not confirmed within that time.

 

TeamLastDuty

Summary: An object holding information about the occurred alert volume and your teams response behavior in its previous duty period. Will be empty if your team has switched off the SIGNL4 duty assistant

Description: An object holding information about the occurred alert volume and your teams response behavior in its previous duty period. Will be empty if your team has switched off the SIGNL4 duty assistant.

 

          Properties:

Name

Type

Summary

acknowledged

integer(int32)

Amount of alerts that occurred in the previous duty period and your team has confirmed within that time

Amount of alerts that occurred in the previous duty period and your team has confirmed within that time.

end

string(date-time)

Time at which this duty period has ended or will end

Time at which this duty period has ended or will end.

lastModified

string(date-time)

Last time this metric changed

Last time this metric changed.

start

string(date-time)

Time at which this duty period has started or will start

Time at which this duty period has started or will start.

unhandled

integer(int32)

Amount of alerts that occurred in the previous duty period and your team has not confirmed within that time

Amount of alerts that occurred in the previous duty period and your team has not confirmed within that time.

 

UserLastDutyChange

Summary: An object holding information about the occurred alert volume and the users response behavior since the duty status of the user changed last time. Will be empty if your team has switched on the SIGNL4 duty assistant

Description: An object holding information about the occurred alert volume and the users response behavior since the duty status of the user changed last time. Will be empty if your team has switched on the SIGNL4 duty assistant.

 

          Properties:

Name

Type

Summary

acknowledged

integer(int32)

Amount of alerts that occurred since the users duty status changed last time and she has confirmed within that time

Amount of alerts that occurred since the users duty status changed last time and she has confirmed within that time.

end

string(date-time)

Time at which this period has ended or will end

Time at which this period has ended or will end.

lastModified

string(date-time)

 

 

start

string(date-time)

Time at which this period has started or will start

Time at which this period has started or will start.

unhandled

integer(int32)

Amount of alerts that occurred since the users duty status changed last time and she has not confirmed within that time

Amount of alerts that occurred since the users duty status changed last time and she has not confirmed within that time.

 


 

RaiseAlertInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

externalId

string

External id

A unique id in your system for referencing this alert. You may use this field to match alerts that you have triggered with that id, e.g. when querying for an updated status of the alert later on.

category

string

Alert category

Name of a system or device category in your SIGNL4 team to which this alert should belong.

severity

integer(int32)

Alert severity

Severity of this alert in SIGNL4. This field is reserved for later use.  Values: [, , ]

attachments

array of (AttachmentsItem)

 

Collection of attachments such as images that belong to this alert.

parameters

array of (ParametersItem)

 

A collection of of key/value pairs with additional device or system parameters that belong to this alert.

title

string

Alert title

Title or subject of this alert, e.g. 'Temperature alert'.

text

string

Alert details

Textual alert details, e.g. 'Temperature decreased by 10F within the last 4 minutes'.

flags

integer(int32)

Reserved property

Internal property reserved for later use.

 

AttachmentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Unique id of this attachment in SIGNL4

Unique id of this attachment in SIGNL4.

encoding

integer(int32)

Attachment encoding

Indicates if the content is Base64 encoded (1) or not (0).  Values: [, ]

name

string

Attachment name

Name of this attachment, e.g. an original image file name.

contentType

string

Attachment MIME type

MIME content type of this attachment such as image/jpg (with encoding 1) or text/plain (e.g. with encoding 0).

content

string

Attachment data

Data of this attachment, such as a Base64 string representing a jpg image.

 

ParametersItem

Summary:

Description: An object that represents a system or device parameter that belongs to this alert.

 

          Properties:

Name

Type

Summary

name

string

Parameter name

Name of this parameter, e.g. temperature.

type

integer(int32)

Parameter type

Type of this parameter. This field is reserved for later use and should always match 0 when setting it.  Values: [, , , , , , , , , , , , , , , , , , ]

value

string

Parameter value

The value of the parameter, e.g. 56F.

 


 

UserDutyInfo

Summary:

Description: Information about a user's duty status.

 

          Properties:

Name

Type

Summary

lastChange

string(date-time)

Punch In Date-Time

The date-time in UTC format. ex. yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

onDuty

boolean

On Duty

True if the user is on duty.

overdue

boolean

Overdue

True if the user is currently overdue, e.g. because nobody else has replaced that user in time.


 

UserInfo

Summary:

Description: Basic information about a user.

 

          Properties:

Name

Type

Summary

id

string

User Id

ID of the user.

mail

string

Email

The user's mail address.

name

string

Name

Name of the user.

subscriptionId

string

Subscription Id

ID of the subscription the user belongs to.