Event Types

Event type describes a type of an occasion of significance for which an event can be created. It will also be used to configure the events and their lifecycle. For example, the entity in the system with which an event is associated and if calendar entries should be generated or not.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
required
length between 1 and 64

Unique Name for the Event Type

string
required
length between 1 and 256

Description of the Event Type.

string | null

Miscellaneous notes and information for the entry or record.

string | null

The system Entity that the event type is associated with (if applicable).

boolean

When checked, events of this type will be added to the Calendar Event. That is, for each day of the event, a collection of calendar events will be generated.

boolean

The CanEditAllDay field is a special attribute within the EventType table that is represented by a data type of bit. This field allows users to set a permission that determines whether or not they have the ability to edit events that last for the entire day. When the CanEditAllDay bit is set to 1, the user has full editing capabilities for all-day events. However, when the bit is set to 0, the user is restricted from making any changes to events that span the entire day. This field provides an important level of control and flexibility for managing events within the EventType table.

boolean

The DefaultAllDay field in the EventType table stores a bit value indicating whether the event is configured to be an all-day event by default. This data type allows for the convenient management of events that do not have a specific start and end time, such as holidays or recurring weekly events. A value of 1 indicates that the event is set to be all-day by default, while a value of 0 indicates that it is not set to be all-day by default. This field is useful for quickly identifying the type of event and determining its scheduling needs.

Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!