Get annotation type

The name of the annotation type.

The ID of the set this annotation type belongs to. This is used to group annotation types together. For example, if the id field is set to goal, the set ID might be set to football. Another annotation type corner_kick might belong to the same set. This should not be confused with the group_name field, which is used to group annotation types in the UI (within a single set).

Optional. Data that can be used to store additional information about the annotation type. This can be useful to communicate additional information to downstream systems that want to act on annotations of this type (e.g. to render overlays in a video).

Optional. The number of milliseconds to wait before an annotation of this type starts triggering associated actions. It is recommended to set this to a value that is high enough to allow for Studio operators to delete the annotation in case of a mistaken click on an annotation. Important: this is only a hint to the UI client (the client is responsible for handling the delay).

Whether the annotation type should be shown in the tagging UI of the Studio.

Optional. The CMS entity types that are associated with annotations of this type. For example, if your annotation type is "goal", you might want to associate it with the entity type "team". The Motto Studio (or another custom-built client) will use this information to show a dialog to the tagger to provide this information when the annotation is created. This information can then be used in downstream services.

Important: Make sure that such an entity type exists in the CMS, first.

The group name is used to group annotation types in the UI. For example, all annotation types related to time-keeping (like kickoff, half_time or full_time) might be grouped under the group name "Time". This can be any name you'd like to assign to it.

The asset ID of the icon. Can be left empty to show no icon.

System generated unique identifier for the annotation type.

The priority determines the order in which the annotation types are shown in the UI. A higher value means it shows up earlier in the list. Note: this also determines the order of the groups in the list response. The groups are ordered by the highest priority of the first element in each group.

The visibility of annotations of this type to end users. This may be overwritten by the visibility of individual annotations.