Logo

View the Project on GitHub elements-storage/elements-sdk-dotnet

ElementsSDK.Api.MediaLibraryApi

All URIs are relative to https://elements.local

Method HTTP request Description
BookmarkMediaDirectory POST /api/2/media/files/{id}/bookmark  
ClearSubclipClipboard DELETE /api/2/media/subclips/clipboard/clear  
CombineAssetsIntoSet POST /api/2/media/assets/combine  
CreateAsset POST /api/2/media/assets  
CreateAssetRating POST /api/2/media/ratings  
CreateComment POST /api/2/media/comments  
CreateCustomField POST /api/2/media/custom-fields  
CreateEditorProject POST /api/2/media/editor  
CreateExternalTranscoder POST /api/2/media/external-transcoders  
CreateMarker POST /api/2/media/markers  
CreateMediaFileTemplate POST /api/2/media/files/templates  
CreateMediaRoot POST /api/2/media/roots  
CreateMediaRootPermission POST /api/2/media/root-permissions  
CreateMediaTag POST /api/2/media/tags  
CreateProxyProfile POST /api/2/media/proxy-profiles  
CreateSubclip POST /api/2/media/subclips  
CreateSubclipClipboardEntry POST /api/2/media/subclips/clipboard  
DeleteAsset DELETE /api/2/media/assets/{id}  
DeleteAssetRating DELETE /api/2/media/ratings/{id}  
DeleteComment DELETE /api/2/media/comments/{id}  
DeleteCustomField DELETE /api/2/media/custom-fields/{id}  
DeleteEasySharingTokenForBundle DELETE /api/2/media/bundles/{id}/easy-sharing-token  
DeleteEasySharingTokenForDirectory DELETE /api/2/media/files/{id}/easy-sharing-token  
DeleteExternalTranscoder DELETE /api/2/media/external-transcoders/{id}  
DeleteMarker DELETE /api/2/media/markers/{id}  
DeleteMediaFileTemplate DELETE /api/2/media/files/templates/{id}  
DeleteMediaLibraryObjects POST /api/2/media/delete  
DeleteMediaRoot DELETE /api/2/media/roots/{id}  
DeleteMediaRootPermission DELETE /api/2/media/root-permissions/{id}  
DeleteMediaTag DELETE /api/2/media/tags/{id}  
DeleteMediaUpdate DELETE /api/2/media/updates/{id}  
DeleteProxy DELETE /api/2/media/proxies/{id}  
DeleteProxyProfile DELETE /api/2/media/proxy-profiles/{id}  
DeleteSubclip DELETE /api/2/media/subclips/{id}  
DeleteSubclipClipboardEntry DELETE /api/2/media/subclips/clipboard/{id}  
DiscoverMedia POST /api/2/scanner/discover  
DownloadAssetProxyFile GET /api/2/media/assets/{id}/proxy-files/{filename}  
DownloadMediaFile GET /api/2/media/files/{id}/download  
DownloadProxy GET /api/2/media/proxies/{id}/download  
EditorExportXMLForAssset GET /api/2/media/editor/asset/{asset_ids}/xml-export  
EditorExportXMLForBundle GET /api/2/media/editor/bundle/{bundle_ids}/xml-export  
EditorExportXMLForProject GET /api/2/media/editor/{id}/xml-export  
ExportCommentsForAvid GET /api/2/media/editor/asset/{asset_id}/{export_format}-export/avid-comments  
ExportEditorTimeline POST /api/2/media/editor/timeline-export  
ForgetDeletedMediaFiles POST /api/2/media/files/{id}/forget-deleted  
GenerateProxies POST /api/2/media/proxies  
GetAllAssetProjectLinks GET /api/2/media/assets/project-links  
GetAllAssetRatings GET /api/2/media/ratings  
GetAllAssetTapeBackups GET /api/2/media/backups  
GetAllAssets GET /api/2/media/assets  
GetAllBundlesForMediaRoot GET /api/2/media/bundles/flat/{root}  
GetAllClickLinks GET /api/2/media/assets/click-links  
GetAllComments GET /api/2/media/comments  
GetAllCustomFields GET /api/2/media/custom-fields  
GetAllExternalTranscoders GET /api/2/media/external-transcoders  
GetAllMarkers GET /api/2/media/markers  
GetAllMediaFileBundles GET /api/2/media/bundles  
GetAllMediaFileTemplates GET /api/2/media/files/templates  
GetAllMediaFiles GET /api/2/media/files  
GetAllMediaFilesForBundles POST /api/2/media/files/for-bundles  
GetAllMediaFilesForMediaRoot GET /api/2/media/files/flat/{root}  
GetAllMediaRootPermissions GET /api/2/media/root-permissions  
GetAllMediaRoots GET /api/2/media/roots  
GetAllMediaTags GET /api/2/media/tags  
GetAllMediaUpdates GET /api/2/media/updates  
GetAllProxyGenerators GET /api/2/media/proxy-generators  
GetAllProxyProfiles GET /api/2/media/proxy-profiles  
GetAllSubclipClipboardEntries GET /api/2/media/subclips/clipboard  
GetAllSubclips GET /api/2/media/subclips  
GetAllTranscoderProfiles GET /api/2/transcoder-profiles  
GetAsset GET /api/2/media/assets/{id}  
GetAssetRating GET /api/2/media/ratings/{id}  
GetBookmarkedMediaFilesDirectories GET /api/2/media/files/bookmarks  
GetComment GET /api/2/media/comments/{id}  
GetCustomField GET /api/2/media/custom-fields/{id}  
GetEasySharingTokenForBundle GET /api/2/media/bundles/{id}/easy-sharing-token  
GetEasySharingTokenForDirectory GET /api/2/media/files/{id}/easy-sharing-token  
GetEditorProject GET /api/2/media/editor/{id}  
GetExternalTranscoder GET /api/2/media/external-transcoders/{id}  
GetFrame GET /api/2/media/assets/{id}/frames/{frame}  
GetLatestMediaUpdate GET /api/2/media/updates/latest  
GetMarker GET /api/2/media/markers/{id}  
GetMediaFile GET /api/2/media/files/{id}  
GetMediaFileBundle GET /api/2/media/bundles/{id}  
GetMediaFileContents GET /api/2/media/files/{id}/contents  
GetMediaFileTemplate GET /api/2/media/files/templates/{id}  
GetMediaRoot GET /api/2/media/roots/{id}  
GetMediaRootPermission GET /api/2/media/root-permissions/{id}  
GetMediaTag GET /api/2/media/tags/{id}  
GetMultipleAssets POST /api/2/media/assets/multiple  
GetMultipleBundles POST /api/2/media/bundles/multiple  
GetMultipleFiles POST /api/2/media/files/multiple  
GetMyMediaRootPermissions GET /api/2/media/root-permissions/mine  
GetMyResolvedMediaRootPermissions GET /api/2/media/root-permissions/mine/resolved  
GetProxy GET /api/2/media/proxies/{id}  
GetProxyGenerator GET /api/2/media/proxy-generators/{id}  
GetProxyProfile GET /api/2/media/proxy-profiles/{id}  
GetProxyProfileProxyCount GET /api/2/media/proxy-profiles/{id}/proxy-count  
GetSubclip GET /api/2/media/subclips/{id}  
GetTranscoderProfile GET /api/2/transcoder-profiles/{id}  
GetVantageWorkflows GET /api/2/media/external-transcoders/{id}/workflows  
InstantiateMediaFileTemplate POST /api/2/media/files/templates/{id}/instantiate  
LocateEditorProjectPaths GET /api/2/media/editor/{id}/locate-paths  
MarkMediaDirectoryAsShowroom POST /api/2/media/files/{id}/showroom  
PatchAsset PATCH /api/2/media/assets/{id}  
PatchAssetRating PATCH /api/2/media/ratings/{id}  
PatchComment PATCH /api/2/media/comments/{id}  
PatchCustomField PATCH /api/2/media/custom-fields/{id}  
PatchEditorProject PATCH /api/2/media/editor/{id}  
PatchExternalTranscoder PATCH /api/2/media/external-transcoders/{id}  
PatchMarker PATCH /api/2/media/markers/{id}  
PatchMediaFile PATCH /api/2/media/files/{id}  
PatchMediaFileTemplate PATCH /api/2/media/files/templates/{id}  
PatchMediaRoot PATCH /api/2/media/roots/{id}  
PatchMediaRootPermission PATCH /api/2/media/root-permissions/{id}  
PatchMediaTag PATCH /api/2/media/tags/{id}  
PatchProxyProfile PATCH /api/2/media/proxy-profiles/{id}  
PatchSubclip PATCH /api/2/media/subclips/{id}  
RecursivelyTagMediaDirectory POST /api/2/media/files/{id}/tag  
ReindexMediaDirectory POST /api/2/media/files/{id}/search-reindex  
RenameCustomField POST /api/2/media/custom-fields/{id}/rename  
RenderSequence POST /api/2/media/editor/render  
RenderSubclip POST /api/2/media/subclips/{id}/render  
RequestMediaScan POST /api/2/scanner/scan  
ResolveComment POST /api/2/media/comments/{id}/resolve  
ShareMediaLibraryObjects POST /api/2/media/share  
TestExternalTranscoderConnection POST /api/2/media/external-transcoders/test-connection  
TransitionWorkflow POST /api/2/media/workflow/transition  
UnbookmarkMediaDirectory DELETE /api/2/media/files/{id}/bookmark  
UnmarkMediaDirectoryAsShowroom DELETE /api/2/media/files/{id}/showroom  
UnresolveComment POST /api/2/media/comments/{id}/unresolve  
UpdateAsset PUT /api/2/media/assets/{id}  
UpdateAssetRating PUT /api/2/media/ratings/{id}  
UpdateComment PUT /api/2/media/comments/{id}  
UpdateCustomField PUT /api/2/media/custom-fields/{id}  
UpdateEditorProject PUT /api/2/media/editor/{id}  
UpdateExternalTranscoder PUT /api/2/media/external-transcoders/{id}  
UpdateMarker PUT /api/2/media/markers/{id}  
UpdateMediaFile PUT /api/2/media/files/{id}  
UpdateMediaFileTemplate PUT /api/2/media/files/templates/{id}  
UpdateMediaRoot PUT /api/2/media/roots/{id}  
UpdateMediaRootPermission PUT /api/2/media/root-permissions/{id}  
UpdateMediaTag PUT /api/2/media/tags/{id}  
UpdateProxyProfile PUT /api/2/media/proxy-profiles/{id}  
UpdateSubclip PUT /api/2/media/subclips/{id}  

BookmarkMediaDirectory

void BookmarkMediaDirectory (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class BookmarkMediaDirectoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                apiInstance.BookmarkMediaDirectory(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.BookmarkMediaDirectory: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClearSubclipClipboard

void ClearSubclipClipboard ()

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ClearSubclipClipboardExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);

            try
            {
                apiInstance.ClearSubclipClipboard();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.ClearSubclipClipboard: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CombineAssetsIntoSet

void CombineAssetsIntoSet (MultipleAssetsRequest multipleAssetsRequest)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CombineAssetsIntoSetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var multipleAssetsRequest = new MultipleAssetsRequest(); // MultipleAssetsRequest | 

            try
            {
                apiInstance.CombineAssetsIntoSet(multipleAssetsRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CombineAssetsIntoSet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
multipleAssetsRequest MultipleAssetsRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAsset

Asset CreateAsset (Asset asset)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateAssetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = new Asset(); // Asset | 

            try
            {
                Asset result = apiInstance.CreateAsset(asset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateAsset: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset Asset    

Return type

Asset

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAssetRating

AssetRating CreateAssetRating (AssetRating assetRating)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateAssetRatingExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var assetRating = new AssetRating(); // AssetRating | 

            try
            {
                AssetRating result = apiInstance.CreateAssetRating(assetRating);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateAssetRating: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
assetRating AssetRating    

Return type

AssetRating

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateComment

Comment CreateComment (Comment comment)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateCommentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var comment = new Comment(); // Comment | 

            try
            {
                Comment result = apiInstance.CreateComment(comment);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateComment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
comment Comment    

Return type

Comment

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateCustomField

CustomField CreateCustomField (CustomField customField)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateCustomFieldExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var customField = new CustomField(); // CustomField | 

            try
            {
                CustomField result = apiInstance.CreateCustomField(customField);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateCustomField: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
customField CustomField    

Return type

CustomField

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateEditorProject

EditorProject CreateEditorProject (EditorProject editorProject)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateEditorProjectExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var editorProject = new EditorProject(); // EditorProject | 

            try
            {
                EditorProject result = apiInstance.CreateEditorProject(editorProject);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateEditorProject: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
editorProject EditorProject    

Return type

EditorProject

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateExternalTranscoder

ExternalTranscoder CreateExternalTranscoder (ExternalTranscoder externalTranscoder)

Required permissions * User account permission: media:access (read) / system:admin-access (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateExternalTranscoderExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var externalTranscoder = new ExternalTranscoder(); // ExternalTranscoder | 

            try
            {
                ExternalTranscoder result = apiInstance.CreateExternalTranscoder(externalTranscoder);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateExternalTranscoder: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
externalTranscoder ExternalTranscoder    

Return type

ExternalTranscoder

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateMarker

Marker CreateMarker (Marker marker)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateMarkerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var marker = new Marker(); // Marker | 

            try
            {
                Marker result = apiInstance.CreateMarker(marker);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateMarker: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
marker Marker    

Return type

Marker

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateMediaFileTemplate

MediaFileTemplate CreateMediaFileTemplate (MediaFileTemplate mediaFileTemplate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateMediaFileTemplateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var mediaFileTemplate = new MediaFileTemplate(); // MediaFileTemplate | 

            try
            {
                MediaFileTemplate result = apiInstance.CreateMediaFileTemplate(mediaFileTemplate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateMediaFileTemplate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
mediaFileTemplate MediaFileTemplate    

Return type

MediaFileTemplate

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateMediaRoot

MediaRoot CreateMediaRoot (MediaRoot mediaRoot)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateMediaRootExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var mediaRoot = new MediaRoot(); // MediaRoot | 

            try
            {
                MediaRoot result = apiInstance.CreateMediaRoot(mediaRoot);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateMediaRoot: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
mediaRoot MediaRoot    

Return type

MediaRoot

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateMediaRootPermission

MediaRootPermission CreateMediaRootPermission (MediaRootPermission mediaRootPermission)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateMediaRootPermissionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var mediaRootPermission = new MediaRootPermission(); // MediaRootPermission | 

            try
            {
                MediaRootPermission result = apiInstance.CreateMediaRootPermission(mediaRootPermission);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateMediaRootPermission: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
mediaRootPermission MediaRootPermission    

Return type

MediaRootPermission

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateMediaTag

UnfilteredTag CreateMediaTag (UnfilteredTag unfilteredTag)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateMediaTagExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var unfilteredTag = new UnfilteredTag(); // UnfilteredTag | 

            try
            {
                UnfilteredTag result = apiInstance.CreateMediaTag(unfilteredTag);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateMediaTag: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
unfilteredTag UnfilteredTag    

Return type

UnfilteredTag

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateProxyProfile

ProxyProfile CreateProxyProfile (ProxyProfile proxyProfile)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateProxyProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var proxyProfile = new ProxyProfile(); // ProxyProfile | 

            try
            {
                ProxyProfile result = apiInstance.CreateProxyProfile(proxyProfile);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateProxyProfile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
proxyProfile ProxyProfile    

Return type

ProxyProfile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateSubclip

Subclip CreateSubclip (Subclip subclip)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateSubclipExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var subclip = new Subclip(); // Subclip | 

            try
            {
                Subclip result = apiInstance.CreateSubclip(subclip);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateSubclip: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
subclip Subclip    

Return type

Subclip

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateSubclipClipboardEntry

SubclipClipboardEntry CreateSubclipClipboardEntry (SubclipClipboardEntry subclipClipboardEntry)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateSubclipClipboardEntryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var subclipClipboardEntry = new SubclipClipboardEntry(); // SubclipClipboardEntry | 

            try
            {
                SubclipClipboardEntry result = apiInstance.CreateSubclipClipboardEntry(subclipClipboardEntry);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.CreateSubclipClipboardEntry: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
subclipClipboardEntry SubclipClipboardEntry    

Return type

SubclipClipboardEntry

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAsset

void DeleteAsset (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteAssetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Asset.

            try
            {
                apiInstance.DeleteAsset(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteAsset: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Asset.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAssetRating

void DeleteAssetRating (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteAssetRatingExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Rating.

            try
            {
                apiInstance.DeleteAssetRating(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteAssetRating: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Rating.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteComment

void DeleteComment (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteCommentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Comment.

            try
            {
                apiInstance.DeleteComment(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteComment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Comment.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCustomField

void DeleteCustomField (int id)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteCustomFieldExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Custom field.

            try
            {
                apiInstance.DeleteCustomField(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteCustomField: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Custom field.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteEasySharingTokenForBundle

void DeleteEasySharingTokenForBundle (int id)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteEasySharingTokenForBundleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Bundle.

            try
            {
                apiInstance.DeleteEasySharingTokenForBundle(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteEasySharingTokenForBundle: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Bundle.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteEasySharingTokenForDirectory

void DeleteEasySharingTokenForDirectory (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteEasySharingTokenForDirectoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                apiInstance.DeleteEasySharingTokenForDirectory(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteEasySharingTokenForDirectory: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteExternalTranscoder

void DeleteExternalTranscoder (int id)

Required permissions * User account permission: media:access (read) / system:admin-access (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteExternalTranscoderExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this external transcoder.

            try
            {
                apiInstance.DeleteExternalTranscoder(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteExternalTranscoder: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this external transcoder.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMarker

void DeleteMarker (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteMarkerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this marker.

            try
            {
                apiInstance.DeleteMarker(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteMarker: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this marker.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMediaFileTemplate

void DeleteMediaFileTemplate (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteMediaFileTemplateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Template.

            try
            {
                apiInstance.DeleteMediaFileTemplate(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteMediaFileTemplate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Template.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMediaLibraryObjects

List<TaskInfo> DeleteMediaLibraryObjects (MediaLibraryDeleteRequest mediaLibraryDeleteRequest)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteMediaLibraryObjectsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var mediaLibraryDeleteRequest = new MediaLibraryDeleteRequest(); // MediaLibraryDeleteRequest | 

            try
            {
                List<TaskInfo> result = apiInstance.DeleteMediaLibraryObjects(mediaLibraryDeleteRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteMediaLibraryObjects: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
mediaLibraryDeleteRequest MediaLibraryDeleteRequest    

Return type

List<TaskInfo>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMediaRoot

void DeleteMediaRoot (int id)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteMediaRootExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this media root.

            try
            {
                apiInstance.DeleteMediaRoot(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteMediaRoot: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this media root.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMediaRootPermission

void DeleteMediaRootPermission (int id)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteMediaRootPermissionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Media Root Permission.

            try
            {
                apiInstance.DeleteMediaRootPermission(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteMediaRootPermission: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Media Root Permission.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMediaTag

void DeleteMediaTag (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteMediaTagExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Tag.

            try
            {
                apiInstance.DeleteMediaTag(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteMediaTag: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Tag.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMediaUpdate

void DeleteMediaUpdate (int id)

Required permissions * User account permission: media:access (read) / media:updates:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteMediaUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Update.

            try
            {
                apiInstance.DeleteMediaUpdate(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteMediaUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Update.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteProxy

void DeleteProxy (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteProxyExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this proxy.

            try
            {
                apiInstance.DeleteProxy(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteProxy: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this proxy.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteProxyProfile

void DeleteProxyProfile (int id)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteProxyProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this proxy profile.

            try
            {
                apiInstance.DeleteProxyProfile(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteProxyProfile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this proxy profile.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSubclip

void DeleteSubclip (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteSubclipExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this subclip.

            try
            {
                apiInstance.DeleteSubclip(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteSubclip: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this subclip.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSubclipClipboardEntry

void DeleteSubclipClipboardEntry (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteSubclipClipboardEntryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this subclip clipboard entry.

            try
            {
                apiInstance.DeleteSubclipClipboardEntry(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DeleteSubclipClipboardEntry: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this subclip clipboard entry.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DiscoverMedia

MediaFile DiscoverMedia (ScannerDiscoverEndpointRequest scannerDiscoverEndpointRequest)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DiscoverMediaExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var scannerDiscoverEndpointRequest = new ScannerDiscoverEndpointRequest(); // ScannerDiscoverEndpointRequest | 

            try
            {
                MediaFile result = apiInstance.DiscoverMedia(scannerDiscoverEndpointRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DiscoverMedia: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scannerDiscoverEndpointRequest ScannerDiscoverEndpointRequest    

Return type

MediaFile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadAssetProxyFile

void DownloadAssetProxyFile (string filename, int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DownloadAssetProxyFileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var filename = filename_example;  // string | 
            var id = 56;  // int | A unique integer value identifying this Asset.

            try
            {
                apiInstance.DownloadAssetProxyFile(filename, id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DownloadAssetProxyFile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
filename string    
id int A unique integer value identifying this Asset.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadMediaFile

void DownloadMediaFile (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DownloadMediaFileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                apiInstance.DownloadMediaFile(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DownloadMediaFile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadProxy

void DownloadProxy (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DownloadProxyExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this proxy.

            try
            {
                apiInstance.DownloadProxy(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.DownloadProxy: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this proxy.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditorExportXMLForAssset

void EditorExportXMLForAssset (string assetIds, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class EditorExportXMLForAsssetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var assetIds = assetIds_example;  // string | 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                apiInstance.EditorExportXMLForAssset(assetIds, ordering, limit, offset);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.EditorExportXMLForAssset: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
assetIds string    
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditorExportXMLForBundle

void EditorExportXMLForBundle (string bundleIds, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class EditorExportXMLForBundleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var bundleIds = bundleIds_example;  // string | 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                apiInstance.EditorExportXMLForBundle(bundleIds, ordering, limit, offset);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.EditorExportXMLForBundle: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
bundleIds string    
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditorExportXMLForProject

void EditorExportXMLForProject (int id)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class EditorExportXMLForProjectExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                apiInstance.EditorExportXMLForProject(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.EditorExportXMLForProject: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ExportCommentsForAvid

void ExportCommentsForAvid (string assetId, string exportFormat, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ExportCommentsForAvidExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var assetId = assetId_example;  // string | 
            var exportFormat = exportFormat_example;  // string | 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                apiInstance.ExportCommentsForAvid(assetId, exportFormat, ordering, limit, offset);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.ExportCommentsForAvid: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
assetId string    
exportFormat string    
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ExportEditorTimeline

void ExportEditorTimeline (TimelineExportRequest timelineExportRequest)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ExportEditorTimelineExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var timelineExportRequest = new TimelineExportRequest(); // TimelineExportRequest | 

            try
            {
                apiInstance.ExportEditorTimeline(timelineExportRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.ExportEditorTimeline: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
timelineExportRequest TimelineExportRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ForgetDeletedMediaFiles

void ForgetDeletedMediaFiles (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ForgetDeletedMediaFilesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                apiInstance.ForgetDeletedMediaFiles(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.ForgetDeletedMediaFiles: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GenerateProxies

List<TaskInfo> GenerateProxies (GenerateProxiesRequest generateProxiesRequest)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GenerateProxiesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var generateProxiesRequest = new GenerateProxiesRequest(); // GenerateProxiesRequest | 

            try
            {
                List<TaskInfo> result = apiInstance.GenerateProxies(generateProxiesRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GenerateProxies: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
generateProxiesRequest GenerateProxiesRequest    

Return type

List<TaskInfo>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllAssetProjectLinks

List<AssetProjectLink> GetAllAssetProjectLinks (string asset = null, string project = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllAssetProjectLinksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var project = project_example;  // string | Filter the returned list by `project`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<AssetProjectLink> result = apiInstance.GetAllAssetProjectLinks(asset, project, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllAssetProjectLinks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset string Filter the returned list by `asset`. [optional]
project string Filter the returned list by `project`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<AssetProjectLink>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllAssetRatings

List<AssetRating> GetAllAssetRatings (string user = null, string asset = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllAssetRatingsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var user = user_example;  // string | Filter the returned list by `user`. (optional) 
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<AssetRating> result = apiInstance.GetAllAssetRatings(user, asset, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllAssetRatings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
user string Filter the returned list by `user`. [optional]
asset string Filter the returned list by `asset`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<AssetRating>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllAssetTapeBackups

List<AssetBackup> GetAllAssetTapeBackups (string asset = null, string ordering = null, int? limit = null, int? offset = null, bool? includeAsset = null, string advancedSearch = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllAssetTapeBackupsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 
            var includeAsset = true;  // bool? |  (optional) 
            var advancedSearch = advancedSearch_example;  // string |  (optional) 

            try
            {
                List<AssetBackup> result = apiInstance.GetAllAssetTapeBackups(asset, ordering, limit, offset, includeAsset, advancedSearch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllAssetTapeBackups: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset string Filter the returned list by `asset`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]
includeAsset bool?   [optional]
advancedSearch string   [optional]

Return type

List<AssetBackup>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllAssets

List<Asset> GetAllAssets (string syncId = null, string displayName = null, string set = null, string ordering = null, int? limit = null, int? offset = null, bool? includeProxies = null, bool? includeModifiedBy = null, bool? resolveAssetPermission = null, int? forRoot = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllAssetsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var syncId = syncId_example;  // string | Filter the returned list by `sync_id`. (optional) 
            var displayName = displayName_example;  // string | Filter the returned list by `display_name`. (optional) 
            var set = set_example;  // string | Filter the returned list by `set`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 
            var includeProxies = true;  // bool? |  (optional) 
            var includeModifiedBy = true;  // bool? |  (optional) 
            var resolveAssetPermission = true;  // bool? |  (optional) 
            var forRoot = 56;  // int? |  (optional) 

            try
            {
                List<Asset> result = apiInstance.GetAllAssets(syncId, displayName, set, ordering, limit, offset, includeProxies, includeModifiedBy, resolveAssetPermission, forRoot);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllAssets: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
syncId string Filter the returned list by `sync_id`. [optional]
displayName string Filter the returned list by `display_name`. [optional]
set string Filter the returned list by `set`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]
includeProxies bool?   [optional]
includeModifiedBy bool?   [optional]
resolveAssetPermission bool?   [optional]
forRoot int?   [optional]

Return type

List<Asset>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllBundlesForMediaRoot

List<MediaFileBundle> GetAllBundlesForMediaRoot (string root, string asset = null, string location = null, string sharedViaTokens = null, string sharedViaTokensToken = null, string name = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllBundlesForMediaRootExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var root = root_example;  // string | 
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var location = location_example;  // string | Filter the returned list by `location`. (optional) 
            var sharedViaTokens = sharedViaTokens_example;  // string | Filter the returned list by `shared_via_tokens`. (optional) 
            var sharedViaTokensToken = sharedViaTokensToken_example;  // string | Filter the returned list by `shared_via_tokens__token`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<MediaFileBundle> result = apiInstance.GetAllBundlesForMediaRoot(root, asset, location, sharedViaTokens, sharedViaTokensToken, name, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllBundlesForMediaRoot: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
root string    
asset string Filter the returned list by `asset`. [optional]
location string Filter the returned list by `location`. [optional]
sharedViaTokens string Filter the returned list by `shared_via_tokens`. [optional]
sharedViaTokensToken string Filter the returned list by `shared_via_tokens__token`. [optional]
name string Filter the returned list by `name`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<MediaFileBundle>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllClickLinks

List<AssetCloudLink> GetAllClickLinks (string asset = null, string connection = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllClickLinksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var connection = connection_example;  // string | Filter the returned list by `connection`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<AssetCloudLink> result = apiInstance.GetAllClickLinks(asset, connection, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllClickLinks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset string Filter the returned list by `asset`. [optional]
connection string Filter the returned list by `connection`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<AssetCloudLink>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllComments

List<Comment> GetAllComments (string asset = null, string root = null, string user = null, string ordering = null, int? limit = null, int? offset = null, int? forRoot = null, int? tasksForUser = null, bool? includeFullAsset = null, string advancedSearch = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllCommentsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var root = root_example;  // string | Filter the returned list by `root`. (optional) 
            var user = user_example;  // string | Filter the returned list by `user`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 
            var forRoot = 56;  // int? |  (optional) 
            var tasksForUser = 56;  // int? |  (optional) 
            var includeFullAsset = true;  // bool? |  (optional) 
            var advancedSearch = advancedSearch_example;  // string |  (optional) 

            try
            {
                List<Comment> result = apiInstance.GetAllComments(asset, root, user, ordering, limit, offset, forRoot, tasksForUser, includeFullAsset, advancedSearch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllComments: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset string Filter the returned list by `asset`. [optional]
root string Filter the returned list by `root`. [optional]
user string Filter the returned list by `user`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]
forRoot int?   [optional]
tasksForUser int?   [optional]
includeFullAsset bool?   [optional]
advancedSearch string   [optional]

Return type

List<Comment>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllCustomFields

List<CustomField> GetAllCustomFields (string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllCustomFieldsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<CustomField> result = apiInstance.GetAllCustomFields(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllCustomFields: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<CustomField>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllExternalTranscoders

List<ExternalTranscoder> GetAllExternalTranscoders (string name = null, decimal? id = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access (read) / system:admin-access (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllExternalTranscodersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var id = 8.14;  // decimal? | Filter the returned list by `id`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<ExternalTranscoder> result = apiInstance.GetAllExternalTranscoders(name, id, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllExternalTranscoders: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
name string Filter the returned list by `name`. [optional]
id decimal? Filter the returned list by `id`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<ExternalTranscoder>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMarkers

List<Marker> GetAllMarkers (string asset = null, string user = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMarkersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var user = user_example;  // string | Filter the returned list by `user`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<Marker> result = apiInstance.GetAllMarkers(asset, user, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMarkers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset string Filter the returned list by `asset`. [optional]
user string Filter the returned list by `user`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<Marker>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMediaFileBundles

List<MediaFileBundle> GetAllMediaFileBundles (string asset = null, string location = null, string sharedViaTokens = null, string sharedViaTokensToken = null, string name = null, string ordering = null, int? limit = null, int? offset = null, bool? excludeDeleted = null, bool? excludeUnrecognized = null, bool? includeProxies = null, bool? includeParents = null, string advancedSearch = null)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMediaFileBundlesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var location = location_example;  // string | Filter the returned list by `location`. (optional) 
            var sharedViaTokens = sharedViaTokens_example;  // string | Filter the returned list by `shared_via_tokens`. (optional) 
            var sharedViaTokensToken = sharedViaTokensToken_example;  // string | Filter the returned list by `shared_via_tokens__token`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? |  (optional) 
            var offset = 56;  // int? |  (optional) 
            var excludeDeleted = true;  // bool? |  (optional) 
            var excludeUnrecognized = true;  // bool? |  (optional) 
            var includeProxies = true;  // bool? |  (optional) 
            var includeParents = true;  // bool? |  (optional) 
            var advancedSearch = advancedSearch_example;  // string |  (optional) 

            try
            {
                List<MediaFileBundle> result = apiInstance.GetAllMediaFileBundles(asset, location, sharedViaTokens, sharedViaTokensToken, name, ordering, limit, offset, excludeDeleted, excludeUnrecognized, includeProxies, includeParents, advancedSearch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMediaFileBundles: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset string Filter the returned list by `asset`. [optional]
location string Filter the returned list by `location`. [optional]
sharedViaTokens string Filter the returned list by `shared_via_tokens`. [optional]
sharedViaTokensToken string Filter the returned list by `shared_via_tokens__token`. [optional]
name string Filter the returned list by `name`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int?   [optional]
offset int?   [optional]
excludeDeleted bool?   [optional]
excludeUnrecognized bool?   [optional]
includeProxies bool?   [optional]
includeParents bool?   [optional]
advancedSearch string   [optional]

Return type

List<MediaFileBundle>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMediaFileTemplates

List<MediaFileTemplate> GetAllMediaFileTemplates (string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMediaFileTemplatesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<MediaFileTemplate> result = apiInstance.GetAllMediaFileTemplates(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMediaFileTemplates: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<MediaFileTemplate>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMediaFiles

List<MediaFile> GetAllMediaFiles (string bundle = null, string bundleIn = null, string parent = null, string path = null, string name = null, string isDir = null, string isShowroom = null, string present = null, string volume = null, string sharedViaTokens = null, string sharedViaTokensToken = null, string ordering = null, int? limit = null, int? offset = null, bool? resolveFilePermission = null, bool? includeModifiedBy = null, bool? includeEffectiveCustomFields = null, bool? includeRoot = null, bool? includeParents = null, string advancedSearch = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMediaFilesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var bundle = bundle_example;  // string | Filter the returned list by `bundle`. (optional) 
            var bundleIn = bundleIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var parent = parent_example;  // string | Filter the returned list by `parent`. (optional) 
            var path = path_example;  // string | Filter the returned list by `path`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var isDir = isDir_example;  // string | Filter the returned list by `is_dir`. (optional) 
            var isShowroom = isShowroom_example;  // string | Filter the returned list by `is_showroom`. (optional) 
            var present = present_example;  // string | Filter the returned list by `present`. (optional) 
            var volume = volume_example;  // string | Filter the returned list by `volume`. (optional) 
            var sharedViaTokens = sharedViaTokens_example;  // string | Filter the returned list by `shared_via_tokens`. (optional) 
            var sharedViaTokensToken = sharedViaTokensToken_example;  // string | Filter the returned list by `shared_via_tokens__token`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 
            var resolveFilePermission = true;  // bool? |  (optional) 
            var includeModifiedBy = true;  // bool? |  (optional) 
            var includeEffectiveCustomFields = true;  // bool? |  (optional) 
            var includeRoot = true;  // bool? |  (optional) 
            var includeParents = true;  // bool? |  (optional) 
            var advancedSearch = advancedSearch_example;  // string |  (optional) 

            try
            {
                List<MediaFile> result = apiInstance.GetAllMediaFiles(bundle, bundleIn, parent, path, name, isDir, isShowroom, present, volume, sharedViaTokens, sharedViaTokensToken, ordering, limit, offset, resolveFilePermission, includeModifiedBy, includeEffectiveCustomFields, includeRoot, includeParents, advancedSearch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMediaFiles: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
bundle string Filter the returned list by `bundle`. [optional]
bundleIn string Multiple values may be separated by commas. [optional]
parent string Filter the returned list by `parent`. [optional]
path string Filter the returned list by `path`. [optional]
name string Filter the returned list by `name`. [optional]
isDir string Filter the returned list by `is_dir`. [optional]
isShowroom string Filter the returned list by `is_showroom`. [optional]
present string Filter the returned list by `present`. [optional]
volume string Filter the returned list by `volume`. [optional]
sharedViaTokens string Filter the returned list by `shared_via_tokens`. [optional]
sharedViaTokensToken string Filter the returned list by `shared_via_tokens__token`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]
resolveFilePermission bool?   [optional]
includeModifiedBy bool?   [optional]
includeEffectiveCustomFields bool?   [optional]
includeRoot bool?   [optional]
includeParents bool?   [optional]
advancedSearch string   [optional]

Return type

List<MediaFile>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMediaFilesForBundles

List<MediaFile> GetAllMediaFilesForBundles (AllMediaFilesForBundlesRequest allMediaFilesForBundlesRequest)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMediaFilesForBundlesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var allMediaFilesForBundlesRequest = new AllMediaFilesForBundlesRequest(); // AllMediaFilesForBundlesRequest | 

            try
            {
                List<MediaFile> result = apiInstance.GetAllMediaFilesForBundles(allMediaFilesForBundlesRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMediaFilesForBundles: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
allMediaFilesForBundlesRequest AllMediaFilesForBundlesRequest    

Return type

List<MediaFile>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMediaFilesForMediaRoot

List<MediaFile> GetAllMediaFilesForMediaRoot (string root, string bundle = null, string bundleIn = null, string parent = null, string path = null, string name = null, string isDir = null, string isShowroom = null, string present = null, string volume = null, string sharedViaTokens = null, string sharedViaTokensToken = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMediaFilesForMediaRootExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var root = root_example;  // string | 
            var bundle = bundle_example;  // string | Filter the returned list by `bundle`. (optional) 
            var bundleIn = bundleIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var parent = parent_example;  // string | Filter the returned list by `parent`. (optional) 
            var path = path_example;  // string | Filter the returned list by `path`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var isDir = isDir_example;  // string | Filter the returned list by `is_dir`. (optional) 
            var isShowroom = isShowroom_example;  // string | Filter the returned list by `is_showroom`. (optional) 
            var present = present_example;  // string | Filter the returned list by `present`. (optional) 
            var volume = volume_example;  // string | Filter the returned list by `volume`. (optional) 
            var sharedViaTokens = sharedViaTokens_example;  // string | Filter the returned list by `shared_via_tokens`. (optional) 
            var sharedViaTokensToken = sharedViaTokensToken_example;  // string | Filter the returned list by `shared_via_tokens__token`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<MediaFile> result = apiInstance.GetAllMediaFilesForMediaRoot(root, bundle, bundleIn, parent, path, name, isDir, isShowroom, present, volume, sharedViaTokens, sharedViaTokensToken, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMediaFilesForMediaRoot: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
root string    
bundle string Filter the returned list by `bundle`. [optional]
bundleIn string Multiple values may be separated by commas. [optional]
parent string Filter the returned list by `parent`. [optional]
path string Filter the returned list by `path`. [optional]
name string Filter the returned list by `name`. [optional]
isDir string Filter the returned list by `is_dir`. [optional]
isShowroom string Filter the returned list by `is_showroom`. [optional]
present string Filter the returned list by `present`. [optional]
volume string Filter the returned list by `volume`. [optional]
sharedViaTokens string Filter the returned list by `shared_via_tokens`. [optional]
sharedViaTokensToken string Filter the returned list by `shared_via_tokens__token`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<MediaFile>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMediaRootPermissions

List<MediaRootPermission> GetAllMediaRootPermissions (string root = null, decimal? id = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMediaRootPermissionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var root = root_example;  // string | Filter the returned list by `root`. (optional) 
            var id = 8.14;  // decimal? | Filter the returned list by `id`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<MediaRootPermission> result = apiInstance.GetAllMediaRootPermissions(root, id, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMediaRootPermissions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
root string Filter the returned list by `root`. [optional]
id decimal? Filter the returned list by `id`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<MediaRootPermission>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMediaRoots

List<MediaRoot> GetAllMediaRoots (string path = null, string volume = null, string name = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMediaRootsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var path = path_example;  // string | Filter the returned list by `path`. (optional) 
            var volume = volume_example;  // string | Filter the returned list by `volume`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<MediaRoot> result = apiInstance.GetAllMediaRoots(path, volume, name, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMediaRoots: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
path string Filter the returned list by `path`. [optional]
volume string Filter the returned list by `volume`. [optional]
name string Filter the returned list by `name`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<MediaRoot>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMediaTags

List<UnfilteredTag> GetAllMediaTags (string name = null, string nameIcontains = null, string roots = null, string rootsIsnull = null, string shared = null, string ordering = null, int? limit = null, int? offset = null, int? forRoot = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMediaTagsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var nameIcontains = nameIcontains_example;  // string | Filter the returned list by `name__icontains`. (optional) 
            var roots = roots_example;  // string | Filter the returned list by `roots`. (optional) 
            var rootsIsnull = rootsIsnull_example;  // string | Filter the returned list by `roots__isnull`. (optional) 
            var shared = shared_example;  // string | Filter the returned list by `shared`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 
            var forRoot = 56;  // int? |  (optional) 

            try
            {
                List<UnfilteredTag> result = apiInstance.GetAllMediaTags(name, nameIcontains, roots, rootsIsnull, shared, ordering, limit, offset, forRoot);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMediaTags: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
name string Filter the returned list by `name`. [optional]
nameIcontains string Filter the returned list by `name__icontains`. [optional]
roots string Filter the returned list by `roots`. [optional]
rootsIsnull string Filter the returned list by `roots__isnull`. [optional]
shared string Filter the returned list by `shared`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]
forRoot int?   [optional]

Return type

List<UnfilteredTag>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllMediaUpdates

List<MediaUpdate> GetAllMediaUpdates (string asset = null, string user = null, string root = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access (read) / media:updates:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllMediaUpdatesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var user = user_example;  // string | Filter the returned list by `user`. (optional) 
            var root = root_example;  // string | Filter the returned list by `root`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<MediaUpdate> result = apiInstance.GetAllMediaUpdates(asset, user, root, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllMediaUpdates: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset string Filter the returned list by `asset`. [optional]
user string Filter the returned list by `user`. [optional]
root string Filter the returned list by `root`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<MediaUpdate>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllProxyGenerators

List<ProxyGenerator> GetAllProxyGenerators (string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllProxyGeneratorsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<ProxyGenerator> result = apiInstance.GetAllProxyGenerators(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllProxyGenerators: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<ProxyGenerator>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllProxyProfiles

List<ProxyProfile> GetAllProxyProfiles (string name = null, string ordering = null, int? limit = null, int? offset = null, int? forRoot = null)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllProxyProfilesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 
            var forRoot = 56;  // int? |  (optional) 

            try
            {
                List<ProxyProfile> result = apiInstance.GetAllProxyProfiles(name, ordering, limit, offset, forRoot);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllProxyProfiles: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
name string Filter the returned list by `name`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]
forRoot int?   [optional]

Return type

List<ProxyProfile>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllSubclipClipboardEntries

List<SubclipClipboardEntry> GetAllSubclipClipboardEntries (string cut = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllSubclipClipboardEntriesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var cut = cut_example;  // string | Filter the returned list by `cut`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<SubclipClipboardEntry> result = apiInstance.GetAllSubclipClipboardEntries(cut, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllSubclipClipboardEntries: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
cut string Filter the returned list by `cut`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<SubclipClipboardEntry>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllSubclips

List<Subclip> GetAllSubclips (string asset = null, string assetIn = null, string root = null, string name = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllSubclipsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var assetIn = assetIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var root = root_example;  // string | Filter the returned list by `root`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<Subclip> result = apiInstance.GetAllSubclips(asset, assetIn, root, name, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllSubclips: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset string Filter the returned list by `asset`. [optional]
assetIn string Multiple values may be separated by commas. [optional]
root string Filter the returned list by `root`. [optional]
name string Filter the returned list by `name`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<Subclip>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllTranscoderProfiles

List<TranscoderProfile> GetAllTranscoderProfiles (string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: tasks:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllTranscoderProfilesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<TranscoderProfile> result = apiInstance.GetAllTranscoderProfiles(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAllTranscoderProfiles: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<TranscoderProfile>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAsset

Asset GetAsset (int id, bool? includeProxies = null, bool? includeModifiedBy = null, bool? resolveAssetPermission = null, int? forRoot = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAssetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Asset.
            var includeProxies = true;  // bool? |  (optional) 
            var includeModifiedBy = true;  // bool? |  (optional) 
            var resolveAssetPermission = true;  // bool? |  (optional) 
            var forRoot = 56;  // int? |  (optional) 

            try
            {
                Asset result = apiInstance.GetAsset(id, includeProxies, includeModifiedBy, resolveAssetPermission, forRoot);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAsset: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Asset.  
includeProxies bool?   [optional]
includeModifiedBy bool?   [optional]
resolveAssetPermission bool?   [optional]
forRoot int?   [optional]

Return type

Asset

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAssetRating

AssetRating GetAssetRating (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAssetRatingExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Rating.

            try
            {
                AssetRating result = apiInstance.GetAssetRating(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetAssetRating: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Rating.  

Return type

AssetRating

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBookmarkedMediaFilesDirectories

List<MediaFile> GetBookmarkedMediaFilesDirectories (string bundle = null, string bundleIn = null, string parent = null, string path = null, string name = null, string isDir = null, string isShowroom = null, string present = null, string volume = null, string sharedViaTokens = null, string sharedViaTokensToken = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetBookmarkedMediaFilesDirectoriesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var bundle = bundle_example;  // string | Filter the returned list by `bundle`. (optional) 
            var bundleIn = bundleIn_example;  // string | Multiple values may be separated by commas. (optional) 
            var parent = parent_example;  // string | Filter the returned list by `parent`. (optional) 
            var path = path_example;  // string | Filter the returned list by `path`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var isDir = isDir_example;  // string | Filter the returned list by `is_dir`. (optional) 
            var isShowroom = isShowroom_example;  // string | Filter the returned list by `is_showroom`. (optional) 
            var present = present_example;  // string | Filter the returned list by `present`. (optional) 
            var volume = volume_example;  // string | Filter the returned list by `volume`. (optional) 
            var sharedViaTokens = sharedViaTokens_example;  // string | Filter the returned list by `shared_via_tokens`. (optional) 
            var sharedViaTokensToken = sharedViaTokensToken_example;  // string | Filter the returned list by `shared_via_tokens__token`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<MediaFile> result = apiInstance.GetBookmarkedMediaFilesDirectories(bundle, bundleIn, parent, path, name, isDir, isShowroom, present, volume, sharedViaTokens, sharedViaTokensToken, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetBookmarkedMediaFilesDirectories: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
bundle string Filter the returned list by `bundle`. [optional]
bundleIn string Multiple values may be separated by commas. [optional]
parent string Filter the returned list by `parent`. [optional]
path string Filter the returned list by `path`. [optional]
name string Filter the returned list by `name`. [optional]
isDir string Filter the returned list by `is_dir`. [optional]
isShowroom string Filter the returned list by `is_showroom`. [optional]
present string Filter the returned list by `present`. [optional]
volume string Filter the returned list by `volume`. [optional]
sharedViaTokens string Filter the returned list by `shared_via_tokens`. [optional]
sharedViaTokensToken string Filter the returned list by `shared_via_tokens__token`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<MediaFile>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetComment

Comment GetComment (int id, int? forRoot = null, int? tasksForUser = null, bool? includeFullAsset = null, string advancedSearch = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetCommentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Comment.
            var forRoot = 56;  // int? |  (optional) 
            var tasksForUser = 56;  // int? |  (optional) 
            var includeFullAsset = true;  // bool? |  (optional) 
            var advancedSearch = advancedSearch_example;  // string |  (optional) 

            try
            {
                Comment result = apiInstance.GetComment(id, forRoot, tasksForUser, includeFullAsset, advancedSearch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetComment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Comment.  
forRoot int?   [optional]
tasksForUser int?   [optional]
includeFullAsset bool?   [optional]
advancedSearch string   [optional]

Return type

Comment

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCustomField

CustomField GetCustomField (int id)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetCustomFieldExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Custom field.

            try
            {
                CustomField result = apiInstance.GetCustomField(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetCustomField: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Custom field.  

Return type

CustomField

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEasySharingTokenForBundle

OneTimeAccessToken GetEasySharingTokenForBundle (int id)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetEasySharingTokenForBundleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Bundle.

            try
            {
                OneTimeAccessToken result = apiInstance.GetEasySharingTokenForBundle(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetEasySharingTokenForBundle: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Bundle.  

Return type

OneTimeAccessToken

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEasySharingTokenForDirectory

OneTimeAccessToken GetEasySharingTokenForDirectory (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetEasySharingTokenForDirectoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                OneTimeAccessToken result = apiInstance.GetEasySharingTokenForDirectory(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetEasySharingTokenForDirectory: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

OneTimeAccessToken

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEditorProject

EditorProject GetEditorProject (int id)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetEditorProjectExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                EditorProject result = apiInstance.GetEditorProject(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetEditorProject: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

EditorProject

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExternalTranscoder

ExternalTranscoder GetExternalTranscoder (int id)

Required permissions * User account permission: media:access (read) / system:admin-access (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetExternalTranscoderExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this external transcoder.

            try
            {
                ExternalTranscoder result = apiInstance.GetExternalTranscoder(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetExternalTranscoder: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this external transcoder.  

Return type

ExternalTranscoder

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFrame

void GetFrame (string frame, int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetFrameExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var frame = frame_example;  // string | 
            var id = 56;  // int | A unique integer value identifying this Asset.

            try
            {
                apiInstance.GetFrame(frame, id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetFrame: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
frame string    
id int A unique integer value identifying this Asset.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLatestMediaUpdate

MediaUpdate GetLatestMediaUpdate (string asset = null, string user = null, string root = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access (read) / media:updates:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetLatestMediaUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var asset = asset_example;  // string | Filter the returned list by `asset`. (optional) 
            var user = user_example;  // string | Filter the returned list by `user`. (optional) 
            var root = root_example;  // string | Filter the returned list by `root`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                MediaUpdate result = apiInstance.GetLatestMediaUpdate(asset, user, root, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetLatestMediaUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
asset string Filter the returned list by `asset`. [optional]
user string Filter the returned list by `user`. [optional]
root string Filter the returned list by `root`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

MediaUpdate

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarker

Marker GetMarker (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMarkerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this marker.

            try
            {
                Marker result = apiInstance.GetMarker(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMarker: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this marker.  

Return type

Marker

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMediaFile

MediaFile GetMediaFile (int id, bool? resolveFilePermission = null, bool? includeModifiedBy = null, bool? includeEffectiveCustomFields = null, bool? includeRoot = null, bool? includeParents = null, string advancedSearch = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMediaFileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.
            var resolveFilePermission = true;  // bool? |  (optional) 
            var includeModifiedBy = true;  // bool? |  (optional) 
            var includeEffectiveCustomFields = true;  // bool? |  (optional) 
            var includeRoot = true;  // bool? |  (optional) 
            var includeParents = true;  // bool? |  (optional) 
            var advancedSearch = advancedSearch_example;  // string |  (optional) 

            try
            {
                MediaFile result = apiInstance.GetMediaFile(id, resolveFilePermission, includeModifiedBy, includeEffectiveCustomFields, includeRoot, includeParents, advancedSearch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMediaFile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  
resolveFilePermission bool?   [optional]
includeModifiedBy bool?   [optional]
includeEffectiveCustomFields bool?   [optional]
includeRoot bool?   [optional]
includeParents bool?   [optional]
advancedSearch string   [optional]

Return type

MediaFile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMediaFileBundle

MediaFileBundle GetMediaFileBundle (int id, bool? excludeDeleted = null, bool? excludeUnrecognized = null, bool? includeProxies = null, bool? includeParents = null, int? offset = null, int? limit = null, string advancedSearch = null)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMediaFileBundleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Bundle.
            var excludeDeleted = true;  // bool? |  (optional) 
            var excludeUnrecognized = true;  // bool? |  (optional) 
            var includeProxies = true;  // bool? |  (optional) 
            var includeParents = true;  // bool? |  (optional) 
            var offset = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var advancedSearch = advancedSearch_example;  // string |  (optional) 

            try
            {
                MediaFileBundle result = apiInstance.GetMediaFileBundle(id, excludeDeleted, excludeUnrecognized, includeProxies, includeParents, offset, limit, advancedSearch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMediaFileBundle: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Bundle.  
excludeDeleted bool?   [optional]
excludeUnrecognized bool?   [optional]
includeProxies bool?   [optional]
includeParents bool?   [optional]
offset int?   [optional]
limit int?   [optional]
advancedSearch string   [optional]

Return type

MediaFileBundle

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMediaFileContents

MediaFileContents GetMediaFileContents (int id, bool? excludeDeleted = null, bool? excludeUnrecognized = null, int? offset = null, int? limit = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMediaFileContentsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.
            var excludeDeleted = true;  // bool? |  (optional) 
            var excludeUnrecognized = true;  // bool? |  (optional) 
            var offset = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                MediaFileContents result = apiInstance.GetMediaFileContents(id, excludeDeleted, excludeUnrecognized, offset, limit);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMediaFileContents: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  
excludeDeleted bool?   [optional]
excludeUnrecognized bool?   [optional]
offset int?   [optional]
limit int?   [optional]

Return type

MediaFileContents

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMediaFileTemplate

MediaFileTemplate GetMediaFileTemplate (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMediaFileTemplateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Template.

            try
            {
                MediaFileTemplate result = apiInstance.GetMediaFileTemplate(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMediaFileTemplate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Template.  

Return type

MediaFileTemplate

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMediaRoot

MediaRoot GetMediaRoot (int id)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMediaRootExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this media root.

            try
            {
                MediaRoot result = apiInstance.GetMediaRoot(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMediaRoot: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this media root.  

Return type

MediaRoot

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMediaRootPermission

MediaRootPermission GetMediaRootPermission (int id)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMediaRootPermissionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Media Root Permission.

            try
            {
                MediaRootPermission result = apiInstance.GetMediaRootPermission(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMediaRootPermission: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Media Root Permission.  

Return type

MediaRootPermission

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMediaTag

UnfilteredTag GetMediaTag (int id, int? forRoot = null)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMediaTagExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Tag.
            var forRoot = 56;  // int? |  (optional) 

            try
            {
                UnfilteredTag result = apiInstance.GetMediaTag(id, forRoot);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMediaTag: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Tag.  
forRoot int?   [optional]

Return type

UnfilteredTag

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMultipleAssets

List<Asset> GetMultipleAssets (MultipleAssetsRequest multipleAssetsRequest)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMultipleAssetsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var multipleAssetsRequest = new MultipleAssetsRequest(); // MultipleAssetsRequest | 

            try
            {
                List<Asset> result = apiInstance.GetMultipleAssets(multipleAssetsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMultipleAssets: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
multipleAssetsRequest MultipleAssetsRequest    

Return type

List<Asset>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMultipleBundles

List<MediaFileBundle> GetMultipleBundles (GetMultipleBundlesRequest getMultipleBundlesRequest)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMultipleBundlesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var getMultipleBundlesRequest = new GetMultipleBundlesRequest(); // GetMultipleBundlesRequest | 

            try
            {
                List<MediaFileBundle> result = apiInstance.GetMultipleBundles(getMultipleBundlesRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMultipleBundles: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
getMultipleBundlesRequest GetMultipleBundlesRequest    

Return type

List<MediaFileBundle>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMultipleFiles

List<MediaFile> GetMultipleFiles (GetMultipleFilesRequest getMultipleFilesRequest)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMultipleFilesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var getMultipleFilesRequest = new GetMultipleFilesRequest(); // GetMultipleFilesRequest | 

            try
            {
                List<MediaFile> result = apiInstance.GetMultipleFiles(getMultipleFilesRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMultipleFiles: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
getMultipleFilesRequest GetMultipleFilesRequest    

Return type

List<MediaFile>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMyMediaRootPermissions

List<MediaRootPermission> GetMyMediaRootPermissions (string root = null, decimal? id = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMyMediaRootPermissionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var root = root_example;  // string | Filter the returned list by `root`. (optional) 
            var id = 8.14;  // decimal? | Filter the returned list by `id`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<MediaRootPermission> result = apiInstance.GetMyMediaRootPermissions(root, id, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMyMediaRootPermissions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
root string Filter the returned list by `root`. [optional]
id decimal? Filter the returned list by `id`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<MediaRootPermission>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMyResolvedMediaRootPermissions

List<MediaRootPermission> GetMyResolvedMediaRootPermissions (string root = null, decimal? id = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetMyResolvedMediaRootPermissionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var root = root_example;  // string | Filter the returned list by `root`. (optional) 
            var id = 8.14;  // decimal? | Filter the returned list by `id`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<MediaRootPermission> result = apiInstance.GetMyResolvedMediaRootPermissions(root, id, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetMyResolvedMediaRootPermissions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
root string Filter the returned list by `root`. [optional]
id decimal? Filter the returned list by `id`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<MediaRootPermission>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProxy

Proxy GetProxy (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetProxyExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this proxy.

            try
            {
                Proxy result = apiInstance.GetProxy(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetProxy: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this proxy.  

Return type

Proxy

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProxyGenerator

ProxyGenerator GetProxyGenerator (string id)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetProxyGeneratorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = id_example;  // string | 

            try
            {
                ProxyGenerator result = apiInstance.GetProxyGenerator(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetProxyGenerator: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string    

Return type

ProxyGenerator

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProxyProfile

ProxyProfile GetProxyProfile (int id, int? forRoot = null)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetProxyProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this proxy profile.
            var forRoot = 56;  // int? |  (optional) 

            try
            {
                ProxyProfile result = apiInstance.GetProxyProfile(id, forRoot);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetProxyProfile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this proxy profile.  
forRoot int?   [optional]

Return type

ProxyProfile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProxyProfileProxyCount

ProxyCount GetProxyProfileProxyCount (int id)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetProxyProfileProxyCountExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this proxy profile.

            try
            {
                ProxyCount result = apiInstance.GetProxyProfileProxyCount(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetProxyProfileProxyCount: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this proxy profile.  

Return type

ProxyCount

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSubclip

Subclip GetSubclip (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetSubclipExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this subclip.

            try
            {
                Subclip result = apiInstance.GetSubclip(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetSubclip: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this subclip.  

Return type

Subclip

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTranscoderProfile

TranscoderProfile GetTranscoderProfile (int id)

Required permissions * User account permission: tasks:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetTranscoderProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this transcoder profile.

            try
            {
                TranscoderProfile result = apiInstance.GetTranscoderProfile(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetTranscoderProfile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this transcoder profile.  

Return type

TranscoderProfile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetVantageWorkflows

VantageWorkflows GetVantageWorkflows (int id)

Required permissions * User account permission: media:access (read) / system:admin-access (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetVantageWorkflowsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this external transcoder.

            try
            {
                VantageWorkflows result = apiInstance.GetVantageWorkflows(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.GetVantageWorkflows: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this external transcoder.  

Return type

VantageWorkflows

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InstantiateMediaFileTemplate

void InstantiateMediaFileTemplate (int id, InstantiateFileTemplateRequest instantiateFileTemplateRequest)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class InstantiateMediaFileTemplateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Template.
            var instantiateFileTemplateRequest = new InstantiateFileTemplateRequest(); // InstantiateFileTemplateRequest | 

            try
            {
                apiInstance.InstantiateMediaFileTemplate(id, instantiateFileTemplateRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.InstantiateMediaFileTemplate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Template.  
instantiateFileTemplateRequest InstantiateFileTemplateRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LocateEditorProjectPaths

List<LocateResult> LocateEditorProjectPaths (int id)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class LocateEditorProjectPathsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                List<LocateResult> result = apiInstance.LocateEditorProjectPaths(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.LocateEditorProjectPaths: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

List<LocateResult>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MarkMediaDirectoryAsShowroom

void MarkMediaDirectoryAsShowroom (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class MarkMediaDirectoryAsShowroomExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                apiInstance.MarkMediaDirectoryAsShowroom(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.MarkMediaDirectoryAsShowroom: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchAsset

Asset PatchAsset (int id, AssetPartialUpdate assetPartialUpdate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchAssetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Asset.
            var assetPartialUpdate = new AssetPartialUpdate(); // AssetPartialUpdate | 

            try
            {
                Asset result = apiInstance.PatchAsset(id, assetPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchAsset: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Asset.  
assetPartialUpdate AssetPartialUpdate    

Return type

Asset

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchAssetRating

AssetRating PatchAssetRating (int id, AssetRatingPartialUpdate assetRatingPartialUpdate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchAssetRatingExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Rating.
            var assetRatingPartialUpdate = new AssetRatingPartialUpdate(); // AssetRatingPartialUpdate | 

            try
            {
                AssetRating result = apiInstance.PatchAssetRating(id, assetRatingPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchAssetRating: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Rating.  
assetRatingPartialUpdate AssetRatingPartialUpdate    

Return type

AssetRating

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchComment

Comment PatchComment (int id, CommentPartialUpdate commentPartialUpdate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchCommentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Comment.
            var commentPartialUpdate = new CommentPartialUpdate(); // CommentPartialUpdate | 

            try
            {
                Comment result = apiInstance.PatchComment(id, commentPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchComment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Comment.  
commentPartialUpdate CommentPartialUpdate    

Return type

Comment

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchCustomField

CustomField PatchCustomField (int id, CustomFieldPartialUpdate customFieldPartialUpdate)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchCustomFieldExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Custom field.
            var customFieldPartialUpdate = new CustomFieldPartialUpdate(); // CustomFieldPartialUpdate | 

            try
            {
                CustomField result = apiInstance.PatchCustomField(id, customFieldPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchCustomField: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Custom field.  
customFieldPartialUpdate CustomFieldPartialUpdate    

Return type

CustomField

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchEditorProject

EditorProject PatchEditorProject (int id, EditorProjectPartialUpdate editorProjectPartialUpdate)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchEditorProjectExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.
            var editorProjectPartialUpdate = new EditorProjectPartialUpdate(); // EditorProjectPartialUpdate | 

            try
            {
                EditorProject result = apiInstance.PatchEditorProject(id, editorProjectPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchEditorProject: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  
editorProjectPartialUpdate EditorProjectPartialUpdate    

Return type

EditorProject

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchExternalTranscoder

ExternalTranscoder PatchExternalTranscoder (int id, ExternalTranscoderPartialUpdate externalTranscoderPartialUpdate)

Required permissions * User account permission: media:access (read) / system:admin-access (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchExternalTranscoderExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this external transcoder.
            var externalTranscoderPartialUpdate = new ExternalTranscoderPartialUpdate(); // ExternalTranscoderPartialUpdate | 

            try
            {
                ExternalTranscoder result = apiInstance.PatchExternalTranscoder(id, externalTranscoderPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchExternalTranscoder: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this external transcoder.  
externalTranscoderPartialUpdate ExternalTranscoderPartialUpdate    

Return type

ExternalTranscoder

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchMarker

Marker PatchMarker (int id, MarkerPartialUpdate markerPartialUpdate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchMarkerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this marker.
            var markerPartialUpdate = new MarkerPartialUpdate(); // MarkerPartialUpdate | 

            try
            {
                Marker result = apiInstance.PatchMarker(id, markerPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchMarker: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this marker.  
markerPartialUpdate MarkerPartialUpdate    

Return type

Marker

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchMediaFile

MediaFile PatchMediaFile (int id, MediaFilePartialUpdate mediaFilePartialUpdate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchMediaFileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.
            var mediaFilePartialUpdate = new MediaFilePartialUpdate(); // MediaFilePartialUpdate | 

            try
            {
                MediaFile result = apiInstance.PatchMediaFile(id, mediaFilePartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchMediaFile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  
mediaFilePartialUpdate MediaFilePartialUpdate    

Return type

MediaFile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchMediaFileTemplate

MediaFileTemplate PatchMediaFileTemplate (int id, MediaFileTemplatePartialUpdate mediaFileTemplatePartialUpdate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchMediaFileTemplateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Template.
            var mediaFileTemplatePartialUpdate = new MediaFileTemplatePartialUpdate(); // MediaFileTemplatePartialUpdate | 

            try
            {
                MediaFileTemplate result = apiInstance.PatchMediaFileTemplate(id, mediaFileTemplatePartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchMediaFileTemplate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Template.  
mediaFileTemplatePartialUpdate MediaFileTemplatePartialUpdate    

Return type

MediaFileTemplate

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchMediaRoot

MediaRoot PatchMediaRoot (int id, MediaRootPartialUpdate mediaRootPartialUpdate)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchMediaRootExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this media root.
            var mediaRootPartialUpdate = new MediaRootPartialUpdate(); // MediaRootPartialUpdate | 

            try
            {
                MediaRoot result = apiInstance.PatchMediaRoot(id, mediaRootPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchMediaRoot: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this media root.  
mediaRootPartialUpdate MediaRootPartialUpdate    

Return type

MediaRoot

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchMediaRootPermission

MediaRootPermission PatchMediaRootPermission (int id, MediaRootPermissionPartialUpdate mediaRootPermissionPartialUpdate)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchMediaRootPermissionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Media Root Permission.
            var mediaRootPermissionPartialUpdate = new MediaRootPermissionPartialUpdate(); // MediaRootPermissionPartialUpdate | 

            try
            {
                MediaRootPermission result = apiInstance.PatchMediaRootPermission(id, mediaRootPermissionPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchMediaRootPermission: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Media Root Permission.  
mediaRootPermissionPartialUpdate MediaRootPermissionPartialUpdate    

Return type

MediaRootPermission

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchMediaTag

UnfilteredTag PatchMediaTag (int id, UnfilteredTagPartialUpdate unfilteredTagPartialUpdate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchMediaTagExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Tag.
            var unfilteredTagPartialUpdate = new UnfilteredTagPartialUpdate(); // UnfilteredTagPartialUpdate | 

            try
            {
                UnfilteredTag result = apiInstance.PatchMediaTag(id, unfilteredTagPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchMediaTag: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Tag.  
unfilteredTagPartialUpdate UnfilteredTagPartialUpdate    

Return type

UnfilteredTag

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchProxyProfile

ProxyProfile PatchProxyProfile (int id, ProxyProfilePartialUpdate proxyProfilePartialUpdate)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchProxyProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this proxy profile.
            var proxyProfilePartialUpdate = new ProxyProfilePartialUpdate(); // ProxyProfilePartialUpdate | 

            try
            {
                ProxyProfile result = apiInstance.PatchProxyProfile(id, proxyProfilePartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchProxyProfile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this proxy profile.  
proxyProfilePartialUpdate ProxyProfilePartialUpdate    

Return type

ProxyProfile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchSubclip

Subclip PatchSubclip (int id, SubclipPartialUpdate subclipPartialUpdate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchSubclipExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this subclip.
            var subclipPartialUpdate = new SubclipPartialUpdate(); // SubclipPartialUpdate | 

            try
            {
                Subclip result = apiInstance.PatchSubclip(id, subclipPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.PatchSubclip: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this subclip.  
subclipPartialUpdate SubclipPartialUpdate    

Return type

Subclip

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RecursivelyTagMediaDirectory

void RecursivelyTagMediaDirectory (int id, TagMediaDirectoryRequest tagMediaDirectoryRequest)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RecursivelyTagMediaDirectoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.
            var tagMediaDirectoryRequest = new TagMediaDirectoryRequest(); // TagMediaDirectoryRequest | 

            try
            {
                apiInstance.RecursivelyTagMediaDirectory(id, tagMediaDirectoryRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.RecursivelyTagMediaDirectory: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  
tagMediaDirectoryRequest TagMediaDirectoryRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReindexMediaDirectory

void ReindexMediaDirectory (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ReindexMediaDirectoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                apiInstance.ReindexMediaDirectory(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.ReindexMediaDirectory: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RenameCustomField

TaskInfo RenameCustomField (int id, RenameCustomFieldRequest renameCustomFieldRequest)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RenameCustomFieldExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Custom field.
            var renameCustomFieldRequest = new RenameCustomFieldRequest(); // RenameCustomFieldRequest | 

            try
            {
                TaskInfo result = apiInstance.RenameCustomField(id, renameCustomFieldRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.RenameCustomField: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Custom field.  
renameCustomFieldRequest RenameCustomFieldRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RenderSequence

TaskInfo RenderSequence (RenderEndpointRequest renderEndpointRequest)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RenderSequenceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var renderEndpointRequest = new RenderEndpointRequest(); // RenderEndpointRequest | 

            try
            {
                TaskInfo result = apiInstance.RenderSequence(renderEndpointRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.RenderSequence: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
renderEndpointRequest RenderEndpointRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RenderSubclip

TaskInfo RenderSubclip (int id, RenderRequest renderRequest)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RenderSubclipExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this subclip.
            var renderRequest = new RenderRequest(); // RenderRequest | 

            try
            {
                TaskInfo result = apiInstance.RenderSubclip(id, renderRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.RenderSubclip: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this subclip.  
renderRequest RenderRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RequestMediaScan

void RequestMediaScan (ScannerScanEndpointRequest scannerScanEndpointRequest)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RequestMediaScanExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var scannerScanEndpointRequest = new ScannerScanEndpointRequest(); // ScannerScanEndpointRequest | 

            try
            {
                apiInstance.RequestMediaScan(scannerScanEndpointRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.RequestMediaScan: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scannerScanEndpointRequest ScannerScanEndpointRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResolveComment

Comment ResolveComment (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ResolveCommentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Comment.

            try
            {
                Comment result = apiInstance.ResolveComment(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.ResolveComment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Comment.  

Return type

Comment

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ShareMediaLibraryObjects

OneTimeAccessToken ShareMediaLibraryObjects (MediaLibraryShareRequest mediaLibraryShareRequest)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ShareMediaLibraryObjectsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var mediaLibraryShareRequest = new MediaLibraryShareRequest(); // MediaLibraryShareRequest | 

            try
            {
                OneTimeAccessToken result = apiInstance.ShareMediaLibraryObjects(mediaLibraryShareRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.ShareMediaLibraryObjects: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
mediaLibraryShareRequest MediaLibraryShareRequest    

Return type

OneTimeAccessToken

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestExternalTranscoderConnection

TestExternalTranscoderConnectionResponse TestExternalTranscoderConnection (TestExternalTranscoderConnectionRequest testExternalTranscoderConnectionRequest)

Required permissions * User account permission: media:access (read) / system:admin-access (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class TestExternalTranscoderConnectionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var testExternalTranscoderConnectionRequest = new TestExternalTranscoderConnectionRequest(); // TestExternalTranscoderConnectionRequest | 

            try
            {
                TestExternalTranscoderConnectionResponse result = apiInstance.TestExternalTranscoderConnection(testExternalTranscoderConnectionRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.TestExternalTranscoderConnection: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
testExternalTranscoderConnectionRequest TestExternalTranscoderConnectionRequest    

Return type

TestExternalTranscoderConnectionResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TransitionWorkflow

WorkflowTransitionResponse TransitionWorkflow (WorkflowTransitionRequest workflowTransitionRequest)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class TransitionWorkflowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var workflowTransitionRequest = new WorkflowTransitionRequest(); // WorkflowTransitionRequest | 

            try
            {
                WorkflowTransitionResponse result = apiInstance.TransitionWorkflow(workflowTransitionRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.TransitionWorkflow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
workflowTransitionRequest WorkflowTransitionRequest    

Return type

WorkflowTransitionResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnbookmarkMediaDirectory

void UnbookmarkMediaDirectory (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UnbookmarkMediaDirectoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                apiInstance.UnbookmarkMediaDirectory(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UnbookmarkMediaDirectory: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnmarkMediaDirectoryAsShowroom

void UnmarkMediaDirectoryAsShowroom (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UnmarkMediaDirectoryAsShowroomExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.

            try
            {
                apiInstance.UnmarkMediaDirectoryAsShowroom(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UnmarkMediaDirectoryAsShowroom: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnresolveComment

Comment UnresolveComment (int id)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UnresolveCommentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Comment.

            try
            {
                Comment result = apiInstance.UnresolveComment(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UnresolveComment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Comment.  

Return type

Comment

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateAsset

Asset UpdateAsset (int id, Asset asset)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateAssetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Asset.
            var asset = new Asset(); // Asset | 

            try
            {
                Asset result = apiInstance.UpdateAsset(id, asset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateAsset: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Asset.  
asset Asset    

Return type

Asset

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateAssetRating

AssetRating UpdateAssetRating (int id, AssetRating assetRating)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateAssetRatingExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Rating.
            var assetRating = new AssetRating(); // AssetRating | 

            try
            {
                AssetRating result = apiInstance.UpdateAssetRating(id, assetRating);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateAssetRating: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Rating.  
assetRating AssetRating    

Return type

AssetRating

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateComment

Comment UpdateComment (int id, Comment comment)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateCommentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Comment.
            var comment = new Comment(); // Comment | 

            try
            {
                Comment result = apiInstance.UpdateComment(id, comment);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateComment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Comment.  
comment Comment    

Return type

Comment

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCustomField

CustomField UpdateCustomField (int id, CustomField customField)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateCustomFieldExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Custom field.
            var customField = new CustomField(); // CustomField | 

            try
            {
                CustomField result = apiInstance.UpdateCustomField(id, customField);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateCustomField: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Custom field.  
customField CustomField    

Return type

CustomField

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateEditorProject

EditorProject UpdateEditorProject (int id, EditorProject editorProject)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateEditorProjectExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.
            var editorProject = new EditorProject(); // EditorProject | 

            try
            {
                EditorProject result = apiInstance.UpdateEditorProject(id, editorProject);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateEditorProject: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  
editorProject EditorProject    

Return type

EditorProject

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateExternalTranscoder

ExternalTranscoder UpdateExternalTranscoder (int id, ExternalTranscoder externalTranscoder)

Required permissions * User account permission: media:access (read) / system:admin-access (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateExternalTranscoderExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this external transcoder.
            var externalTranscoder = new ExternalTranscoder(); // ExternalTranscoder | 

            try
            {
                ExternalTranscoder result = apiInstance.UpdateExternalTranscoder(id, externalTranscoder);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateExternalTranscoder: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this external transcoder.  
externalTranscoder ExternalTranscoder    

Return type

ExternalTranscoder

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateMarker

Marker UpdateMarker (int id, Marker marker)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateMarkerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this marker.
            var marker = new Marker(); // Marker | 

            try
            {
                Marker result = apiInstance.UpdateMarker(id, marker);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateMarker: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this marker.  
marker Marker    

Return type

Marker

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateMediaFile

MediaFile UpdateMediaFile (int id, MediaFile mediaFile)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateMediaFileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this File.
            var mediaFile = new MediaFile(); // MediaFile | 

            try
            {
                MediaFile result = apiInstance.UpdateMediaFile(id, mediaFile);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateMediaFile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this File.  
mediaFile MediaFile    

Return type

MediaFile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateMediaFileTemplate

MediaFileTemplate UpdateMediaFileTemplate (int id, MediaFileTemplate mediaFileTemplate)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateMediaFileTemplateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Template.
            var mediaFileTemplate = new MediaFileTemplate(); // MediaFileTemplate | 

            try
            {
                MediaFileTemplate result = apiInstance.UpdateMediaFileTemplate(id, mediaFileTemplate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateMediaFileTemplate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Template.  
mediaFileTemplate MediaFileTemplate    

Return type

MediaFileTemplate

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateMediaRoot

MediaRoot UpdateMediaRoot (int id, MediaRoot mediaRoot)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateMediaRootExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this media root.
            var mediaRoot = new MediaRoot(); // MediaRoot | 

            try
            {
                MediaRoot result = apiInstance.UpdateMediaRoot(id, mediaRoot);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateMediaRoot: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this media root.  
mediaRoot MediaRoot    

Return type

MediaRoot

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateMediaRootPermission

MediaRootPermission UpdateMediaRootPermission (int id, MediaRootPermission mediaRootPermission)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateMediaRootPermissionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Media Root Permission.
            var mediaRootPermission = new MediaRootPermission(); // MediaRootPermission | 

            try
            {
                MediaRootPermission result = apiInstance.UpdateMediaRootPermission(id, mediaRootPermission);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateMediaRootPermission: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Media Root Permission.  
mediaRootPermission MediaRootPermission    

Return type

MediaRootPermission

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateMediaTag

UnfilteredTag UpdateMediaTag (int id, UnfilteredTag unfilteredTag)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateMediaTagExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this Tag.
            var unfilteredTag = new UnfilteredTag(); // UnfilteredTag | 

            try
            {
                UnfilteredTag result = apiInstance.UpdateMediaTag(id, unfilteredTag);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateMediaTag: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Tag.  
unfilteredTag UnfilteredTag    

Return type

UnfilteredTag

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateProxyProfile

ProxyProfile UpdateProxyProfile (int id, ProxyProfile proxyProfile)

Required permissions * User account permission: media:access (read) / media:roots:manage (write) * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateProxyProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this proxy profile.
            var proxyProfile = new ProxyProfile(); // ProxyProfile | 

            try
            {
                ProxyProfile result = apiInstance.UpdateProxyProfile(id, proxyProfile);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateProxyProfile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this proxy profile.  
proxyProfile ProxyProfile    

Return type

ProxyProfile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSubclip

Subclip UpdateSubclip (int id, Subclip subclip)

Required permissions * User account permission: media:access * License component: media

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateSubclipExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MediaLibraryApi(config);
            var id = 56;  // int | A unique integer value identifying this subclip.
            var subclip = new Subclip(); // Subclip | 

            try
            {
                Subclip result = apiInstance.UpdateSubclip(id, subclip);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MediaLibraryApi.UpdateSubclip: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this subclip.  
subclip Subclip    

Return type

Subclip

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]