ISearchEvents

Interface

Properties

Property	Type	Notes
access Optional	EventAccess[]	Array of EventAccess. Example: PRIVATE,ORG,PUBLIC
attendanceTypes Optional	EventAttendanceType[]	Array of AttendanceTypes. Example: VIRTUAL,IN_PERSON
canEdit Optional	boolean	boolean to filter events that can be edited by the user
categories Optional	string[]	Array of categories
createdByIds Optional	string[]	Array of user ids
editGroups Optional	string[]	Array of edit groupIds
endDateTimeAfter Optional	string	earliest ISO8601 end date-time for the events
endDateTimeBefore Optional	string	latest ISO8601 end date-time for the events
entityIds Optional	string[]	Array of associated entityIds
entityTypes Optional	EventAssociationEntityType[]	Array of associated entity types. Example: Hub Site Application,Hub Initiative,Hub Project
eventIds Optional	string[]	Array of event ids. Cannot be used with notEventIds.
f Optional	EventsSearchFormat	response data format. Example: csv,json
geometry Optional	ISearchEventsGeometry	esri geometry object
include Optional	GetEventsInclude[]	Array of relation fields to include in response. Example: associations,creator,location,onlineMeeting,registrations
notEventIds Optional	string[]	Array of event ids to exclude. Cannot be used with eventIds
num Optional	number	the max amount of events to return
orgId Optional	string	orgId string
readGroups Optional	string[]	Array of read groupIds
sharedToGroups Optional	string[]	Array of shared groupIds
sortBy Optional	EventSort	Event property to sort results by
sortOrder Optional	EventSortOrder	sort results order desc or asc
start Optional	number	the index to start at
startDateTimeAfter Optional	string	earliest ISO8601 start date-time for the events
startDateTimeBefore Optional	string	latest ISO8601 start date-time for the events
status Optional	EventStatus[]	Array of event statuses. Example: PLANNED,CANCELED,REMOVED
tags Optional	string[]	Array of tags
title Optional	string	string to match within an event title
updatedAtAfter Optional	string	earliest ISO8601 updatedAt for the events
updatedAtBefore Optional	string	latest ISO8601 updatedAt for the events
withoutEditGroups Optional	string[]	Array of edit groupIds that event is not shared to
withoutReadGroups Optional	string[]	Array of read groupIds that event is not shared to

Interface defined in packages/common/src/events/api/orval/api/orval-events.ts:221