Типы данных
ASE.MD.Platform.Base.Models.Errors.IErrorDescription
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| code | string | Код ошибки. | нет | |
| message | string | Пользовательское сообщение об ошибке. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| isError | boolean | Признак наличия ошибки. | нет | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| data | object | Дополнительные данные. | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.BatchRemoveParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| fileIds | string(uuid)[] | Id файлов, которые надо удалить Можно комбинировать с FilePaths | нет | |
| filePaths | string[] | Полные пути файлов, которые надо удалить Можно комбинировать с FileIds | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.ChildFolderInfoParam
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Навзание папки | да | |
| objectIds | string(uuid)[] | Список идентификаторов файлов | да | |
| versionIds | string[] | Список версий файлов. Соответствие по индексу с ObjectIds. Если отсутствует, то берется последняя версия файла | нет | |
| children | ChildFolderInfoParam[] | Дочерняя структура папок | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.CompleteMultipartUploadParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| objectId | string (uuid) | Идентификатор объекта (файла) Не обязательно. Для обратной совместимости | нет | |
| uploadId | string | нет | ||
| description | string | описание файла Не обязательно. Для обратной совместимости | нет | |
| parts | UploadPart[] | список загруженных частей | нет | |
| overwrite | boolean | признак перезаписи | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.CreateStorageLocationParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя | нет | |
| description | string | Описание | нет | |
| mountingPoint | string | путь в логической файловой системе | нет | |
| path | string | Название хранилища(бакета) в S3 | нет | |
| type | string | Сейчас всегда S3 | нет | |
| connectionParamsLink | string | Параметры подключения к хранил ищу S3. В виде ссылки на переменные окружения. Нужны для поддержки нескольких S3 хранилищ. | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FileCopyParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| newName | string | Новое имя файла, если не задано, то должен быть задан NewParentFolder, тогда файл перемещается со старым именем | нет | |
| newParentFolder | FolderParams | |||
| overwrite | boolean | True - не создавать новую версию, а перезаписывать текущую False - создать новую версию | нет | |
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FileMoveParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| newName | string | Новое имя файла, если не задано, то должен быть задан NewParentFolder, тогда файл перемещается со старым именем | нет | |
| newParentFolder | FolderParams | |||
| overwrite | boolean | True - не создавать новую версию, а перезаписывать текущую False - создать новую версию | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FileParameters
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| fileName | string | Имя файла | да | |
| size | integer (int64) | размер файла | да | |
| folder | FolderParams | да | ||
| description | string | описание файла | нет | |
| contentType | string | тип содержимого файла | нет | |
| overwrite | boolean | True - не создавать новую версию, а перезаписывать текущую False - создать новую версию | нет | |
| metadata | string | пользовательская информация о файле | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FileParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FileSharedAccessParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| sharedReadAccess | boolean | Файл доступен на чтение без авторизации | нет | |
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FileUpdateParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| description | string | Человеко-читаемое описание файла, комментарий при загрузке версии | нет | |
| metadata | string | дополнительные метаданные в JSON на будущее, чтоб потом не менять схему | нет | |
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FileVersionParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FolderCreateParams
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| parent | FolderParams | |||
| name | string | Имя создаваемого каталога | да | |
| description | string | нет | ||
| skipIfExists | boolean | Не выдавать ошибку если каталог уже существует | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FolderDownloadArgs
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| continueOnErrors | boolean | Игнорировать ошибки чтения файлов из хранилища. Пропускаются каталоги и файлы к тоторым нет доступа на чтение. | нет | |
| folderId | string (uuid) | ID каталога, который хотим получить Задается или FolderId, или Path | нет | |
| path | string | Полный путь каталога, который хотим получить Задается или FolderId, или Path Пустой путь или / интерперетируется как корневой каталог | нет |
ASE.MD.Platform.Services.FilesService.Models.Params.FolderInfoParam
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| archName | string | Название архива | да | |
| name | string | Навзание папки | да | |
| objectIds | string(uuid)[] | Список идентификаторов файлов | да | |
| versionIds | string[] | Список версий файлов. Соответствие по индексу с ObjectIds. Если отсутствует, то берется последняя версия файла | нет | |
| children | ChildFolderInfoParam[] | Дочерняя структура папок | нет |