63 lines
3.4 KiB
C#
63 lines
3.4 KiB
C#
using Persistence.Models;
|
||
using Refit;
|
||
|
||
namespace Persistence.Client.Clients;
|
||
|
||
/// <summary>
|
||
/// Клиент для работы с репозиторием для хранения разных наборов данных рядов.
|
||
/// idDiscriminator - идентифицирует конкретный набор данных, прим.: циклы измерения АСИБР, или отчет о DrillTest.
|
||
/// idDiscriminator формируют клиенты и только им известно что они обозначают.
|
||
/// Так как данные приходят редко, то их прореживания для построения графиков не предусмотрено.
|
||
/// </summary>
|
||
public interface ITimestampedSetClient
|
||
{
|
||
private const string baseUrl = "/api/TimestampedSet/{idDiscriminator}";
|
||
|
||
/// <summary>
|
||
/// Добавление новых данных
|
||
/// </summary>
|
||
/// <param name="idDiscriminator">Дискриминатор (идентификатор) набора</param>
|
||
/// <param name="sets"></param>
|
||
/// <returns></returns>
|
||
[Post(baseUrl)]
|
||
Task<IApiResponse<int>> InsertRange(Guid idDiscriminator, IEnumerable<TimestampedSetDto> sets);
|
||
|
||
/// <summary>
|
||
/// Получение данных с фильтрацией. Значение фильтра null - отключен
|
||
/// </summary>
|
||
/// <param name="idDiscriminator">Дискриминатор (идентификатор) набора</param>
|
||
/// <param name="geTimestamp">Фильтр позднее даты</param>
|
||
/// <param name="columnNames">Фильтр свойств набора. Можно запросить только некоторые свойства из набора</param>
|
||
/// <param name="skip"></param>
|
||
/// <param name="take"></param>
|
||
/// <returns></returns>
|
||
[Get(baseUrl)]
|
||
Task<IApiResponse<IEnumerable<TimestampedSetDto>>> Get(Guid idDiscriminator, [Query] DateTimeOffset? geTimestamp, [Query] IEnumerable<string>? columnNames, int skip, int take);
|
||
|
||
/// <summary>
|
||
/// Получить последние данные
|
||
/// </summary>
|
||
/// <param name="idDiscriminator">Дискриминатор (идентификатор) набора</param>
|
||
/// <param name="columnNames">Фильтр свойств набора. Можно запросить только некоторые свойства из набора</param>
|
||
/// <param name="take"></param>
|
||
/// <returns></returns>
|
||
[Get($"{baseUrl}/last")]
|
||
Task<IApiResponse<IEnumerable<TimestampedSetDto>>> GetLast(Guid idDiscriminator, [Query] IEnumerable<string>? columnNames, int take);
|
||
|
||
/// <summary>
|
||
/// Количество записей по указанному набору в БД. Для пагинации.
|
||
/// </summary>
|
||
/// <param name="idDiscriminator">Дискриминатор (идентификатор) набора</param>
|
||
/// <returns></returns>
|
||
[Get($"{baseUrl}/count")]
|
||
Task<IApiResponse<int>> Count(Guid idDiscriminator);
|
||
|
||
/// <summary>
|
||
/// Диапазон дат за которые есть данные
|
||
/// </summary>
|
||
/// <param name="idDiscriminator">Дискриминатор (идентификатор) набора</param>
|
||
/// <returns></returns>
|
||
[Get($"{baseUrl}/datesRange")]
|
||
Task<IApiResponse<DatesRangeDto?>> GetDatesRange(Guid idDiscriminator);
|
||
}
|