string

Mediasite ID of the template (read-only)

string

Name of the template

string

Long-form description of the template

bool

Flag indicating if presentations created from the template should have the play cover show a countdown timer when waiting for a live presentation to go live

bool

Flag indicating if presentations created from the template should have the play cover show Waiting to Begin mode rather than Live mode when a presentation status is Live but the presentation's air/record date has not been reached

bool

Flag determining if IsLive is set on presentations created from the template

bool

Flag determining if IsUploadAutomatic is set on presentations created from the template

bool

(Unused)

string

Windows registry key of the templates's time-zone

string

Mediasite ID of the template's parent folder

bool

Flag indicating if presentations created from the template should have the review-edit-approve workflow enabled

bool

Flag indicating if presentations created from the template take their permissions entirely from the template's policy or if it is merged with the parent folder's permissions

bool

Flag determining whether presentations created from the template are opted in to the future adaptive-capture functionality on the hardware Recorder.

Collection(SonicFoundry.Mediasite.WebApi.Model.ContentStreamRepresentation)

The collection of streams on the template. Each entry has 2 fields: StreamType (string, one of 'Video1', 'Video2', 'Video3', 'Slide'), and StreamName (string, may be null; the user-provided friendly name for the stream). This property is read-only.

None,CaptureApplicationDefault,NeverGenerate,Video1,Video2,Video3,Slide

Specify the source stream that should be used to generate the thumbnail for presentations that use this template.

bool

Flag indicating if DVR playback is enabled for the presentation.

int

Minutes after the broadcast ends that the DVR buffer should be removed.

Player

Player used by the template

Presenters

List of the presenters associated with the template

Tags

List of the tags associated with the template

SlideContent

List of all the slide content associated with the template (not available yet)

OnDemandContent

List of all the on-demand content associated with the template (not available yet)

BroadcastContent

List of all the broadcast content associated with the template (not available yet)

PodcastContent

The podcast content associated with the template.

PublishToGoContent

Publish to go content on the template; 404 if there is none.

OcrContent

List of all the OCR content associated with the template (not available yet)

CaptionContent

List of all the caption content associated with the template (not available yet)

VideoPodcastContent

List of all the video podcast content items associated with the template.

ExternalPublishingContent

List of all the external publishing content items associated with the template.

Modules

List of course modules containing the template. (To change the association of a module with a template, use PUT/PATCH to update the Associations property on the module to include or exclude the template, as needed.)

string

MediasiteId of the presentation

string

Title of the presentation

Offline,Record,Viewable,Recorded,ViewableOnDemand,OpenForRecord,Live,Transcoding,Recording,Unavailable

Data status of the presentation

Unknown,DesktopRecorder,MediaUpload,HardwareRecorder,ExternalMediaImport,Catch,None

Source of the presentation media

string

If the presentation is a shortcut, the MediasiteId of the shortcut's target presentation; otherwise same as Id (read-only)

RelatedPresentations

List of presentations ranked as similar to the presentation. The optional query-string parameter similarityType may be used to specify the kind of similarity: Tags, Presenters, or All. If not specified then All is assumed. If ShowcaseId is set in the header of the request, results will be limited to the specified showcase.

Tags

List of the tags associated with the presentation

TimedEvents

List of the timed events associated with the presentation. If ShowcaseId is specified in the header of the request, this can be retrieved anonymously from a showcase that has registration enabled.

InteractiveElements

List of the interactive elements associated with the presentation. If ShowcaseId is specified in the header of the request, this can be retrieved anonymously from a showcase that has registration enabled.

Presenters

List of the presenters associated with the presentation

Questions

List of the forum questions submitted by viewers of the presentation

ThumbnailContent

List of all the thumbnail images associated with the presentation. Items are returned in decreasing order of content revision. If ShowcaseId is specified in the header of the request, this will only return thumbnails associated with the specified showcase.

SlideContent

List of all the slide content items associated with the presentation. Items are returned in decreasing order of content revision.

SlideDetailsContent

If the presentation's current revision has a Slide stream, returns a list of all slides in it, annotated with number and position in the presentation, as well as title, description, and OCR text (when defined).

OnDemandContent

List of all the on-demand video associated with the presentation. Items are returned in decreasing order of content revision.

BroadcastContent

List of all the broadcast content associated with the presentation. Items are returned in decreasing order of content revision.

PodcastContent

List of all the podcast content associated with the presentation. Items are returned in decreasing order of content revision.

PublishToGoContent

Publish to go content on the head revision; 404 if there is none. This link requires either View on the presentation or access to the Publish To Go operation.

OcrContent

List of all the OCR content associated with the presentation. Items are returned in decreasing order of content revision.

CaptionContent

List of all the caption content associated with the presentation. Items are returned in decreasing order of content revision.

AudioPeaksContent

List of all the audio peaks data associated with the presentation. Items are returned in decreasing order of content revision.

LayoutOptions

Per-presentation player layout options for the presentation

EmailInvitation

Default email invitation for the presentation

ShowcaseChannels

List of Showcase channels containing the presentation

ShowcaseChannelsForAllInstances

List of Showcase channels containing either the presentation itself, or any shortcut to the same content. This will search within the default showcase unless ShowcaseId is specified in the header of the request.

VideoPodcastContent

List of all the video podcast content items associated with the presentation. Items are returned in decreasing order of content revision.

Modules

List of course modules containing the presentation. (To change the association of a module with a presentation, use PUT/PATCH to update the Associations property on the module to include or exclude the presentation, as needed.)

Tags

List of tags for the schedule

Recorder

Recorder used by the schedule

Player

Player used by the schedule

Folder

Parent folder of the schedule

SlideContent

List of all the slide content associated with the schedule (not available yet)

OnDemandContent

List of all the on-demand content associated with the schedule (not available yet)

BroadcastContent

List of all the broadcast content associated with the schedule (not available yet)

PodcastContent

List of all the podcast content associated with the schedule

PublishToGoContent

Publish to go content on the schedule; 404 if there is none.

OcrContent

List of all the OCR content associated with the schedule (not available yet)

CaptionContent

List of all the caption content associated with the schedule (not available yet)

VideoPodcastContent

List of all the video podcast content items associated with the schedule.

ExternalPublishingContent

List of all the external publishing content items associated with the schedule.

Modules

List of course modules containing the schedule. (To change the association of a module with a schedule, use PUT/PATCH to update the Associations property on the module to include or exclude the schedule, as needed.)

string

MediasiteId of the Recorder registration

string

Name assigned to the Recorder registration

string

Long-form description of Recorder registration

string

Serial number of the Recorder hardware

string

Version of Mediasite Recorder software installed on the Recorder

string

Root URL of the Recorder Management Web service

string

Encryption key for communication with Recorder

string

Recorder username for remote login

string

Recorder password for remote login

DateTime

Last date the Recorder software was updated

string

MAC address of the Recorder

string

Version of the image installed on the Recorder

int

Maximum number of simultaneous video streams the Recorder hardware is able to capture

string

Descriptor for the registered model of Recorder

string

A token that may be used for direct (not proxied via the Web API) communication with the Recorder, whether to launch the Recorder's remote interface or connect to the Recorder's own REST API. The level of access granted by the RecorderCode depends on the current user's permissions on the Recorder (Write or Monitor).

LicenseStatus

Structure representing whether the Recorder software is licensed

string

Status of the capture engine on the Recorder

ExtendedStatus

Structure representing current status of the Recorder engine and hardware; places less load on the Recorder than RecorderStatus

ActiveConnection

Structure containing the site root URL of the Recorder's current active connection. If there is no such connection, a 404 Not Found will be returned.

ActiveSchedulerConnection

Structure containing the site root URL of the Recorder's current active scheduler connection. If there is no such connection, a 404 Not Found will be returned.

ScheduledRecordingTimes

List of scheduled recordings for this Recorder, ordered by start-time. By default the list spans a week starting from the current day. The start-time of the query can be specified with a filter clause (StartTime ge datetime'YYYY-MM-DD') and the end-time with a clause (EndTime le datetime'YYYY-MM-DD'). Excluded recording sessions can be omitted from the result by including the filter clause (IsExcluded eq false).

ActiveInputs

Active hardware input(s) being used for the current recording.

SyncPresenceOnInputs

List of all inputs the device is aware of. Properties indicate which ones are currently in use as well as which ones currently have a signal.

CurrentPresentationMetadata

Metadata for the current recording including title, start datetime, and if a schedule is available, linked modules and presenter names.

TimeRemaining

Time in seconds remaining until the current presentation will auto-stop. A status value is returned if the current presentation will not auto-stop.

AudioLevels

The current audio level (decibels below full scale). Future: an RMS average of the last 5 seconds (dbfs).

string

MediasiteId of the Recorder registration

Unknown,Idle,Busy,RecordStart,Recording,RecordEnd,Pausing,Paused,Resuming,OpeningSession,ConfiguringDevices

Current state of the Recorder engine

string

MediasiteId of the Recorder registration

Unknown,Idle,Busy,RecordStart,Recording,RecordEnd,Pausing,Paused,Resuming,OpeningSession,ConfiguringDevices

Current state of the Recorder engine

None,Initializing,StartingServices,StartingRecordedPresentationHost,StartingRecorderHost,Ready,ShuttingDown

Current state of the Recorder system

bool

Indicates if Recorder is available for remote access

bool

Indicates if Recorder has a verified SSL certificate

bool

Indicates if Recorder has AMT enabled

bool

Indicates if Recorder has an AMT-usable network adapter

bool

Indicates if Recorder has the Recorder Update Service installed

bool

Indicates if Recorder has the Recorder Update Service currently running

bool

Indicates if the Recorder is of too low a version to support extended status queries

string

MediasiteId of the Recorder

DateTime

Start time (UTC) of the recording

DateTime

End time (UTC) of the recording

int

Duration in minutes of the recording

string

MediasiteId of the schedule the recording is based on

int

Id (integer) of the time zone used by the recording's parent schedule

int

Id of the recurrence within the schedule

bool

Flag indicating if the scheduled recording has been cancelled

string

Link to the API resource for the recording's schedule

string

Link to the API resource for the recording's recurrence

IEnumerable<SonicFoundry.Mediasite.WebApi.Model.ScheduleContentItem>

List of details about the schedule's content items.

string

MediasiteId of the Recorder registration

string

Collection of input connections with Type (Video1, Image, Audio, Video2, Video3) and Status (Init, NoDevices, ErrorAudioOnlyNoAudioDevice, ErrorNoVideoDevice, ErrorNoAudioDevice, ErrorEncoderPortInUse, ConfigurationError, ErrorNoVideoSignal, RecordAudio, RecordAudioVideo, PreviewAndRecordAudioVideo)

string

MediasiteId of the Recorder registration

string

Collection of inputs with Name, Type (Audio, Video, InterleavedAV, File, CombinedAV), and a boolean SignalDetected

string

MediasiteId of the Recorder registration

string

MediasiteId of the current schedule if one is being used

string

MediasiteId of the current presentation if it exists on the server

string

Title of the presentation

IEnumerable<string>

List of the presenters

DateTime

Time the presentation is scheduled to begin recording

string

MediasiteId of the Recorder registration

string

How many seconds are there remaining in the current recording (if the status is Normal)

Normal,AdHocRecording,RecordingNotStarted,NoAutoStop,RecordingExtended

Status of the current recording

string

MediasiteId of the Recorder registration

double

The average audio level over the past 5 seconds of the left audio channel in decibels relative to full scale

double

The average audio level over the past 5 seconds of the right audio channel in decibels relative to full scale

string

MediasiteId of the presentation statistics report

string

Name of the presentation statistics report

string

Long-form description of the presentation statistics report

string

Owner of the presentation statistics report

Custom,Today,LastWeek,LastMonth,LastYear,AllDates,Yesterday

Type of the report's date-range

DateTime

If the DateRangeType is Custom, the start of the custom date-range; otherwise this field is null

DateTime

If the DateRangeType is Custom, the end of the custom date-range; otherwise this field is null

int

Numeric ID of the report's time-zone

bool

Flag indicating if presentations with no views matching the report's date-range and filters are to be included in the report

bool

Flag indicating if views from the Management Portal's preview player are to be included in the report

bool

Flag indicating if views from My Mediasite's preview player are to be included in the report

bool

If the report has FolderIdList set, this flag determines if views for presentations in subfolders of filter folders are to be included

List<string>

List of MediasiteIds of presentations to filter the report with; if null, no presentation filtering is specified

List<string>

List of MediasiteIds of folders to filter the report with; if null, no folder filtering is specified

List<string>

List of MediasiteIds of channels to filter the report with; if null, no channel filtering is specified

List<string>

List of MediasiteIds of Showcases to filter the report with; if null, no Showcase filtering is specified

List<string>

List of display-names of presenters to filter the report with; if null, no presenter is specified

List<string>

List of names of users to filter the report with; if null, no username filtering is specified

List<SonicFoundry.Mediasite.WebApi.Model.IPAddressRangeForReport>

List of IP address ranges to filter the report with; if null, no IP address range filtering is specified. Each IPAddressRangeForReport consists of three fields: string IPAddressRangeType (value must be either 'Include' or 'Exclude'); string FromIPAddress (low address of the range, inclusive); string ToIPAddress (high address of the range, inclusive).

ReportRecurrence

Recurrence and notification information (if defined) for the report

string

MediasiteId of the presenter statistics report

string

Name of the presenter statistics report

string

Long-form description of the presenter statistics report

string

Owner of the presenter statistics report

Custom,Today,LastWeek,LastMonth,LastYear,AllDates,Yesterday

Type of the report's date-range

DateTime

If the DateRangeType is Custom, the start of the custom date-range; otherwise this field is null

DateTime

If the DateRangeType is Custom, the end of the custom date-range; otherwise this field is null

int

Numeric ID of the report's time-zone

bool

Flag indicating if presentations with no views matching the report's date-range and filters are to be included in the report

bool

Flag indicating if views from the Management Portal's preview player are to be included in the report

bool

Flag indicating if views from My Mediasite's preview player are to be included in the report

List<string>

List of display-names of presenters to filter the report with; if null, no presenter is specified

string

MediasiteId of the user statistics report

string

Name of the user statistics report

string

Long-form description of the user statistics report

string

Owner of the user statistics report

Custom,Today,LastWeek,LastMonth,LastYear,AllDates,Yesterday

Type of the report's date-range

DateTime

If the DateRangeType is Custom, the start of the custom date-range; otherwise this field is null

DateTime

If the DateRangeType is Custom, the end of the custom date-range; otherwise this field is null

int

Numeric ID of the report's time-zone

bool

Flag indicating if presentations with no views matching the report's date-range and filters are to be included in the report

bool

Flag indicating if views from the Management Portal's preview player are to be included in the report

bool

Flag indicating if views from My Mediasite's preview player are to be included in the report

bool

If the presentation has FolderIdList set, this flag determines if views for presentations in subfolders of filter folders are to be included

List<string>

List of MediasiteIds of presentations to filter the report with; if null, no presentation filtering is specified

List<string>

List of MediasiteIds of folders to filter the report with; if null, no folder filtering is specified

List<string>

List of MediasiteIds of channels to filter the report with; if null, no channel filtering is specified

List<string>

List of MediasiteIds of Showcases to filter the report with; if null, no Showcase filtering is specified

List<string>

List of display-names of presenters to filter the report with; if null, no presenter is specified

List<string>

List of names of users to filter the report with; if null, no username filtering is specified

List<SonicFoundry.Mediasite.WebApi.Model.IPAddressRangeForReport>

ReportRecurrence

Recurrence and notification information (if defined) for the report

string

MediasiteId of the video collection statistics report

string

Name of the video collection statistics report

string

Long-form description of the video collection statistics report

string

Owner of the video collection statistics report

Custom,Today,LastWeek,LastMonth,LastYear,AllDates,Yesterday

Type of the report's date-range

DateTime

If the DateRangeType is Custom, the start of the custom date-range; otherwise this field is null

DateTime

If the DateRangeType is Custom, the end of the custom date-range; otherwise this field is null

int

Numeric ID of the report's time-zone

List<string>

List of MediasiteIds of video collections (e.g., Showcase channels, Mediasite channels) to filter the report with; if null, no filtering by video collection is specified

ReportRecurrence

Recurrence and notification information (if defined) for the report

string

MediasiteId of the download statistics report

string

Name of the download statistics report

string

Long-form description of the download statistics report

string

Owner of the download statistics report

Custom,Today,LastWeek,LastMonth,LastYear,AllDates,Yesterday

Type of the report's date-range

DateTime

If the DateRangeType is Custom, the start of the custom date-range; otherwise this field is null

DateTime

If the DateRangeType is Custom, the end of the custom date-range; otherwise this field is null

int

Numeric ID of the report's time-zone

bool

Flag indicating if presentations with no downloads matching the report's date-range and filters are to be included in the report

bool

If the report has FolderIdList set, this flag determines if views for presentations in subfolders of filter folders are to be included

List<string>

List of MediasiteIds of presentations to filter the report with; if null, no presentation filtering is specified

List<string>

List of MediasiteIds of folders to filter the report with; if null, no folder filtering is specified

List<string>

List of MediasiteIds of channels to filter the report with; if null, no channel filtering is specified

List<string>

List of display-names of presenters to filter the report with; if null, no presenter is specified

List<string>

List of names of users to filter the report with; if null, no username filtering is specified

ReportRecurrence

Recurrence and notification information (if defined) for the report

string

MediasiteId of the authoring statistics report

string

Name of the authoring statistics report

string

Long-form description of the authoring statistics report

string

Owner of the authoring statistics report

Custom,Today,LastWeek,LastMonth,LastYear,AllDates,Yesterday

Type of the report's date-range

DateTime

If the DateRangeType is Custom, the start of the custom date-range; otherwise this field is null

DateTime

If the DateRangeType is Custom, the end of the custom date-range; otherwise this field is null

int

Numeric ID of the report's time-zone

bool

If the report has FolderIdList set, this flag determines if views for presentations in subfolders of filter folders are to be included

List<string>

List of MediasiteIds of folders to filter the report with; if null, no folder filtering is specified

List<string>

List of display-names of presenters to filter the report with; if null, no presenter is specified

ReportRecurrence

Recurrence and notification information (if defined) for the report

string

MediasiteId of the content storage report

string

Name of the content storage report

string

Long-form description of the content storage report

string

Owner of the content storage report

Custom,Today,LastWeek,LastMonth,LastYear,AllDates,Yesterday

Type of the report's date-range

DateTime

If the DateRangeType is Custom, the start of the custom date-range; otherwise this field is null

DateTime

If the DateRangeType is Custom, the end of the custom date-range; otherwise this field is null

int

Numeric ID of the report's time-zone

bool

If the report has FolderIdList set, this flag determines if storage for presentations in subfolders of filter folders are to be included

bool

Flag specifying whether presentations with only one content revision should be excluded from the report

bool

Flag specifying whether presentations with no archival content should be excluded from the report

bool

Flag specifying whether presentations under My Mediasite user folders should be excluded from the report

bool

Flag specifying whether presentations in the Recycle Bin should be included in the report

long?

If set, presentations whose total content size in bytes is smaller than the given threshold will be excluded from the report

List<string>

List of MediasiteIds of presentations to filter the report with; if null, no presentation filtering is specified

List<string>

List of MediasiteIds of folders to filter the report with; if null, no folder filtering is specified

List<string>

List of usernames of presentation owners to filter the report with; if null, no owner filtering is specified

string

MediasiteId of the My Mediasite storage report

string

Name of the My Mediasite storage report

string

Long-form description of the My Mediasite storage report

string

Owner of the My Mediasite storage report

Custom,Today,LastWeek,LastMonth,LastYear,AllDates,Yesterday

Type of the report's date-range

DateTime

If the DateRangeType is Custom, the start of the custom date-range; otherwise this field is null

DateTime

If the DateRangeType is Custom, the end of the custom date-range; otherwise this field is null

int

Numeric ID of the report's time-zone

bool

This flag determines whether only users over their storage quota will be included in the report

long?

If set, users whose total content size in bytes is smaller than the given threshold will be excluded from the report

List<string>

List of usernames of presentation owners to filter the report with; if null, no owner filtering is specified

string

MediasiteId of the player (read-only).

string

Owner of the player (read-only).

DateTime

Date and time when the playlist was created (read-only).

string

Date and time when the playlist was last modified (read-only).

string

Mediasite ID of the player's parent folder

bool

Flag indicating if the player is in the Recycle Bin

string

Name of the player.

string

Long-form description of the player.

string

Mediasite ID of the player's layout

string

Serialized layout options for the player

string

URL for the storage location of the player options file

string

Preview URL for the player

string

Alternate (friendly) name for the player

string

MediasiteId of the audio transcription profile

string

Name of the audio transcription profile

string

Long-form description of the audio transcription profile

string

Owner of the audio transcription profile

string

Name of the audio transcription template used by the profile

string

Username used for connection with the captioning provider

string

Language used for transcriptions

string

Service level sent to the captioning provider for transcriptions

string

Current version of the API.

DateTime

Publication date of current API version.

string

Qualifying prefix that remote sites will use for roles imported from this site through a Mediasite trust.

string

Human-readable name used by the site when participating in Mediasite trusts.

bool

Flag indicating if the logged-in user is authorized to create Mediasite trusts.

DateTime

Current time on server.

string

If currently authenticated, the name of the logged-in user; NULL otherwise.

string

If currently authenticated, the ID of the root Mediasite folder; NULL otherwise.

IEnumerable<string>

List of the custom metadata types currently enabled in the system.

int

Maximum number of allowed Player connections (site-wide).

int

Maximum number of allowed Player connections per user.

NowPlaying

Returns the presentations that are currently being broadcast live in the system. (NB: a string identifier must be provided when making this request. This can be any string.) If ShowcaseId is set in the request header, results will be limited to the specified showcase.

RecentlyViewed

Returns the presentations recently viewed by the current user, to a maximum of 20, most recently viewed first. (NB: a string identifier must be provided when making this request. This can be any string.) If ShowcaseId is set in the request header, results will be limited to the specified showcase.

string

MediasiteId of the site

string

Name to be displayed in the Showcase.

string

File name stored on the file server.

string

File name stored on the file server.

string

Theme that the user has provided.

string

HTML Content defined by the user to be inserted into the header of the Showcase pages.

string

HTML content defined by the user to be inserted into the bottom of the Showcase pages.

List<SonicFoundry.Mediasite.WebApi.Model.ShowcaseContentRepresentation>

Currently used for the Custom Footer Links.

int

Number of days for the Showcase to look back for recent videos.

None,Title,DateDesc,DateAsc

The Default Sort for the Spotlight Channel.

None,DateDesc,MostViewed,CurrentlyLive,DateAsc

The Default Sort for Recent Videos.

None,Title,DateDesc,MostViewed,ChannelName,DateAsc

The Default Sort for Recent Channels.

None,Title,Relevance,DateDesc,DateAsc

The Default Sort for Video Search Results.

None,Title,Relevance,DateDesc,DateAsc

The Default Sort for Channel Search Results.

None,Title,DateDesc,DateAsc

The Default Sort for browsing videos.

None,Title,DateDesc,DateAsc

The Default Sort for browsing channels.

None,Title,Relevance,DateDesc,DateAsc

The Default Sort for searching channel videos.

FullSite,OnlyListedChannels

The search scope for the Showcase public search.

string

Custom desctriptor for recent channels displayed in this showcase

string

Link for the logo in the Showcase app.

bool

Open the logo link in a new window.

string

Link for the right logo in the Showcase app.

bool

Open the right logo link in a new window.

string

Scope Query Parameter for Showcase Searches.

string

Scope Various API Calls to the following Mediasite Folder Ids.

bool

Flag indicating if this showcase uses showcase registration

bool

Flag indicating if this showcase should use the blanket mediasite registration

string

Url for the Showcase Registration Page (if enabled)

string

MediasiteId of the quota policy (read-only)

string

Name of the policy

string

Description of the policy

DateTime

Last modified date of the policy (UTC) in ISO 8601 format (read-only)

DateTime

Last modified date of the policy (UTC) in ISO 8601 format (read-only)

string

Owner of the policy (read-only)

double

Number of bytes total assigned to the user

double

Number of bytes at which the user may be warned that they are approaching their storage limit

double

Number of bytes of storage used that counts against the user's quota

None,WithinLimits,NearingThreshold,Exceeded,WithinLimitsAfterExceeded

Current quota compliance status of the user

Nothing,DisableCreatePresentations

Action to be taken when the user goes over quota

bool

Flag indicating if the user will be notified via email upon exceeding their threshold quota

bool

Flag indicating if the user will be notified via email upon exceeding their assigned quota

bool

Flag indicating if the user will be notified via email upon returning their usage below their assigned quota after exceeding it

string

MediasiteId of the quota level (read-only)

string

Name of the level

string

Description of the level

DateTime

Last modified date of the level (UTC) in ISO 8601 format (read-only)

DateTime

Last modified date of the level (UTC) in ISO 8601 format (read-only)

string

Owner of the level (read-only)

double

Number of bytes total to be assigned to a user

double

Number of bytes at which a user may be warned that they are approaching their storage limit

Nothing,DisableCreatePresentations

Action to be taken when the user goes over quota

bool

Flag indicating if a user will be notified via email upon exceeding their threshold quota

bool

Flag indicating if a user will be notified via email upon exceeding their assigned quota

bool

Flag indicating if a user will be notified via email upon returning their usage below their assigned quota after exceeding it

bool

Flag indicating if the terms and conditions object is currently available for use, or is archived

string

Text of the terms and conditions to be displayed in the user interface, in Markdown format

string

Long-form description of the presentation

DateTime

Record date of the presentation (UTC) in ISO 8601 format

DateTime

Record date of the presentation (in the presentation's time zone) in ISO 8601 format

int

Total duration of the presentation in milliseconds

int

Number of times the presentation has been viewed

string

Owner of the presentation

string

Creator of the presentation

string

Display name of the primary presenter

string

URL of the presentation thumbnail; null if no thumbnail is set

string

MediasiteId of the player set on the presentation

string

When creating a presentation, set this property to use the specified template to create the presentation. It will always be null when reading.

string

Alternate name of the presentation (unused)

string

int

Maximum number of simultaneous playback sessions allowed for the presentation

string

Name of the CDN publishing point used for live distribution of the presentation

bool

Flag determining whether the Recorder automatically publishes the presentation once recording is complete

string

Time-zone of the presentation

bool

Flag determining whether polls are enabled on the presentation during playback

bool

Flag determining whether the play cover will show a countdown timer when waiting for a live presentation to go live

bool

Flag determining whether the play cover will show Waiting to Begin mode rather than Live mode when a presentation status is Live but the presentation's air/record date has not been reached

bool

Flag determining whether Q&A is enabled on the presentation during playback

bool

Flag determining whether viewers of the presentation can send invitations to view it

bool

Flag determining whether the player on the presentation is locked to prevent overriding

bool

Flag determining whether Mediasite polls will be used or a link to an external poll will be provided

bool

Flag determining whether the presentation is private or viewable to others

bool

(Unused)

Unknown,ReviewRequired,ChangesRequired,Approved

Approval state of presentation in the review-edit-approve workflow

None,DefaultApprovalChanges,DefaultNotificationChanges

(Unused)

bool

Flag determining whether the presentation is approved (only relevant under review-edit-approve workflow)

int

The number of the presentation's head content revision (read-only)

string

URL for external presentation poll

string

Name of the presentation's parent folder (read-only)

string

MediasiteId of the presentation's parent folder

DateTime

Actual date the presentation was recorded, if available; otherwise same as RecordDate

bool

Flag indicating if the presentation is set up for live

NotAvailable,ScheduledForLive,OpenForLive,Live,LiveEnded,OnDemand,LivePaused

Status of the presentation relevant to playback

Collection(SonicFoundry.Mediasite.WebApi.Model.ApiCustomFieldValue)

Custom-field values set for the presentation. Each entry has 4 fields: FieldName (string), FieldDefinitionId (MediasiteId of the custom field definition), DataType (string, one of), and Value (string - the actual custom value). This property is read-only; custom field values may be set, updated, and deleted for the presentation using the /CustomFieldValues endpoint.

IEnumerable<string>

Tags as a list of strings. This is a read-only property; use the Tags navigation property to update tags on a presentation.

bool

Flag indicating if the presentation's head revision has completed all pending content work.

Int64

The Mediasite system's most recent calculation of the total amount of storage (in bytes) used by the presentation.

Collection(SonicFoundry.Mediasite.WebApi.Model.ExternalLinkRepresentation)

External links on the presentation as an ordered list. Each entry has 3 fields: Order (int), Name (string), Url (string).

Collection(SonicFoundry.Mediasite.WebApi.Model.ContentStreamRepresentation)

The collection of streams on the head revision of the presentation. Each entry has 2 fields: StreamType (string, one of 'Video1', 'Video2', 'Video3', 'Slide'), and StreamName (string, may be null; the user-provided friendly name for the stream). This property is read-only.

bool

Flag determining whether the presentation is opted in to the future adaptive-capture functionality on the hardware Recorder.

Unchangeable,Open

The type of discussion that is allowed on annotations of the presentation.

bool

Flag indicating if the permissions are inherited from the parent folder

None,CaptureApplicationDefault,NeverGenerate,Video1,Video2,Video3,Slide

Specify the source stream that should be used to generate the presentation thumbnail.

bool

Flag indicating if DVR playback is enabled for the presentation.

int

Minutes after the broadcast ends that the DVR buffer should be removed.

string

MediasiteId of the entity the options are set for

bool

Structure of two boolean flags: AllowOverride, indicating if the setting can be overriden at the presentation level, and Value, indicating whether presentation metadata should be available in the Player during playback

bool

Structure of two boolean flags: AllowOverride, indicating if the setting can be overriden at the presentation level, and Value, indicating whether presentation air date should be available in the Player during playback

bool

Flag indicating whether a user has permission to add annotations to the presentation.

bool

Flag indicating whether a user has permission to moderate annotations on the presentation.

string

The live RTMP server URL.

string

The live RTMP stream key.

string

MediasiteId of the presentation

string

Title of the presentation

Offline,Record,Viewable,Recorded,ViewableOnDemand,OpenForRecord,Live,Transcoding,Recording,Unavailable

Data status of the presentation

Unknown,DesktopRecorder,MediaUpload,HardwareRecorder,ExternalMediaImport,None

Source of the presentation media

string

If the presentation is a shortcut, the MediasiteId of the shortcut's target presentation; otherwise same as Id (read-only)

string

Long-form description of the presentation

DateTime

Record date of the presentation (UTC) in ISO 8601 format

DateTime

Record date of the presentation (in the presentation's time zone) in ISO 8601 format

int

Total duration of the presentation in seconds

int

Number of times the presentation has been viewed

string

Owner of the presentation

string

Creator of the presentation

string

Display name of the primary presenter

string

URL of the presentation thumbnail; null if no thumbnail is set

string

MediasiteId of the player set on the presentation

string

When creating a presentation, set this property to use the specified template to create the presentation. It will always be null when reading.

string

Alternate name of the presentation (unused)

string

int

Maximum number of simultaneous playback sessions allowed for the presentation

string

Name of the CDN publishing point used for live distribution of the presentation

bool

Flag determining whether the Recorder automatically publishes the presentation once recording is complete

string

Time-zone of the presentation

bool

Flag determining whether polls are enabled on the presentation during playback

bool

Flag determining whether Q&A is enabled on the presentation during playback

bool

Flag determining whether the play cover will show a countdown timer when waiting for a live presentation to go live

bool

Flag determining whether the play cover will show Waiting to Begin mode rather than Live mode when a presentation status is Live but the presentation's air/record date has not been reached

bool

Flag determining whether viewers of the presentation can send invitations to view it

bool

Flag determining whether the player on the presentation is locked to prevent overriding

bool

Flag determining whether Mediasite polls will be used or a link to an external poll will be provided

bool

Flag determining whether the presentation is private or viewable to others

bool

(Unused)

Unknown,ReviewRequired,ChangesRequired,Approved

Approval state of presentation in the review-edit-approve workflow

None,DefaultApprovalChanges,DefaultNotificationChanges

(Unused)

bool

Flag determining whether the presentation is approved (only relevant under review-edit-approve workflow)

int

The number of the presentation's head content revision (read-only)

string

URL for external presentation poll

string

Name of the presentation's parent folder (read-only)

string

MediasiteId of the presentation's parent folder

DateTime

Actual date the presentation was recorded, if available; otherwise same as RecordDate

bool

Flag indicating if the presentation is set up for live

NotAvailable,ScheduledForLive,OpenForLive,Live,LiveEnded,OnDemand,LivePaused

Status of the presentation relevant to playback

IEnumerable<string>

Tags as a list of strings. This is a read-only property; use the Tags navigation property to update tags on a presentation.

bool

Flag indicating if the presentation's head revision has completed all pending content work.

string

MediasiteId of the folder (read-only)

string

Name of the folder (cannot be empty)

string

Owner of the folder (read-only)

string

Long-form description of the folder

DateTime

Creation date of the folder in ISO 8601 format (read-only)

DateTime

Last modified date of the folder in ISO 8601 format (read-only)

string

MediasiteId of the folder's parent folder (cannot be empty)

bool

Flag indicating if the folder is in the Recycle Bin

None,Root,RecycleBin,Folder,SystemFolder,ReviewEditApproveEnabled,MyMediasiteRoot,MyMediasiteUserRoot,MyMediasiteUserFolder,Shared,CopyDestination

Combination of values describing the type of the folder. Read-only.

bool

Flag indicating if the folder is shared

bool

Flag indicating if the folder is marked as a copy destination

bool

Flag indicating if the folder is in the review-edit-approve workflow

Presentations

List of presentations and shortcuts in the folder

string

MediasiteId of the job (read-only)

Successful,Queued,Working,Disabled,Failed,Canceled

Current status of the job

string

Human-readable status message for the job

Mediasite.MediaImportWithTranscode.MultiFormatMediaUpload.7_0_0,Mediasite.MediaImportWithTranscode.MediaUpload.7_0_0,Mediasite.System.DeleteFolder.7_0_0,Mediasite.System.UpdateResourcePermissions.7_0_0,Mediasite.Vodcast.CreateVodcast.7_0_8

Type of the job

string

The identifier (this will be automatically created)

string

This is a vendor specific name for this timed event type in order to categorize it. Use your vendor name in the type to avoid collisions.

string

This is a string that you can provide in anyway that you need. We do not evaluate this payload. It is for integration only.

Int32

The time, in seconds, that this event is assigned to.

string

For future use.

string

The Id of the presentation that this event should be assigned to.

string

The identifier (this will be automatically created)

Hotspot,Button,Text

The type of interactive element

string

Name of the interactive element

Int32

The time, in milliseconds, that this interactive element starts

Int32

The time, in milliseconds, that this interactive element ends

double

X position of the interactive element from 0.0 to 1.0

double

Y position of the interactive element from 0.0 to 1.0

string

Primary color of the interactive element; must be in 32-bit hexadecimal RGB format (#xxxxxx) or (xxxxxx)

string

Secondary color of the interactive element; must be in 32-bit hexadecimal RGB format (#xxxxxx) or (xxxxxx)

double

Opacity of the interactive element as a percentage from 0 to 100

bool

Flag indicating whether the element's fill value (Hotspots only)

double

Width of the interactive element from 0.0 to 1.0 (Hotspot or Text elements only)

double

Height of the interactive element from 0.0 to 1.0 (Hotspot or Text elements only)

Small,Medium,Large

Button size of interactive element (Button elements only)

string

Text on the interactive element (Buttons or Text elements only)

Start,Center,End

Alignment of text on interactive element (Text elements only)

Small,Medium,Large

Text size on interactive element (Text elements only)

Circle,Rectangle

Shape of interactive element (Hotspots only)

LinkNewPresentation,TimeInCurrentPresentation,ExternalUrl

The effect of navigating the link for the interactive element (Hotspot or Button elements only)

string

For LinkNewPresentation interactions, this is a presentation ID. For TimeInCurrentPresentation interactions, this is the time in seconds to skip to. For ExternalUrl interactions, this is the URL to navigate to. (Hotspot or Button elements only)

bool

Flag indicating whether the video should pause on interaction start

string

The Id of the presentation that this interactive element should be assigned to.

string

MediasiteId of the content server (read-only)

string

Name of the content server

Unknown,MediasiteData,SlideServer,PublishToGoServer,WmsOnDemandServer,WmsUnicastPullServer,WmsMulticastPullServer,WmsUnicastPushServer,CustomPullServer,CustomPushServer,IIsProgressiveServer,IIsMediaPushServer,IIsMediaOnDemandServer,IIsMediaPullServer,SmoothStreamingCustomPullServer,SmoothStreamingCustomPushServer,RtmpContentServer,DeliverLiveRtmpServer

Type of the content server (read-only)

StorageEndpoint

Storage connection settings for a non-broadcast content server

DistributionEndpoint

Distribution settings for a live or on-demand content server

string

MediasiteId of the content encoding setting (read-only)

string

Owner of the content encoding setting (read-only)

DateTime

Date and time when the content encoding setting was created (read-only)

DateTime

Date and time when the content encoding setting was last modified (read-only)

string

MediasiteId of the content encoding setting's parent folder (read-only)

bool

Flag indicating if the content encoding setting is in the Recycle Bin (read-only)

string

Name of the content encoding setting

string

Long-form description of the content encoding setting

string

MIME type of the content encoding setting (read-only)

string

Serialized XML settings on the content encoding setting (read-only)

EncodingSettingsFilters

List of filters for the content encoding setting (H.264 settings only)

EncodingStreamDescriptions

List of stream descriptions for the content encoding setting (H.264 settings only)

string

User name attached to the authorization ticket

string

IP address of the client that can use the authorization ticket; may be null to allow it to be used anywhere

string

Name of the user who created the authorization ticket (read-only)

DateTime

Date and time that the authorization ticket was created (read-only)

DateTime

Date and time that the authorization ticket expires (read-only)

string

MediasiteId of the resource the the authorization ticket allows access to

int

Number of minutes after creation that the authorization ticket will remain valid

int

Id of the recurrence

string

MediasiteId of the schedule the recurrence belongs to

int

Duration of the scheduled recording in milliseconds

DateTime

UTC Date and time when the recurrence begins

DateTime

Date and time when the recurrence ends (time will be set to 11:59:59 PM of the schedule's local time zone)

None,Daily,Weekly,Monthly,Yearly

Which pattern the recurrence follows

DateTime

Date and time of the next scheduled instance of the recurrence (this does not need to be set at create time)

int

Type of the schedule's recurrence pattern (0 for Simple, 1 for Long)

int

For all repeating recurrence patterns, specifies that the recurrence happens every RecurrenceFrequency units of the pattern. (2 means every 2 days for Daily, every 2 weeks for Weekly, etc.)

bool

For Daily recurrences, specifies if recordings are only to be scheduled on weekdays

None,Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday

For Weekly recurrences, specifies which days of the week the recurrence falls on. Days are separated by '|', so e.g. 'Monday', 'Tuesday|Thursday' are valid settings. For Monthy and Yearly recurrences only a single day is valid.

None,First,Second,Third,Fourth,Last

For Monthly or Yearly recurrences, specifies which week of a month the recurrence falls on.

int

For Monthly or Yearly recurrences, specifies which day of a month the recurrence falls on.

None,January,February,March,April,May,June,July,August,September,October,November,December

For Yearly recurrences, specifies which month of a year the recurrence falls on.

bool

** DEPRECATED ** Field is unused and will only return false. ** OLD DOCUMENTATION ** Flag indicating if holidays are to be excluded from the recurrence

IEnumerable<SonicFoundry.Mediasite.WebApi.Model.ExcludeDateRangeRepresentation

A list (which may be empty) of ExcludeDateRangeRepresentation objects, each containing Start and End (DateTimes) and ExcludeId (integer). The ExcludeId is not necessary when creating or updating a recurrence. This specifies schedule-specific time windows when no recordings will be scheduled.

string

ID of the current site

int

Total number of connections

int

Total number of live connections

int

Total number of on-demand connections

int

Total number of presentations being watched

int

Total number of live presentations being watched

int

Total number of on-demand presentations being watched

int

Total number of distinct users watching now

int

Total number of distinct IP addresses watching now

string

Mediasite ID of the presentation

string

Title of the presentation

string

Mediasite ID of the presentation's parent folder

string

Name of the presentation's parent folder

int

Total number of current connections to the presentation

int

Total number of users currently watching the presentation

int

Total number of distinct IP addresses currently watching the presentation

ActiveSessions

List of details of all current viewing sessions for the presentation

string

MediasiteId of the user profile

string

Display name of the user profile

string

Email address uniquely associated with the profile

bool

Flag indicating if the profile is validated

string

Mediasite ID of the profile's home folder; null if the profile has no home folder.

bool

Flag indicating if the profile has a home folder. If NULL or not specified at creation time, the API defaults to the old behavior of creating a home folder; if set to true or false, that setting will be respected. For a profile with no home folder, this can be updated to true to prompt Mediasite to create a home folder for the profile. It is not possible to set it to false and remove a profile's home folder.

string

Email address to use for forum moderation notifications (defaults to Email if not set)

bool

Flag indicating if the profile is opted out of forum moderation notifications

booll

Flag indicating if the profile is opted out of notifications when user's private presentations are processed and ready for viewing

bool

Flag indicating if the profile is opted out of notifications when processing fails on user's private presentations are processed

bool

Flag indicating if the profile is opted out of notifications when the user becomes the new owner of a presentation

bool

Flag indicating if the profile is opted out of notifications when user's presentations are submitted for copying to a new folder

bool

Flag indicating if the profile is opted out of notifications when user's presentations are submitted for copying to a trusted server

bool

Flag indicating if the profile is opted out of notifications when user's presentation fails to be successfully copied to a trusted server

bool

Flag indicating if the profile is opted out of notifications when user's presentation fails to be successfully exported for copying to a trusted server

bool

Flag indicating if the profile is opted out of notifications when user's presentation has been successfully moved to a trusted server

bool

Flag indicating if the profile is opted out of notifications when user's presentation fails to be successfully moved to a trusted server

bool

Flag indicating if the profile is opted out of notifications when user's presentation or other resource has a comment posted to it

bool

Flag indicating if the profile is opted out of notifications when user's comment is flagged as offensive.

bool

Flag indicating if the profile is opted out of notifications when user's presentation or other resource has an annotation posted to it

bool

Flag indicating if the profile is opted out of notifications when user's annotation is flagged as offensive.

bool

Flag indicating if the profile is opted out of notifications when user's presentations captioning is completed.

bool

Flag indicating if the profile is opted out of notifications when user's presentations are scheduled to be archived or have been archived.

int

Maximum number of Recorder Interface windows that can be opened in a bulk operation in the Management Portal. When this is zero, the bulk operation is not available.

boolean

Nullable flag indicating if the user's Desktop Recorder uploads should be made immediately viewable after post-processing. If null, Mediasite will defer to the site-level setting. Note: this property cannot be set if the profile does not have a home folder.

boolean

Nullable flag indicating if the user's My Mediasite uploads should be made immediately viewable after post-processing. If null, Mediasite will defer to the site-level setting. Note: this property cannot be set if the profile does not have a home folder.

int

ID of the user profile's home time-zone

bool

First name of presenter information

bool

Middle name of presenter information

bool

Last name of presenter information

List<string>

Email address of presenter information

List<string>

Prefix of presenter information

List<string>

Suffix of presenter information

List<string>

Additional info of presenter information

List<string>

Biography link (must be valid URI) of presenter information

string

Trust-prefix-qualified identifier for the user profile (only populated when using the UserProfiles navigation property on OutboundTrusts)

QuotaPolicy

Quota policy for the user profile (if defined). May be modified by PUT, PATCH or the SetQuotaPolicyFromLevel action. Note that PUT and PATCH have slightly different semantics: if you are modifying a large number of profiles at a time, PUT should be used so that each edit does not trigger a job to recompute usage and status for the affected quota policy. If PATCH is used, this job will be created (unless one is already scheduled to run shortly).

Entitlements

Collection of entitlements granted to the user profile.

string

ID of the API key

string

Name of the application the key is issued for

int

Timeout in minutes of authentication tickets automatically created by the API when using this key (only used if CreateAuthTicketsForResources is TRUE)

bool

Flag indicating if the API key is system-created

bool

Flag indicating if viewing URLs for channels and presentations created by the API when using this key should have authentication tickets automatically created

bool

Flag indicating if the Web API should return a status code of 500 for authentication/authorization errors rather than 401

bool

Flag indicating if Private presentations not belonging to the current user should be excluded from API queries

bool

Flag indicating if the API key is an Enghouse-internal key (keys created via the API will never have this set to True)

bool

Flag indicating if the API key grants view access, rather than read access, to resources.

bool

Flag indicating if ThumbnailUrls generated for presentations and channels should have query-string parameters added to allow them to be served anonymously

bool

Flag indicating if the API key can be used to issue application tickets that allow upload to Desktop Recorder sessions on the server (keys created through the API will never have this set to True)

string

URI for the thumbnail file

string

MediasiteId of the content item

Unknown,Slides,Chapters,PresentationThumbnail,CaptionFile,OnDemandFile,BroadcastStream,PublishToGo,SlideOcr,Podcast,TimedEvents,AudioPeaks,Vodcast,ExternalPublishing,Rtmp,AudioDescriptions,OnDemandStream,OnDemandDownload,Composition,VideoLayout,PreviewThumbnails

Type of the content item

Unknown,Pending,Working,Completed,Error,Canceled,PendingManualCompletion,Inactive

Status of the content item

string

MIME type of the content item

int

(unused)

int

(unused)

string

Filename of the thumbnail

string

(unused)

string

MediasiteId of the content server for the thumbnail

int

(unused)

bool

(unused)

int

Number of the presentation content revision containing the thumbnail

string

Size in bytes of the thumbnail file

string

(unused)

string

Where to download the MP3 file, when it has been created

string

MediasiteId of the content item

string

Where to download the publish-to-go package, when it has been created

string

MediasiteId of the content item

IEnumerable<SlideDetails>

A list of SlideDetails objects, one per slide. This object contains: Number (number of the slide), TimeMilliseconds (slide's offset from the start of the presentation), Title (title of the slide, if any), Content (description of the slide, if any), OcrText (results of OCR of the slide, if any). Please note that OCR text is automatically generated and may differ from the actual text on the slide.

string

MediasiteId of the content item

string

Mediasite ID of the publishing project (read-only).

Unknown,YouTube

Type of the publishing project.

string

Name of the publishing project.

string

Long-form description of the publishing project.

string

Id of the Mediasite role

string

Name assigned to the role

string

Long-form description of the role

bool

Flag indicating if the role is built into the Mediasite system (read only)

string

Active Directory entry corresponding to the role (if any)

string

List of email addresses associated with the role separated by a semicolon

bool

Flag indicating if the role is an entitlement

string

MediasiteId of the entity

string

Owner of the entity

bool

Flag indicating if the entity inherits permissions from its parent folder

IEnumerable<SonicFoundry.Mediasite.WebApi.Model.AccessControlEntry>

List of access control entries for the resource. Each access control entry consists of the following fields: RoleId (string), PermissionMask (int), Read, Write, Execute, Approve, Moderate, Annotate, DenyRead, DenyWrite, DenyExecute, DenyApprove, DenyModerate, DenyAnnotate (all bool). When updating resource permissions, you may use either the PermissionMask or the flags to set a role's permissions, but not both.

string

MediasiteId of the resource

bool

True or false if Read is a valid bit for the resource, indicating the requesting user's effective permission; otherwise null.

bool

True or false if Execute is a valid bit for the resource, indicating the requesting user's effective permission; otherwise null. Note that in the UI the Execute bit has different names depending on the resource; for instance, it is called View for presentations and Monitor for Recorder registrations.

bool

True or false if Write is a valid bit for the resource, indicating the requesting user's effective permission; otherwise null.

bool

True or false if Moderate is a valid bit for the resource, indicating the requesting user's effective permission; otherwise null.

bool

True or false if Approve is a valid bit for the resource, indicating the requesting user's effective permission; otherwise null.

bool

True or false if Annotate is a valid bit for the resource, indicating the requesting user's effective permission; otherwise null.

string

MediasiteId of the video podcast project

string

Name of the video podcast project

string

Long-form description of the video podcast project

string

Name of the background image file (if any) to be used in video podcast generation

string

Name of the watermark image file (if any) to be used in video podcast generation

None,TopLeft,TopRight,BottomLeft,BottomRight,Stretched

Position of the watermark (if any) in generated video podcasts

string

Name of the video file (if any) to be placed at the start of generated video podcasts

string

Name of the video file (if any) to be placed at the end of generated video podcasts

bool

Flag indicating if the banner from the presentation should be included in the generated video podcast

AllStreamsResponsiveLayout,SlideAndAudio,SingleVideo,SingleVideoAndSlide

Specification of the layout used for the video podcast

OnePointFiveMbps,TwoPointFiveMbps,FourPointFiveMbps

Specification of the bit-rate to be used in encoding the video podcast

string

Mediasite ID of the module (read-only).

string

Course ID of the module (used for LMS integration)

string

Name of the module.

string

Long-form description of the module.

DateTime

Creation date and time (UTC) of the module (read-only).

DateTime

Last modified date and time (UTC) of the module (read-only).

string

Owner of the module (read-only).

IEnumerable<string>

List of entities the module is associated with. The API returns these in API resource URL format (e.g. "http://site.mediasite.com/mediasite/api/v1/MediasiteChannels('46f6ef5fa8bf4f59b1a714b1b05f60f621')"). The recommended way to associate a module with a Mediasite entity is with the AddAssociation action (see below), and the recommended way to sever that association is with the RemoveAssociation action. However, when updating the module, you can supply a list of Mediasite IDs either as API URLs or as IDs in URL string format, and this will completely replace the current associations for the module.

string

MediasiteId of the custom field definition

string

Name of the custom field definition

string

(For future development.)

string

The error message to display when field validation fails

string

For String-type custom field definitions, an optional regular expression specifying allowed values of the field. It will only be consulted when IsRegexRequired=true.

String,Integer,Decimal,DateTime,Xml,Json,Markdown,Boolean,Enumeration

Type of the custom field

boolean

Flag indicating if any the field will be included in the search index.

boolean

Flag indicating if the field must match the specified RegularExpression. If true, RegularExpression must not be null or empty.

boolean

Flag indicating if the field must not be null or empty.

boolean

(For future development.)

boolean

Flag determining if the field is hidden from the UI for adding custom fields to entities.

boolean

Flag indicating if any given value of the field can be assigned to at most one Mediasite object.

For Enumeration-type custom field definitions, a list of the enumeration values (Key, LocalizedName). It will only be used when FieldType=Enumeration

string

MediasiteId of the entity whose custom field values are being managed

string

The collection of custom field values on the entity. From a GET, all metadata fields (DataType, FieldName, FieldDefinitionId) will be populated as well as the actual Value field; for doing a PUT/PATCH, however, the client needs only provide either FieldName or FieldDefinitionId to specify the custom field definition completely.

string

MediasiteId of the report

DateTime

Date when the recurrence begins

DateTime

Date when the recurrence ends

int

Numeric ID of the recurrence's time-zone

bool

Flag indicating if results generated by running the recurrence should be saved indefinitely

int

If SaveResults is false, determines how many days (at least 1) the generated results are kept before being discarded

None,Daily,Weekly,Monthly,Yearly

The pattern of the recurrence (None if the recurrence is one-time-only). When setting report recurrences, this determines which of DailySettings, WeeklySettings, MonthlySettings, and YearlySettings must be non-NULL in the request.

string

Must be set exactly when ReportRecurrenceType=Daily. Fields are FrequencyInDays (int) to be used if the recurrence is to run every given number of days, and EveryWeekDays (bool) which indicates if the recurrence should run every weekday. If EveryWeekDays is true do not set FrequencyInDays.

string

Must be set exactly when ReportRecurrenceType=Weekly. Fields are FrequencyInWeeks (int) specifying that the recurrence runs every given number of weeks, and booleans Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday indicating which days of the week the recurrence runs on in weeks where it runs.

string

Must be set exactly when ReportRecurrenceType=Monthly. Fields are: FrequencyInMonths (int) specifiying that the recurrence runs every given number on months; MonthlyRecurrenceType (string, one of 'Simple' or 'Long'); when 'Simple', the field DayOfMonth specifies which day of the month the recurrence runs on, in weeks when it runs. When 'Long', WeekOfMonth (string, one of 'None', 'First', 'Second', 'Third', 'Fourth', 'Last') describes which week in the month the recurrence runs, and DayOfWeek (string, one of 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday') specifies which day of that week the recurrence runs.

string

Must be set exactly when ReportRecurrenceType=Yearly. Fields are: MonthOfYear (string, ranging over the standard English names of months) specifies which month the recurrence runs in; YearlyRecurrenceType (string, one of 'Simple' or 'Long'); when 'Simple', DayOfMonth (int) specifies which day of the specified month the recurrence runs on. When 'Long', WeekOfMonth (string, one of 'None', 'First', 'Second', 'Third', 'Fourth', 'Last') describes which week in the specified month the recurrence runs, and DayOfWeek (string, one of 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday') specifies which day of that week the recurrence runs.(

bool

Flag indicating if an email message should be generated when a recurring report is ready

string

If NotifyOnCompletion is true, this field defines the sender email address for completion notifications

List<string>

If NotifyOnCompletion is true, this field defines the recipient email addresses for completion notifications

string

ID of the app ticket (read-only)

string

Mediasite ID of the user profile the ticket is issued to. (NB: this profile must be activated for the ticket to be respected)

int

UserName of the user profile the ticket is issued to (read-only)

DateTime

Date and time the ticket was issued (read-only)

DateTime

Date and time the ticket was last used (read-only)

bool

Flag indicating if the app ticket has been revoked. (Read-only; you may revoke an application ticket by calling DELETE on it.)

string

Machine-name of the app ticket

string

Mediasite ID of the API key that was in use when the ticket was created (read-only; when creating an app ticket via the API, the API will automatically set this to the request's API key)

string

Full name of the user.

string

Distinguished name of the user in the MediasiteDirectory. Automatically generated by Mediasite; cannot be set through the API.

string

Full text description of the user.

bool

Flag indicating whether the user account is currently disabled in the MediasiteDirectory.

string

List of Mediasite Directory groups (if any) that the user belongs to. This can be set and updated, but the user can never be added to or removed from a system group.

string

CN of the group.

string

Distinguished name of the group in the MediasiteDirectory. Automatically generated by Mediasite; cannot be set through the API.

string

Full text description of the group.

string

Id of the Mediasite role corresponding to the group, if it exists. Automatically generated by Mediasite; cannot be set through the API.

string

List of Mediasite Directory members (if any) that the user belongs to. This can be set and updated through the API, but system accounts can never be added to or removed from a group.

string

MediasiteId of the trust

string

Name of the trust

string

Root URL of the remote site

Roles

Internal use only.

UserProfiles

Internal use only.

ExportedPresentations

List of presentations exported via the trust, together with their status.

string

MediasiteId of the trust

string

Name of the trust

string

Root URL of the remote site

string

Full path for Mediasite root to the folder

string

Mediasite ID of the project (read-only).

string

Name of the project.

string

Owner of the project (read-only).

int

The update interval (in minutes).

object

Connection settings for the dropbox to use. {Location (URL), Username, Password}

object

Settings to control how the import functions. Note that if an external import project is configured with a Catch template ID, an ImportFolderId must always be specified. {AlwaysUsePresentersFromTemplate(bool), DeleteDropboxFileOnSuccessfulImport(bool), StartTimeUtc, ImportFolderId, TitlePresentationBasedOnTemplate(bool)}

string

The Id of the presentation template associated with this project.

DateTime

Creation date and time (UTC) of the project (read-only).

DateTime

Last modified date and time (UTC) of the project (read-only).

string

Mediasite Id of the project's parent folder.

bool

Flag indicating if the project is in the Recycle Bin (read-only).

Default,MediasitePackageImport,ExternalMediaImport,ExternalMediaImportWithoutTranscode

The type of import this project will do.

string

For MediasitePackageImport projects, this must contain a single element ContentServers, which is an array of objects with properties ImportableContentType and ContentServerId, where ImportableContentType ranges over Slides, TimedEvents, PresentationThumbnail, CaptionFile, PublishToGo, AudioMP3, BroadcastVideoMicrosoftWMV, BroadcastVideoMP4Fragmented, OnDemandVideoMicrosoftWMV, OnDemandVideoMP4, OnDemandVideoMP4Fragmented, PresenterImage, PlayerLayoutFiles, GenericBinaryMedia, SlideOcr, PlayerOverrideFiles, AudioPeaks, Vodcast and ContentServerId is the MediasiteId of a content server valid for the importable type.

string

Name of the user

PresentationData

The requested user's playback context data on presentations where it exists, returned in pages ordered by presentation ID. Note that the paging and $orderby can be specified, but $filter will have no effect.

string

MediasiteId of the presentation

UserData

The requested presentation's playback context data for all users, returned in pages. Note that the paging and $orderby can be specified, but $filter will have no effect. If the requesting user lacks the Manage Playback Contexts operation, only their own playback context data may be returned.

string

Mediasite ID of the object.

string

Name of the object.

string

Type of the Mediasite object.

Available,Recycled,Deleted

Availability of the object; either available, in the Recycle Bin, or permanently deleted with full deletion from database and filesystem still pending.

string

MediasiteId of the quiz (read-only).

string

Name of the quiz.

string

Long-form description of the quiz.

string

Creator of the quiz (read-only).

DateTime

Date and time when the quiz was created (read-only).

DateTime

Date and time when the quiz was last modified (read-only).

Scored,StudyGuide

What kind of subquizzes will be associated with the presentation.

bool

A flag indicating whether or not the quiz has been published for consumption.

bool

A flag indicating whether or not the score should be shown to users after completion.

bool

A flag indicating whether or not the correct answers should be shown to users after completion.

string

MediasiteId of the presentation containing the quiz (read-only).

string

MediasiteId of an engage player to use when taking a quiz.

string

Publication state of the quiz.

Presentation

The Presentation containing this quiz.

SubQuizzes

A collection of subquizzes that are associated with this presentation.

string

MediasiteId of the subquiz (read-only).

string

Unique title of the subquiz.

string

Long-form description of the subquiz.

int

The time, in seconds, that this quiz is associated with.

IEnumerable<SonicFoundry.Mediasite.WebApi.Model.QuizQuestionRepresentation>

Collection of questions that are part of the subquiz.

string

MediasiteId of the question (read-only).

MultipleChoiceSingle ,MultipleChoiceMany ,Boolean

How will this question be answered.

int

The order of this question within the quiz (may not be used for some quiz types).

string

int

string

MediasiteId of the choice (read-only).

int

The order of this choice within the question (may not be used for some question types).

string

Text to be displated for this choice.

bool

Is this choice the correct answer that should earn points.

string

MediasiteId of the room (read-only).

string

Name of the room.

string

Long-form description of the room.

string

Owner of the room (read-only).

DateTime

Date and time when the room was created (read-only).

string

Date and time when the room was last modified (read-only).

string

Room Meta label (configurable in application settings).

string

Room Meta label (configurable in application settings).

string

Room Meta label (configurable in application settings).

string

Room Meta label (configurable in application settings).

string

MediasiteId of the room configuration (read-only).

string

Name of the room configuration.

string

Long-form description of the room configuration.

string

Owner of the room configuration (read-only).

DateTime

Date and time when the room configuration was created (read-only).

string

Date and time when the room configuration was last modified (read-only).

Unknown,HardwareRecorder,Catch

string

The identifier (this will be automatically created)

string

The identifier of the presentation content revision the annotation is associated with (this will be automatically populated).

Int32

The time, in milliseconds, that the annotation is assigned to.

string

The title of the annotation.

string

The message body of the annotation.

string

Author of the annotation.

bool

Limit which users are able to view this annotation.

bool

Indication that this message should not be displayed.

string

The user who created the flag.

UnwantedCommercialContentOrSpam,ExplicitMaterial,HateSpeechOrGraphicViolence,HarassmentOrBullying,CopyrightedMaterial,IrrelevantToDiscussion

The reason this message should not be displayed.

DateTime

Date and time when the annotation was last modified (read-only).

DateTime

Date and time when the annotation was created (read-only).

bool

Indication of whether or not users are allowed to contribute to a discussion associated with this annotation.

DateTime

A count of all the discussions and responses that are not hidden (read-only).

DateTime

A count of all the discussions and responses that are hidden (read-only).

AnnotationDiscussions

List of all discussions that are associated with the annotation

string

The identifier (this will be automatically created)

string

The identifier of the annotation this discussion is associated with (this will be automatically populated).

string

The identifier of the root discussion this is a response to (this will be automatically populated).

string

The message body of the discussion.

string

Author of the annotation.

bool

Limit which discussions and responses should be displayed.

bool

Indication that this message should not be displayed.

string

The user who created the flag.

UnwantedCommercialContentOrSpam,ExplicitMaterial,HateSpeechOrGraphicViolence,HarassmentOrBullying,CopyrightedMaterial,IrrelevantToDiscussion

The reason this message should not be displayed.

DateTime

Date and time when the discussion was created (read-only).

DateTime

Date and time when the discussion was last modified (read-only).

AnnotationDiscussionThreadSummary

The count of replies to the discussion as well as a preview of the most recent two replies.

Replies

List of responses to the discussion

string

MediasiteId of the channel (read-only)

string

MediasiteId of the folder linked to the channel, if any; if the channel is unlinked, null. (Read-only)

string

Name of the channel

string

If set, the string used in the short URL for the channel

string

Long-form description of the channel

string

URL to navigate to the channel (read-only)

bool

Flag indicating if the channel is in the Recycle Bin (read-only)

bool

Flag indicating if the catalog is a channel (read-only)

bool

Not used by Mediasite Channels.

bool

Flag indicating if the channel is a user channel (read-only)

bool

Flag indicating if the channel is search-based

bool

Flag indicating if the searching for a search-based channel is limited to the channel's contents

bool

Flag indicating if the channel is a custom channel that can only be published to via the publishing tab of a presentation

bool

Flag indicating if the channel can be published to via the publishing tab of a presentation

string

Owner of the channel (read-only)

DateTime

Date and time when the channel was created (read-only)

string

Date and time when the channel was last modified (read-only)

string

Search string to be used to determine channel membership in a search-based channel

bool

Not used by Mediasite Channels.

string

URL of the channel thumbnail, if any (read-only)

string

Not used by Mediasite Channels.

bool

For linked channel folders, this flag indicates if subfolders of the linked folder are included

bool

Not used by Mediasite Channels.

bool

string

Mediasite ID of the folder used to store shortcuts that are published to a publishing-tab channel (read-only)

string

Mediasite ID of the terms and conditions for a publishing-tab channel (read-only; may be updated using the SetTermsAndConditions and ClearTermsAndConditions actions.

bool

Not used by Mediasite Channels.

bool

Not used by Mediasite Channels.

bool

Not used by Mediasite Channels.

Presentations

List of presentations that are in the channel.

Settings

Display options and search settings (if any) for the channel.

string

MediasiteId of the channel (read-only)

bool

Flag indicating if this channel is a user channel that was created in MyMediasite

string

Imgae to use as a thumbnail for the channel

string

Imgae to use for the top banner.

string

Background color behind the top banner; must be in 32-bit hexadecimal RGB format (#xxxxxx) or (xxxxxx)

string

URL for the top-banner link, if defined

GrayLine,BlackBeauty,BlueLine

Display theme of the channel

bool

Flag indicating if a top banner will be displayed in the Channel

bool

Flag indicating if a thumbnail will be displayed in the Channel

bool

Flag indicating if a download link will be shown in the Channel for presentations with publish-to-go enabled

bool

Flag indicating if email invitations from the Channel can be sent

bool

Flag indicating if an RSS feed for the Channel will be available

bool

Flag indicating of login/logout links will be shown on the Channel

bool

Flag indicating if annotations are allowed on presentations in the channel

bool

Flag indicating if comments are allowed on presentations in the channel

bool

Flag indicating if the share/embed functions should be displayed

bool

Flag indicating if continuous playback of presentations is supported in the channel

0,1,2

Default sort order for presentations. 0: Date new-old, 1: Date old-new, 2: Title A-Z

Int32

When RSS feeds are allowed, this field determines the maximum number of presentations to be included in the RSS feed.

Int32

bool

Flag indicating if a CAPTCHA will be required to send email invitations

string

Search string to be used to determine channel membership in a search-based channel

Title,Description,SlideText,CaptionText,Tags,Presenters,All

This setting specifies the fields that the SearchTerm will be applied to; it is given as a sequence of allowed field names separated by a | (pipe) character

string

Mediasite ID of the schedule

string

Name of the schedule

string

Long-form description of the schedule

string

This must be set when creating a schedule via POST, to specify the template used to create the new schedule. It will always be null when reading a schedule via GET.

string

DeviceId of the device set for the schedule (if any)

string

MediasiteId of the Recorder set for the schedule (if any)

IEnumerable<SonicFoundry.Mediasite.WebApi.Model.AccessControlEntry>

int

The ID of the next recurrence.

int

Duration of the next scheduled recording in milliseconds.

DateTime

UTC Date and time when the next recurrence begins.

DateTime

UTC Date when the next recurrence ends (time will be set to midnight).

DateTime

Date and time of the next scheduled instance of the recurrence.

string

MediasiteId of the webhook subscription (read-only).

string

Mediasite FolderId . The user must have Write permission on this folder to perform a POST or DELETE operation

string

The URL of the webhook endpoint.

string

Owner of the webhook subscription (read-only).

vodcast.completed

The list of events to enable for this endpoint. Currently only support 'vodcast.completed' as the event type.

Templates

Mediasite presentation templates. Search-backed resource.

Presentations

Mediasite presentations and shortcuts. By default only a subset of fields are served; a larger subset can be retrieved by using the query parameter $select=card and the full set by using $select=full. The 'excludeduplicatepresentations' query-string parameter can be used to request that the results not contain multiple presentations sharing a root; the 'excludeshortcutpresentations' query-string parameter can be used to request that no shortcuts be included in the results. Search-backed resource.

ShowcaseChannels

Mediasite Showcase channels. Search-backed resource. If ShowcaseId is set in the request header, results will be limited to the specified showcase.

CatalogSettings

Settings for Mediasite channels. This resource no longer applies to catalogs, only channels. The name was not modified to maintain backward compatibility.

Showcases

Mediasite Showcases (includes the associated video library settings).

AnnotatedPlaylists

(not available for direct use)

Schedules

Mediasite schedules. Search-backed resource.

Recorders

Mediasite Recorder registrations. Search-backed resource.

RecorderStatus

Status of a connected Mediasite Recorder.

RecorderExtendedStatus

Extended status of a connected Mediasite Recorder.

RecorderLicenseStatus

(not available for direct use)

ScheduledRecordingTimes

Recordings scheduled for a Recorder.

ActiveConnection

(not available for direct use)

ActiveSchedulerConnection

(not available for direct use)

ActiveInputs

SyncPresenceOnInputs

CurrentPresentationMetadata

TimeRemaining

AudioLevels

PresentationReports

Presentation Statistics reports.

PresenterReports

Presenter Statistics reports.

UserReports

User Statistics reports.

CatalogReports

Video Collection Statistics reports. This resource no longer applies to catalogs. The resource name was not modified to maintain backward compatibility.

DownloadReports

Download Statistics reports.

AuthoringReports

Authoring Statistics reports.

ContentStorageReports

Content storage reports.

MyMediasiteStorageReports

My Mediasite storage reports.

Players

Mediasite players. Search-backed resource.

AudioTranscriptionProfiles

Mediasite audio transcription (closed captioning) provider profiles.

Home

API Home contains site-level information. The properties MaximumConnections and PerUserConnectionLimit may be modified via PUT or PATCH, provided the user has System Management permissions; all other properties are read-only.

ShowcaseSettings

Mediasite Showcase settings. Returns settings for the default showcase unless ShowcaseId is set in the header of the request.

Tags

(not available for direct use)

CommentCounts

(not available for direct use)

PresentationQuestions

(not available for direct use)

PlayerLayoutOptions

(not available for direct use)

EmailInvitations

(not available for direct use)

ModerateOrAnnotate

(not available for direct use)

LiveStreamKey

(not available for direct use)

CaptionContent

(not available for direct use)

RecycledPresentations

Mediasite presentations and shortcuts that are in the Recycle Bin. By default only a subset of fields are served; a larger subset can be retrieved by using the query parameter $select=card and the full set by using $select=full. Search-backed resource.

Folders

Mediasite folders. Search-backed resource.

Jobs

Tracking information for Mediasite jobs.

TimedEvents

InteractiveElements

DistributionContentServerEndpoints

(not available for direct use)

StorageContentServerEndpoints

(not available for direct use)

ContentServers

Mediasite content servers. Search-backed resource.

Presenters

Mediasite presenters. The presenters viewed and managed using this controller have the Portal Resources system folder as a parent resource; other presenters should be managed via their own parent resource (presentation, template, or schedule).

ContentEncodingSettings

Mediasite content encoding settings. Search-backed resource.

EncodingSettingsFilters

(not available for direct use)

EncodingStreamDescriptions

(not available for direct use)

AuthorizationTickets

Authorization tickets for Mediasite resources

Recurrences

Recurrences on Mediasite schedules

PresentationAnalytics

Reporting information organized by presentation.

PresentationClientAnalytics

(not available for direct use)

PresentationUserAnalytics

(not available for direct use)

PresentationIPAnalytics

(not available for direct use)

ViewingTrendsSegments

(not available for direct use)

ViewingSessions

(not available for direct use)

ActiveSessions

(not available for direct use)

ViewingPlatformTotals

(not available for direct use)

UserAnalytics

Reporting information organized by user.

UserPresentationAnalytics

(not available for direct use)

ServerAnalytics

Reporting data organized by server-wide criteria.

PresentationSources

(not available for direct use)

ActiveConnections

Analytics for current playback connections to Mediasite

ActivePresentations

Analytics for currently-watched presentations in Mediasite.

UserProfiles

Endpoint for managing Mediasite user profiles. When using the DELETE verb, the default behavior is to leave user content un-recycled; add DeleteProfileContent=true to the query-string to have user content sent to the Recycle Bin if possible. Whether recycled or not, the user profile home folder will be moved to a new parent, by default the root Mediasite folder. To override this, add RehomeFolderId=GUID to specify the Mediasite ID of a different folder. The ID should be in URL-string format and not inside quotation marks.

MediasiteTimeZones

Time-zone data for the site.

ApiKeys

Application keys for the Mediasite Web API

PresentationThumbnailContent

(not available for direct use)

PodcastContent

(not available for direct use)

PublishToGoContent

(not available for direct use)

VideoPodcastContent

(not available for direct use)

SlideContent

(not available for direct use)

SlideDetailsContent

(not available for direct use)

OcrContent

(not available for direct use)

OnDemandContent

(not available for direct use)

BroadcastContent

(not available for direct use)

AudioPeaksContent

(not available for direct use)

ExternalPublishingContent

(not available for direct use)

ExternalPublishingProjects

Configuration for publishing Mediasite content to external services.

Roles

Mediasite roles.

ResourcePermissions

Mediasite resource permission entries. It is not possible to retrieve a feed of resource permissions. If you require the requesting user's effective permissions on a resource (for instance, checking whether you have Write on a resource), use the EffectivePermissions resource instead.

EffectivePermissions

The requesting user's effective permissions on Mediasite resources. If the permission bit applies to a particular resource, it will be either true or false; otherwise it will be null. If you need to see the complete access control list for the resource, use the ResourcePermissions resource instead.

EmailTemplates

Mediasite email templates.

Registrations

Registration configuration for presentations and channels.

ResourceRegistrations

(not available for direct use)

VideoPodcastProjects

Mediasite video podcast projects.

Modules

Course modules.

CustomFieldDefinitions

Mediasite custom field definitions

CustomFieldValues

This resource is used to set and update CustomFieldValues on Mediasite entities. Note that this is one of the few API resources where PUT and PATCH have different semantics; a PUT will clear the entity's existing custom field values before applying the ones provided in the request; a PATCH will merge the request with the existing set of custom field values.

ReportRecurrences

Recurrences for reports.

Podcasts

(future development)

ServerReports

(future development)

ApplicationTickets

Mediasite application tickets

MediasiteDirectoryUsers

Users in the Mediasite Directory. System accounts may be viewed in the API but never created, updated, or deleted; ordinary accounts can be created, updated, and deleted.

MediasiteDirectoryGroups

Groups in the Mediasite Directory. System groups (MediasiteAdministrators and MediasitePresenters) can be read through the API, but never updated or deleted; other groups may be read, written, and deleted.

OutboundTrusts

Outbound Mediasite trusts

InboundTrusts

Inbound Mediasite trusts

ExportedPresentations

(not available for direct use)

MediaImportProjects

Media Import Projects.

UserPlaybackContexts

Per-user per-presentation bookmark and viewing coverage information. Note that a requesting user must have the Manage Playback Contexts operation to see this information for any user other than themselves.

PresentationData

(not available for direct use)

PresentationPlaybackContexts

Per-presentation per-user bookmark and viewing coverage information. Note that a requesting user must have the Manage Playback Contexts operation to see this information for any user other than themselves.

UserData

(not available for direct use)

PublishingDetails

(not available for direct use)

DeviceScheduledRecordingTimes

(not available for direct use)

MediasiteObjects

Read-only view of Mediasite objects to check existence and availability on a per-ID basis (not in bulk). Requires a non-view-only API key to use. The requesting user must still have Read on a resource to see it.

Playlists

Showcase Playlists.

PresentationQuizzes

Presentation Quizzes.

SubQuizzes

SubQuizzes.

QuizQuestions

Questions for a presentation quiz.

QuizQuestionChoices

Possible answers for a quiz question.

Rooms

Rooms.

RoomConfigurations

Room Configurations.

Annotations

AnnotationDiscussionCounts

(not available for direct use)

AnnotationDiscussions

MediasiteChannels

Channels. Search-backed resource.

MediasiteChannelSettings

Settings for Channels

MosaicSchedules

WebHooks

Webhooks.

AddVideoPodcast

Add video podcast content to the schedule.

VideoPodcastProjectId

Mediasite ID in URL string format of the video podcast project to use. Video podcast projects can be queried using the VideoPodcastProjects resource.

AddExternalPublishing

Add external publishing content to the schedule.

ExternalPublishingPointId

Mediasite ID in URL string format of the external publishing point to use. External publishing points can be queried using the ExternalPublishingPoints resource.

CreateLike

This action allows a new presentation to be created using an existing presentation as the template. The Name and ParentFolderId may be overriden at create time.

Name

The name of the new template. If not set, then a title based on the source template's name is automatically set

ParentFolderId

The parent folder ID of the new template. If not set, the source template's home folder is used

CreatePresentationFromTemplate

Create a presentation using the settings from this template using specified overrides.

Title

The title of the new presentation (Required).

Duration

Total duration of the presentation in milliseconds

AddPublishToGo

Add publish-to-go content to the template. Write access to the template and access to the Publish to Go operation are required.

PublishToGoContentServerId

(Optional) Mediasite ID in URL string format of the publish-to-go server to use. If this is not provided, the API will attempt to use one from the template's server group; if that fails, but there is a single publish-to-go server in the site, that one will be used. Otherwise the action will fail.

RemovePublishToGo

Remove publish-to-go content from the template. Write access to the template is required.

AddPodcast

Add podcast content to the template. Write access to the template is required.

AudioEncodingSettingsId

Mediasite ID in URL string format of the podcast encoding settings. Available settings can be listed through the API via GET /api/v1/ContentEncodingSettings?$filter=MimeType eq 'audio*mpeg'

RemovePodcast

Remove podcast content from the template. Write access to the template is required.

AddPresentations

This action allows presentations to be added in bulk to a static channel.

PresentationIds

An array of MediasiteIds of presentations to be added to the channel.

RemovePresentations

This action allows presentations to be removed in bulk from a static channel.

PresentationIds

An array of MediasiteIds of presentations to be removed from the channel.

SetTermsAndConditions

This action allows terms and conditions for a publishing-tab channel to be set.

TermsAndConditionsId

Mediasite ID of the terms and conditions entity to apply; these are viewable using the TermsAndConditions resource.

ClearTermsAndConditions

This action allows terms and conditions for a publishing-tab channel to be removed.

PublishToSpotlight

This action allows presentations to be added in bulk to the spotlight channel.

PresentationIds

An array of MediasiteIds of presentations to be added to the spotlight channel.

UnpublishFromSpotlight

This action allows presentations to be removed in bulk from the spotlight channel.

PresentationIds

An array of MediasiteIds of presentations to be removed from the spotlight channel.

GetPlaylistPresentationSummary

Return a list of all playlists in the specified showcase and for each one, a flag indicating whether the presentation has already been published or not.

PresentationId

The MediasiteId of a presentation to be added/removed from available playlists.

AddVideoPodcast

Add video podcast content to the schedule.

VideoPodcastProjectId

Mediasite ID in URL string format of the video podcast project to use. Video podcast projects can be queried using the VideoPodcastProjects resource.

AddExternalPublishing

Add external publishing content to the schedule.

ExternalPublishingPointId

Mediasite ID in URL string format of the external publishing point to use. External publishing points can be queried using the ExternalPublishingPoints resource.

AddPublishToGo

Add publish-to-go content to the schedule. Write access to the schedule and access to the Publish to Go operation are required.

PublishToGoContentServerId

(Optional) Mediasite ID in URL string format of the publish-to-go server to use. If this is not provided, the API will attempt to use one from the schedule's server group; if that fails, but there is a single publish-to-go server in the site, that one will be used. Otherwise the action will fail.

RemovePublishToGo

Remove publish-to-go content from the schedule. Write access to the schedule is required.

AddPodcast

Add podcast content to the schedule. Write access to the schedule is required.

AudioEncodingSettingsId

Mediasite ID in URL string format of the podcast encoding settings. Available settings can be listed through the API via GET /api/v1/ContentEncodingSettings?$filter=MimeType eq 'audio*mpeg'

RemovePodcast

Remove podcast content from the schedule. Write access to the schedule is required.

SyncSchedules

This action prompts the Recorder to immediately sync with its currently-configured Server to get schedules.

Start

This action is equivalent to the Start Recording/Go Live button on the Recorder.

Stop

This action is equivalent to the Stop button on the Recorder.

Pause

This action is equivalent to clicking Pause on the Recorder.

Resume

This action is equivalent to clicking Resume on the Recorder..

Execute

This action allows the report to be run in the Job Farm. It returns a structure with the IDs of the job and the result, along with URLs for monitoring job progress and launching the report result when it is complete.

DateRangeTypeOverride

If set, execute the report with a custom date-range rather than the default date-range

DateRangeCustomStartDate

If the DateRangeTypeOverride is Custom, the start of the custom date-range

DateRangeCustomEndDate

If the DateRangeTypeOverride is Custom, the end of the custom date-range

Export

This action allows an exported results file (either XML or Excel) to be generated in the Job Farm. It returns a structure with the ID of the job, along with an URL for monitoring job progress via the API, and an URL for downloading the export when complete

ResultId

The MediasiteId of the result to export. This parameter is required.

FileFormat

File format to generate (Excel or Xml). If you do not provide this the API will default to Xml.

Execute

DateRangeTypeOverride

If set, execute the report with a custom date-range rather than the default date-range

DateRangeCustomStartDate

If the DateRangeTypeOverride is Custom, the start of the custom date-range

DateRangeCustomEndDate

If the DateRangeTypeOverride is Custom, the end of the custom date-range

Export

ResultId

The MediasiteId of the result to export. This parameter is required.

FileFormat

File format to generate (Excel or Xml). If you do not provide this the API will default to Xml.

Execute

DateRangeTypeOverride

If set, execute the report with a custom date-range rather than the default date-range

DateRangeCustomStartDate

If the DateRangeTypeOverride is Custom, the start of the custom date-range

DateRangeCustomEndDate

If the DateRangeTypeOverride is Custom, the end of the custom date-range

Export

ResultId

The MediasiteId of the result to export. This parameter is required.

FileFormat

File format to generate (Excel or Xml). If you do not provide this the API will default to Xml.

Execute

DateRangeTypeOverride

If set, execute the report with a custom date-range rather than the default date-range

DateRangeCustomStartDate

If the DateRangeTypeOverride is Custom, the start of the custom date-range

DateRangeCustomEndDate

If the DateRangeTypeOverride is Custom, the end of the custom date-range

Export

ResultId

The MediasiteId of the result to export. This parameter is required.

FileFormat

File format to generate (Excel or Xml). If you do not provide this the API will default to Xml.

Execute

DateRangeTypeOverride

If set, execute the report with a custom date-range rather than the default date-range

DateRangeCustomStartDate

If the DateRangeTypeOverride is Custom, the start of the custom date-range

DateRangeCustomEndDate

If the DateRangeTypeOverride is Custom, the end of the custom date-range

Export

ResultId

The MediasiteId of the result to export. This parameter is required.

FileFormat

File format to generate (Excel or Xml). If you do not provide this the API will default to Xml.

Execute

DateRangeTypeOverride

If set, execute the report with a custom date-range rather than the default date-range

DateRangeCustomStartDate

If the DateRangeTypeOverride is Custom, the start of the custom date-range

DateRangeCustomEndDate

If the DateRangeTypeOverride is Custom, the end of the custom date-range

Export

ResultId

The MediasiteId of the result to export. This parameter is required.

FileFormat

File format to generate (Excel or Xml). If you do not provide this the API will default to Xml.

Execute

DateRangeTypeOverride

If set, execute the report with a custom date-range rather than the default date-range

DateRangeCustomStartDate

If the DateRangeTypeOverride is Custom, the start of the custom date-range

DateRangeCustomEndDate

If the DateRangeTypeOverride is Custom, the end of the custom date-range

Execute

DateRangeTypeOverride

If set, execute the report with a custom date-range rather than the default date-range

DateRangeCustomStartDate

If the DateRangeTypeOverride is Custom, the start of the custom date-range

DateRangeCustomEndDate

If the DateRangeTypeOverride is Custom, the end of the custom date-range

RefreshReportData

This action will prompt Mediasite to run a job to update current analytics data. If such a job is already running or queued to run immediately, the ID of this job will be returned; otherwise a new job will be queued. (NB: a string identifier must be provided when invoking this action. This can be any string; the URL can be, for example, /Home('1')/RefreshReportData.)

ValidatePlaybackTicket

Check whether a playback ticket is valid for a given IP address and requested media URL. The return value is a structure with 2 boolean fields: IsValid indicating if the validation was successful, IPValidationPerformed indicating if Mediasite actually checked the ClientIPAddress against the ticket's IP address.

ClientIPAddress

The client IP address where the playback ticket will be used from

HeaderIPAddress

(Optional) The IP address that will be set in the configured request header by a proxy or load-balancer between the client and Mediasite

RequestedUrl

The full URL of the Mediasite media file being requested with the playback ticket

TicketId

ID of the playback ticket to be validated

MinimumValidUntilDateUtc

(Optional, but if given must be a time after the request is issued) If set, confirm that the playback ticket, if valid for the IP address and requested URL, will not expire before the given time.

ComputePerSiteStorage

Compute the total storage in bytes used by presentations, broken down by presentation availability (Available, Recycled, or Deleted and awaiting final deletion by the System Maintenance Worker)

BatchSearchReindex

This action will prompt Mediasite to run a job to reindex the specified entities in batches of 1000.

ReindexIds

A list of IDs for entities that should be reindexed (Max: 1500)

RunAtUtc

When the reindex job should start (Optional, default value is now)

CreateLike

This action allows a new presentation to be created using an existing presentation as the template. The Title and ParentFolderId may be overriden at create time.

Title

The title of the new presentation. If not set, then a title based on the source presentation's title is automatically set

ParentFolderId

The parent folder ID of the new presentation. If not set, the source presentation's home folder is used

CreateShortcut

Create a shortcut to the presentation, with optional overrides for title, description, parent folder, and player.

Title

Title of the shortcut (if not provided, title of presentation will be used)

Description

Description of the shortcut

ParentFolderId

Mediasite ID in URL string format of the folder to create the shortcut in (if not provided, parent folder of presentation will be used)

PlayerId

Mediasite ID in URL string format of the Player to use for the shortcut (if not provided, player of presentation will be used)

Upload

The Upload link on a presentation is an URL where media files may be posted to as part of Media Upload. The caller must supply a target filename, so the URL will have the form /FileServer/presentation/(guid)/filename.extension

CreateMediaUpload

This action allows a media upload job to be created for a presentation (once a file is uploaded to the Upload link location); it returns the ID of the media upload job.

FileName

The name of the file to use for single-file uploads. This file must already have been uploaded to the Upload link location.

AudioSource

(Optional) The name of the file to be used as the audio source for a multi-file upload. If not set, the audio source will be set to the camera filename or else the first filename supplied.

MediaStart

(Optional) The start of a presentation in milliseconds when specifying a start trim. Must be greater than 0 and less than MediaEnd, if specified, or otherwise must be less than the duration of the uploaded media.

MediaEnd

(Optional) The end of a presentation in milliseconds when specifying an end trim. Must be less than the duration of the uploaded media and greater than MediaStart, if specified.

FileNames

An array of files to use for multi-file uploads. These files must already have been uploaded to the Upload link location.

Play

The Play link on a presentation can be loaded into a browser to play the presentation back in the Mediasite player

CopyPresentation

Generate a job to copy a presentation to a new folder. The folder must be set as a CopyDestination before calling this action. The response includes links to the job and to the new presentation.

TargetFolderId

Mediasite ID in URL string format of the target folder. IsCopyDestination must be true on this folder.

AddVideoPodcast

Add video podcast content to the presentation.

VideoPodcastProjectId

Mediasite ID in URL string format of the video podcast project to use. Video podcast projects can be queried using the VideoPodcastProjects resource.

AddExternalPublishing

Add external publishing content to the presentation.

ExternalPublishingPointId

Mediasite ID in URL string format of the external publishing point to use. External publishing points can be queried using the ExternalPublishingPoints resource.

ConvertVideoToSlide

Convert a full video stream (which must already have had slides generated) to a slide-only stream. If OCR content exists it will be kept. The video file will be permanently deleted.

StreamType

The stream (Video1, Video2, or Video3) to convert.

GetCommentCount

Get a count of comments on the presentations. This consists of two numbers, <tt>Root</tt> counting the root-level comments, and <tt>All</tt> counting both comments and replies. If <tt>Hidden</tt> and <tt>Flagged</tt> are both <tt>true</tt> in the request body, the action will count comments that are either hidden or flagged; if both are <tt>false</tt>, the action will count comments that are neither hidden nor flagged; furthermore, in this case <tt>All</tt> does not count replies whose parent comment is either flagged or hidden.

Hidden

If <tt>true</tt>, include hidden comments; if <tt>false</tt>, exclude them. If not set, do not filter on visibility at all.

Flagged

If <tt>true</tt>, include flagged comments; if <tt>false</tt>, exclude them. If not set, do not filter on flag status at all.

ResetMedia

To facilitate re-publishing, this action will remove any existing content from the presentation.

DeleteLogs

Whether or not the analytics data for the presentation should also be deleted.

EnableAnnotationCreation

Give all roles with view permissions the ability to create annotations on the presentation.

SetThumbnail

This action will set the specified file as the thumbnail for the presentation. First the file must be uploaded to the Upload link, then this action will set the file as the thumbnail. The current thumbnail will be deleted.

FileName

The name of the file to use. This file must already have been uploaded to the Upload link location.

AddCaptionContent

Submit the presentation for captioning. To execute this action, a user must have the <tt>Caption Presentations</tt> operation as well as <tt>Write</tt> permission on the target presentation.

AudioTranscriptionProfileId

The MediasiteId of a valid audio transcription profile. This must not be set for manual upload of caption files.

IsRushJob

Indicates whether the captioning job that's created will be marked as a rush job. If not set in the request, defaults to <tt>false</tt>. Only supported for AST captioning.

Language

Indicates the caption language code. Only supported for Mediasite captioning.

FileName

Indicates the caption filename that will be uploaded. This is required for manual upload of caption files.

RemoveCaptionContent

Remove captioning content from the presentation. Write access to the presentation is required.

AddPublishToGo

Add publish-to-go content to the presentation. Write access to the presentation and access to the Publish to Go operation are required.

SubmitPublishToGo

If necessary, create a publish-to-go package for download. This requires either View on the presentation or access to the Publish to Go operation.

RemovePublishToGo

Remove publish-to-go content from the presentation. Write access to the presentation is required.

AddPodcast

Add podcast content to the presentation. Write access to the presentation is required.

AudioEncodingSettingsId

Mediasite ID in URL string format of the podcast encoding settings. Available settings can be listed through the API via GET /api/v1/ContentEncodingSettings?$filter=MimeType eq 'audio*mpeg'

RemovePodcast

Remove podcast content from the presentation. Write access to the presentation is required.

UpdateCommentVisibility

Hide or unhide comments based on a date range

Visibility

False to hide, true to unhide

CutoffDate

End of the date range

StartDate

Optional start of the date range. If not specified, all comments created prior to the cutoff date will be affected.

DeleteComments

Delete comments based on a date range

CutoffDate

End of the date range

StartDate

Optional start of the date range. If not specified, all comments created prior to the cutoff date will be affected.

UpdateAnnotationVisibility

Hide or unhide annotations based on a date range

Visibility

False to hide, true to unhide

CutoffDate

End of the date range

StartDate

Optional start of the date range. If not specified, all annotations created prior to the cutoff date will be affected.

DeleteAnnotations

Delete annotations based on a date range

CutoffDate

End of the date range

StartDate

Optional start of the date range. If not specified, all annotations created prior to the cutoff date will be affected.

ResetLiveStreamKey

Reset the live RTMP stream key. Returns the RTMP server URL and updated stream key for streaming live to this presentation. Write access to the presentation and access to the Presentation Management operation are required.

UpdatePermissions

This action allows permissions and ownership on a folder to be updated, with options to propagate/merge permission edits down to child entities. The action returns the job which is created to perform the permission update asynchronously.

Owner

The owner to set. (To set only the owner, use UpdateOwner, below, instead.)

InheritFromParent

Flag indicating whether to reset permission on the folder to inherit from its parent.

MergePermissions

Flag indicating whether to merge (rather than replace) permissions on child entities when propagating.

PropagatePermissions

Flag indicating whether to propagate permission edits to child entities recursively.

PropagateOwner

Flag indicating whether to propagate the owner edit to child entities recursively.

Permissions

List of access control entries for the resource. Each access control entry consists of the following fields: RoleId (string), PermissionMask (int), Read, Write, Execute, Approve, Moderate, DenyRead, DenyWrite, DenyExecute, DenyApprove, DenyModerate (all bool). When updating resource permissions, you may use either the PermissionMask or the flags to set a role's permissions, but not both.

UpdateOwner

This action allows ownership on a folder to be updated, instantly, with no propagation to children.

Owner

The owner to set.

DeleteFolder

This action creates a recursive job to delete a folder. The created job ID will be returned for monitoring.

ExchangeTicket

A showcase authorization ticket allows the holder to request an authorization ticket for any presentation listed in the showcase.

SaveCookie

Should the newly generated authorization ticket be saved to the cookie?

DailyViewingTotals

This action will query playback audits for a single day and group them by user.

TimezoneOffset

The UTC offset, or difference between the local timezone and UTC.

UsageDate

The day to collect viewing totals for.

SetQuotaPolicyFromLevel

Create or update the user profile's quota policy based on a quota level. If an update, the CurrentStorageUsage will not be changed, although the QuotaStatus may chane based on the quota and threshold values of the level.

QuotaLevelId

Mediasite ID in URL string format of the quota level to use. Quota levels can be queried using the QuotaLevels resource.

IsBulkUpdate

Boolean flag (required) indicating whether the operation is part of a bulk update of user profiles. If true, then per-profile jobs for recomputing storage usage will not be triggered; these updates and notifications will wait until the nightly quota maintenance job runs.

AddEntitlement

Grant an entitlement to the user profile.

EntitlementId

Mediasite ID of the entitlement

RemoveEntitlement

Remove an entitlement from the user profile.

EntitlementId

Mediasite ID of the entitlement

CopyPermissionsFromRole

Copy all permissions from another Mediasite role.

SourceRoleId

Id of the role to use as source for the copy.

AddAssociation

This action allows a single Mediasite entity to be associated with the module. If the entity is already associated with the module, the action will report success; however, a warning will be logged.

MediasiteId

The MediasiteId of the entity. This parameter is required.

RemoveAssociation

This action allows a single Mediasite entity to be removed from its association with the module. If the entity is not associated with the module, the action will report failure.

MediasiteId

The MediasiteId of the entity. This parameter is required.

ChangePassword

Set a new password for the specified Mediasite user.

NewPassword

New password.

OnRemoteTrustUpdated

For internal use only.

OnRemoteTrustDeleted

For internal use only.

OnRemoteSiteRemoved

For internal use only.

OnRemoteSiteRootChanged

For internal use only.

OnImportStatusUpdated

For internal use only.

ExportPresentation

Initiate an ad-hoc export job via the trust.

PresentationId

The MediasiteId of the local presentation to export. This parameter is required.

TargetFolderId

The MediasiteId of the target remote folder presentation to export to. This parameter is required.

ExportType

The type of the export (FullCopy, PublishToGo, or FullMove). This parameter is required.

OnOutboundTrustCreated

For internal use only.

OnRemoteTrustUpdated

For internal use only.

OnRemoteTrustDeleted

For internal use only.

OnRemoteSiteRemoved

For internal use only.

OnRemoteSiteRootChanged

For internal use only.

OnExportedPackageAvailable

For internal use only.

OnExportCancelled

For internal use only.

QueryProgress

This action queries the current status of files being imported by the specified project.

Filenames

An array of filenames to check the status of.

GetBatch

Get playback context data for a user and a batch of presentations

Ids

An array of presentation IDs. Any presentations that the requesting user lacks Read on will not have any results returned; otherwise, the requested user's playback context data for the presentation will be included in the result set.

GetBatch

Get playback context data for a presentation and a batch of usernames

Usernames

An array of usernames. If the requesting user does not have the Manage Playback Contexts operation, only their own playback context data may be returned.

AddPresentations

This action allows presentations to be added in bulk to the playlist.

PresentationIds

An array of MediasiteIds of presentations to be added to the playlist.

RemovePresentations

This action allows presentations to be removed in bulk from the playlist.

PresentationIds

An array of MediasiteIds of presentations to be removed from the playlist.

InsertOrMovePresentation

This action allows presentations to be added to a specific place in the playlist.

PresentationId

A presentation to be added to or move within the playlist.

Position

The postion that the presentation will be in.

AddSubQuiz

This action allows subquizzes to be added in to the presentation.

Title

Unique title for the subquiz.

Description

Long-form description of the subquiz.

Position

The time, in seconds, that this quiz is associated with.

Questions

An array of QuizQuestions that will be part of the subquiz.

RemoveSubQuiz

This action allows subquizzes to be removed from the presentation.

SubQuizId

MediasiteId of the subquiz to be removed.

ClearResults

This action will delete any submitted answers for the quiz.

AddPresentationTemplates

This action allows presentation templates to be added in bulk to the room configuration.

TemplateIds

An array of MediasiteIds of presentation templates to be added to the room configuration.

RemovePresentationTemplates

This action allows presentation templates to be removed in bulk from the room configuration.

TemplateIds

An array of MediasiteIds of presentation templates to be removed from the room configuration.

ReorderPresentationTemplates

This action allows presentation templates associated with the room configuration to be reordered.

OrderedTemplates

A collection of presentation template representations each having a PresentationTemplateId and a Position.

GetDiscussionCount

Get the count of root discussions as well as the count of all responses. If both parameters are included they must be the same. Both true will return any items that are either Flagged or Hidden. Both false will return all items that are neither Flagged nor Hidden.

Hidden

Filter the discussion being counted based on Visibility

Flagged

Filter the discussion being counted based on the presence of flags

Flag

Mark an annotation as potentially inappropriate

WhyFlagged

The reason this item may be inappropriate.

Unflag

Remove a flag from an annotation

ChangeVisibility

Hide an annotation so that it does not show up on the presentation

Visibility

True if the annotation should be visible, False if the annotation should be hidden

Add a response to this discussion thread

Text

The body of the message being added.

Flag

Mark a discussion or response as potentially inappropriate

WhyFlagged

The reason this item may be inappropriate.

Unflag

Remove a flag from a discussion or response

ChangeVisibility

Hide a discussion or response so that it does not show up on the annotation

Visibility

True if the discussion or response should be visible, False if the item should be hidden

AddPresentations

This action allows presentations to be added in bulk to a static channel.

PresentationIds

An array of MediasiteIds of presentations to be added to the channel.

RemovePresentations

This action allows presentations to be removed in bulk from a static channel.

PresentationIds

An array of MediasiteIds of presentations to be removed from the channel.

SetTermsAndConditions

This action allows terms and conditions for a publishing-tab channel to be set.

TermsAndConditionsId

Mediasite ID of the terms and conditions entity to apply; these are viewable using the TermsAndConditions resource.

ClearTermsAndConditions

This action allows terms and conditions for a publishing-tab channel to be removed.

GetSiteProperties

Get siteproperties associated with Mosaic.

GetOrCreatePresentation

Get the presentation associated with the specified recurrence, or create one if it doesn't exist.

RecurrenceId

The ID of the recurrence.

StartDateTime

The date and time the recurrence is schedules to start.