Loading ...

REST API: Update Video | Communifire Documentation

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

REST API: Update Video

0 
 /5
0 (0votes)

Update Video

POST /api/videos/{contentid}

Update an existing video. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
PUT
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.
ContentID Used in the request URL Unique Identifier for the content to be updated.
Optional parameters How to use Description
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.
CategoryID Used in the request body

Specifies the category of the video.
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/7523

Response JSON sample where video JSON object is returned as ResponseData


{
  "IsError": false,
  "ResponseData": {
  "ContentID": 7523,
  "EntityType": 7,
  "ContentTypeID": 7,
  "ContentTitle": "Health Video",
  "ContentStub": "Health Video",
  "ContentBody": "Health Video",
  "ContentBodyUnprocessed": "Health Video",
  "ContentSummary": "Health Video",
  "AuthorID": 628,
  "AuthorUserName": "Aparna",
  "UpdatedByUserID": 628,
  "UpdatedByUserDisplayName": "Aparna Anand",
  "UpdatedByUserUsername": "Aparna",
  "UpdatedByUserEmail": "aparna@axerosolutions.com",
  "UpdatedByUserFirstName": "Aparna",
  "UpdatedByUserLastName": "Anand",
  "UpdatedByUserAvatarImageUrl": "https://your-community.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
  "UpdatedByUserProfileUrl": "https://your-community.com/people/aparna",
  "CategoryID": 993,
  "ContentVersionID": 1,
  "SpaceID": 0,
  "WorkflowID": 0,
  "CurrentWorkflowStepID": 0,
  "StatusID": 1,
  "DateCreated": "2019-04-11T06:41:17.777",
  "DatePublished": "2019-04-11T06:41:17.777",
  "DateUpdated": "2019-04-11T06:41:47.6757976Z",
  "IsFeatured": false,
  "ViewCount": 1,
  "CommentCount": 0,
  "Rating": 0,
  "MetaTitle": "Health Video",
  "MetaDescription": "Health video",
  "MetaKeywords": "",
  "ContentFeaturedImage": "19c92b96-b79e-431c-b8a5-58a9f8d9adea_thumb.jpg",
  "ContentThumbImage": "19c92b96-b79e-431c-b8a5-58a9f8d9adea_thumb.jpg",
  "ContentFeaturedImageFullURL": "https://your-community.com/Assets/Uploaded-Videos/26addd83-6dc0-43d0-8058-f904e778251b.png",
  "ContentThumbImageFullURL": "https://your-community.com/Assets/Uploaded-Videos/26addd83-6dc0-43d0-8058-f904e778251b.png",
  "PageH1Content": "",
  "HeadCustomContent": "",
  "SideBarContent": "",
  "ExtraSideBarContent": "",
  "AllowAnonymousComments": false,
  "AllowRating": true,
  "ContentMediaServerID": 4,
  "ExternalContentType": 0,
  "ContentMediaFileName": "19c92b96-b79e-431c-b8a5-58a9f8d9adea.mp4",
  "ContentMediaServerRootURL": "https://your-community.com/Assets/Uploaded-Videos",
  "CategoryName": "wall videos",
  "CategoryStub": "wall-videos",
  "AuthorDisplayName": "Aparna Anand",
  "AuthorEmail": "aparna@axerosolutions.com",
  "AuthorFirstName": "Aparna",
  "AuthorLastName": "Anand",
  "AuthorAvatarImageUrl": "https://your-community.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
  "AuthorProfileUrl": "https://your-community.com/people/aparna",
  "IsLatest": false,
  "TagsCSV": "",
  "DateCreatedString": "27 seconds ago",
  "DateCreatedShortString": "27 seconds ago",
  "DatePublishedString": "27 seconds ago",
  "DatePublishedShortString": "27 seconds ago",
  "DateUpdatedString": "27 seconds ago",
  "DateUpdatedShortString": "27 seconds ago",
  "ContentURL": "https://your-community.com/video/aparna/wall-videos/7523/video-by-aparna",
  "ContentVersionURL": "",
  "IsPublishedFromDraftMode": false,
  "IsPublishedFromDelayedPublishingMode": false,
  "ParentCategoryID": 0,
  "IsPublishedFromUnderProcessingMode": false,
  "IsWallContent": false,
  "RequiresReadConfirmation": false,
  "HasRead": false,
  "ContentTypeIconCSSClass": "icon-facetime-video",
  "IsEditable": true,
  "IsDeletable": true,
  "IsDownloadable": true,
  "IsChekoutable": false,
  "IsUndochekoutable": false,
  "IsChekinable": false,
  "IsRestoreable": false,
  "IsPurgeable": false,
  "IsHistoryViewable": false,
  "IsMoveable": false,
  "ContentMediaOnlineViewUrl": "",
  "ContentHistoryUrl": "",
  "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=7523&vid=1','Google Docs',800,600)",
  "ViewerVote": 0,
  "VoteCount": 0,
  "IsDirectory": false,
  "IsActivityStreamAlbum": false,
  "EmbedCode": "",
  "EmbedURL": "https://your-community.com/embed/7523",
  "LastChildAuthorUserID": 0,
  "LastGrandChildAuthorUserID": 0,
  "TotalChildRecords": 0,
  "TotalGrandChildRecords": 0,
  "IsSticky": false,
  "IsAnswered": false,
  "AuthorRankImageUrl": "https://your-community.com/Assets/Uploaded-Photos/rank-lurker.gif",
  "AuthorRankName": "Lurker",
  "IsContentAvailablePostExpiry": true,
  "ContentIDCode": "PewhW1XYrPeo%2FpoI75LrwA%3D%3D",
  "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