Skip to content

UpdateEventInput

Input

This input type is used to update an existing Event for a custom event producer. See EventProducer for more details.

Input fields

NameTypeDescription
idID!

The unique identifier for the event.

typeString

The type of the event, which should convey the broad category of the event.

subTypeString

The subtype of the event, if provided, which should provide more context on the category of the event.

startTimeDateTimeOffset

The time at which the event started.

endTimeDateTimeOffset

The time at which the event ended. If not provided, the event is still ongoing.

positionGeoJSONPointInput

The GeoJSON point to be recorded with the event, if any.

timezoneString

The timezone for the event, if provided.

metadataJSON

Additional metadata associated with the event. This may represent any JSON object structure.

snapshots[CreateSnapshotInput!]

Requests to generate snapshots for this event Snapshots are only generated when the event is ended for the first time. Therefore, snapshots will only be generated the first time that the endTime is specified for this event.

uploads[UploadImageInput!]

Requests to upload images for this event.

imageIds[ID!]

IDs of existing images to associate to this event. If this is provided, existing event images not included will be removed from the event, and only uploads and imageIds from the most update request will be associated with the event.

clips[CreateClipInput!]

Requests to associate clips to this event

trackIds[ID!]

List of Track IDs to attach to this event. Ensures that the Events UI page renders a map with plotted tracks.

propertiesEventPropertiesInput

Optional additional information associated with this event, including related data sources, sites, and tags.

draftBoolean

Whether the event is a draft.

validationEventValidationInput

Optional information to validate the accuracy of the event.

priorityString

Optional string to indicate the priority of an event.