{ "opencollection": "1.0.0", "info": { "name": "Quinyx Absence Schedules Forecast Data API", "version": "v2" }, "items": [ { "info": { "name": "Forecast Data", "type": "folder" }, "items": [ { "info": { "name": "Upload actual data with maximum 366 rows", "type": "http" }, "http": { "method": "POST", "url": "https://api.quinyx.com/v2/forecasts/raw-data", "params": [ { "name": "appendData", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Operation used to upload actual data. The total amount of data rows must not exceed 366. Deprecated. Use /actual-data instead." }, { "info": { "name": "Upload prediction data with maximum 366 rows at the variable resolution", "type": "http" }, "http": { "method": "POST", "url": "https://api.quinyx.com/v2/forecasts/predicted-data", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update forecast configuration and related data", "type": "http" }, "http": { "method": "POST", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/forecast-configurations/:externalForecastConfigurationId/edit-forecast", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalForecastConfigurationId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Operation used to edit forecast configurations and update related forecast data." }, { "info": { "name": "Upload forecast data with maximum 366 rows", "type": "http" }, "http": { "method": "POST", "url": "https://api.quinyx.com/v2/forecasts/forecast-data", "params": [ { "name": "appendData", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Operation used to upload forecast data. The total amount of data rows must not exceed 366. Deprecated. Use /budget-data instead." }, { "info": { "name": "Upload budget data with maximum 366 rows", "type": "http" }, "http": { "method": "POST", "url": "https://api.quinyx.com/v2/forecasts/budget-data", "params": [ { "name": "appendData", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Operation used to upload budget data. The total amount of data rows must not exceed 366." }, { "info": { "name": "Upload pre-aggregated data with maximum 366 rows", "type": "http" }, "http": { "method": "POST", "url": "https://api.quinyx.com/v2/forecasts/aggregated-data", "body": { "type": "json", "data": "{}" } }, "docs": "Operation used to upload data already grouped at input data resolution. The total amount of data rows must not exceed 366." }, { "info": { "name": "Upload actual data with maximum 366 rows", "type": "http" }, "http": { "method": "POST", "url": "https://api.quinyx.com/v2/forecasts/actual-data", "params": [ { "name": "appendData", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Operation used to upload actual data. The total amount of data rows must not exceed 366." }, { "info": { "name": "Get uploaded raw data for forecast variable, up to 120 days", "type": "http" }, "http": { "method": "GET", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/raw-data", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Getting the actual data previously uploaded for the given forecast variable. The range between these two dates can not exceed 120 days. Deprecated. Use ../actual-data instead." }, { "info": { "name": "Delete uploaded raw data and matching calculated forecast", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/raw-data", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "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. Deprecated. Use ../actual-data instead." }, { "info": { "name": "Stream uploaded raw data for forecast variable, up to 120 days", "type": "http" }, "http": { "method": "GET", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/raw-data-stream", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Stream the actual data previously uploaded for the given forecast variable. The range between these two dates can not exceed 120 days. Deprecated. Use ../actual-data instead." }, { "info": { "name": "Get uploaded forecast data for a forecast variable, up to 120 days", "type": "http" }, "http": { "method": "GET", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/forecast-data", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Getting the uploaded forecast data for the given forecast variable. The range between these two dates can not exceed 120 days. Deprecated. Use /budget-data instead." }, { "info": { "name": "Delete previously uploaded forecast data for a forecast variable", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/forecast-data", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Deleting the previously uploaded forecast data for 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. Deprecated. Use /forecast-variables/{externalForecastVariableId}/budget-data instead." }, { "info": { "name": "Get the calculated forecast for a forecast variable, ignoring forecast events", "type": "http" }, "http": { "method": "GET", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/calculated-forecast", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Getting the calculated forecast for the given forecast variable. The range between these two dates can not exceed 120 days. Forecast events are NOT taken into consideration." }, { "info": { "name": "Get uploaded budget data for a forecast variable, up to 120 days", "type": "http" }, "http": { "method": "GET", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/budget-data", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Getting the uploaded budget data for the given forecast variable. The range between these two dates can not exceed 120 days." }, { "info": { "name": "Delete previously uploaded budget data for a forecast variable", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/budget-data", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Deleting the previously uploaded budget data for 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." }, { "info": { "name": "Get aggregated data for a forecast variable, up to 120 days", "type": "http" }, "http": { "method": "GET", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/aggregated-data", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Getting the aggregated data for the given forecast variable. The range between these two dates can not exceed 120 days." }, { "info": { "name": "Get previously uploaded actual data for a forecast variable, up to 120 days", "type": "http" }, "http": { "method": "GET", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/actual-data", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Getting the actual data previously uploaded for the given forecast variable. The range between these two dates can not exceed 120 days." }, { "info": { "name": "Delete previously uploaded actual data and the matching calculated forecast", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/actual-data", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Stream previously uploaded actual data for a forecast variable, up to 120 days", "type": "http" }, "http": { "method": "GET", "url": "https://api.quinyx.com/v2/forecasts/forecast-variables/:externalForecastVariableId/actual-data-stream", "params": [ { "name": "externalForecastVariableId", "value": "", "type": "path" }, { "name": "externalUnitId", "value": "", "type": "query" }, { "name": "externalSectionId", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" } ] }, "docs": "Stream the actual data previously uploaded for the given forecast variable. The range between these two dates can not exceed 120 days." }, { "info": { "name": "Get calculated variable data by external id, up to 120 days", "type": "http" }, "http": { "method": "GET", "url": "https://api.quinyx.com/v2/forecasts/calculated-variables/:extCalculatedVarId", "params": [ { "name": "extCalculatedVarId", "value": "extId", "type": "path", "description": "Calculated Variable External Id" }, { "name": "externalUnitId", "value": "unitId", "type": "query", "description": "External Group Id" }, { "name": "startTime", "value": "2020-01-26T00:00:00Z", "type": "query", "description": "Start of the period in ISO format" }, { "name": "endTime", "value": "2020-01-27T00:00:00Z", "type": "query", "description": "End of the period ISO format" } ] }, "docs": "Getting the data for calculated variable identified by externalId. The range between these two dates can not exceed 120 days." } ] } ], "bundled": true }