Kaltura API Documentationcategory.add

Add new Category

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

Request Parameters

body:object
object
category*:object:KalturaCategory
aggregationCategories:string

List of aggregation channels the category belongs to

appearInList:integer
Enum: PARTNER_ONLY [1], CATEGORY_MEMBERS_ONLY [3]

Enum Type: KalturaAppearInListType

If category will be returned for list action.

contributionPolicy:integer
Enum: ALL [1], MEMBERS_WITH_CONTRIBUTION_PERMISSION [2]

Enum Type: KalturaContributionPolicyType

who can assign entries to this category

createdAt:integer

readOnly

Creation date as Unix timestamp (In seconds)

defaultOrderBy: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]

Enum Type: KalturaCategoryOrderBy

Enable client side applications to define how to sort the category child categories

defaultPermissionLevel:integer
Enum: MANAGER [0], MODERATOR [1], CONTRIBUTOR [2], MEMBER [3], NONE [4]

Enum Type: KalturaCategoryUserPermissionLevel

Default permissionLevel for new users

depth:integer

readOnly

description:string

Category description

directEntriesCount:integer

readOnly

Number of entries that belong to this category directly

directSubCategoriesCount:integer

readOnly

Number of direct children categories

entriesCount:integer

readOnly

Number of entries in this Category (including child categories)

fullIds:string

readOnly

The full ids of the Category

fullName:string

readOnly

The full name of the Category

id:integer

readOnly

The id of the Category

inheritanceType:integer
Enum: INHERIT [1], MANUAL [2]

Enum Type: KalturaInheritanceType

If Category members are inherited from parent category or set manualy.

inheritedParentId:integer

readOnly

The category id that this category inherit its members and members permission (for contribution and join)

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

Enum Type: KalturaNullableBoolean

Flag indicating that the category is an aggregation category

membersCount:integer

readOnly

Number of active members for this category

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

Enum Type: KalturaNullableBoolean

Moderation to add entries to this category by users that are not of permission level Manager or Moderator.

name:string

The name of the Category.

The following characters are not allowed: '<', '>', ','

owner:string

Category Owner (User id)

parentId:integer
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

pendingEntriesCount:integer

readOnly

Nunber of pending moderation entries

pendingMembersCount:integer

readOnly

Number of pending members for this category

privacy:integer
Enum: ALL [1], AUTHENTICATED_USERS [2], MEMBERS_ONLY [3]

Enum Type: KalturaPrivacyType

defines the privacy of the entries that assigned to this category

privacyContext:string

Set privacy context for search entries that assiged to private and public categories. the entries will be private if the search context is set with those categories.

privacyContexts:string

readOnly

comma separated parents that defines a privacyContext for search

referenceId:string

Category external id, controlled and managed by the partner.

status:integer
Enum: UPDATING [1], ACTIVE [2], DELETED [3], PURGED [4]

readOnly

Enum Type: KalturaCategoryStatus

Status

tags:string

Category tags

updatedAt:integer

readOnly

Update date as Unix timestamp (In seconds)

userJoinPolicy:integer
Enum: AUTO_JOIN [1], REQUEST_TO_JOIN [2], NOT_ALLOWED [3]

readOnly

Enum Type: KalturaUserJoinPolicyType

Who can ask to join this category

Response

Success

object:KalturaCategory
aggregationCategories:string

List of aggregation channels the category belongs to

appearInList:integer
Enum: PARTNER_ONLY [1], CATEGORY_MEMBERS_ONLY [3]

Enum Type: KalturaAppearInListType

If category will be returned for list action.

contributionPolicy:integer
Enum: ALL [1], MEMBERS_WITH_CONTRIBUTION_PERMISSION [2]

Enum Type: KalturaContributionPolicyType

who can assign entries to this category

createdAt:integer

readOnly

Creation date as Unix timestamp (In seconds)

defaultOrderBy: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]

Enum Type: KalturaCategoryOrderBy

Enable client side applications to define how to sort the category child categories

defaultPermissionLevel:integer
Enum: MANAGER [0], MODERATOR [1], CONTRIBUTOR [2], MEMBER [3], NONE [4]

Enum Type: KalturaCategoryUserPermissionLevel

Default permissionLevel for new users

depth:integer

readOnly

description:string

Category description

directEntriesCount:integer

readOnly

Number of entries that belong to this category directly

directSubCategoriesCount:integer

readOnly

Number of direct children categories

entriesCount:integer

readOnly

Number of entries in this Category (including child categories)

fullIds:string

readOnly

The full ids of the Category

fullName:string

readOnly

The full name of the Category

id:integer

readOnly

The id of the Category

inheritanceType:integer
Enum: INHERIT [1], MANUAL [2]

Enum Type: KalturaInheritanceType

If Category members are inherited from parent category or set manualy.

inheritedParentId:integer

readOnly

The category id that this category inherit its members and members permission (for contribution and join)

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

Enum Type: KalturaNullableBoolean

Flag indicating that the category is an aggregation category

membersCount:integer

readOnly

Number of active members for this category

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

Enum Type: KalturaNullableBoolean

Moderation to add entries to this category by users that are not of permission level Manager or Moderator.

name:string

The name of the Category.

The following characters are not allowed: '<', '>', ','

owner:string

Category Owner (User id)

parentId:integer
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

pendingEntriesCount:integer

readOnly

Nunber of pending moderation entries

pendingMembersCount:integer

readOnly

Number of pending members for this category

privacy:integer
Enum: ALL [1], AUTHENTICATED_USERS [2], MEMBERS_ONLY [3]

Enum Type: KalturaPrivacyType

defines the privacy of the entries that assigned to this category

privacyContext:string

Set privacy context for search entries that assiged to private and public categories. the entries will be private if the search context is set with those categories.

privacyContexts:string

readOnly

comma separated parents that defines a privacyContext for search

referenceId:string

Category external id, controlled and managed by the partner.

status:integer
Enum: UPDATING [1], ACTIVE [2], DELETED [3], PURGED [4]

readOnly

Enum Type: KalturaCategoryStatus

Status

tags:string

Category tags

updatedAt:integer

readOnly

Update date as Unix timestamp (In seconds)

userJoinPolicy:integer
Enum: AUTO_JOIN [1], REQUEST_TO_JOIN [2], NOT_ALLOWED [3]

readOnly

Enum Type: KalturaUserJoinPolicyType

Who can ask to join this category