Kaltura API DocumentationcuePoint.list

List cue point objects by filter and pager

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

Request Parameters

body:object
object
filter:object:KalturaCuePointFilter
freeText:string
objectType:string
Enum: 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
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

object:KalturaCuePointListResponse
objects:array[object:KalturaCuePoint]
object:KalturaCuePoint

abstract

copiedFrom:string

readOnly

createdAt:integer

readOnly

cuePointType:string
Enum: AD [adCuePoint.Ad], ANNOTATION [annotation.Annotation], CODE [codeCuePoint.Code], EVENT [eventCuePoint.Event], QUIZ_ANSWER [quiz.QUIZ_ANSWER], QUIZ_QUESTION [quiz.QUIZ_QUESTION], THUMB [thumbCuePoint.Thumb]

readOnly

Enum Type: KalturaCuePointType

entryId:string

insertOnly

forceStop:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]

Enum Type: KalturaNullableBoolean

id:string

readOnly

intId:integer

readOnly

isMomentary:boolean

readOnly

objectType:string
Enum: KalturaAnnotation, KalturaAdCuePoint, KalturaAnswerCuePoint, KalturaCodeCuePoint, KalturaEventCuePoint, KalturaQuestionCuePoint, KalturaThumbCuePoint
partnerData:string
partnerId:integer

readOnly

partnerSortValue:integer
startTime:integer

Start time in milliseconds

status:integer
Enum: READY [1], DELETED [2], HANDLED [3], PENDING [4]

readOnly

Enum Type: KalturaCuePointStatus

systemName:string
tags:string
thumbOffset:integer
triggeredAt:integer
updatedAt:integer

readOnly

userId:string

readOnly

KalturaCuePointListResponse must also match all of:
object:KalturaListResponse