Kaltura API DocumentationcaptionAssetItem.searchEntries

Search caption asset items by filter, pager and free text

Try it out
post https://www.kaltura.com/api_v3/service/captionsearch_captionassetitem/action/searchEntries

Request Parameters

body:object
object
captionAssetItemFilter:object:KalturaCaptionAssetItemFilter
contentLike:string
contentMultiLikeAnd:string
contentMultiLikeOr:string
endTimeGreaterThanOrEqual:integer
endTimeLessThanOrEqual:integer
labelEqual:string
labelIn:string
languageEqual:string
Enum: Abaza, Abkhazian, Abnaki Western, Abure, Achang, Achinese, Achterhooks, Achumawi, Adioukrou, Adyghe; Adygei, Adynyamathanha, Afade, Afar, Afrikaans, Aghem, Aghul, Aguacateco, Aguaruna, Ainu (Japan), Akkadian, Aklanon, Akum, Alabama, Albanian, Albanian (Gheg), Albanian (Tosk), Aleut, Algonquian languages, Algonquin, Altai (Southern), Amharic, Angloromani, Apache (Jicarilla), Apache (Western), Arabic, Arabic (standard), Arabic Tunisian Spoken, Aramaic, Aramaic Samaritan, Arapaho, Araucanian, Arikara, Armenian, Aromanian, Assamese, Assiniboine, Assyrian Neo-Aramaic, Asturian, Athapascan languages, Atikamekw, Awadhi, Aymara, Azerbaijani, Babine, Badaga, Bai, Balinese, Balochi Southern, Balti, Baluchi, Basa (Cameroon), Bashkir, Basque, Bavarian, Beaver, Beja, Bemba (Zambia), Bengali (Bangla), Betawi, Bezhta, Bhili, Bhojpuri, Bhutani, Bihari, Bikol, Bini, Bishnupriya Manipuri, Bislama, Breton, Buginese, Bulgarian, Buriat, Burmese, Byelorussian (Belarusian), Caddo, Cambodian, Cantonese, Carrier, Carrier Southern, Catalan, Catawba, Cayuga, Cebuano, Chagatai, Chaldean Neo-Aramaic, Cherokee, Cheyenne, Chickasaw, Chilcotin, Chinese, Chinook jargon, Chipewyan, Chippewa, Choctaw, Chor, Chukot, Cimbrian, Clallam Klallam, Cochimi, Cocopa, Colognian, Comanche, Comorian, Comox, Coptic, Corsican, Cree, Creek, Crimean Tatar, Croatian, Cupeo, Czech, Dakota, Danish, Dargwa, Dari (Persian), Dari Zoroastrian, Dehu, Delaware, Dinka, Dogri (generic), Dogrib, Dolgan, Dong, Duala, Dungan, Dutch, Dyula, E, Emilian, English, English (American), English (British), English Middle (1100-1500), Erzya, Esperanto, Estonian, Even, Evenki, Faeroese, Fala, Fang (Equatorial Guinea), Farsi, Fiji, Filipino, Finnish, Finnish (Tornedalen), Fon, Franco-Prove, Frankish, French, Frisian, Frisian Northern, Friulian, Fur, Ga, Gaelic (Manx), Gaelic (Scottish), Gagauz, Galician, Gan, Geez, Georgian, German, German Hutterite, German Pennsylvania, Gilbertese, Gilyak Nivkh, Gitxsan, Greek, Greek Ancient (to 1453), Greenlandic, Guarani, Gujarati, Gwichin, Haida, Hainanese, Haisla, Hakka, Halkomelem, Han, Hani, Hausa, Hawaiian, Hebrew, Heiltsuk, Hidatsa, Hiligaynon, Hindi, Hmong, Hokkien, Hopi, Huizhou Chinese, Hungarian, Icelandic, Ikposo, Iloko, Inari Sami, Indonesian, Ingrian, Ingush, Interlingua, Interlingue, Inuinnaqtun, Inuktitut, Inupiak, Irish, Iroquoian languages, Italian, Itelmen, Japanese, Javanese, Jinyu Chinese, Jju, Judeo-Crimean Tatar, Judeo-Georgian, Jutish, Kabardian, Kabuverdianu, Kabyle, Kachchi, Kaikavian literary language (Kajkavian), Kalmyk Oirat, Kannada, Kansa, Karachay-Balkar, Karagas, Karaim, Karakalpak, Karelian, Kashmiri, Kashubian, Kaska, Kawi, Kazakh, Khakas, Khalaj Turkic, Khanty, Khasi, Khmer Northern, Kickapoo, Kinyarwanda (Ruanda), Kiowa, Kirghiz, Kirundi (Rundi), Klingon tlhIngan-Hol, Kodava, Komi-Permyak, Konkani (generic), Konkani (specific), Konkani Goan, Korean, Koryak, Kosraean, Kotava, Kpelle, Kumiai, Kumyk, Kurdish, Kutenai, Kwakiutl, Laal, Ladin, Ladino, Lahnda, Lahu, Lak, Laki, Lakota, Laothian, Latin, Latvian (Lettish), Laz, Lezghian, Ligurian, Lillooet, Limbu, Limburgish ( Limburger), Lingala, Lithuanian, Lojban, Loma (Liberia), Lombard, Low German Low Saxon, Lozi, Luba-Lulua, Lucumi, Ludian, Lule Sami, Lunda, Luo (Kenya and Tanzania), Lushootseed, Luxembourgish (Letzeburgesch), Macedonian, Madurese, Magahi, Maithili, Malagasy, Malay, Malayalam, Malecite-Passamaquoddy, Maltese, Manchu, Mandaic, Mandan, Mandarin Chinese, Mansi, Maori, Maranao, Marathi, Mari (Russia), Marwari, Masai, Mayo, Meitei, Mende (Sierra Leone), Menominee, Michif, Micmac, Min Bei Chinese, Min Dong Chinese, Minangkabau, Mingrelian, Mirandese, Mohawk, Moksha, Moldavian, Mon, Mongolian, Montagnais, Morisyen, Mossi, Mozarabic, Multilingual, Muong, Nama (Namibia), Nanai, Naskapi, Nauru, Neapolitan, Nepali, Newari Nepal Bhasa, Nganasan, Nisgaa, Niuean, No linguistic content, Nogai, Norse Old, Northern Sotho Pedi Sepedi, Norwegian, Novial, Nyamwezi, Nyoro, Nyungah, Occitan, Ojibwa Central, Ojibwa Eastern, Ojibwa Northwestern, Ojibwa Severn, Ojibwa Western, Ojibwe, Ojibwa, Okanagan, Okinawan Central, Old English, Oneida, Onondaga, Oriya, Oromo (Afan, Galla), Ottawa, Paipai, Palauan, Pampanga, Pangasinan, Papiamento, Pashto (Pushto), Persian, Persian (Dari), Pfaelzisch, Picard, Piedmontese, Pirah, Pitcairn-Norfolk, Plautdietsch, Polish, Pontic, Portuguese, Potawatomi, Prussian, Pulaar, Punjabi, Qashqai, Qawasqar, Quechua, Quich Central, Rapanui, Rarotongan, Reserved for local use., Rhaeto-Romance, Romagnol, Romani Kalo Finnish, Romani Sinte, Romanian, Romanian Istro, Romanian Megleno, Romany, Runion Creole French, Russian, Rusyn, Saint Lucian Creole French, Sakha, Salar, Salish Straits, Salishan languages, Sami Kildin, Sami languages, Samoan, Sangro, Sanskrit, Santali, Saramaccan, Sardinian Sassarese, Saterland Frisian, Saxon Upper, Scots, Sechelt, Seediq, Sekani, Selkup, Seneca, Serbian, Serbo-Croatian, Seri, Sesotho, Setswana, Shawnee, Shona, Shor, Shoshoni, Shuswap, Sicilian, Sidamo, Siksika, Silesian, Sindhi, Sinhalese, Siswati, Skolt Sami, Slavey North, Slavey South, Slovak, Slovenian, Somali, Soninke, Sorbian Lower, Sorbian Upper, Southern Sami, Southern Tutchone, Spanish, Sranan, Stoney, Sudovian, Sumerian, Sundanese, Svan, Swabian, Swahili (Kiswahili), Swedish, Swedish Sign Language, Swiss German Alemannic Alsatian, Syriac, Tabassaran, Tachawit, Tachelhit, Tagalog, Tagbanwa, Tagish, Tahltan, Tai Na, Tajik, Talysh, Tamajaq Tawallammat, Tamasheq, Tamazight Central Atlas, Tamil, Tarahumara Central, Tat Muslim, Tatar, Telugu, Teo Chew, Tetum, Thai, Thai (Northern), Thai Northeastern, Thompson, Tibetan, Tigre, Tigrinya, Tlingit, Toda, Tohono Oodham, Tok Pisin, Tonga, Tonga (Nyasa), Tsez, Tsimshian, Tsonga, Tulu, Tumbuka, Tumzabt, Tupinamb, Turkana, Turkish, Turkish Ottoman, Turkmen, Tuscarora, Tuvalu, Tuvinian, Twi, Ubykh, Udi, Udmurt, Uighur, Ukrainian, Undefined, Urdu, Urum, Uzbek, Venetian, Veps, Vietnamese, Volapuk, Voro, Votic, Vro, Waorani, Waray (Philippines), Welsh, Western Farsi, Western Neo-Aramaic, Wiyot, Wolof, Wu Chinese, Wymysorys, Xhosa, Yanesha, Yiddish, Yoruba, Zapotec Isthmus, Zarma, Zulu

Enum Type: KalturaLanguage

languageIn:string
partnerDescriptionLike:string
partnerDescriptionMultiLikeAnd:string
partnerDescriptionMultiLikeOr:string
startTimeGreaterThanOrEqual:integer
startTimeLessThanOrEqual:integer
KalturaCaptionAssetItemFilter must also match all of:
object:KalturaCaptionAssetFilter
captionAssetItemPager:object:KalturaFilterPager

The KalturaFilterPager object enables paging management to be applied upon service list actions.

KalturaFilterPager must also match all of:
object:KalturaPager
entryFilter:object:KalturaBaseEntryFilter
categoriesFullNameIn:string
categoryAncestorIdIn:string

All entries within this categoy or in child categories

freeText:string
isRoot:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]

Enum Type: KalturaNullableBoolean

objectType:string
Enum: KalturaPlayableEntryFilter, KalturaMediaEntryFilter, KalturaMediaEntryFilterForPlaylist, KalturaExternalMediaEntryFilter, KalturaLiveEntryFilter, KalturaLiveChannelFilter, KalturaLiveStreamEntryFilter, KalturaLiveStreamAdminEntryFilter, KalturaMixEntryFilter, KalturaDataEntryFilter, KalturaDocumentEntryFilter, KalturaPlaylistFilter
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], END_DATE_ASC [+endDate], MODERATION_COUNT_ASC [+moderationCount], NAME_ASC [+name], PARTNER_SORT_VALUE_ASC [+partnerSortValue], RANK_ASC [+rank], RECENT_ASC [+recent], START_DATE_ASC [+startDate], TOTAL_RANK_ASC [+totalRank], UPDATED_AT_ASC [+updatedAt], WEIGHT_ASC [+weight], CREATED_AT_DESC [-createdAt], END_DATE_DESC [-endDate], MODERATION_COUNT_DESC [-moderationCount], NAME_DESC [-name], PARTNER_SORT_VALUE_DESC [-partnerSortValue], RANK_DESC [-rank], RECENT_DESC [-recent], START_DATE_DESC [-startDate], TOTAL_RANK_DESC [-totalRank], UPDATED_AT_DESC [-updatedAt], WEIGHT_DESC [-weight]
redirectFromEntryId:string

The id of the original entry

KalturaBaseEntryFilter must also match all of:
object:KalturaBaseEntryBaseFilter

Response

Success

object:KalturaBaseEntryListResponse
objects:array[object:KalturaBaseEntry]
object:KalturaBaseEntry
accessControlId:integer

The Access Control ID assigned to this entry (null when not set, send -1 to remove)

adminTags:string

Entry admin tags can be updated only by administrators

capabilities:string

readOnly

Comma seperated string of the capabilities of the entry. Any capability needed can be added to this list.

categories:string

Comma separated list of full names of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action.

categoriesIds:string

Comma separated list of ids of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action.

conversionProfileId:integer

Override the default ingestion profile

createdAt:integer

readOnly

Entry creation date as Unix timestamp (In seconds)

creatorId:string

insertOnly

The ID of the user who created this entry

description:string

Entry description

displayInSearch:integer
Enum: SYSTEM [-1], NONE [0], PARTNER_ONLY [1], KALTURA_NETWORK [2]

Enum Type: KalturaEntryDisplayInSearchType

should we display this entry in search

downloadUrl:string

readOnly

Download URL for the entry

endDate:integer

Entry scheduling end date (null when not set, send -1 to remove)

entitledUsersEdit:string

list of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only

entitledUsersPublish:string

list of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only

entitledUsersView:string

list of user ids that are entitled to view the entry (no server enforcement) The difference between entitledUsersEdit, entitledUsersPublish and entitledUsersView is applicative only

groupId:integer
id:string

readOnly

Auto generated 10 characters alphanumeric string

licenseType:integer
Enum: UNKNOWN [-1], NONE [0], COPYRIGHTED [1], PUBLIC_DOMAIN [2], CREATIVECOMMONS_ATTRIBUTION [3], CREATIVECOMMONS_ATTRIBUTION_SHARE_ALIKE [4], CREATIVECOMMONS_ATTRIBUTION_NO_DERIVATIVES [5], CREATIVECOMMONS_ATTRIBUTION_NON_COMMERCIAL [6], CREATIVECOMMONS_ATTRIBUTION_NON_COMMERCIAL_SHARE_ALIKE [7], CREATIVECOMMONS_ATTRIBUTION_NON_COMMERCIAL_NO_DERIVATIVES [8], GFDL [9], GPL [10], AFFERO_GPL [11], LGPL [12], BSD [13], APACHE [14], MOZILLA [15]

Enum Type: KalturaLicenseType

License type used for this entry

moderationCount:integer

readOnly

Number of moderation requests waiting for this entry

moderationStatus:integer
Enum: PENDING_MODERATION [1], APPROVED [2], REJECTED [3], DELETED [4], FLAGGED_FOR_REVIEW [5], AUTO_APPROVED [6]

readOnly

Enum Type: KalturaEntryModerationStatus

Entry moderation status

name:string

Entry name (Min 1 chars)

objectType:string
Enum: KalturaDataEntry, KalturaDocumentEntry, KalturaPlayableEntry, KalturaPlaylist, KalturaMediaEntry, KalturaMixEntry, KalturaExternalMediaEntry, KalturaLiveChannel, KalturaLiveStreamEntry, KalturaLiveStreamAdminEntry
operationAttributes:array[object:KalturaOperationAttributes]parentEntryId:string

ID of source root entry, used for defining entires association

partnerData:string

Can be used to store various partner related data as a string

partnerId:integer

readOnly

partnerSortValue:integer

Can be used to store various partner related data as a numeric value

rank:number

readOnly

The calculated average rank. rank = totalRank / votes

redirectEntryId:string

IF not empty, points to an entry ID the should replace this current entry's id.

referenceId:string

Entry external reference id

replacedEntryId:string

readOnly

ID of the entry that will be replaced when the replacement approved and this entry is ready

replacementStatus:string
Enum: NONE [0], APPROVED_BUT_NOT_READY [1], READY_BUT_NOT_APPROVED [2], NOT_READY_AND_NOT_APPROVED [3], FAILED [4]

readOnly

Enum Type: KalturaEntryReplacementStatus

Status of the replacement readiness and approval

replacingEntryId:string

readOnly

ID of temporary entry that will replace this entry when it's approved and ready for replacement

rootEntryId:string

readOnly

ID of source root entry, used for clipped, skipped and cropped entries that created from another entry

searchText:string

readOnly

Indexed search text for full text search

startDate:integer

Entry scheduling start date (null when not set, send -1 to remove)

status:string
Enum: ERROR_IMPORTING [-2], ERROR_CONVERTING [-1], SCAN_FAILURE [virusScan.ScanFailure], IMPORT [0], INFECTED [virusScan.Infected], PRECONVERT [1], READY [2], DELETED [3], PENDING [4], MODERATE [5], BLOCKED [6], NO_CONTENT [7]

readOnly

Enum Type: KalturaEntryStatus

tags:string

Entry tags

templateEntryId:string

insertOnly

Template entry id

thumbnailUrl:string

readOnly

Thumbnail URL

totalRank:integer

readOnly

The sum of all rank values submitted to the baseEntry.anonymousRank action

type:string
Enum: AUTOMATIC [-1], CONFERENCE_ENTRY_SERVER [conference.CONFERENCE_ENTRY_SERVER], EXTERNAL_MEDIA [externalMedia.externalMedia], SIP_ENTRY_SERVER [sip.SIP_ENTRY_SERVER], MEDIA_CLIP [1], MIX [2], PLAYLIST [5], DATA [6], LIVE_STREAM [7], LIVE_CHANNEL [8], DOCUMENT [10]

Enum Type: KalturaEntryType

The type of the entry, this is auto filled by the derived entry object

updatedAt:integer

readOnly

Entry update date as Unix timestamp (In seconds)

userId:string

The ID of the user who is the owner of this entry

version:integer

readOnly

Version of the entry data

votes:integer

readOnly

A count of all requests made to the baseEntry.anonymousRank action

KalturaBaseEntryListResponse must also match all of:
object:KalturaListResponse