Entity - EventSubscriptions - handles Event Subscriptions

Page version: 12, last updated:

Minimum API version 5.0

VerbRequestNotesPermissions required
GET/Consumer/EventSubscriptions

Returns all Event Subscriptions within the system.

Read on EventSubscription
GET/Consumer/EventSubscriptions/{id}

Returns a single Event Subscription.

Example data returned:

Example response
{
    "Id": 2,
    "ConsumerId": 2,
    "Topic": "1E.Performance.*",
    "Url": "https://target.acme.lab/Test",
    "Strategy": 0,
    "Bookmark": null,
    "Status": 1
}
Read on EventSubscription
POST/Consumer/EventSubscriptionsAdds an Event SubscriptionWrite on EventSubscription
PUT/Consumer/EventSubscriptionsModifies an existing Event SubscriptionWrite on EventSubscription
POST/Consumer/EventSubscriptions/Search

Gets a list of filtered and sorted event subscriptions.

Example Request
{
    "filter":{
        "Operator": "AND",
        "Operands": [ 
            { 
                "Attribute": "ConsumerId",
                "Operator": "==",
                "Value": 2
            },
            { 
                "Attribute": "Status",
                "Operator": "==",
                "Value": 1
            }
        ]
    },
    "start": 1,
    "pageSize": 10,
    "sort": [
        {
            "Column": "Topic",
            "Direction": "ASC"
        },
        {
            "Column": "Url",
            "Direction": "ASC"
        }
    ]
}
  • filter - filter expression.To learn about how to define filter check Using scope and filter expressions page.
  • start - starting index to support pagination. Begins from 1.
  • pagesize - number of results to fetch
  • sort - sort expression. To learn about how to define sort criteria check Sort Definition page.

Allowed filter columns:

  • Id
  • ConsumerId
  • Topic
  • Url
  • Strategy
  • Status

Allowed sortable columns

  • ConsumerId
  • Topic
  • Url
  • Strategy
  • Status

 

Read on EventSubscription
DELETE/Consumer/EventSubscriptions/{id}Removes an Event Subscription given its IdDelete on EventSubscription
POST/Consumer/EventSubscriptions/{id}/AssignmentsAssigns selected Management groups to an Event SubscriptionWrite on EventSubscription
PUT/Consumer/EventSubscriptions/{id}/AssignmentsReplaces all Management groups assigned to the Event Subscription with supplied Management groupsWrite on EventSubscription
GET/Consumer/EventSubscriptions/{id}/AssignmentsReturns Management groups assigned to a given Event SubscriptionRead on EventSubscription
DELETE/Consumer/EventSubscriptions/{id}/AssignmentsUnassigns specified Management groups from a given Event SubscriptionWrite on EventSubscription