Loading ...

REST API: Create Video | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Videos » REST API: Create Video
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 5

REST API: Create Video

0 
 /5
0 (0votes)

Create Video

POST /api/videos

Creates a new video. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
EntityType Used in the request body Entity Type of the entity. Here is the value of EntityType parameter for video:
  • Video = 7
CategoryID Used in the request body

Specifies the category of the video.
SpaceID Used in the request body Unique ID of the space. Space ID should be 0 for Top Level Community and 1 for any space.
ContentTitle Used in the request body Title of the video.
ContentBody Used in the request body Body of the video.
ContentSummary Used in the request body Summary of the video.
Optional parameters How to use Description
IsFeatured Used in the request body Used to mark video as featured.
Possible values:
  • false
  • true
AllowAnonymousComments Used in the request body It allows anonymous users to comment to the entity.
Possible values:
  • false
  • true
RequiresReadConfirmation Used in the request body Set it to true if Content is required to read.

Example URL: https://your-community.com/api/videos

Response JSON sample where video JSON object is returned as ResponseData


{
  "IsError": false,
  "ResponseData": {
    "ContentID": 87,
    "EntityType": 7,
    "ContentTypeID": 0,
    "ContentTitle": "video",
    "ContentStub": "video",
    "ContentBody": "body",
    "ContentSummary": "summary of the video",
    "AuthorID": 4,
    "AuthorUserName": "aparna",
    "UpdatedByUserID": 4,
    "CategoryID": 4,
    "ContentVersionID": 1,
    "SpaceID": 0,
    "WorkflowID": 0,
    "CurrentWorkflowStepID": 0,
    "StatusID": 1,
    "DateCreated": "2019-01-08T06:06:19.0045151Z",
    "DatePublished": "2019-01-08T06:06:29.1133158Z",
    "DateUpdated": "2019-01-08T06:06:19.0045151Z",
    "IsFeatured": false,
    "ViewCount": 0,
    "CommentCount": 0,
    "Rating": 0,
    "MetaTitle": "video",
    "MetaDescription": "summary of the video",
    "MetaKeywords": "",
    "ContentFeaturedImage": "65026557-9b24-4f35-9d12-b0a6c0d47ec5_thumb.jpg",
    "ContentThumbImage": "65026557-9b24-4f35-9d12-b0a6c0d47ec5_thumb.jpg",
    "AllowAnonymousComments": false,
    "AllowRating": true,
    "ContentMediaServerID": 4,
    "ExternalContentType": 0,
    "ContentMediaFileName": "65026557-9b24-4f35-9d12-b0a6c0d47ec5.jpg",
    "IsLatest": false,
    "TagsCSV": "",
    "ContentURL": "https://your-community.com/video/video/87",
    "IsPublishedFromDraftMode": false,
    "IsPublishedFromDelayedPublishingMode": false,
    "IsPublishedFromUnderProcessingMode": false,
    "IsWallContent": false,
    "RequiresReadConfirmation": false,
    "HasRead": false,
    "IsEditable": true,
    "IsDeletable": true,
    "IsDownloadable": true,
    "IsChekoutable": false,
    "IsUndochekoutable": false,
    "IsChekinable": false,
    "IsRestoreable": false,
    "IsPurgeable": false,
    "IsHistoryViewable": false,
    "IsMoveable": false,
    "ViewerVote": 0,
    "IsDirectory": false,
    "IsActivityStreamAlbum": false,
    "LastChildAuthorUserID": 0,
    "LastGrandChildAuthorUserID": 0,
    "IsContentAvailablePostExpiry": false,
    "TenantID": 1
   }
}

Please Note Your content type that you pass in the header of your request should be 'multipart/form-data'.

Wiki Index

Pages

Intranet Software