MediaItems

Getting and searching for media items. Managing media items.

APIDescription
GET api/MediaItems?id={id}

Getting the absolute path to media item

GET api/MediaItems?ids={ids}

Getting media items by IDs

GET api/MediaItems?importId={importId}

Getting media items by import session ID

GET api/MediaItems?line={line}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/MediaItems/GetAbsolutePath/{id}

Getting the absolute path to media item

GET api/MediaItems/GetAbsolutePaths

Getting the absolute path to media items

GET api/MediaItems/GetSort

Getting sort tags

GET api/MediaItems/Get

Search for media items

GET api/MediaItems/Tray

Getting favourite media items

POST api/MediaItems/AppendToTray

Changing a list of favourite media items

POST api/MediaItems/ClearTray

Deleting all media items from the list of favourites

GET api/MediaItems/GetCount

Getting the number of found media items

GET api/MediaItems/MyItems

Getting the list of media items that do not have all required metadata filled in

GET api/MediaItems/MyItemsCount

Getting the number of media items that do not have all required metadata filled in

GET api/MediaItems/GetByIds?ids={ids}

Getting media items by IDs

GET api/MediaItems/GetByImportId?importId={importId}

Getting media items by import session ID

POST api/MediaItems/ApproveItems

Approval of media items

POST api/MediaItems/ProcessAILabels

Auto-tagging of media items

GET api/MediaItems/GetItemValues

Getting the status of media items

POST api/MediaItems/Remove

Batch deletion of media items

GET api/MediaItems/GetSearch?line={line}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/MediaItems/GetItems

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/MediaItems/GetLastSearch

Deprecated endpoint. It will be removed in the upcoming versions.

IndexedTagValues

Managing catalog tags

APIDescription
GET api/IndexedTagValues?indexedTagId={indexedTagId}&parentValueId={parentValueId}&filter={filter}&pageIndex={pageIndex}&pageSize={pageSize}

Getting tag values

POST api/IndexedTagValues?tagId={tagId}&sourceValueId={sourceValueId}&targetValueId={targetValueId}

Merging the values of the indexed tag

GET api/IndexedTagValues?indexedId={indexedId}&id={id}&queryLine={queryLine}

Getting statistics by the value of the indexed tag

POST api/IndexedTagValues?tagGuid={tagGuid}&newName={newName}

Renaming a custom tag

GET api/IndexedTagValues?indexedTagId={indexedTagId}&indexedTagValueId={indexedTagValueId}

Getting the existing tag value links

GET api/IndexedTagValues?mode={mode}

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/IndexedTagValues/CreateValueByGuid

Creating a value of the indexed tag by GUID

GET api/IndexedTagValues/GetIndexedTagValues?indexedTagId={indexedTagId}&parentValueId={parentValueId}&filter={filter}&pageIndex={pageIndex}&pageSize={pageSize}

Getting tag values

POST api/IndexedTagValues/ChangeValue

Changing a tag value by ID

POST api/IndexedTagValues/ChangeParent

Moving a tag value

POST api/IndexedTagValues/MergeValues?tagId={tagId}&sourceValueId={sourceValueId}&targetValueId={targetValueId}

Merging the values of the indexed tag

POST api/IndexedTagValues/DeleteValueByGuid

Deleting a tag value by GUID

GET api/IndexedTagValues/GetStatistic/{id}?indexedId={indexedId}&queryLine={queryLine}

Getting statistics by the value of the indexed tag

GET api/IndexedTagValues/FindValues

Search for tag values

POST api/IndexedTagValues/CreateCustomTag

Creating a custom tag

GET api/IndexedTagValues/GetCustomTags

Getting custom tags

POST api/IndexedTagValues/RenameCustomTag?tagGuid={tagGuid}&newName={newName}

Renaming a custom tag

POST api/IndexedTagValues/DeleteCustomTag

Deleting a custom tag

GET api/IndexedTagValues/GetTagLinks?indexedTagId={indexedTagId}&indexedTagValueId={indexedTagValueId}

Getting the existing tag value links

POST api/IndexedTagValues/ProcessTagLinks

Linking tag values

GET api/IndexedTagValues/GetTray

Getting the favourite list IDs for the current user

POST api/IndexedTagValues/SaveBrowseList

Saving the tag list for the filters panel

GET api/IndexedTagValues/SearchTags

Getting quick search options

GET api/IndexedTagValues/GetIndexedTags?mode={mode}

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/IndexedTagValues/ChangeValueByGuid

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/IndexedTagValues/DeleteValue

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/IndexedTagValues/CreateValue

Deprecated endpoint. It will be removed in the upcoming versions.

UserManager

User management

APIDescription
POST api/UserManager?userName={userName}&password={password}

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/UserManager/CreateRole

Creating a user role

POST api/UserManager/DuplicateRole

Role cloning

GET api/UserManager/GetRoles

Getting roles

POST api/UserManager/DeleteRole

Deleting a role

GET api/UserManager/GetPermissions/{id}

Getting permission

POST api/UserManager/SetPermissions

Setting permissions

POST api/UserManager/Create

Creating a user

GET api/UserManager/GetUsers

Getting user list

POST api/UserManager/Edit

Editing a user

POST api/UserManager/Delete

Deleting a user

GET api/UserManager/GetAccessControlGroup/{id}

Getting access control group

POST api/UserManager/ChangeAccessGroup

Changing the access control group

POST api/UserManager/Login?userName={userName}&password={password}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/UserManager/Get/{id}

Deprecated endpoint. It will be removed in the upcoming versions.

Settings

Managing catalog settings

APIDescription
GET api/Settings?param={param}

Getting the API key

POST api/Settings?scale={scale}&opacity={opacity}&align={align}

Changing the watermark settings

GET api/Settings?paramName={paramName}&global={global}

Getting a parameter

GET api/Settings?roleId={roleId}

Getting blocked (hidden) tags

GET api/Settings?flag={flag}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Settings/GetVersion

Getting Daminion server version

GET api/Settings/GetCatalogGuid

Getting the current catalog GUID

GET api/Settings/GetDomains

Getting a list of Active Directory domains

GET api/Settings/IsAllowUnsecure

Checking permission for login-free access

GET api/Settings/GetLoggedUser

Getting the current user

POST api/Settings/SetApiKey

Setting the API key

GET api/Settings/GetApiKey?param={param}

Getting the API key

POST api/Settings/SetCustomColors

Setting system color labels

GET api/Settings/GetCustomColors

Getting system color labels

POST api/Settings/SetEditableProperties

Setting editable properties

GET api/Settings/GetEditableProperties?mode={mode}

Getting editable properties

GET api/Settings/GetTags

Gettings Tags

GET api/Settings/GetFilters?mode={mode}

Getting a list of tags for the Filters panel

GET api/Settings/GetRights

Getting permissions for the current user

POST api/Settings/CreateActionSet

Creating an export preset

GET api/Settings/GetExportPresets

Getting export presets

POST api/Settings/ChangeActionSet

Modifying an export preset

POST api/Settings/DeleteActionSet

Deleting an export preset

GET api/Settings/GetWatermarkData?guid={guid}

Getting watermark settings

POST api/Settings/ChangeWatermark?scale={scale}&opacity={opacity}&align={align}

Changing the watermark settings

POST api/Settings/RemoveWatermark

Deleting a watermark

POST api/Settings/UploadWatermark

Uploading the watermark

GET api/Settings/GetWatermark?guid={guid}

Getting the watermark

POST api/Settings/SetParam

Setting a parameter

GET api/Settings/GetParam?paramName={paramName}&global={global}

Getting a parameter

POST api/Settings/SetAutoModeration

Activating the waiting room

GET api/Settings/GetAutoModeration

Getting the waiting room settings

POST api/Settings/SetTagVisibility

Restricting access to tags for a role

GET api/Settings/GetHiddenTags?roleId={roleId}

Getting blocked (hidden) tags

GET api/Settings/GetSecurityMode

Getting the current security mode

GET api/Settings/GetAllConnections

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Settings/SetVideoPreviewRender?flag={flag}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Settings/GetVideoPreviewRender

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Settings/GetPropertiesDescription

Deprecated endpoint. It will be removed in the upcoming versions.

Upload

Deprecated. It will be removed in the upcoming versions.

APIDescription
POST api/Upload

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Upload/UploadFiles

Deprecated endpoint. It will be removed in the upcoming versions.

Thumbnail

Managing thumbnails

APIDescription
GET api/thumbnail/{id}/{width}/{height}

Getting a thumbnail of the Media Item

GET api/Thumbnail/Get/{id}?width={width}&height={height}

Getting a thumbnail of the Media Item

GET api/Thumbnail/GetByFileName?fileName={fileName}

Getting a thumbnail of the Media Item by filename

POST api/Thumbnail/UpdateThumbnails

Updating thumbnails

POST api/Thumbnail/CancelUpdateThumbnails

Canceling the thumbnail update operation

GET api/Thumbnail/GetActiveUpdateThumbnailsTasks

Getting thumbnail update tasks

SharedCollection

Managing shared collections

APIDescription
GET api/sharedCollection/publicItems/{code}/{index}/{size}/{sortag}/{asc}

Getting media items of the published shared collection

POST api/sharedCollection/downloadCollection?code={code}

Downloading all files from a shared collection

GET api/sharedCollection/thumb/{code}/{id}/{width}/{height}

Getting a thumbnail of the media item added to the shared collection

GET api/sharedCollection/preview/{code}/{id}/{width}/{height}

Getting a preview image

GET api/sharedCollection/itemdata/{code}/{id}

Getting the data of the media item added to a shared collection

POST api/SharedCollection/Create

Creating a shared collection

GET api/SharedCollection/GetCollections?index={index}&pageSize={pageSize}

Getting a list of shared collections

GET api/SharedCollection/GetDetails/{id}

Getting the paremeters of the shared collection by ID

GET api/SharedCollection/GetInfo?code={code}

Getting the paremeters of the shared collection by code

POST api/SharedCollection/Change

Changing the parameters of the shared collection

POST api/SharedCollection/Sort

Sorting media items added to a shared collection

POST api/SharedCollection/Delete

Deleting shared collections

GET api/SharedCollection/CollectionPreview/{id}

Getting the shared collection preview image

GET api/SharedCollection/PublicItems?code={code}&index={index}&size={size}&sortag={sortag}&asc={asc}

Getting media items of the published shared collection

GET api/SharedCollection/GetItems

Getting media items of the shared collection

GET api/SharedCollection/Thumb/{id}?code={code}&width={width}&height={height}

Getting a thumbnail of the media item added to the shared collection

GET api/SharedCollection/DownloadFile/{id}?code={code}

Downloading a file from a shared collection

GET api/SharedCollection/DownloadList?code={code}

Batch downloading from a shared collection

GET api/SharedCollection/GetActiveConvertTasks?code={code}

Getting the archive preparation task of shared collection files

GET api/SharedCollection/ItemData/{id}?code={code}

Getting the data of the media item added to a shared collection

GET api/SharedCollection/Preview/{id}?code={code}&width={width}&height={height}

Getting a preview image

GET api/SharedCollection/GetVideoPoint/{id}?code={code}

Getting the data of the video item

GET api/SharedCollection/Download?code={code}

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/SharedCollection/ChangeCollection

Deprecated endpoint. It will be removed in the upcoming versions.

Preview

Getting preview files

APIDescription
GET api/preview/{id}/{width}/{height}

Getting a preview image

GET api/preview/getPoint?id={id}

Getting preview data

GET api/preview/getPoint?id={id}&code={code}

Getting preview data for the shared collection

GET api/preview/getPoint2?id={id}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/preview/getPoint2?id={id}&code={code}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Preview/GetPoint/{id}

Getting preview data

GET api/Preview/GetPoint/{id}?code={code}

Getting preview data for the shared collection

GET api/Preview/Get/{id}?width={width}&height={height}

Getting a preview image

GET api/Preview/GetBase64/{id}?width={width}&height={height}

Getting an image for Base64 encoded preview

GET api/Preview/GetStatic?mediaItemGuid={mediaItemGuid}

Getting a static preview image

GET api/Preview/GetByFileName?fileName={fileName}

Getting a preview image by filename

GET api/Preview/GetPoint2/{id}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Preview/GetPoint2/{id}?code={code}

Deprecated endpoint. It will be removed in the upcoming versions.

Video

Working with video files

APIDescription
GET api/video/get/{id}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Video/GetVideoPoint/{id}

Getting video item data

POST api/Video/Rebuild

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Video/GetVideo

Deprecated endpoint. It will be removed in the upcoming versions.

ItemData

Managing media item data

APIDescription
POST api/itemData?id={id}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/ItemData/Get/{id}

Getting media item data based on the Property Inspector settings

GET api/ItemData/GetAll/{id}

Getting media item data

POST api/ItemData/BatchChange

Assigning Tags

POST api/ItemData/ChangeData

Assigning tags to media items filtered by the specified criteria

GET api/ItemData/GetActiveDataChangeTasks

Gettings tag values assignment tasks

POST api/ItemData/CancelChangeDataTask

Canceling the tag values assignment task

POST api/ItemData/SetLayout

Setting the Properties panel for the current user

GET api/ItemData/GetSavedLayout

Getting the Properties panel settings for the current user

POST api/ItemData/SetDefaultGuiSettings

Setting the Properties panel for all users

GET api/ItemData/GetDefaultLayout

Gettings a list of tags that can be added to the Properties panel

GET api/ItemData/GetEditProperties

Getting tags that can be used as required tags in the waiting room

POST api/ItemData/ChangeById

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/ItemData/ChangeByFile

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/ItemData/Change/{id}

Deprecated endpoint. It will be removed in the upcoming versions.

Intranet

System and support operations

APIDescription
GET api/intranet?extension={extension}

Getting applications that can be used for this file type

GET api/Intranet/GetAliases

Getting existing catalogs

POST api/Intranet/SetApplications

Setting applications used on the client side

GET api/Intranet/GetApps?extension={extension}

Getting applications that can be used for this file type

POST api/Intranet/OpenFile

Opening the file

POST api/Intranet/OpenDir

Opening the file directory

POST api/Intranet/CloseApp

Closing the application

POST api/Intranet/CloseAppEx

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Intranet/GetLarge

Deprecated endpoint. It will be removed in the upcoming versions.

Collection

Deprecated. It will be removed in the upcoming versions.

APIDescription
GET api/Collection/GetCollections?parent={parent}&index={index}&pageSize={pageSize}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Collection/GetCollectionItems/{id}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Collection/GetCollection

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Collection/RenameCollection

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Collection/CreateCollection

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Collection/DeleteCollection/{id}

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Collection/ChangeCollection

Deprecated endpoint. It will be removed in the upcoming versions.

Maps

Working with the map

APIDescription
POST api/Maps/Set

Placing Media Items on the map

GET api/Maps/Get

Getting markers of Media Items placed on the map

POST api/Maps/SetPlace

Setting the Place tag for Media Items

GET api/Maps/FindPlaces

Searching for the Place tag values

GET api/Maps/GetItemsAtPoint

Deprecated endpoint. It will be removed in the upcoming versions.

Localization

Localization

APIDescription
POST api/Localization/Save

Setting the language for the current user

GET api/Localization/Get

Getting the language for the current user

POST api/Localization/SetDefault

Setting the default language

GET api/Localization/GetDefault

Getting the default language

File

File operations

APIDescription
POST api/File/RenameFile/{id}?newName={newName}

Renaming a file

AI

Auto-tagging

APIDescription
POST api/AI/ProcessAITags

Auto-tagging of Media Items

VersionControl

Versioning of Media Items

APIDescription
POST api/VersionControl/CheckOut

Checking a Media Item out

POST api/VersionControl/UndoCheckOut

Cancelling the check-out

POST api/VersionControl/CheckIn

Checking a new file version in

POST api/VersionControl/Rollback/{id}

Reverting to the previous file version

GET api/VersionControl/GetRevisions?mediaItemId={mediaItemId}

Getting Media Item versions

GET api/VersionControl/GetRevisionThumbnail/{id}?width={width}&height={height}

Getting a thumbnail for the Media Item version

GET api/VersionControl/GetRevisionPreview/{id}

Getting a preview image for the Media Item version

Import

File import

APIDescription
GET api/Import/GetSupported

Getting a list of supported file formats

POST api/Import/SaveTags

Saving import tags for the current user

GET api/Import/GetTags

Getting import tags for the current users

POST api/Import/SavePresets

Saving import presets for the current users

GET api/Import/GetPresets

Getting import presets for the current users

POST api/Import/UploadFile

File upload

GET api/Import/GetImports

Getting file import tasks

POST api/Import/CloseLastImport

Closing the last import session

POST api/Import/ImportFiles

Importing files by direct links

GET api/Import/GetAllImports

Getting all file import tasks. Available only for administrators.

POST api/Import/Cancel

Cancelling import

POST api/Import/ImportDropboxFiles

Importing files from Dropbox

GET api/Import/GetDropboxImports/{id}

Getting the Dropbox import task

POST api/Import/CancelDropboxImport

Cancelling import from Dropbox

GET api/Import/GetSettings

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Import/Post

Deprecated endpoint. It will be removed in the upcoming versions.

Branding

Branding

APIDescription
POST api/Branding/SetDefaultBackgorund

Setting the default background

GET api/Branding/GetDefaultBackground

Getting the default background

POST api/Branding/SetCustomBackground

Setting the background for the user

GET api/Branding/GetCustomBackground

Getting the background for the user

POST api/Branding/SetDefaultLoginLogo

Setting the default logo for the login page

GET api/Branding/GetDefaultLoginLogo

Getting the default logo for the login page

POST api/Branding/SetCustomLoginLogo

Setting the user logo for the login page

GET api/Branding/GetCustomLoginLogo

Getting the user logo for the login page

POST api/Branding/SetDefaultLogo

Setting the default logo

GET api/Branding/GetDefaultLogo

Getting the default logo

POST api/Branding/SetCustomLogo

Setting the user logo

GET api/Branding/GetCustomLogo

Getting the user logo

POST api/Branding/SetDefaultScheme

Setting the default color scheme

GET api/Branding/GetDefaultScheme

Getting the default color scheme

POST api/Branding/SetCustomScheme

Setting the color scheme for the user

GET api/Branding/GetCustomScheme

Getting the color scheme for the user

POST api/Branding/SetDefaultWelcome

Setting the default welcome message

GET api/Branding/GetDefaultWelcome

Getting the default welcome message

POST api/Branding/SetCustomWelcome

Setting the custom welcome message

GET api/Branding/GetCustomWelcome

Getting the custom welcome message

POST api/Branding/SetDefaultColor

Setting the default accent color

GET api/Branding/GetDefaultColor

Getting the default accent color

POST api/Branding/SetCustomColor

Setting the custom accent color

GET api/Branding/GetCustomColor

Getting the custom accent color

GET api/Branding/GetColors

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Branding/GetCustomDarkLogo

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Branding/GetDefaultDarkLogo

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Branding/SetDefaultDarkLogo

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Branding/ChangeColors

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Branding/UploadBackground

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Branding/UploadFile

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Branding/UploadDarkLogo

Deprecated endpoint. It will be removed in the upcoming versions.

Collaboration

Commenting on Media Items

APIDescription
POST api/Collaboration/CreateCommentThread

Creating a new comment thread

GET api/Collaboration/GetCommentThreads?itemId={itemId}&revisionId={revisionId}&resolved={resolved}

Getting comment threads for the specified Media Item version

POST api/Collaboration/EditCommentThread

Edit the geometry of the comment thread

POST api/Collaboration/ResolveCommentThread?geometryId={geometryId}

Resolving a comment thread

POST api/Collaboration/DeleteCommentThread?geometryId={geometryId}

Deleting a comment thread

POST api/Collaboration/AddComment

Adding a comment

GET api/Collaboration/FetchCommentThread?geometryId={geometryId}

Getting the comments of the thread

POST api/Collaboration/EditComment

Editing a comment

POST api/Collaboration/RemoveComment?commentId={commentId}

Deleting a comment

GET api/Collaboration/GetCommentSummaryStatus

Getting the status of comments for the current user

GET api/Collaboration/GetCommentSummary

Getting notifications for the current user

GET api/Collaboration/GetThreadStatus?mediaItemId={mediaItemId}

Getting the comment status for Media Item (for current user)

GET api/Collaboration/GetRevisionStatus?itemId={itemId}

Getting comment statuses for Media Item versions

Download

Downloading files

APIDescription
GET api/Download/Get/{id}

Downloading the original file

GET api/Download/GetWithPreset/{id}?guid={guid}

Exporting a file using the export preset

POST api/Download/GetItemsWithPreset

Batch download

POST api/Download/GetFolderAsZip/{id}

Recursive folder download

GET api/Download/GetPDFSettings

Getting PDF export settings

POST api/Download/CreatePDF

Export to PDF

GET api/Download/GetActiveConvertTasks

Getting batch tasks

POST api/Download/CancelConvertTask

Canceling the batch task

POST api/Download/CreateCDNWithPreset

Creating an embed link

GET api/Download/GetEmbedLinksById/{id}

Getting the existing embed links

POST api/Download/UpdateCDN/{id}?preset={preset}&hash={hash}

Updating the embed link

POST api/Download/DeleteCDN/{id}?preset={preset}&hash={hash}

Deleting the embed link

GET api/Download/GetAssistantSettings

Getting the web client assistant settings

GET api/Download/GetAdobe/{id}

Deprecated endpoint. It will be removed in the upcoming versions.

POST api/Download/ExportToCDN/{id}?guid={guid}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Download/GetZipWithPreset?guid={guid}

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Download/GetZip

Deprecated endpoint. It will be removed in the upcoming versions.

GET api/Download/GetTrayZip

Deprecated endpoint. It will be removed in the upcoming versions.