Loading ...

REST API: Files | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Files
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 41

REST API: Files

0 
 /5
0 (0votes)
Open API Guide

Upload, version, and move large binary assets with ease. The Files API handles large-scale operations across private personal folders and departmental space resources.

Available Endpoints

Method Endpoint Description
POST Add File /api/files Adds a file to a specific directory
GET Check File Directory Name Availability /api/file/directory/name/status Check whether a file directory name is available for use or if it already exists
GET Check File Name Availability /api/files/availability Check whether a file name is available in a directory or if it already exists
PUT Check in File /api/files/checkin/{FileID} Check in a file in place of an already checked out file. Used to update an existing file.
PUT Check Out File /api/files/checkout Check out a file to lock it for updating
POST Create File Directory /api/file/directories Provides programmatic access for the creation and processing of create file directory resources.
DELETE Delete File /api/files/{fileid} Provides an automated mechanism for removing delete file data from the system.
DELETE Delete File Directory /api/file/directories/{filedirectoryid} Provides an automated mechanism for removing delete file directory data from the system.
DELETE Delete Multiple Files /api/files/multiple Provides an automated mechanism for removing delete multiple files data from the system.
GET Download File /api/content/{ContentID}/stream Download the binary file associated with a content item using token-authenticated requests.
GET Get Child Directories /api/file/directories/parent/{ParentDirectoryID} Enables administrators and developers to programmatically retrieve a list of child directories based on the parent directory ID.
GET Get Directory Files /api/directory/{DirectoryID}/files/list Enables administrators and developers to programmatically retrieve a list of files from a specific directory.
GET Get File Directory /api/file/directories/{directoryid} Enables administrators and developers to programmatically retrieve a file directory.
GET Get Files /api/files Enables administrators and developers to programmatically retrieve a list of files.
GET Get Parent Directories /api/file/directories/{DirectoryID}/parent Enables administrators and developers to programmatically retrieve a list of parent directories for a specific directory.
GET Get Recycled Files /api/files/recycled Enables administrators and developers to programmatically retrieve files which have been deleted and are in the recycle bin.
PUT Move File /api/content/{ContentID}/move Copy content to a different space. Supported for articles, blogs, CMS pages, files and folders, photos and albums, videos, wikis.
PUT Restore File /api/files/restore Restore a file from the recycle bin.
PUT Restore Multiple Files and Directories /api/files/multiple/restore Restore multiple files and directories from the recycle bin.
PUT Undo Check Out File /api/files/undo/checkout Undo a check out to unlock a file.
PUT Update File Directory /api/file/directories/{DirectoryID} Supports the synchronization and modification of update file directory properties via the API.

Wiki Index

Pages