Loading
Documentation Powered by ReDoc

DFS Alerting API (latest)

Download OpenAPI specification:Download

Contains methods to manage alerts

Alerts

Get alert by its id

Authorizations:
Bearer
path Parameters
alertId
required
integer <int32>

Alert id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "productIds":
    [
    ],
  • "isActive": true,
  • "owner": "string"
}

Get condition details by its id

Authorizations:
Bearer
path Parameters
conditionId
required
integer <int32>

Condition id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

Content type
application/json
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
}

Updates condition by its id

Authorizations:
Bearer
path Parameters
conditionId
required
integer <int32>

The condition id to update

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The condition data to use for update

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Request samples

Content type
application/json
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
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Get conditions by alert id

Authorizations:
Bearer
path Parameters
alertId
required
integer <int32>

Alert id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Search alerts

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

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The parameter DTO

sortColumnName
string (AlertSortableColumn)
Enum: "Id" "Name" "IsActive" "CreatedBy"
sortDirection
string (SortDirection)
Enum: "Asc" "Desc"
searchTerm
string Nullable

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "alerts":
    [
    ],
  • "totalNumberOfResults": 0
}