MediaItems
Getting and searching for media items. Managing media items.
| API | Description | 
|---|---|
| GET api/MediaItems?id={id} | Getting the absolute path to media item | 
| POST api/MediaItems?id={id} | Deleting all media items from the list of favourites | 
| 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/{id} | 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/AppendLinks | TODO | 
| POST api/MediaItems/RemoveLinks | TODO | 
| GET api/MediaItems/GetLinks/{id}?index={index}&size={size} | TODO | 
| GET api/MediaItems/GetMasters/{id}?index={index}&size={size} | TODO | 
| POST api/MediaItems/ApproveItems | Approval of media items | 
| POST api/MediaItems/ProcessAILabels | Auto-tagging of media items | 
| POST api/MediaItems/ProcessAILabelsQuery | 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
UserManager
User management
Settings
Managing catalog settings
Upload
Deprecated. It will be removed in the upcoming versions.
| API | Description | 
|---|---|
| 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
| API | Description | 
|---|---|
| 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
Preview
Getting preview files
Video
Working with video files
| API | Description | 
|---|---|
| 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
| API | Description | 
|---|---|
| POST api/itemData?id={id} | Deprecated endpoint. It will be removed in the upcoming versions. | 
| GET api/ItemData/GetAudioTranscript/{id} | No documentation available. | 
| 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
| API | Description | 
|---|---|
| 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. | 
Maps
Working with the map
| API | Description | 
|---|---|
| GET api/maps?id={id} | No documentation available. | 
| POST api/Maps/Set | Placing Media Items on the map | 
| GET api/Maps/GetCoordsById/{id} | No documentation available. | 
| 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
| API | Description | 
|---|---|
| POST api/Localization/Save | Setting the language for the current user | 
| POST api/Localization/SaveTagLanguage | Setting the language for the current user | 
| GET api/Localization/Get | Getting the language for the current user | 
| GET api/Localization/GetTagLanguages | No documentation available. | 
| GET api/Localization/GetTagLanguage | Getting the language for the current user | 
| POST api/Localization/SetDefault | Setting the default language | 
| GET api/Localization/GetDefault | Getting the default language | 
Import
File import
| API | Description | 
|---|---|
| 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/DropFileUpload?guid={guid} | Deleting multiple temporary files created when uploading a file in chunks | 
| 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. | 
Download
Downloading files
VersionControl
Versioning of Media Items
| API | Description | 
|---|---|
| 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 | 
Collaboration
Commenting on Media Items
Favorites
| API | Description | 
|---|---|
| GET api/Favorites/GetList | TODO | 
| GET api/Favorites/GetTotalCount | TODO | 
| GET api/Favorites/GetFavoritesWithIds | TODO | 
| GET api/Favorites/GetFavoritesCounts | TODO | 
| GET api/Favorites/GetItems/{id} | Getting favourite media items | 
| POST api/Favorites/CreateList?title={title} | TODO | 
| POST api/Favorites/DeleteList/{id} | TODO | 
| POST api/Favorites/RenameList/{id}?newTitle={newTitle} | TODO | 
Collection
Deprecated. It will be removed in the upcoming versions.
| API | Description | 
|---|---|
| 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. | 
AI
Auto-tagging
| API | Description | 
|---|---|
| POST api/AI/ProcessAITags | Auto-tagging of Media Items | 
File
File operations
| API | Description | 
|---|---|
| POST api/File/RenameFile/{id}?newName={newName} | Renaming a file | 
Branding
Branding
| API | Description | 
|---|---|
| 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 | 
| GET api/Branding/GetPromotionText | No documentation available. | 
| POST api/Branding/SetCustomLoginLogo | Setting the user logo for the login page | 
| POST api/Branding/SetCustomDarkLoginLogo | Setting the user logo for the login page | 
| GET api/Branding/GetCustomLoginLogo | Getting the user logo for the login page | 
| GET api/Branding/GetCustomDarkLoginLogo | 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 | 
| POST api/Branding/SetCustomDarkLogo | Setting the user logo | 
| GET api/Branding/GetCustomLogo | Getting the user logo | 
| GET api/Branding/GetCustomDarkLogo | 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 | 
| POST api/Branding/SetAdditionalDefaultColor | No documentation available. | 
| GET api/Branding/GetDefaultColor | Getting the default accent color | 
| GET api/Branding/GetAdditionalDefaultColor | No documentation available. | 
| POST api/Branding/SetCustomColor | Setting the custom accent color | 
| POST api/Branding/SetAdditionalCustomColor | No documentation available. | 
| GET api/Branding/GetCustomColor | Getting the custom accent color | 
| GET api/Branding/GetAdditionalCustomColor | Getting the custom accent color | 
| GET api/Branding/GetColors | 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. |