API для работы с объектами

/api/Object/PutObject

Загрузить объект на сервер

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

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
bucketName	string	Имя бакета	query	да
description	string		query	нет

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

MIME-тип HTTP запроса: multipart/form-data

Название поля	Тип поля	Описание	Обязательное	Возможные значения
file	string (binary)		да

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

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

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	string (uuid)	Данные результата метода 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 ObjectController PutObject(Microsoft.AspNetCore.Http.IFormFile, System.String, 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/Object/PutObjectUnbuffered

Загрузить объект на сервер (новая реализация)

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

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
bucketName	string	Имя бакета	query	да
fileSize	string	Размер файла	query	да
description	string		query	нет

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

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

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

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	string (uuid)	Данные результата метода 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 ObjectController PutObjectUnbuffered(System.String, System.String, 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/Object/NewMultipartUpload

Начать загрузку объекта на сервер по частям

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

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
fileName	string	Имя загружаемого файла	query	да
size	integer (int64)	Размер загружаемого файла	query	да
bucketName	string	Имя бакета	query	да

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

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

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

MIME-тип HTTP ответа: application/json

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 ObjectController NewMultipartUpload(System.String, System.Int64, 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/Object/RemoveUpload

Отменить загрузку объекта на сервер по частям

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

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
objectId	string (uuid)	ID загружаемого файла	query	да
uploadId	string	ID загрузки	query	да

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

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

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

MIME-тип HTTP ответа: application/json

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 ObjectController RemoveUpload(System.Guid, 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/Object/PutObjectPart

Загрузка части объекта на сервер

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

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
uploadId	string	Идентификатор загрузки	query	да
objectId	string (uuid)	Идентификатор бакета	query	да
partNumber	integer (int32)	Номер загружаемой части	query	да
size	integer (int64)	Размер загружаемого файла	query	нет

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

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

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

MIME-тип HTTP ответа: application/json

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 ObjectController PutObjectPart(System.String, System.Guid, System.Int32, System.Int64)

Тип схемы безопасности: 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/Object/CompleteMultipartUpload

Завершить загрузку объекта на сервер по частям

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

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

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

Параметры загрузки

Название поля	Тип поля	Описание	Обязательное	Возможные значения
objectId	string (uuid)	Идентификатор объекта (файла) Не обязательно. Для обратной совместимости	нет
uploadId	string		нет
description	string	описание файла Не обязательно. Для обратной совместимости	нет
parts	UploadPart[]	список загруженных частей	нет
overwrite	boolean	признак перезаписи	нет

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

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

MIME-тип HTTP ответа: application/json

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 ObjectController 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/Object/ListObjects

Получить все объекты

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

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
bucketId	string (uuid)		query	нет
start	integer (int32)		query	нет
count	integer (int32)		query	нет

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

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

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

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
currentPage	integer (int32)		нет
pageCount	integer (int32)		нет
pageSize	integer (int32)		нет
rowCount	integer (int32)		нет
result	ObjectInfoResult[]	Данные результата метода 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 ObjectController ListObjects(System.Nullable1[[System.Guid, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Nullable1[[System.Int32, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]])

Тип схемы безопасности: 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/Object/GetObjectInfoById

Получить информацию об объекте

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

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
objectId	string (uuid)	Идентификатор объекта	query	да

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

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

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

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	ObjectInfoResult
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

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

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

Unauthorized

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

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

Forbidden

Схемы авторизации

/components/securitySchemes/filesservice public ObjectController GetObjectInfoById(System.Guid)

Тип схемы безопасности: 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/Object/RemoveObject

Удалить объект

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

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

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

Информация об объекте (имя объекта и название бакета)

Название поля	Тип поля	Описание	Обязательное	Возможные значения
objectName	string	Название объекта	да
bucketName	string	Название бакета	да
versionId	string	Версия объекта, который надо удалить. Если Null - удалить все версии	нет

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

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

MIME-тип HTTP ответа: application/json

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 ObjectController RemoveObject(ASE.MD.Platform.Services.FilesService.Models.Params.ObjectDeleteParam)

Тип схемы безопасности: 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/Object/RemoveObjectList

Удалить список файлов

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

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

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

Список объектов (Идентификатор объекта и идентификатор бакета)

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

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

MIME-тип HTTP ответа: application/json

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 ObjectController RemoveObjectList(System.Collections.Generic.List`1[[ASE.MD.Platform.Services.FilesService.Models.Params.ObjectListDeleteParams, FilesService, Version=5.0.0.0, Culture=neutral, PublicKeyToken=null]])

Тип схемы безопасности: 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/Object/GetObjectSignedUrl

Получить ссылку на скачивание объекта

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

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

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

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

Название поля	Тип поля	Описание	Обязательное	Возможные значения
objectId	string (uuid)	id объекта (файла), обязательное	нет
expirationTime	integer (int32)	время истечения срока действия ссылки в секундах, не обязательный, по умолчанию 86400 секунд - 1 день, можно задать в конфигурации сервиса.	нет
versionId	string	versionId - версия файла (не обязательно), если не указано - используется последняя версия файла	нет

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

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

MIME-тип HTTP ответа: application/json

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 ObjectController GetObjectSignedUrl(ASE.MD.Platform.Services.FilesService.Models.Params.GetObjectUrlParams)

Тип схемы безопасности: 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/Object/ListObjectVersions

Получить список версий объекта

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

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
objectId	string (uuid)	Идентификатор объекта	query	нет

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

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

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

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	FileVersionModel[]	Данные результата метода 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 ObjectController ListObjectVersions(System.Guid)

Тип схемы безопасности: 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