Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.

Video

Video Service

Service for retrieving still images of videos, both embedded or not, and information about embedded videos. Use the Content Service (i.e. /contents) for creating, updating and deleting regular videos.

Availability:

Available only when the Video plugin is installed in this Jive instance

Since: 3.1
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.

Get Embedded Video

GET /videos/embedded/{videoID}/contentType/{contentType}/contentID/{contentID}

Return the specified embedded video with the specified fields. The parameters contentType and contentID are usually obtained from the body of the content object that contains the embedded video. In the body look for a macro named 'jive-content-video' and in particular for the attributes 'data-object-type', 'data-object-id' and 'data-video-ids'.

Path Parameters:
NameTypeRequiredDescription
videoIDStringtrueThe ID of the embedded video to be returned (obtained from 'data-video-id')
contentTypeStringtrueThe ID that represents the type of content that contains the video (obtained from 'data-object-type')
contentIDStringtrueThe ID of the content that contains the video (obtained from 'data-object-id')
Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseThe fields to be returned
Retrieves:
  • A Video containing the specified video
  • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)If any input field is malformed
    403 (Forbidden)If you are not allowed to access the specified content object
    404 (Not Found)If the specified content does not exist
    Requires ModuleWhat's this?
    This capability is implemented by a Jive Module.
    This feature may not be available on all Jive instances.

    Get Video Image

    GET /videos/images/{videoID}

    Return the still image of the specified video as binary content and scaled to the requested size.

    Path Parameters:
    NameTypeRequiredDescription
    videoIDStringtruethe ID of the video to return its still image
    Query Parameters:
    NameTypeRequiredDescription
    sizeIntegerfalsesize to scale the video to. By default this is 520.
    Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)if an input parameter is missing or malformed
    403 (Forbidden)if the requesting user is not allowed to retrieve this image
    500 (Internal Server Error)if an I/O error occurs while processing this image
    404 (Not Found)if the requested video does not exist