Event Subscription

What can you do with EventSubscription?


Properties

Property Details
id
"id": 770
Type: Number
This is the unique numeric identifier for the EventSubscription
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
isActive
"isActive": true
Type: Boolean
eventRegistrationId
"eventRegistrationId": 132
Type: Number
Unique identifier for the associated EventRegistration object.
eventBindingActionId
"eventBindingActionId": 93
Type: Number
Unique identifier for the associated EventBindingAction object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • description
  • isActive
  • eventRegistrationId
  • eventBindingActionId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the EventSubscription object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/EventSubscription/{id:int}
Delete an instance of the EventSubscription object.
GETapi/v1/EventSubscription
Retrieve all of the EventSubscription objects.
GETapi/v1/EventSubscription/Metadata
Retrieve all of the meta data details of the EventSubscription object.
GETapi/v1/EventSubscription/Metadata/{option}
Retrieve all the meta data details of the EventSubscription object based on provided options.
{option}Metadata options for the EventSubscription object.
GETapi/v1/EventSubscription/Paged
Retreive all of the EventSubscription objects in a paged fashion.
GETapi/v1/EventSubscription/Paged/Detail
Retreive all of the EventSubscription objects in a paged fashion with all object details.
GETapi/v1/EventSubscription/{id:int}
Retrieve an instance of the EventSubscription object by it's ID.
{id:int}Unique identifier for the EventSubscription object.
GETapi/v1/EventSubscription/{id:int}/Detail
Retreive all of the Detail objects for the specified EventSubscription.
{id:int}Unique identifier for the EventSubscription object.
PATCHapi/v1/EventSubscription/{id:int}
Update the EventSubscription object and optionally make changes to any child objects.
POSTapi/v1/EventSubscription
Create a new instance of the EventSubscription object.
PUTapi/v1/EventSubscription/{id:int}
Update an existing instance of the EventSubscription object.