Logo

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

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

    open class func bookmarkMediaDirectory( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.bookmarkMediaDirectory(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

clearSubclipClipboard

    open class func clearSubclipClipboard() -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MediaLibraryAPI.clearSubclipClipboard().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

combineAssetsIntoSet

    open class func combineAssetsIntoSet( multipleAssetsRequest: MultipleAssetsRequest) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let multipleAssetsRequest = MultipleAssetsRequest(assets: [123]) // MultipleAssetsRequest | 

MediaLibraryAPI.combineAssetsIntoSet(multipleAssetsRequest: multipleAssetsRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
multipleAssetsRequest MultipleAssetsRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

createAsset

    open class func createAsset( asset: Asset) -> Promise<Asset>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = Asset(id: 123, urls: "TODO", proxies: [Proxy(id: 123, urls: "TODO", profile: ProxyProfileMini(id: 123, name: "name_example"), failedReason: "failedReason_example", transforms: "transforms_example", generated: false, failed: false, name: "name_example", variantId: "variantId_example", variantConfig: "variantConfig_example", asset: 123)], defaultProxy: nil, info: "TODO", proxyInfo: "TODO", customFields: "TODO", tags: [TagReference(id: 123, name: "name_example", color: "color_example", root: 123)], resolvedPermission: MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123), bundles: ["TODO"], backups: "backups_example", proxiesGenerated: false, proxiesFailed: false, modifiedBy: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), syncId: 123, displayName: "displayName_example", hasFiles: false, hasBackups: false, hasCloudLinks: false, checksum: "checksum_example", type: "type_example", thumbnailGenerated: false, matchedScanner: "matchedScanner_example", rating: 123, workflowState: 123, isTemporary: false, created: Date(), modified: Date(), _set: 123) // Asset | 

MediaLibraryAPI.createAsset(asset: asset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
asset Asset    

Return type

Asset

Authorization

Bearer

HTTP request headers

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

createAssetRating

    open class func createAssetRating( assetRating: AssetRating) -> Promise<AssetRating>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let assetRating = AssetRating(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), rating: 123, date: Date(), asset: 123) // AssetRating | 

MediaLibraryAPI.createAssetRating(assetRating: assetRating).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
assetRating AssetRating    

Return type

AssetRating

Authorization

Bearer

HTTP request headers

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

createComment

    open class func createComment( comment: Comment) -> Promise<Comment>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let comment = Comment(id: 123, assignee: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), user: nil, drawing: "TODO", tags: [TagReference(id: 123, name: "name_example", color: "color_example", root: 123)], fullAsset: Asset(id: 123, urls: "TODO", proxies: [Proxy(id: 123, urls: "TODO", profile: ProxyProfileMini(id: 123, name: "name_example"), failedReason: "failedReason_example", transforms: "transforms_example", generated: false, failed: false, name: "name_example", variantId: "variantId_example", variantConfig: "variantConfig_example", asset: 123)], defaultProxy: nil, info: "TODO", proxyInfo: "TODO", customFields: "TODO", tags: [nil], resolvedPermission: MediaRootPermission(id: 123, user: nil, group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123), bundles: ["TODO"], backups: "backups_example", proxiesGenerated: false, proxiesFailed: false, modifiedBy: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), syncId: 123, displayName: "displayName_example", hasFiles: false, hasBackups: false, hasCloudLinks: false, checksum: "checksum_example", type: "type_example", thumbnailGenerated: false, matchedScanner: "matchedScanner_example", rating: 123, workflowState: 123, isTemporary: false, created: Date(), modified: Date(), _set: 123), syncId: 123, date: Date(), text: "text_example", time: 123, isCloud: false, resolved: false, resolvedDate: Date(), asset: 123, root: 123, parent: 123) // Comment | 

MediaLibraryAPI.createComment(comment: comment).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
comment Comment    

Return type

Comment

Authorization

Bearer

HTTP request headers

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

createCustomField

    open class func createCustomField( customField: CustomField) -> Promise<CustomField>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let customField = CustomField(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example") // CustomField | 

MediaLibraryAPI.createCustomField(customField: customField).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
customField CustomField    

Return type

CustomField

Authorization

Bearer

HTTP request headers

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

createEditorProject

    open class func createEditorProject( editorProject: EditorProject) -> Promise<EditorProject>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let editorProject = EditorProject(file: 123, parent: 123, parentPath: "parentPath_example", existingFile: 123, format: "format_example", project: "TODO") // EditorProject | 

MediaLibraryAPI.createEditorProject(editorProject: editorProject).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
editorProject EditorProject    

Return type

EditorProject

Authorization

Bearer

HTTP request headers

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

createExternalTranscoder

    open class func createExternalTranscoder( externalTranscoder: ExternalTranscoder) -> Promise<ExternalTranscoder>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let externalTranscoder = ExternalTranscoder(id: 123, pathMappings: ["pathMappings_example"], name: "name_example", type: "type_example", address: "address_example") // ExternalTranscoder | 

MediaLibraryAPI.createExternalTranscoder(externalTranscoder: externalTranscoder).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
externalTranscoder ExternalTranscoder    

Return type

ExternalTranscoder

Authorization

Bearer

HTTP request headers

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

createMarker

    open class func createMarker( marker: Marker) -> Promise<Marker>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let marker = Marker(id: 123, veritoneMetadataParser: "veritoneMetadataParser_example", title: "title_example", text: "text_example", tIn: 123, tOut: 123, createdAt: Date(), modifiedAt: Date(), user: 123, asset: 123, comment: 123, veritoneMetadata: 123) // Marker | 

MediaLibraryAPI.createMarker(marker: marker).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
marker Marker    

Return type

Marker

Authorization

Bearer

HTTP request headers

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

createMediaFileTemplate

    open class func createMediaFileTemplate( mediaFileTemplate: MediaFileTemplate) -> Promise<MediaFileTemplate>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let mediaFileTemplate = MediaFileTemplate(id: 123, file: MediaFileReference(id: 123, volume: VolumeMini(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), info: "TODO", customFields: "TODO", resolvedPermission: MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123), parentFile: "TODO", root: MediaRootMini(id: 123, name: "name_example", fullPath: "fullPath_example", customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), path: "path_example", prefetchThumbnailStrips: false), effectiveCustomFields: "TODO", modifiedBy: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), fullPath: "fullPath_example", searchHighlight: "searchHighlight_example", isShared: false, isExcluded: false, isHardlink: false, isBookmarked: false, name: "name_example", path: "path_example", pathhash: "pathhash_example", isDir: false, totalFiles: 123, size: 123, mtime: 123, present: false, needsRescan: false, isShowroom: false, bundleIndex: 123, modified: Date(), parent: 123, bundle: 123, bookmarkedBy: [123]), name: "name_example") // MediaFileTemplate | 

MediaLibraryAPI.createMediaFileTemplate(mediaFileTemplate: mediaFileTemplate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
mediaFileTemplate MediaFileTemplate    

Return type

MediaFileTemplate

Authorization

Bearer

HTTP request headers

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

createMediaRoot

    open class func createMediaRoot( mediaRoot: MediaRoot) -> Promise<MediaRoot>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let mediaRoot = MediaRoot(id: 123, customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], workflow: "TODO", aiConfig: "TODO", veritoneConfig: "TODO", volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), fullPath: "fullPath_example", resolvedPermissions: [MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123)], jobs: [JobReference(id: 123, subtasks: [SubtaskReference(id: 123, kwargs: "TODO", graphLayout: "TODO", validationError: "validationError_example", trigger: "trigger_example", name: "name_example", noopDontSave: false, noConcurrency: false, timeout: 123, logVariable: false, task: "task_example", conditionVariable: "conditionVariable_example", conditionValue: "conditionValue_example", sync: false, queue: "queue_example", enqueueAtFront: false, parent: 123, relativeTo: 123)], schedules: [ScheduleReference(id: 123, variables: "TODO", nextRun: Date(), type: 123, enabled: false, lastRun: Date(), every: 123, period: "period_example", crontabDayOfMonth: "crontabDayOfMonth_example", crontabDayOfWeek: "crontabDayOfWeek_example", crontabHour: "crontabHour_example", crontabMinute: "crontabMinute_example", crontabMonthOfYear: "crontabMonthOfYear_example", job: 123)], allowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], allowGroups: [nil], startable: false, variableDefinitions: ["variableDefinitions_example"], mediaRoots: [123], webhookUrl: "webhookUrl_example", specialType: 123, name: "name_example", enabled: false, allowOthersToStart: false, allowClientToStart: false, showAsButton: false, inputType: "inputType_example", hook: "hook_example", webhookSecret: "webhookSecret_example", securityContext: 123, partOfWorkflowFor: 123)], workflowJobs: [Job(id: 123, subtasks: [nil], schedules: [nil], allowUsers: [nil], allowGroups: [nil], startable: false, variableDefinitions: ["variableDefinitions_example"], mediaRoots: [123], webhookUrl: "webhookUrl_example", specialType: 123, name: "name_example", enabled: false, allowOthersToStart: false, allowClientToStart: false, showAsButton: false, inputType: "inputType_example", hook: "hook_example", webhookSecret: "webhookSecret_example", securityContext: 123, partOfWorkflowFor: 123)], name: "name_example", path: "path_example", needsRescan: false, viewMode: "viewMode_example", viewStyle: "viewStyle_example", viewDefaultTab: "viewDefaultTab_example", showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showMarkers: false, showAiMetadata: false, prefetchThumbnailStrips: false, cover: "cover_example", nameField: "nameField_example", shareComments: false, shareLinkDuration: 123, defaultProxyProfile: 123, cloudProxyProfile: 123, veritoneConnection: 123, veritoneProxyProfile: 123, aiConnection: 123, aiProxyProfile: 123, proxyProfiles: [123]) // MediaRoot | 

MediaLibraryAPI.createMediaRoot(mediaRoot: mediaRoot).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
mediaRoot MediaRoot    

Return type

MediaRoot

Authorization

Bearer

HTTP request headers

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

createMediaRootPermission

    open class func createMediaRootPermission( mediaRootPermission: MediaRootPermission) -> Promise<MediaRootPermission>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let mediaRootPermission = MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123) // MediaRootPermission | 

MediaLibraryAPI.createMediaRootPermission(mediaRootPermission: mediaRootPermission).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
mediaRootPermission MediaRootPermission    

Return type

MediaRootPermission

Authorization

Bearer

HTTP request headers

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

createMediaTag

    open class func createMediaTag( tag: Tag) -> Promise<Tag>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let tag = Tag(id: 123, name: "name_example", color: "color_example", root: 123) // Tag | 

MediaLibraryAPI.createMediaTag(tag: tag).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
tag Tag    

Return type

Tag

Authorization

Bearer

HTTP request headers

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

createProxyProfile

    open class func createProxyProfile( proxyProfile: ProxyProfile) -> Promise<ProxyProfile>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let proxyProfile = ProxyProfile(id: 123, name: "name_example", proxyGenerator: "proxyGenerator_example", resolution: "resolution_example", rateControl: 123, crf: 123, bitrate: 123, audioBitrate: 123, variantsLimit: 123, enableRealtimeRead: false, enableDenseFilmstrip: false, enableWatermark: false, watermarkImage: "watermarkImage_example", watermarkPosition: 123, watermarkOpacity: 123, watermarkSize: 123, enableTimecode: false, timecodePosition: 123, timecodeOpacity: 123, timecodeSize: 123, lut: "lut_example", hotfolderCopyTo: "hotfolderCopyTo_example", hotfolderReadFrom: "hotfolderReadFrom_example", hotfolderQueueTimeout: 123, hotfolderEncodeTimeout: 123, vantageWorkflowId: "vantageWorkflowId_example", externalTranscoderStagingPath: "externalTranscoderStagingPath_example", externalTranscoder: 123) // ProxyProfile | 

MediaLibraryAPI.createProxyProfile(proxyProfile: proxyProfile).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
proxyProfile ProxyProfile    

Return type

ProxyProfile

Authorization

Bearer

HTTP request headers

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

createSubclip

    open class func createSubclip( subclip: Subclip) -> Promise<Subclip>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let subclip = Subclip(id: 123, asset: AssetMiniReference(id: 123, syncId: 123, defaultProxy: Proxy(id: 123, urls: "TODO", profile: ProxyProfileMini(id: 123, name: "name_example"), failedReason: "failedReason_example", transforms: "transforms_example", generated: false, failed: false, name: "name_example", variantId: "variantId_example", variantConfig: "variantConfig_example", asset: 123), urls: "TODO", type: "type_example", displayName: "displayName_example", info: "info_example", thumbnailGenerated: false), rendered: nil, shared: false, date: Date(), name: "name_example", tIn: 123, tOut: 123, user: 123, root: MediaRootMiniReference(id: 123, name: "name_example", fullPath: "fullPath_example", customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), path: "path_example", prefetchThumbnailStrips: false)) // Subclip | 

MediaLibraryAPI.createSubclip(subclip: subclip).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
subclip Subclip    

Return type

Subclip

Authorization

Bearer

HTTP request headers

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

createSubclipClipboardEntry

    open class func createSubclipClipboardEntry( subclipClipboardEntry: SubclipClipboardEntry) -> Promise<SubclipClipboardEntry>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let subclipClipboardEntry = SubclipClipboardEntry(id: 123, cut: SubclipReference(id: 123, asset: AssetMiniReference(id: 123, syncId: 123, defaultProxy: Proxy(id: 123, urls: "TODO", profile: ProxyProfileMini(id: 123, name: "name_example"), failedReason: "failedReason_example", transforms: "transforms_example", generated: false, failed: false, name: "name_example", variantId: "variantId_example", variantConfig: "variantConfig_example", asset: 123), urls: "TODO", type: "type_example", displayName: "displayName_example", info: "info_example", thumbnailGenerated: false), rendered: nil, shared: false, date: Date(), name: "name_example", tIn: 123, tOut: 123, user: 123, root: MediaRootMiniReference(id: 123, name: "name_example", fullPath: "fullPath_example", customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), path: "path_example", prefetchThumbnailStrips: false)), bundle: MediaFileBundleMiniReference(id: 123, asset: 123, name: "name_example", location: 123, mainfile: MediaFileMini(id: 123, name: "name_example", bundle: 123, fullPath: "fullPath_example", customFields: "TODO", isDir: false, isHardlink: false, mtime: 123, parent: 123, parentFile: "TODO", path: "path_example", present: false, size: 123, volume: VolumeMini(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"))), date: Date()) // SubclipClipboardEntry | 

MediaLibraryAPI.createSubclipClipboardEntry(subclipClipboardEntry: subclipClipboardEntry).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
subclipClipboardEntry SubclipClipboardEntry    

Return type

SubclipClipboardEntry

Authorization

Bearer

HTTP request headers

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

deleteAsset

    open class func deleteAsset( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Asset.

MediaLibraryAPI.deleteAsset(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteAssetRating

    open class func deleteAssetRating( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Rating.

MediaLibraryAPI.deleteAssetRating(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteComment

    open class func deleteComment( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Comment.

MediaLibraryAPI.deleteComment(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteCustomField

    open class func deleteCustomField( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Custom field.

MediaLibraryAPI.deleteCustomField(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteEasySharingTokenForBundle

    open class func deleteEasySharingTokenForBundle( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Bundle.

MediaLibraryAPI.deleteEasySharingTokenForBundle(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteEasySharingTokenForDirectory

    open class func deleteEasySharingTokenForDirectory( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.deleteEasySharingTokenForDirectory(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteExternalTranscoder

    open class func deleteExternalTranscoder( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this external transcoder.

MediaLibraryAPI.deleteExternalTranscoder(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteMarker

    open class func deleteMarker( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this marker.

MediaLibraryAPI.deleteMarker(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteMediaFileTemplate

    open class func deleteMediaFileTemplate( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Template.

MediaLibraryAPI.deleteMediaFileTemplate(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteMediaLibraryObjects

    open class func deleteMediaLibraryObjects( mediaLibraryDeleteRequest: MediaLibraryDeleteRequest) -> Promise<[TaskInfo]>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let mediaLibraryDeleteRequest = MediaLibraryDeleteRequest(bundles: [123], files: [123], assets: [123], deleteFromDatabase: false, deleteFromStorage: false) // MediaLibraryDeleteRequest | 

MediaLibraryAPI.deleteMediaLibraryObjects(mediaLibraryDeleteRequest: mediaLibraryDeleteRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
mediaLibraryDeleteRequest MediaLibraryDeleteRequest    

Return type

[TaskInfo]

Authorization

Bearer

HTTP request headers

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

deleteMediaRoot

    open class func deleteMediaRoot( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this media root.

MediaLibraryAPI.deleteMediaRoot(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteMediaRootPermission

    open class func deleteMediaRootPermission( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Media Root Permission.

MediaLibraryAPI.deleteMediaRootPermission(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteMediaTag

    open class func deleteMediaTag( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Tag.

MediaLibraryAPI.deleteMediaTag(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteMediaUpdate

    open class func deleteMediaUpdate( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Update.

MediaLibraryAPI.deleteMediaUpdate(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteProxy

    open class func deleteProxy( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this proxy.

MediaLibraryAPI.deleteProxy(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteProxyProfile

    open class func deleteProxyProfile( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this proxy profile.

MediaLibraryAPI.deleteProxyProfile(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteSubclip

    open class func deleteSubclip( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this subclip.

MediaLibraryAPI.deleteSubclip(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

deleteSubclipClipboardEntry

    open class func deleteSubclipClipboardEntry( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this subclip clipboard entry.

MediaLibraryAPI.deleteSubclipClipboardEntry(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

discoverMedia

    open class func discoverMedia( scannerDiscoverEndpointRequest: ScannerDiscoverEndpointRequest) -> Promise<MediaFile>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let scannerDiscoverEndpointRequest = ScannerDiscoverEndpointRequest(path: "path_example", recursive: false) // ScannerDiscoverEndpointRequest | 

MediaLibraryAPI.discoverMedia(scannerDiscoverEndpointRequest: scannerDiscoverEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
scannerDiscoverEndpointRequest ScannerDiscoverEndpointRequest    

Return type

MediaFile

Authorization

Bearer

HTTP request headers

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

downloadAssetProxyFile

    open class func downloadAssetProxyFile( filename: String,  id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let filename = "filename_example" // String | 
let id = 987 // Int | A unique integer value identifying this Asset.

MediaLibraryAPI.downloadAssetProxyFile(filename: filename, id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

downloadMediaFile

    open class func downloadMediaFile( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.downloadMediaFile(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

downloadProxy

    open class func downloadProxy( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this proxy.

MediaLibraryAPI.downloadProxy(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

editorExportXMLForAssset

    open class func editorExportXMLForAssset( assetIds: String,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let assetIds = "assetIds_example" // String | 
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.editorExportXMLForAssset(assetIds: assetIds, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

editorExportXMLForBundle

    open class func editorExportXMLForBundle( bundleIds: String,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let bundleIds = "bundleIds_example" // String | 
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.editorExportXMLForBundle(bundleIds: bundleIds, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

editorExportXMLForProject

    open class func editorExportXMLForProject( id: Int) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.editorExportXMLForProject(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

exportCommentsForAvid

    open class func exportCommentsForAvid( assetId: String,  exportFormat: String,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let assetId = "assetId_example" // String | 
let exportFormat = "exportFormat_example" // String | 
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.exportCommentsForAvid(assetId: assetId, exportFormat: exportFormat, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

exportEditorTimeline

    open class func exportEditorTimeline( timelineExportRequest: TimelineExportRequest) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let timelineExportRequest = TimelineExportRequest(project: "TODO", sequence: "TODO", format: "format_example") // TimelineExportRequest | 

MediaLibraryAPI.exportEditorTimeline(timelineExportRequest: timelineExportRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
timelineExportRequest TimelineExportRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

forgetDeletedMediaFiles

    open class func forgetDeletedMediaFiles( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.forgetDeletedMediaFiles(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

generateProxies

    open class func generateProxies( generateProxiesRequest: GenerateProxiesRequest) -> Promise<[TaskInfo]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let generateProxiesRequest = GenerateProxiesRequest(bundles: [123], directories: [123], proxyProfiles: [123], enqueueAtFront: false, force: false) // GenerateProxiesRequest | 

MediaLibraryAPI.generateProxies(generateProxiesRequest: generateProxiesRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
generateProxiesRequest GenerateProxiesRequest    

Return type

[TaskInfo]

Authorization

Bearer

HTTP request headers

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

getAllAssetProjectLinks

    open class func getAllAssetProjectLinks( asset: String? = nil,  project: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AssetProjectLink]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let project = "project_example" // String | Filter the returned list by `project`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllAssetProjectLinks(asset: asset, project: project, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[AssetProjectLink]

Authorization

Bearer

HTTP request headers

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

getAllAssetRatings

    open class func getAllAssetRatings( user: String? = nil,  asset: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AssetRating]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let user = "user_example" // String | Filter the returned list by `user`. (optional)
let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllAssetRatings(user: user, asset: asset, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[AssetRating]

Authorization

Bearer

HTTP request headers

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

getAllAssetTapeBackups

    open class func getAllAssetTapeBackups( asset: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  includeAsset: Bool? = nil,  advancedSearch: String? = nil) -> Promise<[AssetBackup]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let includeAsset = true // Bool |  (optional)
let advancedSearch = "advancedSearch_example" // String |  (optional)

MediaLibraryAPI.getAllAssetTapeBackups(asset: asset, ordering: ordering, limit: limit, offset: offset, includeAsset: includeAsset, advancedSearch: advancedSearch).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[AssetBackup]

Authorization

Bearer

HTTP request headers

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

getAllAssets

    open class func getAllAssets( syncId: String? = nil,  displayName: String? = nil,  _set: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  includeProxies: Bool? = nil,  includeModifiedBy: Bool? = nil,  resolveAssetPermission: Bool? = nil,  forRoot: Int? = nil) -> Promise<[Asset]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let syncId = "syncId_example" // String | Filter the returned list by `sync_id`. (optional)
let displayName = "displayName_example" // String | Filter the returned list by `display_name`. (optional)
let _set = "_set_example" // String | Filter the returned list by `set`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let includeProxies = true // Bool |  (optional)
let includeModifiedBy = true // Bool |  (optional)
let resolveAssetPermission = true // Bool |  (optional)
let forRoot = 987 // Int |  (optional)

MediaLibraryAPI.getAllAssets(syncId: syncId, displayName: displayName, _set: _set, ordering: ordering, limit: limit, offset: offset, includeProxies: includeProxies, includeModifiedBy: includeModifiedBy, resolveAssetPermission: resolveAssetPermission, forRoot: forRoot).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[Asset]

Authorization

Bearer

HTTP request headers

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

getAllBundlesForMediaRoot

    open class func getAllBundlesForMediaRoot( root: String,  asset: String? = nil,  location: String? = nil,  sharedViaTokens: String? = nil,  sharedViaTokensToken: String? = nil,  name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[MediaFileBundle]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let root = "root_example" // String | 
let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let location = "location_example" // String | Filter the returned list by `location`. (optional)
let sharedViaTokens = "sharedViaTokens_example" // String | Filter the returned list by `shared_via_tokens`. (optional)
let sharedViaTokensToken = "sharedViaTokensToken_example" // String | Filter the returned list by `shared_via_tokens__token`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllBundlesForMediaRoot(root: root, asset: asset, location: location, sharedViaTokens: sharedViaTokens, sharedViaTokensToken: sharedViaTokensToken, name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[MediaFileBundle]

Authorization

Bearer

HTTP request headers

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

getAllClickLinks

    open class func getAllClickLinks( asset: String? = nil,  connection: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AssetCloudLink]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let connection = "connection_example" // String | Filter the returned list by `connection`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllClickLinks(asset: asset, connection: connection, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[AssetCloudLink]

Authorization

Bearer

HTTP request headers

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

getAllComments

    open class func getAllComments( asset: String? = nil,  root: String? = nil,  user: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  forRoot: Int? = nil,  tasksForUser: Int? = nil,  includeFullAsset: Bool? = nil,  advancedSearch: String? = nil) -> Promise<[Comment]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let root = "root_example" // String | Filter the returned list by `root`. (optional)
let user = "user_example" // String | Filter the returned list by `user`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let forRoot = 987 // Int |  (optional)
let tasksForUser = 987 // Int |  (optional)
let includeFullAsset = true // Bool |  (optional)
let advancedSearch = "advancedSearch_example" // String |  (optional)

MediaLibraryAPI.getAllComments(asset: asset, root: root, user: user, ordering: ordering, limit: limit, offset: offset, forRoot: forRoot, tasksForUser: tasksForUser, includeFullAsset: includeFullAsset, advancedSearch: advancedSearch).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[Comment]

Authorization

Bearer

HTTP request headers

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

getAllCustomFields

    open class func getAllCustomFields( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[CustomField]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllCustomFields(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[CustomField]

Authorization

Bearer

HTTP request headers

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

getAllExternalTranscoders

    open class func getAllExternalTranscoders( name: String? = nil,  id: Double? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[ExternalTranscoder]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let name = "name_example" // String | Filter the returned list by `name`. (optional)
let id = 987 // Double | Filter the returned list by `id`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllExternalTranscoders(name: name, id: id, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
name String Filter the returned list by `name`. [optional]
id Double 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

[ExternalTranscoder]

Authorization

Bearer

HTTP request headers

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

getAllMarkers

    open class func getAllMarkers( asset: String? = nil,  user: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[Marker]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let user = "user_example" // String | Filter the returned list by `user`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllMarkers(asset: asset, user: user, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[Marker]

Authorization

Bearer

HTTP request headers

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

getAllMediaFileBundles

    open class func getAllMediaFileBundles( asset: String? = nil,  location: String? = nil,  sharedViaTokens: String? = nil,  sharedViaTokensToken: String? = nil,  name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  excludeDeleted: Bool? = nil,  excludeUnrecognized: Bool? = nil,  includeProxies: Bool? = nil,  includeParents: Bool? = nil,  advancedSearch: String? = nil) -> Promise<[MediaFileBundle]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let location = "location_example" // String | Filter the returned list by `location`. (optional)
let sharedViaTokens = "sharedViaTokens_example" // String | Filter the returned list by `shared_via_tokens`. (optional)
let sharedViaTokensToken = "sharedViaTokensToken_example" // String | Filter the returned list by `shared_via_tokens__token`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int |  (optional)
let offset = 987 // Int |  (optional)
let excludeDeleted = true // Bool |  (optional)
let excludeUnrecognized = true // Bool |  (optional)
let includeProxies = true // Bool |  (optional)
let includeParents = true // Bool |  (optional)
let advancedSearch = "advancedSearch_example" // String |  (optional)

MediaLibraryAPI.getAllMediaFileBundles(asset: asset, location: location, sharedViaTokens: sharedViaTokens, sharedViaTokensToken: sharedViaTokensToken, name: name, ordering: ordering, limit: limit, offset: offset, excludeDeleted: excludeDeleted, excludeUnrecognized: excludeUnrecognized, includeProxies: includeProxies, includeParents: includeParents, advancedSearch: advancedSearch).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[MediaFileBundle]

Authorization

Bearer

HTTP request headers

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

getAllMediaFileTemplates

    open class func getAllMediaFileTemplates( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[MediaFileTemplate]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllMediaFileTemplates(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[MediaFileTemplate]

Authorization

Bearer

HTTP request headers

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

getAllMediaFiles

    open class func getAllMediaFiles( bundle: String? = nil,  bundleIn: String? = nil,  parent: String? = nil,  name: String? = nil,  isDir: String? = nil,  isShowroom: String? = nil,  present: String? = nil,  volume: String? = nil,  sharedViaTokens: String? = nil,  sharedViaTokensToken: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  resolveFilePermission: Bool? = nil,  includeModifiedBy: Bool? = nil,  includeEffectiveCustomFields: Bool? = nil,  includeRoot: Bool? = nil,  includeParents: Bool? = nil,  advancedSearch: String? = nil) -> Promise<[MediaFile]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let bundle = "bundle_example" // String | Filter the returned list by `bundle`. (optional)
let bundleIn = "bundleIn_example" // String | Multiple values may be separated by commas. (optional)
let parent = "parent_example" // String | Filter the returned list by `parent`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let isDir = "isDir_example" // String | Filter the returned list by `is_dir`. (optional)
let isShowroom = "isShowroom_example" // String | Filter the returned list by `is_showroom`. (optional)
let present = "present_example" // String | Filter the returned list by `present`. (optional)
let volume = "volume_example" // String | Filter the returned list by `volume`. (optional)
let sharedViaTokens = "sharedViaTokens_example" // String | Filter the returned list by `shared_via_tokens`. (optional)
let sharedViaTokensToken = "sharedViaTokensToken_example" // String | Filter the returned list by `shared_via_tokens__token`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let resolveFilePermission = true // Bool |  (optional)
let includeModifiedBy = true // Bool |  (optional)
let includeEffectiveCustomFields = true // Bool |  (optional)
let includeRoot = true // Bool |  (optional)
let includeParents = true // Bool |  (optional)
let advancedSearch = "advancedSearch_example" // String |  (optional)

MediaLibraryAPI.getAllMediaFiles(bundle: bundle, bundleIn: bundleIn, parent: parent, name: name, isDir: isDir, isShowroom: isShowroom, present: present, volume: volume, sharedViaTokens: sharedViaTokens, sharedViaTokensToken: sharedViaTokensToken, ordering: ordering, limit: limit, offset: offset, resolveFilePermission: resolveFilePermission, includeModifiedBy: includeModifiedBy, includeEffectiveCustomFields: includeEffectiveCustomFields, includeRoot: includeRoot, includeParents: includeParents, advancedSearch: advancedSearch).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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]
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

[MediaFile]

Authorization

Bearer

HTTP request headers

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

getAllMediaFilesForBundles

    open class func getAllMediaFilesForBundles( allMediaFilesForBundlesRequest: AllMediaFilesForBundlesRequest) -> Promise<[MediaFile]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let allMediaFilesForBundlesRequest = AllMediaFilesForBundlesRequest(bundles: [123]) // AllMediaFilesForBundlesRequest | 

MediaLibraryAPI.getAllMediaFilesForBundles(allMediaFilesForBundlesRequest: allMediaFilesForBundlesRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
allMediaFilesForBundlesRequest AllMediaFilesForBundlesRequest    

Return type

[MediaFile]

Authorization

Bearer

HTTP request headers

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

getAllMediaFilesForMediaRoot

    open class func getAllMediaFilesForMediaRoot( root: String,  bundle: String? = nil,  bundleIn: String? = nil,  parent: String? = nil,  name: String? = nil,  isDir: String? = nil,  isShowroom: String? = nil,  present: String? = nil,  volume: String? = nil,  sharedViaTokens: String? = nil,  sharedViaTokensToken: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[MediaFile]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let root = "root_example" // String | 
let bundle = "bundle_example" // String | Filter the returned list by `bundle`. (optional)
let bundleIn = "bundleIn_example" // String | Multiple values may be separated by commas. (optional)
let parent = "parent_example" // String | Filter the returned list by `parent`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let isDir = "isDir_example" // String | Filter the returned list by `is_dir`. (optional)
let isShowroom = "isShowroom_example" // String | Filter the returned list by `is_showroom`. (optional)
let present = "present_example" // String | Filter the returned list by `present`. (optional)
let volume = "volume_example" // String | Filter the returned list by `volume`. (optional)
let sharedViaTokens = "sharedViaTokens_example" // String | Filter the returned list by `shared_via_tokens`. (optional)
let sharedViaTokensToken = "sharedViaTokensToken_example" // String | Filter the returned list by `shared_via_tokens__token`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllMediaFilesForMediaRoot(root: root, bundle: bundle, bundleIn: bundleIn, parent: parent, name: name, isDir: isDir, isShowroom: isShowroom, present: present, volume: volume, sharedViaTokens: sharedViaTokens, sharedViaTokensToken: sharedViaTokensToken, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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]
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

[MediaFile]

Authorization

Bearer

HTTP request headers

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

getAllMediaRootPermissions

    open class func getAllMediaRootPermissions( root: String? = nil,  id: Double? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[MediaRootPermission]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let root = "root_example" // String | Filter the returned list by `root`. (optional)
let id = 987 // Double | Filter the returned list by `id`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllMediaRootPermissions(root: root, id: id, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
root String Filter the returned list by `root`. [optional]
id Double 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

[MediaRootPermission]

Authorization

Bearer

HTTP request headers

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

getAllMediaRoots

    open class func getAllMediaRoots( volume: String? = nil,  name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[MediaRoot]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let volume = "volume_example" // String | Filter the returned list by `volume`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllMediaRoots(volume: volume, name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
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

[MediaRoot]

Authorization

Bearer

HTTP request headers

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

getAllMediaTags

    open class func getAllMediaTags( name: String? = nil,  nameIcontains: String? = nil,  root: String? = nil,  rootIsnull: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  forRoot: Int? = nil) -> Promise<[Tag]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let name = "name_example" // String | Filter the returned list by `name`. (optional)
let nameIcontains = "nameIcontains_example" // String | Filter the returned list by `name__icontains`. (optional)
let root = "root_example" // String | Filter the returned list by `root`. (optional)
let rootIsnull = "rootIsnull_example" // String | Filter the returned list by `root__isnull`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let forRoot = 987 // Int |  (optional)

MediaLibraryAPI.getAllMediaTags(name: name, nameIcontains: nameIcontains, root: root, rootIsnull: rootIsnull, ordering: ordering, limit: limit, offset: offset, forRoot: forRoot).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
name String Filter the returned list by `name`. [optional]
nameIcontains String Filter the returned list by `name__icontains`. [optional]
root String Filter the returned list by `root`. [optional]
rootIsnull String Filter the returned list by `root__isnull`. [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

[Tag]

Authorization

Bearer

HTTP request headers

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

getAllMediaUpdates

    open class func getAllMediaUpdates( asset: String? = nil,  user: String? = nil,  root: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[MediaUpdate]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let user = "user_example" // String | Filter the returned list by `user`. (optional)
let root = "root_example" // String | Filter the returned list by `root`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllMediaUpdates(asset: asset, user: user, root: root, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

getAllProxyGenerators

    open class func getAllProxyGenerators( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[ProxyGenerator]>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllProxyGenerators(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[ProxyGenerator]

Authorization

Bearer

HTTP request headers

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

getAllProxyProfiles

    open class func getAllProxyProfiles( name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  forRoot: Int? = nil) -> Promise<[ProxyProfile]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let forRoot = 987 // Int |  (optional)

MediaLibraryAPI.getAllProxyProfiles(name: name, ordering: ordering, limit: limit, offset: offset, forRoot: forRoot).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[ProxyProfile]

Authorization

Bearer

HTTP request headers

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

getAllSubclipClipboardEntries

    open class func getAllSubclipClipboardEntries( cut: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[SubclipClipboardEntry]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let cut = "cut_example" // String | Filter the returned list by `cut`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllSubclipClipboardEntries(cut: cut, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[SubclipClipboardEntry]

Authorization

Bearer

HTTP request headers

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

getAllSubclips

    open class func getAllSubclips( asset: String? = nil,  assetIn: String? = nil,  root: String? = nil,  name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[Subclip]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let assetIn = "assetIn_example" // String | Multiple values may be separated by commas. (optional)
let root = "root_example" // String | Filter the returned list by `root`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllSubclips(asset: asset, assetIn: assetIn, root: root, name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[Subclip]

Authorization

Bearer

HTTP request headers

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

getAllTranscoderProfiles

    open class func getAllTranscoderProfiles( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[TranscoderProfile]>

Required permissions * User account permission: tasks:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getAllTranscoderProfiles(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

[TranscoderProfile]

Authorization

Bearer

HTTP request headers

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

getAsset

    open class func getAsset( id: Int,  includeProxies: Bool? = nil,  includeModifiedBy: Bool? = nil,  resolveAssetPermission: Bool? = nil,  forRoot: Int? = nil) -> Promise<Asset>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Asset.
let includeProxies = true // Bool |  (optional)
let includeModifiedBy = true // Bool |  (optional)
let resolveAssetPermission = true // Bool |  (optional)
let forRoot = 987 // Int |  (optional)

MediaLibraryAPI.getAsset(id: id, includeProxies: includeProxies, includeModifiedBy: includeModifiedBy, resolveAssetPermission: resolveAssetPermission, forRoot: forRoot).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

getAssetRating

    open class func getAssetRating( id: Int) -> Promise<AssetRating>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Rating.

MediaLibraryAPI.getAssetRating(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

AssetRating

Authorization

Bearer

HTTP request headers

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

getBookmarkedMediaFilesDirectories

    open class func getBookmarkedMediaFilesDirectories( bundle: String? = nil,  bundleIn: String? = nil,  parent: String? = nil,  name: String? = nil,  isDir: String? = nil,  isShowroom: String? = nil,  present: String? = nil,  volume: String? = nil,  sharedViaTokens: String? = nil,  sharedViaTokensToken: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[MediaFile]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let bundle = "bundle_example" // String | Filter the returned list by `bundle`. (optional)
let bundleIn = "bundleIn_example" // String | Multiple values may be separated by commas. (optional)
let parent = "parent_example" // String | Filter the returned list by `parent`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let isDir = "isDir_example" // String | Filter the returned list by `is_dir`. (optional)
let isShowroom = "isShowroom_example" // String | Filter the returned list by `is_showroom`. (optional)
let present = "present_example" // String | Filter the returned list by `present`. (optional)
let volume = "volume_example" // String | Filter the returned list by `volume`. (optional)
let sharedViaTokens = "sharedViaTokens_example" // String | Filter the returned list by `shared_via_tokens`. (optional)
let sharedViaTokensToken = "sharedViaTokensToken_example" // String | Filter the returned list by `shared_via_tokens__token`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getBookmarkedMediaFilesDirectories(bundle: bundle, bundleIn: bundleIn, parent: parent, name: name, isDir: isDir, isShowroom: isShowroom, present: present, volume: volume, sharedViaTokens: sharedViaTokens, sharedViaTokensToken: sharedViaTokensToken, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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]
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

[MediaFile]

Authorization

Bearer

HTTP request headers

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

getComment

    open class func getComment( id: Int,  forRoot: Int? = nil,  tasksForUser: Int? = nil,  includeFullAsset: Bool? = nil,  advancedSearch: String? = nil) -> Promise<Comment>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Comment.
let forRoot = 987 // Int |  (optional)
let tasksForUser = 987 // Int |  (optional)
let includeFullAsset = true // Bool |  (optional)
let advancedSearch = "advancedSearch_example" // String |  (optional)

MediaLibraryAPI.getComment(id: id, forRoot: forRoot, tasksForUser: tasksForUser, includeFullAsset: includeFullAsset, advancedSearch: advancedSearch).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

getCustomField

    open class func getCustomField( id: Int) -> Promise<CustomField>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Custom field.

MediaLibraryAPI.getCustomField(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

CustomField

Authorization

Bearer

HTTP request headers

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

getEasySharingTokenForBundle

    open class func getEasySharingTokenForBundle( id: Int) -> Promise<OneTimeAccessToken>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Bundle.

MediaLibraryAPI.getEasySharingTokenForBundle(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

OneTimeAccessToken

Authorization

Bearer

HTTP request headers

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

getEasySharingTokenForDirectory

    open class func getEasySharingTokenForDirectory( id: Int) -> Promise<OneTimeAccessToken>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.getEasySharingTokenForDirectory(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

OneTimeAccessToken

Authorization

Bearer

HTTP request headers

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

getEditorProject

    open class func getEditorProject( id: Int) -> Promise<EditorProject>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.getEditorProject(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

EditorProject

Authorization

Bearer

HTTP request headers

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

getExternalTranscoder

    open class func getExternalTranscoder( id: Int) -> Promise<ExternalTranscoder>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this external transcoder.

MediaLibraryAPI.getExternalTranscoder(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

ExternalTranscoder

Authorization

Bearer

HTTP request headers

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

getFrame

    open class func getFrame( frame: String,  id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let frame = "frame_example" // String | 
let id = 987 // Int | A unique integer value identifying this Asset.

MediaLibraryAPI.getFrame(frame: frame, id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

getLatestMediaUpdate

    open class func getLatestMediaUpdate( asset: String? = nil,  user: String? = nil,  root: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<MediaUpdate>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = "asset_example" // String | Filter the returned list by `asset`. (optional)
let user = "user_example" // String | Filter the returned list by `user`. (optional)
let root = "root_example" // String | Filter the returned list by `root`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getLatestMediaUpdate(asset: asset, user: user, root: root, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

getMarker

    open class func getMarker( id: Int) -> Promise<Marker>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this marker.

MediaLibraryAPI.getMarker(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Marker

Authorization

Bearer

HTTP request headers

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

getMediaFile

    open class func getMediaFile( id: Int,  resolveFilePermission: Bool? = nil,  includeModifiedBy: Bool? = nil,  includeEffectiveCustomFields: Bool? = nil,  includeRoot: Bool? = nil,  includeParents: Bool? = nil,  advancedSearch: String? = nil) -> Promise<MediaFile>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.
let resolveFilePermission = true // Bool |  (optional)
let includeModifiedBy = true // Bool |  (optional)
let includeEffectiveCustomFields = true // Bool |  (optional)
let includeRoot = true // Bool |  (optional)
let includeParents = true // Bool |  (optional)
let advancedSearch = "advancedSearch_example" // String |  (optional)

MediaLibraryAPI.getMediaFile(id: id, resolveFilePermission: resolveFilePermission, includeModifiedBy: includeModifiedBy, includeEffectiveCustomFields: includeEffectiveCustomFields, includeRoot: includeRoot, includeParents: includeParents, advancedSearch: advancedSearch).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

getMediaFileBundle

    open class func getMediaFileBundle( id: Int,  excludeDeleted: Bool? = nil,  excludeUnrecognized: Bool? = nil,  includeProxies: Bool? = nil,  includeParents: Bool? = nil,  offset: Int? = nil,  limit: Int? = nil,  advancedSearch: String? = nil) -> Promise<MediaFileBundle>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Bundle.
let excludeDeleted = true // Bool |  (optional)
let excludeUnrecognized = true // Bool |  (optional)
let includeProxies = true // Bool |  (optional)
let includeParents = true // Bool |  (optional)
let offset = 987 // Int |  (optional)
let limit = 987 // Int |  (optional)
let advancedSearch = "advancedSearch_example" // String |  (optional)

MediaLibraryAPI.getMediaFileBundle(id: id, excludeDeleted: excludeDeleted, excludeUnrecognized: excludeUnrecognized, includeProxies: includeProxies, includeParents: includeParents, offset: offset, limit: limit, advancedSearch: advancedSearch).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

getMediaFileContents

    open class func getMediaFileContents( id: Int,  excludeDeleted: Bool? = nil,  excludeUnrecognized: Bool? = nil,  offset: Int? = nil,  limit: Int? = nil) -> Promise<MediaFileContents>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.
let excludeDeleted = true // Bool |  (optional)
let excludeUnrecognized = true // Bool |  (optional)
let offset = 987 // Int |  (optional)
let limit = 987 // Int |  (optional)

MediaLibraryAPI.getMediaFileContents(id: id, excludeDeleted: excludeDeleted, excludeUnrecognized: excludeUnrecognized, offset: offset, limit: limit).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

getMediaFileTemplate

    open class func getMediaFileTemplate( id: Int) -> Promise<MediaFileTemplate>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Template.

MediaLibraryAPI.getMediaFileTemplate(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

MediaFileTemplate

Authorization

Bearer

HTTP request headers

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

getMediaRoot

    open class func getMediaRoot( id: Int) -> Promise<MediaRoot>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this media root.

MediaLibraryAPI.getMediaRoot(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

MediaRoot

Authorization

Bearer

HTTP request headers

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

getMediaRootPermission

    open class func getMediaRootPermission( id: Int) -> Promise<MediaRootPermission>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Media Root Permission.

MediaLibraryAPI.getMediaRootPermission(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

MediaRootPermission

Authorization

Bearer

HTTP request headers

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

getMediaTag

    open class func getMediaTag( id: Int,  forRoot: Int? = nil) -> Promise<Tag>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Tag.
let forRoot = 987 // Int |  (optional)

MediaLibraryAPI.getMediaTag(id: id, forRoot: forRoot).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Tag

Authorization

Bearer

HTTP request headers

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

getMultipleAssets

    open class func getMultipleAssets( multipleAssetsRequest: MultipleAssetsRequest) -> Promise<[Asset]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let multipleAssetsRequest = MultipleAssetsRequest(assets: [123]) // MultipleAssetsRequest | 

MediaLibraryAPI.getMultipleAssets(multipleAssetsRequest: multipleAssetsRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
multipleAssetsRequest MultipleAssetsRequest    

Return type

[Asset]

Authorization

Bearer

HTTP request headers

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

getMultipleBundles

    open class func getMultipleBundles( getMultipleBundlesRequest: GetMultipleBundlesRequest) -> Promise<[MediaFileBundle]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let getMultipleBundlesRequest = GetMultipleBundlesRequest(bundles: [123], files: [123]) // GetMultipleBundlesRequest | 

MediaLibraryAPI.getMultipleBundles(getMultipleBundlesRequest: getMultipleBundlesRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
getMultipleBundlesRequest GetMultipleBundlesRequest    

Return type

[MediaFileBundle]

Authorization

Bearer

HTTP request headers

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

getMultipleFiles

    open class func getMultipleFiles( getMultipleFilesRequest: GetMultipleFilesRequest) -> Promise<[MediaFile]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let getMultipleFilesRequest = GetMultipleFilesRequest(files: [123]) // GetMultipleFilesRequest | 

MediaLibraryAPI.getMultipleFiles(getMultipleFilesRequest: getMultipleFilesRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
getMultipleFilesRequest GetMultipleFilesRequest    

Return type

[MediaFile]

Authorization

Bearer

HTTP request headers

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

getMyMediaRootPermissions

    open class func getMyMediaRootPermissions( root: String? = nil,  id: Double? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[MediaRootPermission]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let root = "root_example" // String | Filter the returned list by `root`. (optional)
let id = 987 // Double | Filter the returned list by `id`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getMyMediaRootPermissions(root: root, id: id, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
root String Filter the returned list by `root`. [optional]
id Double 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

[MediaRootPermission]

Authorization

Bearer

HTTP request headers

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

getMyResolvedMediaRootPermissions

    open class func getMyResolvedMediaRootPermissions( root: String? = nil,  id: Double? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[MediaRootPermission]>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let root = "root_example" // String | Filter the returned list by `root`. (optional)
let id = 987 // Double | Filter the returned list by `id`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MediaLibraryAPI.getMyResolvedMediaRootPermissions(root: root, id: id, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
root String Filter the returned list by `root`. [optional]
id Double 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

[MediaRootPermission]

Authorization

Bearer

HTTP request headers

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

getProxy

    open class func getProxy( id: Int) -> Promise<Proxy>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this proxy.

MediaLibraryAPI.getProxy(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Proxy

Authorization

Bearer

HTTP request headers

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

getProxyGenerator

    open class func getProxyGenerator( id: String) -> Promise<ProxyGenerator>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | 

MediaLibraryAPI.getProxyGenerator(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id String    

Return type

ProxyGenerator

Authorization

Bearer

HTTP request headers

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

getProxyProfile

    open class func getProxyProfile( id: Int,  forRoot: Int? = nil) -> Promise<ProxyProfile>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this proxy profile.
let forRoot = 987 // Int |  (optional)

MediaLibraryAPI.getProxyProfile(id: id, forRoot: forRoot).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

getProxyProfileProxyCount

    open class func getProxyProfileProxyCount( id: Int) -> Promise<ProxyCount>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this proxy profile.

MediaLibraryAPI.getProxyProfileProxyCount(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

ProxyCount

Authorization

Bearer

HTTP request headers

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

getSubclip

    open class func getSubclip( id: Int) -> Promise<Subclip>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this subclip.

MediaLibraryAPI.getSubclip(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Subclip

Authorization

Bearer

HTTP request headers

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

getTranscoderProfile

    open class func getTranscoderProfile( id: Int) -> Promise<TranscoderProfile>

Required permissions * User account permission: tasks:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this transcoder profile.

MediaLibraryAPI.getTranscoderProfile(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

TranscoderProfile

Authorization

Bearer

HTTP request headers

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

getVantageWorkflows

    open class func getVantageWorkflows( id: Int) -> Promise<VantageWorkflows>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this external transcoder.

MediaLibraryAPI.getVantageWorkflows(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

VantageWorkflows

Authorization

Bearer

HTTP request headers

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

instantiateMediaFileTemplate

    open class func instantiateMediaFileTemplate( id: Int,  instantiateFileTemplateRequest: InstantiateFileTemplateRequest) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Template.
let instantiateFileTemplateRequest = InstantiateFileTemplateRequest(parent: 123, name: "name_example", customField: "TODO") // InstantiateFileTemplateRequest | 

MediaLibraryAPI.instantiateMediaFileTemplate(id: id, instantiateFileTemplateRequest: instantiateFileTemplateRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

locateEditorProjectPaths

    open class func locateEditorProjectPaths( id: Int) -> Promise<[LocateResult]>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.locateEditorProjectPaths(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

[LocateResult]

Authorization

Bearer

HTTP request headers

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

markMediaDirectoryAsShowroom

    open class func markMediaDirectoryAsShowroom( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.markMediaDirectoryAsShowroom(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

patchAsset

    open class func patchAsset( id: Int,  assetPartialUpdate: AssetPartialUpdate) -> Promise<Asset>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Asset.
let assetPartialUpdate = AssetPartialUpdate(customFields: "TODO", tags: [TagReference(id: 123, name: "name_example", color: "color_example", root: 123)], _set: 123) // AssetPartialUpdate | 

MediaLibraryAPI.patchAsset(id: id, assetPartialUpdate: assetPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Asset.  
assetPartialUpdate AssetPartialUpdate    

Return type

Asset

Authorization

Bearer

HTTP request headers

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

patchAssetRating

    open class func patchAssetRating( id: Int,  assetRatingPartialUpdate: AssetRatingPartialUpdate) -> Promise<AssetRating>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Rating.
let assetRatingPartialUpdate = AssetRatingPartialUpdate(user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), rating: 123, asset: 123) // AssetRatingPartialUpdate | 

MediaLibraryAPI.patchAssetRating(id: id, assetRatingPartialUpdate: assetRatingPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Rating.  
assetRatingPartialUpdate AssetRatingPartialUpdate    

Return type

AssetRating

Authorization

Bearer

HTTP request headers

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

patchComment

    open class func patchComment( id: Int,  commentPartialUpdate: CommentPartialUpdate) -> Promise<Comment>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Comment.
let commentPartialUpdate = CommentPartialUpdate(assignee: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), user: nil, drawing: "TODO", tags: [TagReference(id: 123, name: "name_example", color: "color_example", root: 123)], text: "text_example", time: 123, isCloud: false, resolved: false, resolvedDate: Date(), asset: 123, root: 123, parent: 123) // CommentPartialUpdate | 

MediaLibraryAPI.patchComment(id: id, commentPartialUpdate: commentPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Comment.  
commentPartialUpdate CommentPartialUpdate    

Return type

Comment

Authorization

Bearer

HTTP request headers

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

patchCustomField

    open class func patchCustomField( id: Int,  customFieldPartialUpdate: CustomFieldPartialUpdate) -> Promise<CustomField>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Custom field.
let customFieldPartialUpdate = CustomFieldPartialUpdate(labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example") // CustomFieldPartialUpdate | 

MediaLibraryAPI.patchCustomField(id: id, customFieldPartialUpdate: customFieldPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

patchEditorProject

    open class func patchEditorProject( id: Int,  editorProjectPartialUpdate: EditorProjectPartialUpdate) -> Promise<EditorProject>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.
let editorProjectPartialUpdate = EditorProjectPartialUpdate(file: 123, parent: 123, parentPath: "parentPath_example", existingFile: 123, format: "format_example", project: "TODO") // EditorProjectPartialUpdate | 

MediaLibraryAPI.patchEditorProject(id: id, editorProjectPartialUpdate: editorProjectPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this File.  
editorProjectPartialUpdate EditorProjectPartialUpdate    

Return type

EditorProject

Authorization

Bearer

HTTP request headers

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

patchExternalTranscoder

    open class func patchExternalTranscoder( id: Int,  externalTranscoderPartialUpdate: ExternalTranscoderPartialUpdate) -> Promise<ExternalTranscoder>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this external transcoder.
let externalTranscoderPartialUpdate = ExternalTranscoderPartialUpdate(pathMappings: ["pathMappings_example"], name: "name_example", type: "type_example", address: "address_example") // ExternalTranscoderPartialUpdate | 

MediaLibraryAPI.patchExternalTranscoder(id: id, externalTranscoderPartialUpdate: externalTranscoderPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

patchMarker

    open class func patchMarker( id: Int,  markerPartialUpdate: MarkerPartialUpdate) -> Promise<Marker>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this marker.
let markerPartialUpdate = MarkerPartialUpdate(title: "title_example", text: "text_example", tIn: 123, tOut: 123, asset: 123) // MarkerPartialUpdate | 

MediaLibraryAPI.patchMarker(id: id, markerPartialUpdate: markerPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this marker.  
markerPartialUpdate MarkerPartialUpdate    

Return type

Marker

Authorization

Bearer

HTTP request headers

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

patchMediaFile

    open class func patchMediaFile( id: Int,  mediaFilePartialUpdate: MediaFilePartialUpdate) -> Promise<MediaFile>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.
let mediaFilePartialUpdate = MediaFilePartialUpdate(info: "TODO", customFields: "TODO", totalFiles: 123, needsRescan: false, bookmarkedBy: [123]) // MediaFilePartialUpdate | 

MediaLibraryAPI.patchMediaFile(id: id, mediaFilePartialUpdate: mediaFilePartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this File.  
mediaFilePartialUpdate MediaFilePartialUpdate    

Return type

MediaFile

Authorization

Bearer

HTTP request headers

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

patchMediaFileTemplate

    open class func patchMediaFileTemplate( id: Int,  mediaFileTemplatePartialUpdate: MediaFileTemplatePartialUpdate) -> Promise<MediaFileTemplate>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Template.
let mediaFileTemplatePartialUpdate = MediaFileTemplatePartialUpdate(file: MediaFileReference(id: 123, volume: VolumeMini(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), info: "TODO", customFields: "TODO", resolvedPermission: MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123), parentFile: "TODO", root: MediaRootMini(id: 123, name: "name_example", fullPath: "fullPath_example", customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), path: "path_example", prefetchThumbnailStrips: false), effectiveCustomFields: "TODO", modifiedBy: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), fullPath: "fullPath_example", searchHighlight: "searchHighlight_example", isShared: false, isExcluded: false, isHardlink: false, isBookmarked: false, name: "name_example", path: "path_example", pathhash: "pathhash_example", isDir: false, totalFiles: 123, size: 123, mtime: 123, present: false, needsRescan: false, isShowroom: false, bundleIndex: 123, modified: Date(), parent: 123, bundle: 123, bookmarkedBy: [123]), name: "name_example") // MediaFileTemplatePartialUpdate | 

MediaLibraryAPI.patchMediaFileTemplate(id: id, mediaFileTemplatePartialUpdate: mediaFileTemplatePartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Template.  
mediaFileTemplatePartialUpdate MediaFileTemplatePartialUpdate    

Return type

MediaFileTemplate

Authorization

Bearer

HTTP request headers

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

patchMediaRoot

    open class func patchMediaRoot( id: Int,  mediaRootPartialUpdate: MediaRootPartialUpdate) -> Promise<MediaRoot>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this media root.
let mediaRootPartialUpdate = MediaRootPartialUpdate(customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], workflow: "TODO", aiConfig: "TODO", veritoneConfig: "TODO", volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), jobs: [JobReference(id: 123, subtasks: [SubtaskReference(id: 123, kwargs: "TODO", graphLayout: "TODO", validationError: "validationError_example", trigger: "trigger_example", name: "name_example", noopDontSave: false, noConcurrency: false, timeout: 123, logVariable: false, task: "task_example", conditionVariable: "conditionVariable_example", conditionValue: "conditionValue_example", sync: false, queue: "queue_example", enqueueAtFront: false, parent: 123, relativeTo: 123)], schedules: [ScheduleReference(id: 123, variables: "TODO", nextRun: Date(), type: 123, enabled: false, lastRun: Date(), every: 123, period: "period_example", crontabDayOfMonth: "crontabDayOfMonth_example", crontabDayOfWeek: "crontabDayOfWeek_example", crontabHour: "crontabHour_example", crontabMinute: "crontabMinute_example", crontabMonthOfYear: "crontabMonthOfYear_example", job: 123)], allowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], allowGroups: [ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123])], startable: false, variableDefinitions: ["variableDefinitions_example"], mediaRoots: [123], webhookUrl: "webhookUrl_example", specialType: 123, name: "name_example", enabled: false, allowOthersToStart: false, allowClientToStart: false, showAsButton: false, inputType: "inputType_example", hook: "hook_example", webhookSecret: "webhookSecret_example", securityContext: 123, partOfWorkflowFor: 123)], name: "name_example", path: "path_example", needsRescan: false, viewMode: "viewMode_example", viewStyle: "viewStyle_example", viewDefaultTab: "viewDefaultTab_example", showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showMarkers: false, showAiMetadata: false, prefetchThumbnailStrips: false, cover: "cover_example", nameField: "nameField_example", shareComments: false, shareLinkDuration: 123, defaultProxyProfile: 123, cloudProxyProfile: 123, veritoneConnection: 123, veritoneProxyProfile: 123, aiConnection: 123, aiProxyProfile: 123, proxyProfiles: [123]) // MediaRootPartialUpdate | 

MediaLibraryAPI.patchMediaRoot(id: id, mediaRootPartialUpdate: mediaRootPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

patchMediaRootPermission

    open class func patchMediaRootPermission( id: Int,  mediaRootPermissionPartialUpdate: MediaRootPermissionPartialUpdate) -> Promise<MediaRootPermission>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Media Root Permission.
let mediaRootPermissionPartialUpdate = MediaRootPermissionPartialUpdate(user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123) // MediaRootPermissionPartialUpdate | 

MediaLibraryAPI.patchMediaRootPermission(id: id, mediaRootPermissionPartialUpdate: mediaRootPermissionPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

patchMediaTag

    open class func patchMediaTag( id: Int,  tagPartialUpdate: TagPartialUpdate) -> Promise<Tag>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Tag.
let tagPartialUpdate = TagPartialUpdate(name: "name_example", color: "color_example", root: 123) // TagPartialUpdate | 

MediaLibraryAPI.patchMediaTag(id: id, tagPartialUpdate: tagPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Tag.  
tagPartialUpdate TagPartialUpdate    

Return type

Tag

Authorization

Bearer

HTTP request headers

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

patchProxyProfile

    open class func patchProxyProfile( id: Int,  proxyProfilePartialUpdate: ProxyProfilePartialUpdate) -> Promise<ProxyProfile>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this proxy profile.
let proxyProfilePartialUpdate = ProxyProfilePartialUpdate(name: "name_example", proxyGenerator: "proxyGenerator_example", resolution: "resolution_example", rateControl: 123, crf: 123, bitrate: 123, audioBitrate: 123, variantsLimit: 123, enableRealtimeRead: false, enableDenseFilmstrip: false, enableWatermark: false, watermarkImage: "watermarkImage_example", watermarkPosition: 123, watermarkOpacity: 123, watermarkSize: 123, enableTimecode: false, timecodePosition: 123, timecodeOpacity: 123, timecodeSize: 123, lut: "lut_example", hotfolderCopyTo: "hotfolderCopyTo_example", hotfolderReadFrom: "hotfolderReadFrom_example", hotfolderQueueTimeout: 123, hotfolderEncodeTimeout: 123, vantageWorkflowId: "vantageWorkflowId_example", externalTranscoderStagingPath: "externalTranscoderStagingPath_example", externalTranscoder: 123) // ProxyProfilePartialUpdate | 

MediaLibraryAPI.patchProxyProfile(id: id, proxyProfilePartialUpdate: proxyProfilePartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

patchSubclip

    open class func patchSubclip( id: Int,  subclipPartialUpdate: SubclipPartialUpdate) -> Promise<Subclip>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this subclip.
let subclipPartialUpdate = SubclipPartialUpdate(asset: AssetMiniReference(id: 123, syncId: 123, defaultProxy: Proxy(id: 123, urls: "TODO", profile: ProxyProfileMini(id: 123, name: "name_example"), failedReason: "failedReason_example", transforms: "transforms_example", generated: false, failed: false, name: "name_example", variantId: "variantId_example", variantConfig: "variantConfig_example", asset: 123), urls: "TODO", type: "type_example", displayName: "displayName_example", info: "info_example", thumbnailGenerated: false), rendered: nil, shared: false, name: "name_example", tIn: 123, tOut: 123, root: MediaRootMiniReference(id: 123, name: "name_example", fullPath: "fullPath_example", customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), path: "path_example", prefetchThumbnailStrips: false)) // SubclipPartialUpdate | 

MediaLibraryAPI.patchSubclip(id: id, subclipPartialUpdate: subclipPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this subclip.  
subclipPartialUpdate SubclipPartialUpdate    

Return type

Subclip

Authorization

Bearer

HTTP request headers

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

recursivelyTagMediaDirectory

    open class func recursivelyTagMediaDirectory( id: Int,  tagMediaDirectoryRequest: TagMediaDirectoryRequest) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.
let tagMediaDirectoryRequest = TagMediaDirectoryRequest(tag: 123, add: false) // TagMediaDirectoryRequest | 

MediaLibraryAPI.recursivelyTagMediaDirectory(id: id, tagMediaDirectoryRequest: tagMediaDirectoryRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

reindexMediaDirectory

    open class func reindexMediaDirectory( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.reindexMediaDirectory(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

renameCustomField

    open class func renameCustomField( id: Int,  renameCustomFieldRequest: RenameCustomFieldRequest) -> Promise<TaskInfo>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Custom field.
let renameCustomFieldRequest = RenameCustomFieldRequest(name: "name_example") // RenameCustomFieldRequest | 

MediaLibraryAPI.renameCustomField(id: id, renameCustomFieldRequest: renameCustomFieldRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

renderSequence

    open class func renderSequence( renderEndpointRequest: RenderEndpointRequest) -> Promise<TaskInfo>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let renderEndpointRequest = RenderEndpointRequest(sequence: "TODO", project: "TODO", options: "TODO") // RenderEndpointRequest | 

MediaLibraryAPI.renderSequence(renderEndpointRequest: renderEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
renderEndpointRequest RenderEndpointRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

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

renderSubclip

    open class func renderSubclip( id: Int,  renderRequest: RenderRequest) -> Promise<TaskInfo>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this subclip.
let renderRequest = RenderRequest(destination: "destination_example") // RenderRequest | 

MediaLibraryAPI.renderSubclip(id: id, renderRequest: renderRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this subclip.  
renderRequest RenderRequest    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

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

requestMediaScan

    open class func requestMediaScan( scannerScanEndpointRequest: ScannerScanEndpointRequest) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let scannerScanEndpointRequest = ScannerScanEndpointRequest(path: "path_example", recursive: false, notify: false, forceRescan: false) // ScannerScanEndpointRequest | 

MediaLibraryAPI.requestMediaScan(scannerScanEndpointRequest: scannerScanEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
scannerScanEndpointRequest ScannerScanEndpointRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

resolveComment

    open class func resolveComment( id: Int) -> Promise<Comment>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Comment.

MediaLibraryAPI.resolveComment(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Comment

Authorization

Bearer

HTTP request headers

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

shareMediaLibraryObjects

    open class func shareMediaLibraryObjects( mediaLibraryShareRequest: MediaLibraryShareRequest) -> Promise<OneTimeAccessToken>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let mediaLibraryShareRequest = MediaLibraryShareRequest(bundles: [123], directories: [123], expires: Date(), viewLimit: 123, permissions: MediaRootPermissionAccessOptions(showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false), user: 123, email: "email_example", linkType: "linkType_example", password: "password_example") // MediaLibraryShareRequest | 

MediaLibraryAPI.shareMediaLibraryObjects(mediaLibraryShareRequest: mediaLibraryShareRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
mediaLibraryShareRequest MediaLibraryShareRequest    

Return type

OneTimeAccessToken

Authorization

Bearer

HTTP request headers

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

testExternalTranscoderConnection

    open class func testExternalTranscoderConnection( testExternalTranscoderConnectionRequest: TestExternalTranscoderConnectionRequest) -> Promise<TestExternalTranscoderConnectionResponse>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let testExternalTranscoderConnectionRequest = TestExternalTranscoderConnectionRequest(type: "type_example", address: "address_example") // TestExternalTranscoderConnectionRequest | 

MediaLibraryAPI.testExternalTranscoderConnection(testExternalTranscoderConnectionRequest: testExternalTranscoderConnectionRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
testExternalTranscoderConnectionRequest TestExternalTranscoderConnectionRequest    

Return type

TestExternalTranscoderConnectionResponse

Authorization

Bearer

HTTP request headers

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

transitionWorkflow

    open class func transitionWorkflow( workflowTransitionRequest: WorkflowTransitionRequest) -> Promise<WorkflowTransitionResponse>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let workflowTransitionRequest = WorkflowTransitionRequest(bundles: [123], directories: [123], job: 123, root: 123, variables: "TODO") // WorkflowTransitionRequest | 

MediaLibraryAPI.transitionWorkflow(workflowTransitionRequest: workflowTransitionRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
workflowTransitionRequest WorkflowTransitionRequest    

Return type

WorkflowTransitionResponse

Authorization

Bearer

HTTP request headers

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

unbookmarkMediaDirectory

    open class func unbookmarkMediaDirectory( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.unbookmarkMediaDirectory(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

unmarkMediaDirectoryAsShowroom

    open class func unmarkMediaDirectoryAsShowroom( id: Int) -> Promise<Void>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.

MediaLibraryAPI.unmarkMediaDirectoryAsShowroom(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

unresolveComment

    open class func unresolveComment( id: Int) -> Promise<Comment>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Comment.

MediaLibraryAPI.unresolveComment(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Comment

Authorization

Bearer

HTTP request headers

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

updateAsset

    open class func updateAsset( id: Int,  asset: Asset) -> Promise<Asset>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Asset.
let asset = Asset(id: 123, urls: "TODO", proxies: [Proxy(id: 123, urls: "TODO", profile: ProxyProfileMini(id: 123, name: "name_example"), failedReason: "failedReason_example", transforms: "transforms_example", generated: false, failed: false, name: "name_example", variantId: "variantId_example", variantConfig: "variantConfig_example", asset: 123)], defaultProxy: nil, info: "TODO", proxyInfo: "TODO", customFields: "TODO", tags: [TagReference(id: 123, name: "name_example", color: "color_example", root: 123)], resolvedPermission: MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123), bundles: ["TODO"], backups: "backups_example", proxiesGenerated: false, proxiesFailed: false, modifiedBy: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), syncId: 123, displayName: "displayName_example", hasFiles: false, hasBackups: false, hasCloudLinks: false, checksum: "checksum_example", type: "type_example", thumbnailGenerated: false, matchedScanner: "matchedScanner_example", rating: 123, workflowState: 123, isTemporary: false, created: Date(), modified: Date(), _set: 123) // Asset | 

MediaLibraryAPI.updateAsset(id: id, asset: asset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Asset

Authorization

Bearer

HTTP request headers

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

updateAssetRating

    open class func updateAssetRating( id: Int,  assetRating: AssetRating) -> Promise<AssetRating>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Rating.
let assetRating = AssetRating(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), rating: 123, date: Date(), asset: 123) // AssetRating | 

MediaLibraryAPI.updateAssetRating(id: id, assetRating: assetRating).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Rating.  
assetRating AssetRating    

Return type

AssetRating

Authorization

Bearer

HTTP request headers

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

updateComment

    open class func updateComment( id: Int,  comment: Comment) -> Promise<Comment>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Comment.
let comment = Comment(id: 123, assignee: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), user: nil, drawing: "TODO", tags: [TagReference(id: 123, name: "name_example", color: "color_example", root: 123)], fullAsset: Asset(id: 123, urls: "TODO", proxies: [Proxy(id: 123, urls: "TODO", profile: ProxyProfileMini(id: 123, name: "name_example"), failedReason: "failedReason_example", transforms: "transforms_example", generated: false, failed: false, name: "name_example", variantId: "variantId_example", variantConfig: "variantConfig_example", asset: 123)], defaultProxy: nil, info: "TODO", proxyInfo: "TODO", customFields: "TODO", tags: [nil], resolvedPermission: MediaRootPermission(id: 123, user: nil, group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123), bundles: ["TODO"], backups: "backups_example", proxiesGenerated: false, proxiesFailed: false, modifiedBy: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), syncId: 123, displayName: "displayName_example", hasFiles: false, hasBackups: false, hasCloudLinks: false, checksum: "checksum_example", type: "type_example", thumbnailGenerated: false, matchedScanner: "matchedScanner_example", rating: 123, workflowState: 123, isTemporary: false, created: Date(), modified: Date(), _set: 123), syncId: 123, date: Date(), text: "text_example", time: 123, isCloud: false, resolved: false, resolvedDate: Date(), asset: 123, root: 123, parent: 123) // Comment | 

MediaLibraryAPI.updateComment(id: id, comment: comment).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Comment

Authorization

Bearer

HTTP request headers

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

updateCustomField

    open class func updateCustomField( id: Int,  customField: CustomField) -> Promise<CustomField>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Custom field.
let customField = CustomField(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example") // CustomField | 

MediaLibraryAPI.updateCustomField(id: id, customField: customField).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

updateEditorProject

    open class func updateEditorProject( id: Int,  editorProject: EditorProject) -> Promise<EditorProject>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.
let editorProject = EditorProject(file: 123, parent: 123, parentPath: "parentPath_example", existingFile: 123, format: "format_example", project: "TODO") // EditorProject | 

MediaLibraryAPI.updateEditorProject(id: id, editorProject: editorProject).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this File.  
editorProject EditorProject    

Return type

EditorProject

Authorization

Bearer

HTTP request headers

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

updateExternalTranscoder

    open class func updateExternalTranscoder( id: Int,  externalTranscoder: ExternalTranscoder) -> Promise<ExternalTranscoder>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this external transcoder.
let externalTranscoder = ExternalTranscoder(id: 123, pathMappings: ["pathMappings_example"], name: "name_example", type: "type_example", address: "address_example") // ExternalTranscoder | 

MediaLibraryAPI.updateExternalTranscoder(id: id, externalTranscoder: externalTranscoder).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

updateMarker

    open class func updateMarker( id: Int,  marker: Marker) -> Promise<Marker>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this marker.
let marker = Marker(id: 123, veritoneMetadataParser: "veritoneMetadataParser_example", title: "title_example", text: "text_example", tIn: 123, tOut: 123, createdAt: Date(), modifiedAt: Date(), user: 123, asset: 123, comment: 123, veritoneMetadata: 123) // Marker | 

MediaLibraryAPI.updateMarker(id: id, marker: marker).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Marker

Authorization

Bearer

HTTP request headers

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

updateMediaFile

    open class func updateMediaFile( id: Int,  mediaFile: MediaFile) -> Promise<MediaFile>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this File.
let mediaFile = MediaFile(id: 123, volume: VolumeMini(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), info: "TODO", customFields: "TODO", resolvedPermission: MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123), parentFile: "TODO", root: MediaRootMini(id: 123, name: "name_example", fullPath: "fullPath_example", customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), path: "path_example", prefetchThumbnailStrips: false), effectiveCustomFields: "TODO", modifiedBy: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), fullPath: "fullPath_example", searchHighlight: "searchHighlight_example", isShared: false, isExcluded: false, isHardlink: false, isBookmarked: false, name: "name_example", path: "path_example", pathhash: "pathhash_example", isDir: false, totalFiles: 123, size: 123, mtime: 123, present: false, needsRescan: false, isShowroom: false, bundleIndex: 123, modified: Date(), parent: 123, bundle: 123, bookmarkedBy: [123]) // MediaFile | 

MediaLibraryAPI.updateMediaFile(id: id, mediaFile: mediaFile).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this File.  
mediaFile MediaFile    

Return type

MediaFile

Authorization

Bearer

HTTP request headers

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

updateMediaFileTemplate

    open class func updateMediaFileTemplate( id: Int,  mediaFileTemplate: MediaFileTemplate) -> Promise<MediaFileTemplate>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Template.
let mediaFileTemplate = MediaFileTemplate(id: 123, file: MediaFileReference(id: 123, volume: VolumeMini(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), info: "TODO", customFields: "TODO", resolvedPermission: MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123), parentFile: "TODO", root: MediaRootMini(id: 123, name: "name_example", fullPath: "fullPath_example", customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), path: "path_example", prefetchThumbnailStrips: false), effectiveCustomFields: "TODO", modifiedBy: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), fullPath: "fullPath_example", searchHighlight: "searchHighlight_example", isShared: false, isExcluded: false, isHardlink: false, isBookmarked: false, name: "name_example", path: "path_example", pathhash: "pathhash_example", isDir: false, totalFiles: 123, size: 123, mtime: 123, present: false, needsRescan: false, isShowroom: false, bundleIndex: 123, modified: Date(), parent: 123, bundle: 123, bookmarkedBy: [123]), name: "name_example") // MediaFileTemplate | 

MediaLibraryAPI.updateMediaFileTemplate(id: id, mediaFileTemplate: mediaFileTemplate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Template.  
mediaFileTemplate MediaFileTemplate    

Return type

MediaFileTemplate

Authorization

Bearer

HTTP request headers

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

updateMediaRoot

    open class func updateMediaRoot( id: Int,  mediaRoot: MediaRoot) -> Promise<MediaRoot>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this media root.
let mediaRoot = MediaRoot(id: 123, customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], workflow: "TODO", aiConfig: "TODO", veritoneConfig: "TODO", volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), fullPath: "fullPath_example", resolvedPermissions: [MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123)], jobs: [JobReference(id: 123, subtasks: [SubtaskReference(id: 123, kwargs: "TODO", graphLayout: "TODO", validationError: "validationError_example", trigger: "trigger_example", name: "name_example", noopDontSave: false, noConcurrency: false, timeout: 123, logVariable: false, task: "task_example", conditionVariable: "conditionVariable_example", conditionValue: "conditionValue_example", sync: false, queue: "queue_example", enqueueAtFront: false, parent: 123, relativeTo: 123)], schedules: [ScheduleReference(id: 123, variables: "TODO", nextRun: Date(), type: 123, enabled: false, lastRun: Date(), every: 123, period: "period_example", crontabDayOfMonth: "crontabDayOfMonth_example", crontabDayOfWeek: "crontabDayOfWeek_example", crontabHour: "crontabHour_example", crontabMinute: "crontabMinute_example", crontabMonthOfYear: "crontabMonthOfYear_example", job: 123)], allowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], allowGroups: [nil], startable: false, variableDefinitions: ["variableDefinitions_example"], mediaRoots: [123], webhookUrl: "webhookUrl_example", specialType: 123, name: "name_example", enabled: false, allowOthersToStart: false, allowClientToStart: false, showAsButton: false, inputType: "inputType_example", hook: "hook_example", webhookSecret: "webhookSecret_example", securityContext: 123, partOfWorkflowFor: 123)], workflowJobs: [Job(id: 123, subtasks: [nil], schedules: [nil], allowUsers: [nil], allowGroups: [nil], startable: false, variableDefinitions: ["variableDefinitions_example"], mediaRoots: [123], webhookUrl: "webhookUrl_example", specialType: 123, name: "name_example", enabled: false, allowOthersToStart: false, allowClientToStart: false, showAsButton: false, inputType: "inputType_example", hook: "hook_example", webhookSecret: "webhookSecret_example", securityContext: 123, partOfWorkflowFor: 123)], name: "name_example", path: "path_example", needsRescan: false, viewMode: "viewMode_example", viewStyle: "viewStyle_example", viewDefaultTab: "viewDefaultTab_example", showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showMarkers: false, showAiMetadata: false, prefetchThumbnailStrips: false, cover: "cover_example", nameField: "nameField_example", shareComments: false, shareLinkDuration: 123, defaultProxyProfile: 123, cloudProxyProfile: 123, veritoneConnection: 123, veritoneProxyProfile: 123, aiConnection: 123, aiProxyProfile: 123, proxyProfiles: [123]) // MediaRoot | 

MediaLibraryAPI.updateMediaRoot(id: id, mediaRoot: mediaRoot).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

updateMediaRootPermission

    open class func updateMediaRootPermission( id: Int,  mediaRootPermission: MediaRootPermission) -> Promise<MediaRootPermission>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Media Root Permission.
let mediaRootPermission = MediaRootPermission(id: 123, user: ElementsUserMiniReference(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), group: ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123]), fullPath: "fullPath_example", path: "path_example", allowCreate: false, allowWriteFs: false, allowWriteDb: false, allowProxyDownload: false, allowOriginalDownload: false, allowUpload: false, allowSharing: false, allowDeleteFs: false, allowDeleteDb: false, showTags: false, showComments: false, showLocations: false, showCustomFields: false, showRatings: false, showSubclips: false, showAiMetadata: false, showMarkers: false, root: 123, isTemporaryForToken: 123) // MediaRootPermission | 

MediaLibraryAPI.updateMediaRootPermission(id: id, mediaRootPermission: mediaRootPermission).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

updateMediaTag

    open class func updateMediaTag( id: Int,  tag: Tag) -> Promise<Tag>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Tag.
let tag = Tag(id: 123, name: "name_example", color: "color_example", root: 123) // Tag | 

MediaLibraryAPI.updateMediaTag(id: id, tag: tag).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Tag

Authorization

Bearer

HTTP request headers

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

updateProxyProfile

    open class func updateProxyProfile( id: Int,  proxyProfile: ProxyProfile) -> Promise<ProxyProfile>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this proxy profile.
let proxyProfile = ProxyProfile(id: 123, name: "name_example", proxyGenerator: "proxyGenerator_example", resolution: "resolution_example", rateControl: 123, crf: 123, bitrate: 123, audioBitrate: 123, variantsLimit: 123, enableRealtimeRead: false, enableDenseFilmstrip: false, enableWatermark: false, watermarkImage: "watermarkImage_example", watermarkPosition: 123, watermarkOpacity: 123, watermarkSize: 123, enableTimecode: false, timecodePosition: 123, timecodeOpacity: 123, timecodeSize: 123, lut: "lut_example", hotfolderCopyTo: "hotfolderCopyTo_example", hotfolderReadFrom: "hotfolderReadFrom_example", hotfolderQueueTimeout: 123, hotfolderEncodeTimeout: 123, vantageWorkflowId: "vantageWorkflowId_example", externalTranscoderStagingPath: "externalTranscoderStagingPath_example", externalTranscoder: 123) // ProxyProfile | 

MediaLibraryAPI.updateProxyProfile(id: id, proxyProfile: proxyProfile).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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

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

updateSubclip

    open class func updateSubclip( id: Int,  subclip: Subclip) -> Promise<Subclip>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this subclip.
let subclip = Subclip(id: 123, asset: AssetMiniReference(id: 123, syncId: 123, defaultProxy: Proxy(id: 123, urls: "TODO", profile: ProxyProfileMini(id: 123, name: "name_example"), failedReason: "failedReason_example", transforms: "transforms_example", generated: false, failed: false, name: "name_example", variantId: "variantId_example", variantConfig: "variantConfig_example", asset: 123), urls: "TODO", type: "type_example", displayName: "displayName_example", info: "info_example", thumbnailGenerated: false), rendered: nil, shared: false, date: Date(), name: "name_example", tIn: 123, tOut: 123, user: 123, root: MediaRootMiniReference(id: 123, name: "name_example", fullPath: "fullPath_example", customFields: [CustomFieldReference(id: 123, labels: ["labels_example"], options: ["options_example"], name: "name_example", order: 123, type: "type_example", useForUploads: false, requireToUpload: false, nonUserEditable: false, validation: "validation_example", regex: "regex_example", rangeMin: 123, rangeMax: 123, numberOfDigits: 123, metadataPrefill: "metadataPrefill_example", highlightExpiration: false, multipleResponse: false, helpText: "helpText_example")], volume: VolumeMiniReference(id: 123, name: "name_example", path: "path_example", displayName: "displayName_example", visualTag: "visualTag_example", type: "type_example"), path: "path_example", prefetchThumbnailStrips: false)) // Subclip | 

MediaLibraryAPI.updateSubclip(id: id, subclip: subclip).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

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

Return type

Subclip

Authorization

Bearer

HTTP request headers

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