Работа с файлами
/api/v2/File/Get
Скачать файл из хранилища
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
Возвращаемые результаты
Код 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 FileController Get(ASE.MD.Platform.Services.FilesService.Models.Params.FileVersionParams)
Тип схемы безопасности: 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/File/ByPath/{path}
Скачать файл из хранилища по указанному пути
Тип HTTP запроса: get
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| path | string | path | да |
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
/api/v2/File/NewMultipartUpload
Начать загрузку объекта на сервер по частям
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры загружаемого файла
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| fileName | string | Имя файла | да | |
| size | integer (int64) | размер файла | да | |
| folder | FolderParams | да | ||
| description | string | описание файла | нет | |
| contentType | string | тип содержимого файла | нет | |
| overwrite | boolean | True - не создавать новую версию, а перезаписывать текущую False - создать новую версию | нет | |
| metadata | string | пользовательская информация о файле | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | NewMultipartUploadResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FileController NewMultipartUpload(ASE.MD.Platform.Services.FilesService.Models.Params.FileParameters)
Тип схемы безопасности: 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/File/RemoveUpload
Отменить загрузку объекта на сервер по частям
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| uploadId | string | ID загрузки | query | да |
Отсылаемый запрос
Возвращаемые результаты
Код 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 FileController RemoveUpload(System.String)
Тип схемы безопасности: 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/File/PutObjectPart
Загрузка части объекта на сервер
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| uploadId | string | Идентификатор загрузки | query | да |
| partNumber | integer (int32) | Номер загружаемой части | query | да |
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода 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 FileController PutObjectPart(System.String, System.Int32)
Тип схемы безопасности: 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/File/CompleteMultipartUpload
Завершить загрузку объекта на сервер по частям
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры загрузки
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| objectId | string (uuid) | Идентификатор объекта (файла) Не об язательно. Для обратной совместимости | нет | |
| uploadId | string | нет | ||
| description | string | описание файла Не обязательно. Для обратной совместимости | нет | |
| parts | UploadPart[] | список загруженных частей | нет | |
| overwrite | boolean | признак перезаписи | нет |
Возвращаемые результаты
Код 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 FileController CompleteMultipartUpload(ASE.MD.Platform.Services.FilesService.Models.Params.CompleteMultipartUploadParams)
Тип схемы безопасности: 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/File/Put
Загрузить объект на сервер.
Примечание: для корректной работы секция с файлом должна быть последней. Секции данных после файла будут проигнорированы.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: multipart/form-data
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| path | string | нет | ||
| folderId | string | нет | ||
| description | string | нет | ||
| metadata | string | нет | ||
| overwrite | boolean | нет | ||
| file | string (binary) | да |
Возвращаемые результаты
Код 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 FileController Put()
Тип схемы безопасности: 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/File/GetInfo
Получить информацию о файле
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | FileInfoResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/filesservice public FileController GetInfo(ASE.MD.Platform.Services.FilesService.Models.Params.FileParams)
Тип схемы безопасности: 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/File/Remove
Удалить файл
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
Возвращаемые результаты
Код 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 FileController Remove(ASE.MD.Platform.Services.FilesService.Models.Params.FileVersionParams)
Тип схемы безопасности: 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/File/BatchRemove
Удалить список файлов
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| fileIds | string(uuid)[] | Id файлов, которые надо удалить Можно комбинировать с FilePaths | нет | |
| filePaths | string[] | Полные пути файлов, которые надо удалить Можно ком бинировать с FileIds | нет |
Возвращаемые результаты
Код 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 FileController BatchRemove(ASE.MD.Platform.Services.FilesService.Models.Params.BatchRemoveParams)
Тип схемы безопасности: 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/File/GetSignedUrl
Получить ссылку на скачивание объекта
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| expirationTime | integer (int32) | время истечения срока действия ссылки в секундах, не обязательный, по умолчанию 86400 секунд - 1 день, можно задать в конфигурации сервиса. | нет | |
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода 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 FileController GetSignedUrl(ASE.MD.Platform.Services.FilesService.Models.Params.GetFileUrlParams)
Тип схемы безопасности: 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/File/ByUrl
Скачать объект из хранилища MiniO по подписанной ссылке
Тип HTTP запроса: get
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| ObjectId | string (uuid) | Идентификатор объекта | query | нет |
| Algorithm | string | Алгоритм шифрования | query | нет |
| IssueDate | string | Дата создания ссылки | query | нет |
| Version | integer (int32) | Версия объекта (файла) | query | нет |
| Expires | integer (int32) | время истечения срока годности ссылки | query | нет |
| UserId | string (uuid) | Пользователь, создавший ссылку | query | нет |
| Signature | string | Идентифицирующая подпись | query | нет |
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
/api/v2/File/UpdateInfo
Обновить метаданные файла
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| description | string | Человеко-читаемое описание файла, комментарий при загрузке версии | нет | |
| metadata | string | дополнительные метаданные в JSON на будущее, чтоб потом не менять схему | нет | |
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
Возвращаемые результаты
Код 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 FileController UpdateInfo(ASE.MD.Platform.Services.FilesService.Models.Params.FileUpdateParams)
Тип схемы безопасности: 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/File/SetSharedAccess
Установить параметры общего доступа файла
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| sharedReadAccess | boolean | Файл доступен на чтение без авторизации | нет | |
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
Возвращаемые результаты
Код 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 FileController SetSharedAccess(ASE.MD.Platform.Services.FilesService.Models.Params.FileSharedAccessParams)
Тип схемы безопасности: 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/File/Move
Переместить файл
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры файла
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| newName | string | Новое имя файла, если не задано, то должен быть задан NewParentFolder, тогда файл перемещается со старым именем | нет | |
| newParentFolder | FolderParams | |||
| overwrite | boolean | True - не создавать новую версию, а перезаписывать текущую False - создать новую версию | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
Возвращаемые результаты
Код 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 FileController Move(ASE.MD.Platform.Services.FilesService.Models.Params.FileMoveParams)
Тип схемы безопасности: 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/File/Copy
Копировать файл
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры файла
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| newName | string | Новое имя файла, если не задано, то должен быть задан NewParentFolder, тогда файл перемещается со старым именем | нет | |
| newParentFolder | FolderParams | |||
| overwrite | boolean | True - не создавать новую версию, а перезаписывать текущую False - создать новую версию | нет | |
| version | integer (int32) | Версия файла. Если Null - возвращается последняя версия | нет | |
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
Возвращаемые результаты
Код 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 FileController Copy(ASE.MD.Platform.Services.FilesService.Models.Params.FileCopyParams)
Тип схемы безопасности: 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/File/Exists
Проверить существует ли файл с заданным путем или Id
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Целевой файл
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| fileId | string (uuid) | ID файла, который хотим получить Задается или FileId, или FilePath | нет | |
| filePath | string | полный путь файла, который хотим получить Задается или FileId, или FilePath | нет |
Возвращаемые результаты
Код 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 FileController Exists(ASE.MD.Platform.Services.FilesService.Models.Params.FileParams)
Тип схемы безопасности: 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 |