Navigate

Kaltura API Documentationannotation.list

List annotation objects by filter and pager

Try it out
post https://www.kaltura.com/api_v3/service/annotation_annotation/action/list

Request Parameters

body:object
SchemaExample
object
filter:object:KalturaCuePointFilter
freeText:string
objectType:string
Enum: KalturaCuePointFilter, KalturaAdCuePointFilter, KalturaAnnotationFilter, KalturaAnswerCuePointFilter, KalturaCodeCuePointFilter, KalturaEventCuePointFilter, KalturaQuestionCuePointFilter, KalturaThumbCuePointFilter
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], INT_ID_ASC [+intId], PARTNER_SORT_VALUE_ASC [+partnerSortValue], START_TIME_ASC [+startTime], TRIGGERED_AT_ASC [+triggeredAt], UPDATED_AT_ASC [+updatedAt], CREATED_AT_DESC [-createdAt], INT_ID_DESC [-intId], PARTNER_SORT_VALUE_DESC [-partnerSortValue], START_TIME_DESC [-startTime], TRIGGERED_AT_DESC [-triggeredAt], UPDATED_AT_DESC [-updatedAt]
userIdCurrent:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]
Enum Type: KalturaNullableBoolean


userIdEqualCurrent:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]
Enum Type: KalturaNullableBoolean


KalturaCuePointFilter must also match all of:
object:KalturaCuePointBaseFilter
KalturaCuePointFilter must also match any of:
object:KalturaCuePointFilterobject:KalturaAdCuePointFilterobject:KalturaAnnotationFilterobject:KalturaAnswerCuePointFilterobject:KalturaCodeCuePointFilterobject:KalturaEventCuePointFilterobject:KalturaQuestionCuePointFilterobject:KalturaThumbCuePointFilter
pager:object:KalturaFilterPager
The KalturaFilterPager object enables paging management to be applied upon service list actions.


KalturaFilterPager must also match all of:
object:KalturaPager

Response

Success

SchemaExample
object:KalturaAnnotationListResponse
objects:array[object:KalturaAnnotation]
object:KalturaAnnotation
childrenCount:integer
readOnly


Number of all descendants


depth:integer
readOnly


Depth in the tree


directChildrenCount:integer
readOnly


Number of children, first generation only.


duration:integer
readOnly


Duration in milliseconds


endTime:integer
End time in milliseconds


isPublic:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]
Enum Type: KalturaNullableBoolean


Is the annotation public.


parentId:string
insertOnly


searchableOnEntry:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]
Enum Type: KalturaNullableBoolean


Should the cue point get indexed on the entry.


text:string
KalturaAnnotation must also match all of:
object:KalturaCuePoint
KalturaAnnotationListResponse must also match all of:
object:KalturaListResponse