Swagger UI

timelight
 1.0 
OAS3

This is the timelight api.

Import

POST​/v1​/import​/create-source
First source creation
POST​/v1​/import​/{sourceId}​/days
Add new data to a source
POST​/v1​/import​/days
Add new data to a source
POST​/v1​/import​/reprocess-days​/{sourceId}​/{year}
Reprocess days from database

Alert

PATCH​/v1​/alert​/{alertId}​/comment
Add a comment to an alert
PATCH​/v1​/alert​/{alertId}​/favorite
Set alert favorite for the current user
GET​/v1​/alert​/list
List alerts data of the selected year, all alerts if no year is provided
GET​/v1​/alert​/ref​/list
List alerts data of the selected year, all alerts if no year is provided

View Helper

GET​/v1​/view-helper​/alerts
Get the alert view data
GET​/v1​/view-helper​/alerts-ref
Get the alert referential view data

AI

POST​/v1​/ai​/recompute-models​/{sourceId}​/{year}
Triggers a model recompute
POST​/v1​/ai​/recompute-day-models​/{sourceId}​/{year}
Recomputes all day models
POST​/v1​/ai​/recompute-source-models​/{modelCount}
Triggers a model recompute for source groups
POST​/v1​/ai​/recompute-days-projection​/{sourceId}​/{year}
Computes all days projection for a source and save them

Prevision

POST​/v1​/prevision​/save
Save many previsions at once
POST​/v1​/prevision​/save-default-previsions​/{sourceId}​/{year}
Generate default previsions for the source and save them
PATCH​/v1​/prevision​/update
Update a specific prevision
POST​/v1​/prevision​/group-apply-prevision
Apply a source prevision to the whole group
GET​/v1​/prevision​/list​/{sourceId}​/{year}
Fetch data previsions for a given year

Day

PATCH​/v1​/day​/bulk
Update day entities
GET​/v1​/day​/list​/{sourceId}​/{year}
List day data of the reference year

Model

PATCH​/v1​/model​/bulk
Model bulk update
GET​/v1​/model​/list​/{sourceId}
List models data of this source
GET​/v1​/model​/list
List models data of this source
POST​/v1​/model​/bulk-replace​/{sourceId}
Custom Model create
POST​/v1​/model​/reset​/{sourceId}​/{modelCount}
Reset to default timelight models configuration

Source

GET​/v1​/source
Retrieve many SourceDto
GET​/v1​/source​/stats
Get source stats
GET​/v1​/source​/date-domain
Get all sources date domains
GET​/v1​/source​/{id}
Retrieve one SourceDto
GET​/v1​/source​/{sourceId}​/years-with-data
Find which for years this source have data
PATCH​/v1​/source​/{sourceId}​/group
Update a source group
PATCH​/v1​/source​/{sourceId}
Update a source
DELETE​/v1​/source​/{sourceId}
Delete a source and all linked data
GET​/v1​/source-public
Retrieve many SourceDto
GET​/v1​/source-public​/{id}
Retrieve one SourceDto
GET​/v1​/source-import-history​/{id}
Retrieve one SourceImportHistory
GET​/v1​/source-import-history
Retrieve many SourceImportHistory

Source Group

GET​/v1​/source-group​/list
All source groups
POST​/v1​/source-group​/create
Create a new source groups
PATCH​/v1​/source-group​/{groupId}
Updates a group configuration

Day Context

GET​/v1​/day-context
Fetch day contexts
POST​/v1​/day-context​/load-meteo​/{sourceId}
Loads meteo data from our own internal meteo source
POST​/v1​/day-context​/import-meteo-csv​/{sourceId}
Imports a meteo csv file for the source id
GET​/v1​/day-context-corr
Fetch day contexts
GET​/v1​/day-context-corr​/summary-year​/{sourceId}​/{year}
Computes the day context summary for a year for all days

Day Trend

POST​/v1​/day-trend​/replace-all-in-source​/{sourceId}
Imports many trends and replace existing. Recomputes alerts
GET​/v1​/day-trend​/{id}
Retrieve one DayTrend
PATCH​/v1​/day-trend​/{id}
Update one DayTrend
PUT​/v1​/day-trend​/{id}
Replace one DayTrend
DELETE​/v1​/day-trend​/{id}
Delete one DayTrend
GET​/v1​/day-trend
Retrieve many DayTrend
POST​/v1​/day-trend
Create one DayTrend
POST​/v1​/day-trend​/bulk
Create many DayTrend

ImportCsv

POST​/v1​/import-csv​/create-source
First source creation using an ordered csv file
POST​/v1​/import-csv​/{sourceId}​/days
Add new data to a source
POST​/v1​/import-csv​/validate-csv
Validate a CSV input, fetch all errors
POST​/v1​/import-csv-multi​/create-sources
First source creation using an ordered csv file
POST​/v1​/import-csv-multi​/validate-csv
Validate a CSV input, fetch all errors

Source Tags

GET​/v1​/source-user-tags
Fetch available source tags

Serie

GET​/v1​/serie
Fetch series
GET​/v1​/serie-data​/compact​/{serieId}
Fetch serie data in a compact format
GET​/v1​/serie-data​/expanded​/{serieId}
Fetch serie data in a human readable format
POST​/v1​/serie-import-csv​/{serieId}
Add new data to a serie or override existing data
POST​/v1​/serie-import-csv​/{serieId}​/validate-csv
Validate a CSV input, fetch all errors

Forecast

GET​/v1​/forecast-alert​/{id}
Retrieve one ForecastAlert
GET​/v1​/forecast-alert
Retrieve many ForecastAlert
POST​/v1​/forecast-task
Create a new forecast task
GET​/v1​/forecast-task
Retrieve many ForecastTask
POST​/v1​/forecast-task​/{forecastTaskId}
Update a forecast task params and re-run forecast, wipes out previous data
GET​/v1​/forecast-task​/{id}
Retrieve one ForecastTask

Serie Synchronisation

POST​/v1​/sync-task
Create a new synchronisation task
GET​/v1​/sync-task
Retrieve many SerieSyncTask
POST​/v1​/sync-task​/{syncTaskId}
Update a serie sync params and re-run sync, wipes out previous data
DELETE​/v1​/sync-task​/{syncTaskId}
Delete a serie synchronisation task
GET​/v1​/sync-task​/{id}
Retrieve one SerieSyncTask

Source Cluster

POST​/v1​/source-cluster-task
Create a new synchronisation task
GET​/v1​/source-cluster-task
Retrieve many SourceClusterTask
POST​/v1​/source-cluster-task​/{sourceClusterTaskId}
Update a source cluster params and re-run task, wipes out previous data
DELETE​/v1​/source-cluster-task​/{sourceClusterTaskId}
Delete a source custering task
GET​/v1​/source-cluster-task​/{id}
Retrieve one SourceClusterTask
GET​/v1​/source-cluster-model​/{id}
Retrieve one SourceClusterModel
GET​/v1​/source-cluster-model
Retrieve many SourceClusterModel

Context Impact

POST​/v1​/context-impact-task
Create a new context impact task
GET​/v1​/context-impact-task
Retrieve many ContextImpactTask
POST​/v1​/context-impact-task​/{contextImpactTaskId}
Update a context impact params and re-run task, wipes out previous data
GET​/v1​/context-impact-task​/{id}
Retrieve one ContextImpactTask

Schemas

UserDto
LoginDto
LoginResponseDto
RegisterDto
CreateSourceDayDto
CreateSourceDto
GetManySourceDtoResponseDto
SourceTag
SourceDto
DayModelDto
CreateSourceResultDto
ImportDayDto
ImportDaysDto
AlertActivityEnum
AlertDto
ImportDaysResultDto
AlertCommentDto
AlertRefDto
AlertFavoriteDto
AlertListDto
AlertRefListDto
AlertRefResultDto
ModelDto
PrevisionDto
DaysNearDateResultDto
RecomputeModelsResponseDto
RecomputeDayModelsResponseDto
SourceGroupDto
RecomputeSourceModelsResponseDto
RecomputeDaysProjectionResponseDto
AnomaliesResponseDto
PrevisionSaveDto
PrevisionBulkSaveDto
PrevisionBulkSaveResultDto
PrevisionPatchDto
PrevisionUpdateResultDto
PrevisionApplyGroupDto
PrevisionApplyGroupResponseDto
PrevisionListDto
DayPatchDto
DaysPatchDto
DayListDto
ModelPatchDto
ModelsPatchDto
ModelListDto
ModelPostDto
ModelsPostDto
SourceStatsDto
SourceStatsListDto
SourceDateDomainDto
SourceDateDomainListDto
SourceYearWithDataListDto
SourcePatchGroupDto
SourcePatchDto
SourceGroupListDto
SourceGroupCreateDto
SourceGroupPatchDto
DayContextTypes
DayContext
GetManyDayContextResult
ContextTypeStatsDto
ContextTypeStatsListDto
ContextTypeDateDomainDto
ContextTypeDateDomainListDto
DayContextListDto
DayContextCorr
GetManyDayContextCorrResult
DayContextSummary
DayContextSummaryListDto
DayContextDaySummary
DayContextSummaryYearDto
DayTrendInput
DayTrendInputListDto
GetManyDayTrendResponseDto
DayTrendUnitEnum
DayTrendTypeEnum
DayTrend
DayTrendListDto
CreateManyDayTrendDto
GetManySourceImportHistoryResponseDto
SourceImportHistory
GetManySourceTagsResult
GetManySerieResponseDto
SerieBlockTimeStep
SerieBlockTimeSpan
Serie
GetManySerieResult
SerieInterpolationEnum
SerieAggregationEnum
FetchSerieDataCompactResult
FetchSerieDataExpandedResult
SerieImportResult
GetManyForecastAlertResponseDto
ForecastAlert
ForecastType
ForecastTaskInputParams
GetManyForecastTaskResponseDto
TaskStatus
ForecastTask
SerieSyncTaskInputParams
GetManySerieSyncTaskResponseDto
SerieSyncTask
SourceClusterDistance
SourceClusterTaskInputParams
GetManySourceClusterTaskResponseDto
SourceClusterTask
GetManySourceClusterModelResponseDto
SourceClusterModel
ContextTypeImpactSummary
ContextSourceImpactSummary
ContextImpactSummaryDto
ContextImpactTaskInputParams
GetManyContextImpactTaskResponseDto
ContextImpactTask