Skip to main content

1E 8.1 (on-premises)

EventSource

Entity - EventSource - handles Event Sources

Minimum API version 5.1

Verb	Request	Notes	Permissions required
GET	/Consumer/EventSource	Returns all event sources	Requires 'Read' permission on 'Event Subscription' securable type
GET	/Consumer/EventSource/{id}	Returns event source by its Id	Requires 'Read' permission on 'Event Subscription' securable type
POST	/Consumer/EventSource	Adds a new event source	Requires 'Write' permission on 'Event Subscription' securable type
PUT	/Consumer/EventSource	Modifies an existing event source	Requires 'Write' permission on 'Event Subscription' securable type
DELETE	/Consumer/EventSource	Deletes an event source	Requires 'Delete' permission on 'Event Subscription' securable type
POST	/Consumer/EventSource/Search	Returns event sources that fulfil parameters passed in the request body: filter - filter expression.To learn about how to define filter check Using scope and filter expressions page. sort - sort expression. To learn about how to define sort criteria check Sort Definition page. start - starting index to support pagination. It begins from 1. pagesize - number of results to fetch Allowed filter columns: Id Type Source LastProcessedTimestampUtc Allowed sort columns: Id Type LastProcessedTimestampUtc	Requires 'Read' permission on 'Event Subscription' securable type
POST	/Consumer/EventSource/SearchSurveys	Returns event sources that fulfil parameters passed in the request body: filter - filter expression.To learn about how to define filter check Using scope and filter expressions page. sort - sort expression. To learn about how to define sort criteria check Sort Definition page. start - starting index to support pagination. It begins from 1. pagesize - number of results to fetch Allowed filter columns: Id Type CreatedBy Source CreatedTimestampUtc LastProcessedTimestampUtc Name Question Description Link SurveyType DefaultChoiceIndex Validation AllowFreeText PromptFrequencyDays Deadline TemplateType Allowed sort columns: Id Type CreatedBy CreatedTimestampUtc LastProcessedTimestampUtc Name Question Description Link SurveyType DefaultChoiceIndex Validation AllowFreeText PromptFrequencyDays Deadline TemplateType	Requires 'Read' permission on 'Event Subscription' securable type
POST	/Consumer/EventSource/Shallow/Search	Returns event sources that fulfil parameters passed in the request body. This endpoint returns a subset of information without details about event subscription or management groups. filter - filter expression.To learn about how to define filter check Using scope and filter expressions page. sort - sort expression. To learn about how to define sort criteria check Sort Definition page. start - starting index to support pagination. It begins from 1. pagesize - number of results to fetch Allowed filter columns: Id Type Source LastProcessedTimestampUtc Allowed sort columns: Id Type LastProcessedTimestampUtc	Requires 'Read' permission on 'Event Subscription' securable type
POST	/Consumer/EventSource/Shallow/SearchSurveys	Returns event sources that fulfil parameters passed in the request body. This endpoint returns a subset of information without details about event subscription or management groups. filter - filter expression.To learn about how to define filter check Using scope and filter expressions page. sort - sort expression. To learn about how to define sort criteria check Sort Definition page. start - starting index to support pagination. It begins from 1. pagesize - number of results to fetch Allowed filter columns: Id Type CreatedBy Source CreatedTimestampUtc LastProcessedTimestampUtc Name Question Description Link SurveyType DefaultChoiceIndex Validation AllowFreeText PromptFrequencyDays Deadline TemplateType Allowed sort columns: Id Type CreatedBy CreatedTimestampUtc LastProcessedTimestampUtc Name Question Description Link SurveyType DefaultChoiceIndex Validation AllowFreeText PromptFrequencyDays Deadline TemplateType	Requires 'Read' permission on 'Event Subscription' securable type
POST	/Consumer/EventSource/SetDirty	Marks the event sources and related data as "Dirty", indicating that a redeploy is needed so that any changes will reach the Clients.	Requires 'Write' permission on 'Event Subscription' securable type

In this section: