Kaltura API Documentationcategory.exportToCsv

Creates a batch job that sends an email with a link to download a CSV containing a list of categories

Try it out
post https://www.kaltura.com/api_v3/service/category/action/exportToCsv

Request Parameters

body:object
object
additionalFields:array[object:KalturaCsvAdditionalFieldInfo]
object:KalturaCsvAdditionalFieldInfo
fieldName:string
xpath:string
filter:object:KalturaCategoryFilter
ancestorIdIn:string

not includes the category itself (only sub categories)

freeText:string
fullNameStartsWithIn:string
idOrInheritedParentIdIn:string
managerEqual:string
memberEqual:string
membersIn:string
nameOrReferenceIdStartsWith:string
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], DEPTH_ASC [+depth], DIRECT_ENTRIES_COUNT_ASC [+directEntriesCount], DIRECT_SUB_CATEGORIES_COUNT_ASC [+directSubCategoriesCount], ENTRIES_COUNT_ASC [+entriesCount], FULL_NAME_ASC [+fullName], MEMBERS_COUNT_ASC [+membersCount], NAME_ASC [+name], PARTNER_SORT_VALUE_ASC [+partnerSortValue], UPDATED_AT_ASC [+updatedAt], CREATED_AT_DESC [-createdAt], DEPTH_DESC [-depth], DIRECT_ENTRIES_COUNT_DESC [-directEntriesCount], DIRECT_SUB_CATEGORIES_COUNT_DESC [-directSubCategoriesCount], ENTRIES_COUNT_DESC [-entriesCount], FULL_NAME_DESC [-fullName], MEMBERS_COUNT_DESC [-membersCount], NAME_DESC [-name], PARTNER_SORT_VALUE_DESC [-partnerSortValue], UPDATED_AT_DESC [-updatedAt]
KalturaCategoryFilter must also match all of:
object:KalturaCategoryBaseFilter
mappedFields:array[object:KalturaKeyValue]
object:KalturaKeyValue

A key value pair representation to return an array of key-value pairs (associative array)

key:string
objectType:string
Enum: KalturaKeyValue, KalturaKeyValueExtended
value:string
KalturaKeyValue must also match any of:
object:KalturaKeyValueobject:KalturaKeyValueExtended
metadataProfileId:integer
options:object:KalturaExportToCsvOptions
defaultHeader:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]

Enum Type: KalturaNullableBoolean

format:string

The format of the outputted date string. There are also several predefined date constants that may be used instead, so for example DATE_RSS contains the format string 'D, d M Y H:i:s'.

https://www.php.net/manual/en/function.date.php

typeEqual: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

Setting this property will cause additional columns to be added to the final report. The columns will be related to the specific object type passed (currently only MEDIA_CLIP is supported).

Please note that this property will NOT change the result filter in any way (i.e passing MEDIA_CLIP here will not force the report to return only media items).

Response

Success

string