Loading

additiv Alerting REST Services (v1)

Download OpenAPI specification:Download

Contains methods to manage alerts

Alerts

Search alerts

Searches for alerts based on specified conditions and gets a paged list of matching alerts in the system

header Parameters
Authorization
required
string

The BasicAuth token

Request Body schema:

The parameter DTO

sortColumnName
string
Enum: "Id" "Name" "IsActive"

Which column to use during sorting

sortDirection
string
Enum: "Asc" "Desc"

Which direction should be used during sorting

searchTerm
string

Search term to look for

page
integer <int32>

The result page number, starting by 1

pageSize
integer <int32>

The number of items in a result page

Responses

200

Success

422

Incorrect/missing parameters

post/api/v1.0/Alerts/search
https://example-host/api/v1.0/Alerts/search

Request samples

Content type
Copy
Expand all Collapse all
{
  • "sortColumnName": "Id",
  • "sortDirection": "Asc",
  • "searchTerm": "string",
  • "page": 0,
  • "pageSize": 0
}

Response samples

Content type
No sample

Get alert by its id

path Parameters
alertId
required
integer <int32>

Alert id

header Parameters
Authorization
required
string

The BasicAuth token

Responses

200

Success

422

Incorrect/missing parameters

get/api/v1.0/Alerts/{alertId}
https://example-host/api/v1.0/Alerts/{alertId}

Response samples

Content type
No sample

Get condition details by its id

path Parameters
conditionId
required
integer <int32>

Condition id

header Parameters
Authorization
required
string

The BasicAuth token

Responses

200

Success

422

Incorrect/missing parameters

get/api/v1.0/Alerts/conditions/{conditionId}
https://example-host/api/v1.0/Alerts/conditions/{conditionId}

Response samples

Content type
No sample

Updates condition by its id

path Parameters
conditionId
required
integer <int32>

The condition id to update

header Parameters
Authorization
required
string

The BasicAuth token

Request Body schema:

The condition data to use for update

id
integer <int32>
objectGraphDataSource
string
alertDefinitionId
integer <int32>
hasCustomScript
boolean
objectGraphNavigationPathLeft
string
objectGraphNavigationPathRight
string
objectGraphRootNode
string
operator
string
testingOperator
string
threshold
number <double>

Responses

200

Success

204

Success

422

Incorrect/missing parameters

put/api/v1.0/Alerts/conditions/{conditionId}
https://example-host/api/v1.0/Alerts/conditions/{conditionId}

Request samples

Content type
Copy
Expand all Collapse all
{
  • "id": 0,
  • "objectGraphDataSource": "string",
  • "alertDefinitionId": 0,
  • "hasCustomScript": true,
  • "objectGraphNavigationPathLeft": "string",
  • "objectGraphNavigationPathRight": "string",
  • "objectGraphRootNode": "string",
  • "operator": "string",
  • "testingOperator": "string",
  • "threshold": 0
}

Response samples

Content type
No sample

Get conditions by alert id

path Parameters
alertId
required
integer <int32>

Alert id

header Parameters
Authorization
required
string

The BasicAuth token

Responses

200

Success

422

Incorrect/missing parameters

get/api/v1.0/Alerts/{alertId}/conditions
https://example-host/api/v1.0/Alerts/{alertId}/conditions

Response samples

Content type
No sample