microsoft.graph.event

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.event",
  "title": "microsoft.graph.event",
  "allOf": [
    {
      "$ref": "#/components/schemas/microsoft.graph.outlookItem"
    },
    {
      "title": "event",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "allowNewTimeProposals": {
          "type": "boolean",
          "description": "true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. The default is true.",
          "nullable": true
        },
        "attendees": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.attendee"
          },
          "description": "The collection of attendees for the event."
        },
        "body": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.itemBody"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The body of the message associated with the event. It can be in HTML or text format."
        },
        "bodyPreview": {
          "type": "string",
          "description": "The preview of the message associated with the event. It's in text format.",
          "nullable": true
        },
        "cancelledOccurrences": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called canceled occurences.Returned only on $select in a Get operation which specifies the ID (seriesMasterId property value) of a series master event."
        },
        "end": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.dateTimeTimeZone"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The date, time, and time zone that the event ends. By default, the end time is in UTC."
        },
        "hasAttachments": {
          "type": "boolean",
          "description": "Set to true if the event has attachments.",
          "nullable": true
        },
        "hideAttendees": {
          "type": "boolean",
          "description": "When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. The default is false.",
          "nullable": true
        },
        "iCalUId": {
          "type": "string",
          "description": "A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.",
          "nullable": true
        },
        "importance": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.importance"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The importance of the event. The possible values are: low, normal, high."
        },
        "isAllDay": {
          "type": "boolean",
          "description": "Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start, and endtime must be set to midnight and be in the same time zone.",
          "nullable": true
        },
        "isCancelled": {
          "type": "boolean",
          "description": "Set to true if the event has been canceled.",
          "nullable": true
        },
        "isDraft": {
          "type": "boolean",
          "description": "Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes are sent, or if the event is an appointment without any attendees.",
          "nullable": true
        },
        "isOnlineMeeting": {
          "type": "boolean",
          "description": "True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional.  After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Subsequently, Outlook ignores any further changes to isOnlineMeeting, and the meeting remains available online.",
          "nullable": true
        },
        "isOrganizer": {
          "type": "boolean",
          "description": "Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). It also applies if a delegate organized the event on behalf of the owner.",
          "nullable": true
        },
        "isReminderOn": {
          "type": "boolean",
          "description": "Set to true if an alert is set to remind the user of the event.",
          "nullable": true
        },
        "location": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.location"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The location of the event."
        },
        "locations": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.location"
          },
          "description": "The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection are removed and replaced by the new location value."
        },
        "onlineMeeting": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.onlineMeetingInfo"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Details for an attendee to join the meeting online. The default is null. Read-only. After you set the isOnlineMeeting and onlineMeetingProvider properties to enable a meeting online, Microsoft Graph initializes onlineMeeting. When set, the meeting remains available online, and you can't change the isOnlineMeeting, onlineMeetingProvider, and onlneMeeting properties again."
        },
        "onlineMeetingProvider": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.onlineMeetingProviderType"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Represents the online meeting service provider. By default, onlineMeetingProvider is unknown. The possible values are unknown, teamsForBusiness, skypeForBusiness, and skypeForConsumer. Optional.  After you set onlineMeetingProvider, Microsoft Graph initializes onlineMeeting. Subsequently, you can't change onlineMeetingProvider again, and the meeting remains available online."
        },
        "onlineMeetingUrl": {
          "type": "string",
          "description": "A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.",
          "nullable": true
        },
        "organizer": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.recipient"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The organizer of the event."
        },
        "originalEndTimeZone": {
          "type": "string",
          "description": "The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.",
          "nullable": true
        },
        "originalStart": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": "string",
          "description": "Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z",
          "format": "date-time",
          "nullable": true
        },
        "originalStartTimeZone": {
          "type": "string",
          "description": "The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.",
          "nullable": true
        },
        "recurrence": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.patternedRecurrence"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The recurrence pattern for the event."
        },
        "reminderMinutesBeforeStart": {
          "maximum": 2147483647,
          "minimum": -2147483648,
          "type": "number",
          "description": "The number of minutes before the event start time that the reminder alert occurs.",
          "format": "int32",
          "nullable": true
        },
        "responseRequested": {
          "type": "boolean",
          "description": "Default is true, which represents the organizer would like an invitee to send a response to the event.",
          "nullable": true
        },
        "responseStatus": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.responseStatus"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Indicates the type of response sent in response to an event message."
        },
        "sensitivity": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.sensitivity"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The possible values are: normal, personal, private, and confidential."
        },
        "seriesMasterId": {
          "type": "string",
          "description": "The ID for the recurring series master item, if this event is part of a recurring series.",
          "nullable": true
        },
        "showAs": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.freeBusyStatus"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The status to show. The possible values are: free, tentative, busy, oof, workingElsewhere, unknown."
        },
        "start": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.dateTimeTimeZone"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The start date, time, and time zone of the event. By default, the start time is in UTC."
        },
        "subject": {
          "type": "string",
          "description": "The text of the event's subject line.",
          "nullable": true
        },
        "transactionId": {
          "type": "string",
          "description": "A custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. It's useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.",
          "nullable": true
        },
        "type": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.eventType"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The event type. The possible values are: singleInstance, occurrence, exception, seriesMaster. Read-only"
        },
        "webLink": {
          "type": "string",
          "description": "The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.",
          "nullable": true
        },
        "attachments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.attachment"
          },
          "description": "The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.",
          "x-ms-navigationProperty": true
        },
        "calendar": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.calendar"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The calendar that contains the event. Navigation property. Read-only.",
          "x-ms-navigationProperty": true
        },
        "exceptionOccurrences": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.event"
          },
          "description": "Contains the id property values of the event instances that are exceptions in a recurring series.Exceptions can differ from other occurrences in a recurring series, such as the subject, start or end times, or attendees. Exceptions don't include canceled occurrences.Returned only on $select and $expand in a GET operation that specifies the ID (seriesMasterId property value) of a series master event.",
          "x-ms-navigationProperty": true
        },
        "extensions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.extension"
          },
          "description": "The collection of open extensions defined for the event. Nullable.",
          "x-ms-navigationProperty": true
        },
        "instances": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.event"
          },
          "description": "The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn't include occurrences canceled from the series. Navigation property. Read-only. Nullable.",
          "x-ms-navigationProperty": true
        },
        "multiValueExtendedProperties": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty"
          },
          "description": "The collection of multi-value extended properties defined for the event. Read-only. Nullable.",
          "x-ms-navigationProperty": true
        },
        "singleValueExtendedProperties": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty"
          },
          "description": "The collection of single-value extended properties defined for the event. Read-only. Nullable.",
          "x-ms-navigationProperty": true
        },
        "@odata.type": {
          "type": "string",
          "default": "#microsoft.graph.event"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.event"
}