{"openapi":"3.0.1","info":{"title":"Quinyx API for Forecast","description":"Forecast Service Operations","contact":{"name":"Quinyx","url":"https://www.quinyx.com/"},"license":{"name":"","url":""},"version":"v1.0"},"externalDocs":{"description":"Forecast Service Operations"},"servers":[{"url":"https://api.quinyx.com/v2/forecasts","description":""}],"paths":{"/static-rules":{"get":{"tags":["static-rule-controller"],"summary":"Lists static rules.","operationId":"getStaticRulesByGroup","parameters":[{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"maximum":5000,"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"size","in":"query","required":false,"schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32","default":20}}],"responses":{"403":{"description":"Forbidden to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResultListExternalStaticRule"}}}},"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResultListExternalStaticRule"}}}}}},"put":{"tags":["static-rule-controller"],"summary":"Updates a static rule.","operationId":"updateStaticRule","parameters":[{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalStaticRule"}}},"required":true},"responses":{"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalStaticRule"}}}},"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalStaticRule"}}}}}},"post":{"tags":["static-rule-controller"],"summary":"Create new static rule.","operationId":"createStaticRule","parameters":[{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalStaticRule"}}},"required":true},"responses":{"201":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalStaticRule"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalStaticRule"}}}}}}},"/dynamic-rules":{"get":{"tags":["dynamic-rule-controller"],"summary":"Lists dynamic rules.","operationId":"getDynamicRulesByGroup","parameters":[{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"403":{"description":"Forbidden to perform this action","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalDynamicRule"}}}}},"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalDynamicRule"}}}}}}},"put":{"tags":["dynamic-rule-controller"],"summary":"Updates a dynamic rule.","operationId":"updateDynamicRule","parameters":[{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDynamicRule"}}},"required":true},"responses":{"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}},"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}}}},"post":{"tags":["dynamic-rule-controller"],"summary":"Create new dynamic rule.","operationId":"createDynamicRule","parameters":[{"name":"externalUnitId","in":"query","description":"External Group Id","required":true,"schema":{"type":"string"},"example":"unitId"},{"name":"externalSectionId","in":"query","description":"External Section Id","required":false,"schema":{"type":"string"},"example":"sectionId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDynamicRule"}}},"required":true},"responses":{"201":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalDynamicRule"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/raw-data":{"post":{"tags":["data-ingestion-controller"],"summary":"Operation used to upload actual data. The total amount of data rows must not exceed 366","description":"Deprecated. Use /actual-data instead.","operationId":"postRawData","parameters":[{"name":"appendData","in":"query","required":false,"schema":{"type":"boolean","default":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProviderInputList"}}},"required":true},"responses":{"200":{"description":"Data successfully uploaded","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}},"deprecated":true}},"/predicted-data":{"post":{"tags":["data-ingestion-controller"],"summary":"Operation used to upload generated prediction data. Resolution of datapoints must match expected resolution of variable. The total amount of data rows must not exceed 366","operationId":"postPredictedData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastPredictionIntegrationList"}}},"required":true},"responses":{"200":{"description":"Data successfully uploaded","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Unexpected input.","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/forecast-variables/{externalForecastVariableId}/forecast-configurations/{externalForecastConfigurationId}/edit-forecast":{"post":{"tags":["data-ingestion-controller"],"summary":"Operation used to edit forecast configurations and update related forecast data.","operationId":"editCalculatedForecast","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalForecastConfigurationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForecastDataModifier"}}},"required":true},"responses":{"200":{"description":"Forecast successfully updated","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Unexpected input.","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/forecast-data":{"post":{"tags":["data-ingestion-controller"],"summary":"Operation used to upload forecast data. The total amount of data rows must not exceed 366","description":"Deprecated. Use /budget-data instead.","operationId":"postForecastData","parameters":[{"name":"appendData","in":"query","required":false,"schema":{"type":"boolean","default":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProviderInputList"}}},"required":true},"responses":{"200":{"description":"Data successfully uploaded","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}},"deprecated":true}},"/budget-data":{"post":{"tags":["data-ingestion-controller"],"summary":"Operation used to upload budget data. The total amount of data rows must not exceed 366","operationId":"postBudgetData","parameters":[{"name":"appendData","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProviderInputList"}}},"required":true},"responses":{"200":{"description":"Data successfully uploaded","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/aggregated-data":{"post":{"tags":["data-ingestion-controller"],"summary":"Operation used to upload data already grouped at input data resolution . The total amount of data rows must not exceed 366.","operationId":"postAggregatedData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProviderInputList"}}},"required":true},"responses":{"200":{"description":"Data successfully uploaded","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/actual-data":{"post":{"tags":["data-ingestion-controller"],"summary":"Operation used to upload actual data. The total amount of data rows must not exceed 366","operationId":"postActualData","parameters":[{"name":"appendData","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProviderInputList"}}},"required":true},"responses":{"200":{"description":"Data successfully uploaded","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/forecast-variables/{externalForecastVariableId}/raw-data":{"get":{"tags":["data-ingestion-controller"],"summary":"Getting the actual data previously uploaded for the given forecast variable.The range between these two dates can not exceed 120 days.","description":"Deprecated. Use ../actual-data instead.","operationId":"getRawData","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}},"403":{"description":"Forbidden to perform this action","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}}},"deprecated":true},"delete":{"tags":["data-ingestion-controller"],"summary":"Deleting the actual data previously uploaded for the given forecast variable.This operation will also delete the corresponding calculated forecast data. The startTime and endTime must be at the start of hour and the range between these two dates can not exceed 120 days.","description":"Deprecated. Use ../actual-data instead.","operationId":"deleteRawData","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"202":{"description":"The delete request was received successfully and the operation will be performed asynchronously","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}},"deprecated":true}},"/forecast-variables/{externalForecastVariableId}/raw-data-stream":{"get":{"tags":["data-ingestion-controller"],"summary":"Stream the actual data previously uploaded for the given forecast variable.The range between these two dates can not exceed 120 days.","description":"Deprecated. Use ../actual-data instead.","operationId":"getRawDataStream","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"403":{"description":"Forbidden to perform this action","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}}},"deprecated":true}},"/forecast-variables/{externalForecastVariableId}/forecast-data":{"get":{"tags":["data-ingestion-controller"],"summary":"Getting the uploaded forecast data for the given forecast variable. The range between these two dates can not exceed 120 days.","description":"Deprecated. Use /budget-data instead.","operationId":"getUploadedForecastData","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}},"403":{"description":"Forbidden to perform this action","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}}},"deprecated":true},"delete":{"tags":["data-ingestion-controller"],"summary":"Deleting the previously uploaded forecast data for the the given forecast variable. The startTime and endTime must be at the start of hour and the range between these two dates can not exceed 120 days.","description":"Deprecated. Use /forecast-variables/{externalForecastVariableId}/budget-data instead.","operationId":"deleteForecastData","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"202":{"description":"The delete request was received successfully and the operation will be performed asynchronously","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}},"deprecated":true}},"/forecast-variables/{externalForecastVariableId}/calculated-forecast":{"get":{"tags":["data-ingestion-controller"],"summary":"Getting the calculated forecast for the given forecast variable. The range between these two dates can not exceed 120 days.","operationId":"getCalculatedForecastForVariable","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalculatedForecast"}}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CalculatedForecast"}}}}}}}},"/forecast-variables/{externalForecastVariableId}/budget-data":{"get":{"tags":["data-ingestion-controller"],"summary":"Getting the uploaded budget data for the given forecast variable. The range between these two dates can not exceed 120 days.","operationId":"getUploadedBudgetData","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}},"403":{"description":"Forbidden to perform this action","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}}}},"delete":{"tags":["data-ingestion-controller"],"summary":"Deleting the previously uploaded budget data for the the given forecast variable. The startTime and endTime must be at the start of hour and the range between these two dates can not exceed 120 days.","operationId":"deleteBudgetData","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"202":{"description":"The delete request was received successfully and the operation will be performed asynchronously","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/forecast-variables/{externalForecastVariableId}/aggregated-data":{"get":{"tags":["data-ingestion-controller"],"summary":"Getting the aggregated data for the given forecast variable. The range between these two dates can not exceed 120 days.","operationId":"getAggregatedData","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AggregatedData"}}}}},"403":{"description":"Forbidden to perform this action","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AggregatedData"}}}}}}}},"/forecast-variables/{externalForecastVariableId}/actual-data":{"get":{"tags":["data-ingestion-controller"],"summary":"Getting the actual data previously uploaded for the given forecast variable.The range between these two dates can not exceed 120 days.","operationId":"getActualData","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}},"403":{"description":"Forbidden to perform this action","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}}}},"delete":{"tags":["data-ingestion-controller"],"summary":"Deleting the actual data previously uploaded for the given forecast variable.This operation will also delete the corresponding calculated forecast data. The startTime and endTime must be at the start of hour and the range between these two dates can not exceed 120 days.","operationId":"deleteActualData","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"202":{"description":"The delete request was received successfully and the operation will be performed asynchronously","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/forecast-variables/{externalForecastVariableId}/actual-data-stream":{"get":{"tags":["data-ingestion-controller"],"summary":"Stream the actual data previously uploaded for the given forecast variable.The range between these two dates can not exceed 120 days.","operationId":"getActualDataStream","parameters":[{"name":"externalForecastVariableId","in":"path","required":true,"schema":{"type":"string"}},{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"403":{"description":"Forbidden to perform this action","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataIngestionOutput"}}}}}}}},"/calculated-variables/{extCalculatedVarId}":{"get":{"tags":["data-ingestion-controller"],"summary":"Getting the date for calculated variable identified by externalId. The range between these two dates can not exceed 120 days.","operationId":"getCalculatedVariableData","parameters":[{"name":"extCalculatedVarId","in":"path","description":"Calculated Variable External Id","required":true,"schema":{"type":"string"},"example":"extId"},{"name":"externalUnitId","in":"query","description":"External Group Id","required":true,"schema":{"type":"string"},"example":"unitId"},{"name":"startTime","in":"query","description":"Start of the period in ISO format","required":true,"schema":{"type":"string","format":"date-time"},"example":"2020-01-26T00:00:00Z"},{"name":"endTime","in":"query","description":"End of the period ISO format","required":true,"schema":{"type":"string","format":"date-time"},"example":"2020-01-27T00:00:00Z"}],"responses":{"200":{"description":"Calculated variable data for given period","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CalculatedVariableOutput"}}}},"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CalculatedVariableOutput"}}}},"404":{"description":"Calculated variable was not found for given externalId and externalUnitId","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CalculatedVariableOutput"}}}}}}},"/static-rules/{externalStaticRuleId}":{"delete":{"tags":["static-rule-controller"],"summary":"Deletes a static rule.","operationId":"deleteStaticRule","parameters":[{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"externalStaticRuleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}},"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/dynamic-rules/{externalDynamicRuleId}":{"delete":{"tags":["dynamic-rule-controller"],"summary":"Deletes a dynamic rule.","operationId":"deleteDynamicRule","parameters":[{"name":"externalUnitId","in":"query","required":true,"schema":{"type":"string"}},{"name":"externalSectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"externalDynamicRuleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"403":{"description":"Forbidden to perform this action","content":{"*/*":{"schema":{"type":"string"}}}},"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"ExternalShiftType":{"required":["amount","externalShiftTypeId"],"type":"object","properties":{"externalShiftTypeId":{"type":"string","example":"EXTERNAL_SHIFT_ID"},"amount":{"maximum":100000,"type":"integer","format":"int32","example":10}}},"ExternalStaticRule":{"required":["endTime","repeatPeriod","shiftType","startDate","startTime","weekdays"],"type":"object","properties":{"weekdays":{"maxItems":7,"minItems":1,"type":"array","items":{"type":"string","enum":["0","1","2","3","4","5","6"]}},"repeatPeriod":{"maximum":100,"type":"integer","format":"int32"},"shiftType":{"$ref":"#/components/schemas/ExternalShiftType"},"startTime":{"$ref":"#/components/schemas/LocalTime"},"endTime":{"$ref":"#/components/schemas/LocalTime"},"startDate":{"type":"string","format":"date","example":"2022-01-13"},"endDate":{"type":"string","format":"date","example":"2022-02-20"},"comment":{"type":"string"}}},"LocalTime":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"second":{"type":"integer","format":"int32"},"nano":{"type":"integer","format":"int32"}},"example":"13:00"},"ExternalDynamicRule":{"required":["amount","endTime","forecastExternalVariableId","shiftTypes","startTime","weekdays"],"type":"object","properties":{"forecastExternalVariableId":{"type":"string","example":"EXTERNAL_VAR"},"amount":{"maximum":99999999999,"type":"integer","format":"int64","example":100},"weekdays":{"maxItems":7,"minItems":1,"type":"array","items":{"type":"string","enum":["0","1","2","3","4","5","6"]}},"startTime":{"$ref":"#/components/schemas/LocalTime"},"endTime":{"$ref":"#/components/schemas/LocalTime"},"shiftTypes":{"type":"array","items":{"$ref":"#/components/schemas/ExternalShiftType"}}}},"DataProviderInput":{"required":["externalForecastVariableId","externalUnitId"],"type":"object","properties":{"externalForecastVariableId":{"type":"string"},"externalUnitId":{"type":"string"},"externalSectionId":{"type":"string"},"forecastDataPayload":{"type":"array","items":{"$ref":"#/components/schemas/Payload"}}}},"DataProviderInputList":{"required":["requests"],"type":"object","properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/DataProviderInput"}}}},"Payload":{"required":["data","timestamp"],"type":"object","properties":{"data":{"type":"number","format":"double"},"timestamp":{"type":"string"}}},"ForecastPredictionDataInput":{"required":["externalForecastConfigurationId","externalForecastVariableId","externalUnitId","forecastDataPayload","runIdentifier","runTimestamp"],"type":"object","properties":{"externalForecastVariableId":{"type":"string"},"externalForecastConfigurationId":{"type":"string"},"externalUnitId":{"type":"string"},"externalSectionId":{"type":"string"},"runIdentifier":{"type":"string"},"runTimestamp":{"type":"string","format":"date-time"},"forecastDataPayload":{"type":"array","items":{"$ref":"#/components/schemas/Payload"}}}},"ForecastPredictionIntegrationList":{"required":["requests"],"type":"object","properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/ForecastPredictionDataInput"}}}},"ForecastDataModifier":{"required":["endTime","startTime"],"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"percentageModification":{"type":"number","format":"double"},"newValueForPeriod":{"type":"number","format":"double"}}},"PaginatedResultListExternalStaticRule":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ExternalStaticRule"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"Pagination":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int64"},"currentPage":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}},"DataIngestionOutput":{"type":"object","properties":{"externalForecastVariableId":{"type":"string"},"externalUnitId":{"type":"string"},"externalSectionId":{"type":"string"},"dataPayLoad":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/ForecastDataPayload"}},"dataPayload":{"type":"array","items":{"$ref":"#/components/schemas/ForecastDataPayload"}}}},"ForecastDataPayload":{"required":["data","timestamp"],"type":"object","properties":{"data":{"type":"number","format":"double"},"timestamp":{"type":"string","format":"date-time"}}},"CalculatedForecast":{"type":"object","properties":{"externalForecastConfigurationId":{"type":"string"},"externalUnitId":{"type":"string"},"externalSectionId":{"type":"string"},"dataPayLoad":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/CalculatedForecastData"}},"dataPayload":{"type":"array","items":{"$ref":"#/components/schemas/CalculatedForecastData"}}}},"CalculatedForecastData":{"type":"object","properties":{"data":{"type":"number","format":"double"},"editedData":{"type":"number","format":"double"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}}},"AggregatedData":{"type":"object","properties":{"groupId":{"type":"integer","format":"int32"},"forecastVariableId":{"type":"integer","format":"int32"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"data":{"type":"number","format":"double"},"skip":{"type":"boolean"},"dataType":{"type":"string","enum":["ACTUAL","PREDICTED","FORECAST"]}}},"CalculatedVariableOutput":{"type":"object","properties":{"extCalculatedVarId":{"type":"string"},"externalUnitId":{"type":"string"},"externalSectionId":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ForecastDataPayload"}}}}}}}