Get a list of Tripwire notifications

get/tripwire-notifications
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
created
required
string (StringFilterParam)

Filter by the notification created date and time

Example: created=gt:2022-01-01T00:00:00Z
eventStartDate
string (StringFilterParam)

Filter by the date and time an event started

Example: eventStartDate=gt:2022-01-01T00:00:00Z
eventEndDate
string (StringFilterParam)

Filter by a single date and time an event ended

Example: eventEndDate=lt:2022-01-01T00:00:00Z
action
string

Filter notifications by action taken

Example: action=EMAIL_CUSTOMER_CONTACTS
productReference
string (StringFilterParam)

Filter notifications by the product reference of the associated usage product inventory

Example: productReference=xyz | in:x,y | like:xyz
usageProductInventoryId
string (StringFilterParam)

Filter notifications by usage product inventory id

Example: usageProductInventoryId=xyz | in:x,y | like:xyz
customerId
string (StringFilterParam)

Filter notifications by customer identifier

Example: customerId=xyz | in:x,y | like:xyz
siteId
string (StringFilterParam)

Filter notifications by site identifier

Example: siteId=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "created": "2022-01-01T00:00:00Z",
    • "whenActionApplied": "2022-01-01T00:00:00Z",
    • "planId": 0,
    • "planRuleName": "Daily calls exceeding £10.00",
    • "eventStartDate": "2022-01-01T00:00:00Z",
    • "eventEndDate": "2022-01-01T00:00:00Z",
    • "action": "EMAIL_BILLING_CLIENT",
    • "totalPrice": 10,
    • "totalCallCount": 15,
    • "usageProductInventoryId": 10,
    • "productReference": "string",
    • "customerId": 1234,
    • "siteId": 1234
    }
]