Kaltura API DocumentationbaseEntry.recycle

Move the entry to the recycle bin

Try it out
post https://www.kaltura.com/api_v3/service/baseentry/action/recycle

Request Parameters

body:object
object
entryId*:string

Response

Success

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

application:string
Enum: KMC [0], KMS [1], KAF [2], PITCH [3], KMS_GO [4], WEBCAST_APP [5], PERSONAL_CAPTURE [6], KALTURA_MEETING [7], EP [8]

insertOnly

Enum Type: KalturaEntryApplication

Entry application

applicationVersion:string

insertOnly

Entry application version

blockAutoTranscript:boolean

Block auto transcript on Entry

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: RECYCLED [-2], 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

multiLingual_description:array[object:KalturaMultiLingualString]
object:KalturaMultiLingualString

A Multi Lingual String

language:string

The language of the value

value:string

Value

multiLingual_name:array[object:KalturaMultiLingualString]
object:KalturaMultiLingualString

A Multi Lingual String

language:string

The language of the value

value:string

Value

multiLingual_tags:array[object:KalturaMultiLingualString]
object:KalturaMultiLingualString

A Multi Lingual String

language:string

The language of the value

value:string

Value

name:string

Entry name (Min 1 chars)

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

abstract

Base class to all operation attributes types

objectType:string
Enum: KalturaClipAttributes, KalturaConcatAttributes
KalturaOperationAttributes must also match any of:
object:KalturaClipAttributesobject:KalturaConcatAttributes
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