Перейти к основному содержимому

Операции с каталогами

/api/v2/Folder/List

Получить список файлов и каталогов

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Название поляТип поляОписаниеОбязательноеВозможные значения
includeFilesbooleanВключать файлы в выдачунет
includeFoldersbooleanВключать каталоги в выдачунет
recursivebooleanВключать вложенные каталогинет
fileSearchPatternstringМаска для поиска файловнет
pageSizeinteger (int32)Размер страницы выдачинет
afterstringКурсорная пейджинация.
Полный путь записи после которой выдавать результат.
Для получения следующей страницы, сюда надо передать полный путь последней записи на текущей странице.
нет
folderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
pathstringПолный путь каталога, который хотим получить
Задается или FolderId, или Path
Пустой путь или / интерперетируется как корневой каталог
нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultFolderListResult
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Название поляТип поляОписаниеОбязательноеВозможные значения
parentFolderParams
namestringИмя создаваемого каталогада
descriptionstringнет
skipIfExistsbooleanНе выдавать ошибку если каталог уже существуетнет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIdResult
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Название поляТип поляОписаниеОбязательноеВозможные значения
recursivebooleanУдалять вложенные каталогинет
forcebooleanУдалять каталог вместе с файламинет
skipIfNotExistsbooleanНе выдавать ошибку если каталога не существуетнет
folderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
pathstringПолный путь каталога, который хотим получить
Задается или FolderId, или Path
Пустой путь или / интерперетируется как корневой каталог
нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Название поляТип поляОписаниеОбязательноеВозможные значения
includeStatsbooleanВыдавать ли статистику: число файлов, папок, размерынет
folderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
pathstringПолный путь каталога, который хотим получить
Задается или FolderId, или Path
Пустой путь или / интерперетируется как корневой каталог
нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultFolderInfo
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Параметры объекта

Название поляТип поляОписаниеОбязательноеВозможные значения
descriptionstringОписаниенет
metadatastringдополнительные пользовательские метаданные в JSONнет
folderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
pathstringПолный путь каталога, который хотим получить
Задается или FolderId, или Path
Пустой путь или / интерперетируется как корневой каталог
нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Параметры объекта

Название поляТип поляОписаниеОбязательноеВозможные значения
sharedReadAccessbooleanФайлы в каталоге доступны на чтение без авторизациинет
folderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
pathstringПолный путь каталога, который хотим получить
Задается или FolderId, или Path
Пустой путь или / интерперетируется как корневой каталог
нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Название поляТип поляОписаниеОбязательноеВозможные значения
newNamestringНовое имя каталога, если не задано, то должен быть задан NewParentFolder, тогда файл перемещается со старым именемнет
newParentFolderFolderParams
folderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
pathstringПолный путь каталога, который хотим получить
Задается или FolderId, или Path
Пустой путь или / интерперетируется как корневой каталог
нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Название поляТип поляОписаниеОбязательноеВозможные значения
newNamestringНовое имя каталога, если не задано, то должен быть задан NewParentFolder, тогда файл перемещается со старым именемнет
newParentFolderFolderParams
folderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
pathstringПолный путь каталога, который хотим получить
Задается или FolderId, или Path
Пустой путь или / интерперетируется как корневой каталог
нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIdResult
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Целевой каталог

Название поляТип поляОписаниеОбязательноеВозможные значения
continueOnErrorsbooleanИгнорировать ошибки чтения файлов из хранилища.
Пропускаются каталоги и файлы к тоторым нет доступа на чтение.
нет
folderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
pathstringПолный путь каталога, который хотим получить
Задается или 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

Название поляТип поляОписаниеОбязательноеВозможные значения
ZipArchivestring (binary)Загружаемый Zip архив.нет
OverwritebooleanПерезаписывать файлы.
true - остается только последняя ревизия файла.
false - сохраняются все ревизии файлов.
нет
FileNameEncodingstringКодировка имен файлов в архиве.
Можно указать имя кодировки: UTF-8, или кодовую страницу: 1251, 866 и.т.д.
По умолчанию cp-866 для поддержки русских символов в архивах созданных в Windows.
нет
FolderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
PathstringПолный путь каталога, который хотим получить
Задается или FolderId, или Path
Пустой путь или / интерперетируется как корневой каталог
нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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

Целевой каталог

Название поляТип поляОписаниеОбязательноеВозможные значения
folderIdstring (uuid)ID каталога, который хотим получить
Задается или FolderId, или Path
нет
pathstringПолный путь каталога, который хотим получить
Задается или FolderId, или Path
Пустой путь или / интерперетируется как корневой каталог
нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

Код 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