Операции с каталогами
/api/v2/Folder/List
Получить список файлов и каталогов
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| includeFiles | boolean | Включать файлы в выдачу | нет | |
| includeFolders | boolean | Включать каталоги в выдачу | нет | |
| recursive | boolean | Включать вложенные каталоги | нет | |
| fileSearchPattern | string | Маска для поиска файлов | нет | |
| pageSize | integer (int32) | Размер страницы выдачи | нет | |
| after | string | Курсорная пейджинация. Полный путь записи после которой выдавать результат. Для получения следующей страницы, сюда надо передать полный путь последней записи на текущей странице. | нет | |
| folderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | FolderListResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController List(ASE.MD.Platform.Services.FilesService.Models.Params.FolderListParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схе ма http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/Create
Создать каталог
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| parent | FolderParams | |||
| name | string | Имя создаваемого каталога | да | |
| description | string | нет | ||
| skipIfExists | boolean | Не выдавать ошибку если каталог уже существует | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IdResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController Create(ASE.MD.Platform.Services.FilesService.Models.Params.FolderCreateParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/Remove
Удалить каталог
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| recursive | boolean | Удалять вложенные каталоги | нет | |
| force | boolean | Удалять каталог вместе с файлами | нет | |
| skipIfNotExists | boolean | Не выдавать ошибку если каталога не существует | нет | |
| folderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController Remove(ASE.MD.Platform.Services.FilesService.Models.Params.FolderRemoveParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/GetInfo
Получить информацию о каталоге
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| includeStats | boolean | Выдавать ли статистику: число файлов, папок, размеры | нет | |
| folderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | FolderInfo | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController GetInfo(ASE.MD.Platform.Services.FilesService.Models.Params.FolderInfoParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/UpdateInfo
Обновить метаданные каталога
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| description | string | Описание | нет | |
| metadata | string | дополнительные пользовательские метаданные в JSON | нет | |
| folderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController UpdateInfo(ASE.MD.Platform.Services.FilesService.Models.Params.FolderUpdateParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области ра зрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/SetSharedAccess
Установить параметры общего доступа каталога
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Парамет ры объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| sharedReadAccess | boolean | Файлы в каталоге доступны на чтение без авторизации | нет | |
| folderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController SetSharedAccess(ASE.MD.Platform.Services.FilesService.Models.Params.FolderSharedAccessParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/Move
Переместить, переименовать каталог
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| newName | string | Новое имя каталога, если не задано, то должен быть задан NewParentFolder, тогда файл перемещается со старым именем | нет | |
| newParentFolder | FolderParams | |||
| folderId | string (uuid) | ID каталога, который хотим получи ть Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController Move(ASE.MD.Platform.Services.FilesService.Models.Params.FolderMoveCopyParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/Copy
копировать каталог
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| newName | string | Новое имя каталога, если не задано, то должен быть задан NewParentFolder, тогда файл перемещается со старым именем | нет | |
| newParentFolder | FolderParams | |||
| folderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IdResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController Copy(ASE.MD.Platform.Services.FilesService.Models.Params.FolderMoveCopyParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/DownloadAsZip
Скачать каталог с файлами в виде zip архива
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Целевой каталог
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| continueOnErrors | boolean | Игнорировать ошибки чтения файлов из хранилища. Пропускаются каталоги и файлы к тоторым нет доступа на чтение. | нет | |
| folderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController DownloadAsZip(ASE.MD.Platform.Services.FilesService.Models.Params.FolderDownloadArgs)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/UploadZip
Загрузить zip архив и распаковать в каталог
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: multipart/form-data
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| ZipArchive | string (binary) | Загружаемый Zip архив. | нет | |
| Overwrite | boolean | Перезаписывать файлы. true - остается только последняя ревизия файла. false - сохраняются все ревизии файлов. | нет | |
| FileNameEncoding | string | Кодировка имен файлов в архиве. Можно указать имя кодировки: UTF-8, или кодовую страницу: 1251, 866 и.т.д. По умолчанию cp-866 для поддержки русских символов в архивах созданных в Windows. | нет | |
| FolderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| Path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController UploadZip(ASE.MD.Platform.Services.FilesService.Models.Params.UploadZipParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/api/v2/Folder/Exists
Проверить существует ли каталог с заданным путем или Id
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Целевой каталог
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| folderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FolderController Exists(ASE.MD.Platform.Services.FilesService.Models.Params.FolderParams)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |
/components/securitySchemes/filesservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | filesservice:filesservice:execute |