{
"openapi": "3.0.4",
"info": {
"title": "ATLAS ETRM API Documentation",
"description": "# API Specifications\n\n## Overview\n\nThis document outlines the specifications for the ATLAS ETRM API, providing guidance on authentication, rate limiting, endpoints, and response formats. This API is designed for third-party applications to be easily integrated with the ATLAS ETRM.\n\nPlease find additional examples for the ATLAS ETRM API to Please find additional examples for the ATLAS ETRM API to the [API Examples](https://stellarblue987912-my.sharepoint.com/:u:/g/personal/gtsoumalis_stellarblue_eu/EdIGbqIA16NMiD63FgKXTGABFBaHPcwE9VQDunSnz0QCzQ?e=bJNr8S) Postman collection.\n\n## Authentication\n\n### SSL Certificates\n\nAll connections to the API must be secured using SSL certificates to ensure data integrity and privacy between the client and the server. Clients are required to connect using HTTPS protocol to prevent man-in-the-middle attacks.\n\n### Bearer Token Authentication\n\nAccess to the API is granted through Bearer Token Authentication. Clients must provide a valid, unexpired access token in the request header. \n
\nTokens are valid for 1 hour. \n\nTokens can be obtained through the following endpoint:\n\n- **POST** `/api/token`\n - **Description**: Authenticate the user and retrieve an access token.\n - **Parameters**: Username and password are passed via Basic Auth.\n - **Response**:\n - `200 OK` - Successfully authenticated\n - `401 Unauthorized` - Authentication failed\n\n## Rate Limiting\n\nTo ensure fair usage and protect the API from abuse, the API is rate-limited as follows:\n\n**Requests**: 100 requests per minute per client.
\n**Exceeding Limits**: Exceeding this limit results in a `429 Too Many Requests` response until the limit resets.\n\n## Data Formats\n\nResponses from the API are provided in JSON format. Ensure that your client parses the response accordingly.\n\n## Error Handling\n\nThe API utilizes standard HTTP response codes, as defined in [RFC 2616](https://www.ietf.org/rfc/rfc2616.txt) and [RFC 6585](https://www.ietf.org/rfc/rfc6585.txt), to indicate the success or failure of an API request. Here is a detailed list of potential status codes and their meanings:\n\n### Response Status Codes\n\n**200 OK** - The request has succeeded. The client can read the result of the request in both the body and the headers of the response.
\n**201 Created** - The request has been fulfilled, resulting in the creation of a new resource.
\n**202 Accepted** - The request has been accepted for processing, but the processing has not yet been completed.
\n**204 No Content** - The request has succeeded but does not return any content in the message body.
\n\n### Client Error Responses\n\n**400 Bad Request** - The server cannot process the request due to a client error (e.g., malformed request syntax). Additional details will be provided in the message body.
\n**401 Unauthorized** - Authentication is required and has failed or has not been provided. Further details may be available in the message body.
\n**403 Forbidden** - The server understood the request but refused to authorize it.
\n**404 Not Found** - The requested resource was not found. This may be due to a temporary or permanent removal of the resource.
\n**429 Too Many Requests** - The request was not accepted due to rate limiting. The client should reduce the frequency of requests.
\n\n### Server Error Responses\n\n**500 Internal Server Error** - The server encountered an unexpected condition that prevented it from fulfilling the request. This error is usually a server-side issue.
\n**502 Bad Gateway** - The server was acting as a gateway or proxy and received an invalid response from the upstream server.
\n**503 Service Unavailable** - The server is currently unable to handle the request due to a temporary overload or maintenance. The client may repeat the request after a delay.
",
"version": "v2026.08.05"
},
"paths": {
"/api/token": {
"post": {
"tags": [
"Account"
],
"description": "Authenticates a service account and returns a JWT bearer token for all further requests.\nCredentials can be provided as a JSON body (preferred) or as an\n`Authorization: Basic ` header (backwards compatible).",
"responses": {
"200": {
"description": "The JWT token used for all further requests.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request. The request contains malformed data or invalid credentials.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests. The app has exceeded its rate limits.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Basic": [ ]
}
]
}
},
"/api/AlertRule/GetAll": {
"post": {
"tags": [
"AlertRule"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/AlertRule/GetByIds": {
"post": {
"tags": [
"AlertRule"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/AlertRule/CreateOrUpdate": {
"post": {
"tags": [
"AlertRule"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/AlertRule/DeleteByIds": {
"post": {
"tags": [
"AlertRule"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/GetTimeseriesTypeByIds": {
"post": {
"tags": [
"Assets"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Timeseries Types that match the ids.\n\n\nIn order to get all Timeseries Types, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetTimeseriesTypeDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetTimeseriesTypeDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetTimeseriesTypeDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/GetByIds": {
"post": {
"tags": [
"Assets"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Books that match the ids.\n\n\nIn order to get all Books, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/Post": {
"post": {
"tags": [
"Assets"
],
"description": "Creates, fully replaces, or partially patches assets — one call, mixed batch. Each item\nis EXACTLY ONE of:\n\n\n\"entity\": a full Asset record — Id 0/omitted creates a new asset; an existing Id fully\nreplaces that asset (every field you don't include is cleared, not left as-is).\n\n\n\"patch\": { id, operations } — partially updates an EXISTING asset via a single RFC 6902\nJSON Patch document. operations[0] MUST be a \"test\" on \"/modifiedAt\" (the optimistic\nconcurrency check, enforced server-side) using the ModifiedAt value you last read for\nthat asset; \"/id\", \"/createdAt\", \"/modifiedAt\" cannot be targeted by anything else. If the\nasset was changed since that test value, the ENTIRE call is rejected (no item in the\nbatch is written, not even the \"entity\" full-replace items) and the response's Data field\ncarries the CURRENT stored record(s) for the conflicting patch item(s) instead of your\nintended change, so you can inspect what happened and retry with a fresh test value.\n\n\n\n**Custom Fields**\n\n\nIn order to add or update custom fields (via \"entity\"), include the custom field ID, Name, Type and Value in the property customFieldValues of the request body.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "The saved Asset records, or the current conflicting records and Success=false on conflict.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/Delete": {
"post": {
"tags": [
"Assets"
],
"description": "This endpoint will delete the Assets with the specified IDs.\n\n\nPass an array of IDs in the request body to delete multiple Assets at once.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of deleted Assets.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/UpdateStartRepresentation": {
"post": {
"tags": [
"Assets"
],
"description": "Updates the start representation of the Assets",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetStartRepresentationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetStartRepresentationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetStartRepresentationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "A list of created AssetTimeseriesConnectionCreateDto.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/UpdateEndRepresentation": {
"post": {
"tags": [
"Assets"
],
"description": "Updates the end representation of the Assets",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetEndRepresentationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetEndRepresentationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetEndRepresentationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/AddAssetTimeseriesConnection": {
"post": {
"tags": [
"Assets"
],
"description": "Adds connections between Assets and Timeseries.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/RemoveAssetTimeseriesConnection": {
"post": {
"tags": [
"Assets"
],
"description": "Removes connections between Assets and Timeseries.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionDeleteDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionDeleteDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionDeleteDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "A list of AssetTimeseriesConnectionCreateDto that were removed.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/GetRelationshipTypes": {
"post": {
"tags": [
"Assets"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Relationship Types that match the ids.\nIn order to get all Relationship Types, pass an empty array.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipTypeDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipTypeDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipTypeDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/CreateAssetRelationships": {
"post": {
"tags": [
"Assets"
],
"description": "This endpoint will create new Asset Relationships if the IDs are null or zero, or update existing ones if valid IDs are provided.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Assets/DeleteRelationships": {
"post": {
"tags": [
"Assets"
],
"description": "This endpoint will delete the Asset Relationships passed in the request body.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetInterconnectionNetTransferCapacity": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Interconnection NTC values for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Interconnection NTC values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateInterconnectionNetTransferCapacity": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Interconnection NTC values",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Interconnection NTC values updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetCorridorAvailableTransferCapacity": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Corridor ATC values for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Corridor ATC values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateCorridorAvailableTransferCapacity": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Corridor ATC values",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Corridor ATC values updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetSystemLosses": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM System Losses for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "System Losses values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateSystemLosses": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM System Losses",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "System Losses updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetThermalMandatorySchedules": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Thermal Mandatory Schedules for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Thermal Mandatory Schedules",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateThermalMandatorySchedules": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Thermal Mandatory Schedules",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Thermal Mandatory Schedules updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetHydroMandatorySchedules": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Hydro Mandatory Schedules for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Hydro Mandatory Schedules",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateHydroMandatorySchedules": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Hydro Mandatory Schedules",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Hydro Mandatory Schedules updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetThermalAvailabilities": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Thermal Availabilities for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Thermal Availabilities",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateThermalAvailabilities": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Thermal Availabilities",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Thermal Availabilities updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetHydroAvailabilities": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Hydro Availabilities for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Hydro Availabilities",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateHydroAvailabilities": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Hydro Availabilities",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Hydro Availabilities updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetImportsData": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Imports Data for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Imports Data",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateImportsData": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Imports Data",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Imports Data updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetExportsData": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Exports Data for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Exports Data",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateExportsData": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Exports Data",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Exports Data updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetLoadForecastScenarios": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Load Forecast Scenario List for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Load Forecast Scenario List",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetLoadForecastScenarioValues": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Load Forecast Scenarios for a specific target date and scenario ID",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Load Forecast Scenarios",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CLoadForecastDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CLoadForecastDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CLoadForecastDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/NewLoadForecastScenario": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Create a new DAM Load Forecast Scenario",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "New Load Forecast Scenario created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CLoadForecastDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CLoadForecastDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CLoadForecastDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/DeleteLoadForecastScenario": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Delete a DAM Load Forecast Scenario by ID",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "Load Forecast Scenario deleted successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateLoadForecastScenarioValues": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Load Forecasts per scenario",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.LoadForecastPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.LoadForecastPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.LoadForecastPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Load Forecasts updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetHybridOfferScenarios": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Hybrid Offer Scenario List for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Hybrid Offer Scenario List",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetHybridOfferScenarioValues": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Hybrid Offer Scenarios for a specific target date and scenario ID",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Hybrid Offer Scenarios",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CHybridOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CHybridOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CHybridOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateHybridOffersScenarioValues": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Hybrid Offers per scenario",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.HybridOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.HybridOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.HybridOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Hybrid Offers updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/RefreshImportsExportsByScenarioId": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Imports/Exports by Scenario ID",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Imports/Exports updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/NewHybridOffersScenario": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Create a new DAM Hybrid Offers Scenario",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "New Hybrid Offers Scenario created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CHybridOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CHybridOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CHybridOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/DeleteHybridOffersScenario": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Delete a DAM Hybrid Offers Scenario by ID",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "Hybrid Offers Scenario deleted successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetBlockOfferScenarioData": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Block Offer Scenarios for a specific target date and scenario ID",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Block Offer Scenarios",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CBlockOrderScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CBlockOrderScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CBlockOrderScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/GetBlockOfferScenarios": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Get DAM Block Offer Scenario List for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "Block Offer Scenario List",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/NewBlockOffersScenario": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Create a new DAM Block Offers Scenario",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "New Block Offers Scenario created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CBlockOrderScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CBlockOrderScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CBlockOrderScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/DeleteBlockOffersScenario": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Delete a DAM Block Offers Scenario by ID",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "Block Offers Scenario deleted successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/DAM/UpdateBlockOffersValues": {
"post": {
"tags": [
"ATLASi DAM"
],
"description": "Update DAM Block Offers",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrdersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrdersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrdersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Block Offers updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ForwardMarket/GetContracts": {
"post": {
"tags": [
"ATLASi Forward Market"
],
"description": "Get Forward Market contracts for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityTypeAndDateBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityTypeAndDateBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityTypeAndDateBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Forward Market contracts",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CForwardMarketContractDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CForwardMarketContractDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CForwardMarketContractDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ForwardMarket/UpdateContracts": {
"post": {
"tags": [
"ATLASi Forward Market"
],
"description": "Update Forward Market contracts",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.ForwardMarketContractsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.ForwardMarketContractsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.ForwardMarketContractsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Forward Market contracts updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ForwardMarket/GetRRAwards": {
"post": {
"tags": [
"ATLASi Forward Market"
],
"description": "Get DAM RR Awards for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "RR Awards",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CRRAwardsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CRRAwardsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CRRAwardsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ForwardMarket/UpdateRRAwards": {
"post": {
"tags": [
"ATLASi Forward Market"
],
"description": "Update DAM RR Awards",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.RRAwardsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.RRAwardsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.RRAwardsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "RR Awards updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetThermalAvailabilities": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateThermalAvailabilities": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetHydroAvailabilities": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateHydroAvailabilities": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetVirtualThermalAvailabilities": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateVirtualThermalAvailabilities": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetThermalMandatorySchedules": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateThermalMandatorySchedules": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetHydroMandatorySchedules": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateHydroMandatorySchedules": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetVirtualThermalMandatorySchedules": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateVirtualThermalMandatorySchedules": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetThermalInitialConditions": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetHydroInitialConditions": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetVirtualThermalInitialConditions": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetPumpingInitialConditions": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetResPortfolioInitialConditions": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetDemandInitialConditions": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateInitialConditions": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetReserveRequirements": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReserveValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReserveValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReserveValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateReserveRequirements": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ZonalReservePostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ZonalReservePostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ZonalReservePostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetGenericConstraints": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateGenericConstraints": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetBalancingEnergyOfferScenarios": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetBalancingEnergyOfferScenarioValues": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CBalancingEnergyOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CBalancingEnergyOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CBalancingEnergyOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateBalancingEnergyOffersScenarioValues": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.BalancingEnergyOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.BalancingEnergyOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.BalancingEnergyOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/NewBalancingEnergyOffersScenario": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CBalancingEnergyOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CBalancingEnergyOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CBalancingEnergyOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/DeleteBalancingEnergyOffersScenario": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetReserveOffers": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CReserveOfferDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CReserveOfferDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CReserveOfferDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateReserveOffers": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ReserveOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ReserveOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ReserveOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetImbalanceRequirementScenarios": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/GetImbalanceRequirementScenarioValues": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/NewImbalanceRequirementsScenario": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/DeleteImbalanceRequirementsScenario": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/ISP/UpdateImbalanceRequirements": {
"post": {
"tags": [
"ATLASi ISP"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/MarketResults/GetResults": {
"post": {
"tags": [
"ATLASi Market Results"
],
"description": "Get Market Results for a specific target date",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Market Results",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.CEntityMarketResultsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.CEntityMarketResultsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.CEntityMarketResultsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/MarketResults/UpdateResults": {
"post": {
"tags": [
"ATLASi Market Results"
],
"description": "Update Market Results",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Market Results updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/RTBEM/GetImbalanceRequirementScenarios": {
"post": {
"tags": [
"ATLASi RTBEM"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/RTBEM/GetImbalanceRequirementScenarioValues": {
"post": {
"tags": [
"ATLASi RTBEM"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/RTBEM/NewImbalanceRequirementsScenario": {
"post": {
"tags": [
"ATLASi RTBEM"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/RTBEM/DeleteImbalanceRequirementsScenario": {
"post": {
"tags": [
"ATLASi RTBEM"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/RTBEM/UpdateImbalanceRequirements": {
"post": {
"tags": [
"ATLASi RTBEM"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/StandingData/GetEntities": {
"get": {
"tags": [
"ATLASi Standing Data"
],
"description": "Get all entities (Thermal, Hydro, RES, Demand) from ATLASi",
"responses": {
"200": {
"description": "Entities retrieved successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.EntityStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.EntityStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.EntityStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/StandingData/GetZones": {
"get": {
"tags": [
"ATLASi Standing Data"
],
"description": "Get all zones from ATLASi",
"responses": {
"200": {
"description": "Zones retrieved successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.ZoneStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.ZoneStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.ZoneStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/StandingData/GetInterconnections": {
"get": {
"tags": [
"ATLASi Standing Data"
],
"description": "Get all interconnections from ATLASi",
"responses": {
"200": {
"description": "Interconnections retrieved successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.InterconnectionStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.InterconnectionStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.InterconnectionStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/ATLASi/StandingData/GetCorridors": {
"get": {
"tags": [
"ATLASi Standing Data"
],
"description": "Get all corridors from ATLASi",
"responses": {
"200": {
"description": "Corridors retrieved successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.CorridorStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.CorridorStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.CorridorStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/BiddingEntities/Get": {
"post": {
"tags": [
"Bidding Spot Entities"
],
"description": "A datetime is passed in the request body to get the list of entities that are active at that day.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": "2026-09-04"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/BiddingEntities/Post": {
"post": {
"tags": [
"Bidding Spot Entities"
],
"description": "This endpoint will create a new Entity if the ID is null or zero, or update an existing Entity if a valid ID is provided.\n\n\nFor creation, do not include an ID or set the ID to zero in the request body.\n\n\nFor updating, include the existing Entity ID and the updated data in the request body.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "The created or updated Entity.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/BiReports/GetReport/{id}": {
"get": {
"tags": [
"BiReports"
],
"description": "Returns a BI report in the specified format for the specified ID.\n\n\nThe report is downloaded from the Metabase API and returned as a file download.\n\n\nSupported formats: csv, json, xlsx (default).\n\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID for the report to retrieve.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "format",
"in": "query",
"description": "The export format (csv, json, or xlsx). Defaults to xlsx.",
"schema": {
"type": "string",
"default": "xlsx"
}
}
],
"responses": {
"200": {
"description": "The report file in the requested format.",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"BiReports"
],
"description": "Returns a BI report in the specified format for the specified ID, with SQL template-tag parameters applied.\n\n\nEach parameter must match a `{{variable_name}}` defined in the Metabase SQL question.\n\n\nSupported types: `date/single`, `category`, `number/=`.\n\n\nDates must be formatted as `yyyy-MM-dd`.\n\n\nExample body for a report with `start_date` and `end_date` variables:\n```\n[\n { \"name\": \"start_date\", \"value\": \"2024-01-01\", \"type\": \"date/single\" },\n { \"name\": \"end_date\", \"value\": \"2024-12-31\", \"type\": \"date/single\" }\n]\n```",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID for the report to retrieve.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "format",
"in": "query",
"description": "The export format (csv, json, or xlsx). Defaults to xlsx.",
"schema": {
"type": "string",
"default": "xlsx"
}
}
],
"requestBody": {
"description": "List of template-tag parameters to inject into the Metabase query.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ReportParameterDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ReportParameterDto"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ReportParameterDto"
}
}
}
}
},
"responses": {
"200": {
"description": "The report file in the requested format.",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/BiReports/GetReportByName": {
"get": {
"tags": [
"BiReports"
],
"description": "Looks up the Metabase report by its exact name (case-insensitive), then returns the file.\n\n\nSupported formats: csv, json, xlsx (default).",
"parameters": [
{
"name": "name",
"in": "query",
"description": "The exact name of the Metabase question/card.",
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"description": "The export format (csv, json, or xlsx). Defaults to xlsx.",
"schema": {
"type": "string",
"default": "xlsx"
}
}
],
"responses": {
"200": {
"description": "The report file in the requested format.",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"404": {
"description": "No report found with the given name."
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"BiReports"
],
"description": "Looks up the Metabase report by its exact name (case-insensitive), applies SQL template-tag parameters, then returns the file.\n\n\nEach parameter must match a `{{variable_name}}` defined in the Metabase SQL question.\n\n\nSupported types: `date/single`, `category`, `number/=`.\n\n\nDates must be formatted as `yyyy-MM-dd`.\n\n\nExample body:\n```\n[\n { \"name\": \"start_date\", \"value\": \"2024-01-01\", \"type\": \"date/single\" },\n { \"name\": \"end_date\", \"value\": \"2024-12-31\", \"type\": \"date/single\" }\n]\n```",
"parameters": [
{
"name": "name",
"in": "query",
"description": "The exact name of the Metabase question/card.",
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"description": "The export format (csv, json, or xlsx). Defaults to xlsx.",
"schema": {
"type": "string",
"default": "xlsx"
}
}
],
"requestBody": {
"description": "List of template-tag parameters to inject into the Metabase query.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ReportParameterDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ReportParameterDto"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ReportParameterDto"
}
}
}
}
},
"responses": {
"200": {
"description": "The report file in the requested format.",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"404": {
"description": "No report found with the given name."
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Book/GetByIds": {
"post": {
"tags": [
"Book"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Books that match the ids.\n\n\nIn order to get all Books, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BookApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BookApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BookApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Book/GetByFolderId": {
"post": {
"tags": [
"Book"
],
"description": "A Folder id should be passed in the request body, and the API returns a list of Books that corresponds to the Folder.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BookApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BookApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BookApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/BusinessUnit/GetByIds": {
"post": {
"tags": [
"BusinessUnit"
],
"description": "An array of ids is passed in the request body, and the API returns a list of Business Units that match the ids.\n\n\nIn order to get all Business Units, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BusinessUnitApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BusinessUnitApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BusinessUnitApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/BusinessUnit/GetByCompanyId": {
"post": {
"tags": [
"BusinessUnit"
],
"description": "A Company id should be passed in the request body, and the API returns a list of Business Units that corresponds to the Company.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BusinessUnitApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BusinessUnitApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BusinessUnitApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Company/GetByIds": {
"post": {
"tags": [
"Company"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Companies that match the ids.\n\n\nIn order to get all Companies, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.CompanyApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.CompanyApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.CompanyApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Counterparty/GetByIds": {
"post": {
"tags": [
"Counterparty"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Counterparties that match the ids.\n\n\nIn order to get all Counterparties, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Counterparties.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Counterparty/GetCounterpartiesTimeseriesTypeCategories": {
"post": {
"tags": [
"Counterparty"
],
"description": "Returns available counterparty timeseries type categories.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Counterparty/GetCounterpartiesTimeseriesTypes": {
"post": {
"tags": [
"Counterparty"
],
"description": "Returns counterparty timeseries types by ids. Pass null or an empty array for all types.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Counterparty/PostCounterpartyTimeseriesTypes": {
"post": {
"tags": [
"Counterparty"
],
"description": "Creates or updates counterparty timeseries types.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Counterparty/DeleteCounterpartyTimeseriesTypes": {
"post": {
"tags": [
"Counterparty"
],
"description": "Deletes counterparty timeseries types by ids.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Counterparty/AddCounterpartyTimeseriesConnection": {
"post": {
"tags": [
"Counterparty"
],
"description": "Adds connections between counterparties and timeseries.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Counterparty/RemoveCounterpartyTimeseriesConnection": {
"post": {
"tags": [
"Counterparty"
],
"description": "Removes connections between counterparties and timeseries.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionDeleteDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionDeleteDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionDeleteDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Counterparty/Post": {
"post": {
"tags": [
"Counterparty"
],
"description": "This endpoint will create a new Counterparty if the ID is null or zero, or update an existing Counterparty if a valid ID is provided.\n\n\nFor creation, do not include an ID or set the ID to zero in the request body.\n\n\nFor updating, include the existing Counterparty ID and the updated data in the request body.\n\n\n**Custom Fields**\n\n\nIn order to add or update custom fields, include the custom field ID, Name, Type and Value in the property customFieldValues of the request body.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 0,
"legalName": "Sample Counterparty",
"shortName": null,
"address": null,
"municipality": null,
"externalId": null,
"zipCode": null,
"countryId": null,
"phone": null,
"vat": null,
"glAccount": null,
"taxOffice": null,
"isActive": false,
"swiftBic": null,
"comments": null,
"eic": null,
"registryAccount": null,
"selfBilling": 0,
"creditShortTermRating": 0,
"creditLongTermRating": 0,
"counterPartyTypes": null,
"customFieldValues": null,
"counterPartyTimeseries": [ ]
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 0,
"legalName": "Sample Counterparty",
"shortName": null,
"address": null,
"municipality": null,
"externalId": null,
"zipCode": null,
"countryId": null,
"phone": null,
"vat": null,
"glAccount": null,
"taxOffice": null,
"isActive": false,
"swiftBic": null,
"comments": null,
"eic": null,
"registryAccount": null,
"selfBilling": 0,
"creditShortTermRating": 0,
"creditLongTermRating": 0,
"counterPartyTypes": null,
"customFieldValues": null,
"counterPartyTimeseries": [ ]
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 0,
"legalName": "Sample Counterparty",
"shortName": null,
"address": null,
"municipality": null,
"externalId": null,
"zipCode": null,
"countryId": null,
"phone": null,
"vat": null,
"glAccount": null,
"taxOffice": null,
"isActive": false,
"swiftBic": null,
"comments": null,
"eic": null,
"registryAccount": null,
"selfBilling": 0,
"creditShortTermRating": 0,
"creditLongTermRating": 0,
"counterPartyTypes": null,
"customFieldValues": null,
"counterPartyTimeseries": [ ]
}
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Counterparties.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Counterparty/Delete": {
"post": {
"tags": [
"Counterparty"
],
"description": "This endpoint will delete the Counterparties with the provided IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Deleted Counterparties.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/GetByEntityType": {
"post": {
"tags": [
"CustomFields"
],
"description": "Discovers the custom field definitions available for one of the core entity types.\nSupported entityType values: 2 (Order), 4 (Counterparty), 5 (Asset), 6 (MasterAgreement).\nDeal (1) and DealCluster (3) have no custom field discovery endpoint.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "The custom field definitions for the requested entity type.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/GetTypes": {
"post": {
"tags": [
"CustomFields"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/DeleteByIds": {
"post": {
"tags": [
"CustomFields"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/MasterAgreements/Get": {
"post": {
"tags": [
"CustomFields"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/MasterAgreements/Post": {
"post": {
"tags": [
"CustomFields"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/MasterAgreements/GetByMasterAgreementTypeIds": {
"post": {
"tags": [
"CustomFields"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/Assets/Post": {
"post": {
"tags": [
"CustomFields"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/Assets/Get": {
"post": {
"tags": [
"CustomFields"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/Assets/GetByAssetTypeIds": {
"post": {
"tags": [
"CustomFields"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/Counterparties/GetByCounterpartyTypeIds": {
"post": {
"tags": [
"CustomFields"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/Counterparties/Post": {
"post": {
"tags": [
"CustomFields"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/Orders/Get": {
"post": {
"tags": [
"CustomFields"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/Orders/Post": {
"post": {
"tags": [
"CustomFields"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/MasterAgreementAssetConnections/Get": {
"post": {
"tags": [
"CustomFields"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/CustomFields/MasterAgreementAssetConnections/Post": {
"post": {
"tags": [
"CustomFields"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/GetWithPaging": {
"post": {
"tags": [
"Deal"
],
"description": "The parameters offset and limit should be passed and the API returns a list of Deals that match the ids.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PagingDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"limit": 10,
"offset": 0
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PagingDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"limit": 10,
"offset": 0
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PagingDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"limit": 10,
"offset": 0
}
}
}
}
},
"responses": {
"200": {
"description": "A list of Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/GetByIds": {
"post": {
"tags": [
"Deal"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Deals that match the ids.\n\n\nIn order to get all Deals, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/GetDealsByCompanyIds": {
"post": {
"tags": [
"Deal"
],
"description": "A Company id should be passed in the request body, and the API returns a list of Deals that corresponds to the Company.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/GetDealsByBusinessUnitIds": {
"post": {
"tags": [
"Deal"
],
"description": "A Business Unit id should be passed in the request body, and the API returns a list of Deals that corresponds to the Business Unit.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/GetDealsByFolderIds": {
"post": {
"tags": [
"Deal"
],
"description": "A Folder id should be passed in the request body, and the API returns a list of Deals that corresponds to the Folder.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/GetDealsByPortfolioIds": {
"post": {
"tags": [
"Deal"
],
"description": "A Portfolio id should be passed in the request body, and the API returns a list of Deals that corresponds to the Portfolio.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/GetDealsByDealCounterPartyIds": {
"post": {
"tags": [
"Deal"
],
"description": "A Counterparty id should be passed in the request body, and the API returns a list of Deals that corresponds to the Counterparty.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/GetDealsByDealClusterIds": {
"post": {
"tags": [
"Deal"
],
"description": "A Cluster id should be passed in the request body, and the API returns a list of Deals that corresponds to the Cluster.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/Post": {
"post": {
"tags": [
"Deal"
],
"description": "This endpoint will create a new Deal if the ID is null or zero, or update an existing Deal if a valid ID is provided.\n\n\nPassing empty name will automatically create a name for the Deal based on the rule {Company}_{Commodity}_{Product Period}_{ProfileType}_{Transaction Date}_Deal{ID}",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 1,
"externalId": null,
"name": "Deal 1",
"dealClass": 0,
"commodity": 0,
"dealDirection": 0,
"dealStatus": null,
"dealDelivery": 0,
"timeZoneInfo": 0,
"companyId": null,
"businessUnitId": null,
"bookId": null,
"folderId": null,
"portfolioId": null,
"counterPartyId": 0,
"validFrom": "0001-01-01T00:00:00",
"validTo": "0001-01-01T00:00:00",
"profiles": null,
"totalQuantity": null,
"priceType": 0,
"currency": null,
"legs1": null,
"mtmDataseriesId": null,
"transactionTime": null,
"exchangeId": null,
"traderId": null,
"masterAgreementId": null,
"includedInSettlement": false,
"calendar": null,
"ibanId": null,
"vatLevel": null,
"deliveryDate": null,
"consumptionStart": null,
"consumptionEnd": null,
"productionEntityExternalId": null,
"consumptionEntityExternalId": null,
"technology": null,
"country": null,
"counterPartyRegistryAccount": null,
"amount": null,
"dealClusterId": null,
"dealTemplateId": null,
"linkedDeals": null,
"memo": null,
"memo2": null
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 1,
"externalId": null,
"name": "Deal 1",
"dealClass": 0,
"commodity": 0,
"dealDirection": 0,
"dealStatus": null,
"dealDelivery": 0,
"timeZoneInfo": 0,
"companyId": null,
"businessUnitId": null,
"bookId": null,
"folderId": null,
"portfolioId": null,
"counterPartyId": 0,
"validFrom": "0001-01-01T00:00:00",
"validTo": "0001-01-01T00:00:00",
"profiles": null,
"totalQuantity": null,
"priceType": 0,
"currency": null,
"legs1": null,
"mtmDataseriesId": null,
"transactionTime": null,
"exchangeId": null,
"traderId": null,
"masterAgreementId": null,
"includedInSettlement": false,
"calendar": null,
"ibanId": null,
"vatLevel": null,
"deliveryDate": null,
"consumptionStart": null,
"consumptionEnd": null,
"productionEntityExternalId": null,
"consumptionEntityExternalId": null,
"technology": null,
"country": null,
"counterPartyRegistryAccount": null,
"amount": null,
"dealClusterId": null,
"dealTemplateId": null,
"linkedDeals": null,
"memo": null,
"memo2": null
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 1,
"externalId": null,
"name": "Deal 1",
"dealClass": 0,
"commodity": 0,
"dealDirection": 0,
"dealStatus": null,
"dealDelivery": 0,
"timeZoneInfo": 0,
"companyId": null,
"businessUnitId": null,
"bookId": null,
"folderId": null,
"portfolioId": null,
"counterPartyId": 0,
"validFrom": "0001-01-01T00:00:00",
"validTo": "0001-01-01T00:00:00",
"profiles": null,
"totalQuantity": null,
"priceType": 0,
"currency": null,
"legs1": null,
"mtmDataseriesId": null,
"transactionTime": null,
"exchangeId": null,
"traderId": null,
"masterAgreementId": null,
"includedInSettlement": false,
"calendar": null,
"ibanId": null,
"vatLevel": null,
"deliveryDate": null,
"consumptionStart": null,
"consumptionEnd": null,
"productionEntityExternalId": null,
"consumptionEntityExternalId": null,
"technology": null,
"country": null,
"counterPartyRegistryAccount": null,
"amount": null,
"dealClusterId": null,
"dealTemplateId": null,
"linkedDeals": null,
"memo": null,
"memo2": null
}
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/CreateDealsByClusterPerAssetAndMasterAgreement": {
"post": {
"tags": [
"Deal"
],
"description": "Creates one Deal per list entry, each entry naming a single asset, Deal Cluster, and\nMaster Agreement.\n\n\nEntries that share the same dealClusterId, masterAgreementId, includeInSettlement,\nstartDate, and endDate are batched together server-side — submit one entry per asset\nregardless, there is no need to pre-group them yourself.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.PortfolioManagement.Models.Ui.CreateDealsByClusterSingleAssetDto, Atlas.SDK.PortfolioManagement, Version=1.2.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.PortfolioManagement.Models.Ui.CreateDealsByClusterSingleAssetDto, Atlas.SDK.PortfolioManagement, Version=1.2.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.PortfolioManagement.Models.Ui.CreateDealsByClusterSingleAssetDto, Atlas.SDK.PortfolioManagement, Version=1.2.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "The created Deals, one per request entry.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/SoftDelete": {
"post": {
"tags": [
"Deal"
],
"description": "This endpoint will soft-delete the Deals with the provided IDs.\n\n\n The Deals will not be removed from the database, but the IsDeleted flag will be set to true.\n The Deals will not be returned in the future unless the deleted Deals will be restored.\n \n\n The users will be able to see the deleted Deals in the UI in the Trash Can section and restore them if needed.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Soft Deleted Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/GetSoftDeleted": {
"post": {
"tags": [
"Deal"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of soft deleted Deals that match the ids.\n\n\nIn order to get all soft deleted Deals, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of soft deleted Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/Restore": {
"post": {
"tags": [
"Deal"
],
"description": "This endpoint will permanently delete the Deals with the provided IDs.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Soft Deleted Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/PermanentlyDelete": {
"post": {
"tags": [
"Deal"
],
"description": "This endpoint will permanently delete the Deals with the provided IDs.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Soft Deleted Deals.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateDealStatusByDealIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateDealValidRangeByDealIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealValidRangeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealValidRangeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealValidRangeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateDealCurrentLeg1UpfrontByDealIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1UpfrontDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1UpfrontDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1UpfrontDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateDealCurrentLeg1Upfront2ByDealIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1UpfrontDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1UpfrontDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1UpfrontDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateDealCurrentLeg1MultiplierByDealIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1MultiplierDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1MultiplierDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1MultiplierDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateDealClusterByDealIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealClusterDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealClusterDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealClusterDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateDealMemoByDealIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemoDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemoDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemoDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateDealMemo2ByDealIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemo2Dto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemo2Dto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemo2Dto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateDealCollectionByDealIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealCollectionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealCollectionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealCollectionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Deal/UpdateExternalIds": {
"post": {
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealExternalIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealExternalIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealExternalIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DealCluster/GetByIds": {
"post": {
"tags": [
"DealCluster"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DealCluster/Post": {
"post": {
"tags": [
"DealCluster"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DealCluster/Delete": {
"post": {
"tags": [
"DealCluster"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DealCollection/GetTypesByIds": {
"post": {
"tags": [
"DealCollection"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Deal Collection Types that match the ids.\n\n\nIn order to get all Deal Collection Types, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deal Collection Types.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionTypeResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionTypeResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionTypeResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DealCollection/GetByIds": {
"post": {
"tags": [
"DealCollection"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Deal Collections that match the ids.\n\n\nIn order to get all Deal Collections, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deal Collections.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DealCollection/GetDealCollectionsByTypeIds": {
"post": {
"tags": [
"DealCollection"
],
"description": "An array of Deal Collection Type ids should be passed in the request body, and the API returns a list of Deal Collections that match the ids.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Deal Collections.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DealCollection/Post": {
"post": {
"tags": [
"DealCollection"
],
"description": "This endpoint will create a new Deal Collection if the ID is null or zero, or update an existing Deal Collections if a valid ID is provided.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "A list of Deal Collections.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DealCollection/Delete": {
"post": {
"tags": [
"DealCollection"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/GetDocuments": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/GetDocumentsByModules": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/GetDocumentsByEntityTypes": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/GetDocumentMetadata": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/CheckDocuments": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.CheckDocumentsRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.CheckDocumentsRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.CheckDocumentsRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.CheckDocumentResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.CheckDocumentResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.CheckDocumentResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/DownloadFiles": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/DownloadFileVersion": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.VersionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.VersionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.VersionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/DeleteDocuments": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/ImportDocuments": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
}
},
"documentsMapped": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DocumentManager.DocumentDto"
}
}
}
},
"encoding": {
"files": {
"style": "form"
},
"documentsMapped": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/DocumentManager/UpdateDocusignDocumentStatusByExternalId": {
"post": {
"tags": [
"DocumentManager"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.DocumentManager.UpdateDocumentStatusByExternalIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.DocumentManager.UpdateDocumentStatusByExternalIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.DocumentManager.UpdateDocumentStatusByExternalIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/EmsMeasurements/PostRealtimeMeasurements": {
"post": {
"tags": [
"EmsMeasurements"
],
"description": "Accepts one-second EMS measured data points for one or more assets. \n\n \nEach list item contains only asset id, timestamp, measurement kind and value. \n\n \nGateway validates and normalizes the incoming data point only. Aggregations, timeseries management and downstream persistence are handled by another module. \n\n \nAlways send a list, even for a single asset.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Entity/GetCoreEntitiesByNameOrIds": {
"post": {
"tags": [
"Entity"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.EntityGetRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.EntityGetRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.EntityGetRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Entity/SearchByNameLike": {
"post": {
"tags": [
"Entity"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.PortfolioManagement.Models.EntitySearchByNameLikeRequest, Atlas.SDK.PortfolioManagement, Version=1.2.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.PortfolioManagement.Models.EntitySearchByNameLikeRequest, Atlas.SDK.PortfolioManagement, Version=1.2.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.PortfolioManagement.Models.EntitySearchByNameLikeRequest, Atlas.SDK.PortfolioManagement, Version=1.2.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Fee/GetAll": {
"post": {
"tags": [
"Fee"
],
"description": "Returns all available Fees.",
"responses": {
"200": {
"description": "A list of all Fees.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Fee/GetByIds": {
"post": {
"tags": [
"Fee"
],
"description": "Returns Fees matching the provided IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Fees.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Fee/GetByKind": {
"post": {
"tags": [
"Fee"
],
"description": "Returns all Fees of a specific FeeKind.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.Enums.FeeKind, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.Enums.FeeKind, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.Enums.FeeKind, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "A list of Fees filtered by kind.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Folder/GetByIds": {
"post": {
"tags": [
"Folder"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Folders that match the ids.\n\n\nIn order to get all Folders, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.FolderApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.FolderApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.FolderApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Folder/GetByBusinessUnitId": {
"post": {
"tags": [
"Folder"
],
"description": "A Business Unit id should be passed in the request body, and the API returns a list of Folders that corresponds to the Business Unit.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.FolderApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.FolderApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.FolderApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Forecasting/GetScalarMeasurementsByDateRange": {
"post": {
"tags": [
"Forecasting"
],
"description": "Loads scalar measurements from ATLASi API.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.DateRangeRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.DateRangeRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.DateRangeRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Returns scalar measurements.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Forecasting.ScalarMeasurementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Forecasting.ScalarMeasurementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Forecasting.ScalarMeasurementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/GetUsersByIds": {
"post": {
"tags": [
"Account"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Users that match the ids.\n\n\nIn order to get all Users, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Users.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.UserManagement.Models.ApplicationUserDto, Atlas.SDK.UserManagement, Version=1.2.2.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.UserManagement.Models.ApplicationUserDto, Atlas.SDK.UserManagement, Version=1.2.2.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.UserManagement.Models.ApplicationUserDto, Atlas.SDK.UserManagement, Version=1.2.2.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/GetUsersByRoles": {
"post": {
"tags": [
"Account"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.UserManagement.Models.ApplicationUserDto, Atlas.SDK.UserManagement, Version=1.2.2.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.UserManagement.Models.ApplicationUserDto, Atlas.SDK.UserManagement, Version=1.2.2.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.UserManagement.Models.ApplicationUserDto, Atlas.SDK.UserManagement, Version=1.2.2.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Invoice/GetByIds": {
"post": {
"tags": [
"Invoice"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Invoices that match the ids.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Invoices.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Invoice/GetByExternalIds": {
"post": {
"tags": [
"Invoice"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Invoice/GetByOrderId": {
"post": {
"tags": [
"Invoice"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Invoice/Post": {
"post": {
"tags": [
"Invoice"
],
"description": "This endpoint will create a new Invoice if the ID is null or zero, or update an existing Invoice if a valid ID is provided.\n\n\nFor creation, do not include an ID or set the ID to zero in the request body.\n\n\nFor updating, include the existing Invoice ID and the updated data in the request body.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.InvoiceCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.InvoiceCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.InvoiceCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "A list of Invoices.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"304": {
"description": "Not Modified."
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Invoice/Delete": {
"post": {
"tags": [
"Invoice"
],
"description": "This endpoint will delete the Invoices with the provided IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Deleted Invoices.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreement/GetByIds": {
"post": {
"tags": [
"MasterAgreement"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Master Agreements that match the ids.\n\n\nIn order to get all Master Agreements, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Master Agreements.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreement/GetTypes": {
"post": {
"tags": [
"MasterAgreement"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreement/GetAllMasterAgreementStatuses": {
"post": {
"tags": [
"MasterAgreement"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreement/Post": {
"post": {
"tags": [
"MasterAgreement"
],
"description": "Creates, fully replaces, or partially patches master agreements — one call, mixed batch.\nEach item is EXACTLY ONE of:\n\n\n\"entity\": a full Master Agreement record — Id 0/omitted creates a new one; an existing Id\nfully replaces it (every field you don't include is cleared, not left as-is). Passing\nempty name auto-generates one from {Counterparty}_{Commodity}_{MA Type}_{Valid\nFrom}_{Valid To}.\n\n\n\"patch\": { id, operations } — partially updates an EXISTING master agreement via a single\nRFC 6902 JSON Patch document. operations[0] MUST be a \"test\" on \"/modifiedAt\" (the\noptimistic concurrency check, enforced server-side) using the ModifiedAt value you last\nread for that master agreement; \"/id\" cannot be targeted by anything else. If the record\nwas changed since that test value, the ENTIRE call is rejected (no item in the batch is\nwritten, not even the \"entity\" full-replace items) and the response's Data field carries\nthe CURRENT stored record(s) for the conflicting patch item(s) instead of your intended\nchange, so you can inspect what happened and retry with a fresh test value.\n\n\n\n**Custom Fields**\n\n\nIn order to add or update custom fields (via \"entity\"), include the custom field ID, Name, Type and Value in the property customFieldValues of the request body.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "The saved Master Agreement records, or the current conflicting records and Success=false on conflict.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreement/Delete": {
"post": {
"tags": [
"MasterAgreement"
],
"description": "This endpoint will delete the Master Agreements with the provided IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Deleted Master Agreements.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreement/GetAssetMasterAgreementConnections": {
"post": {
"tags": [
"MasterAgreement"
],
"description": "This endpoint will retrieve the asset - master agreement connections",
"responses": {
"200": {
"description": "Asset Master Agreement connections",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreement/PostAssetMasterAgreementConnections": {
"post": {
"tags": [
"MasterAgreement"
],
"description": "This endpoint will create or update asset - master agreement connections",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlag, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlag, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlag, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Created or updated Asset Master Agreement connections",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreementAssetConnection/GetByIds": {
"post": {
"tags": [
"MasterAgreementAssetConnection"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Master Agreement Asset Connections that match the ids.\n\n\nIn order to get all Master Agreement Asset Connections, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Master Agreement Asset Connections.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreementAssetConnection/AddOrUpdate": {
"post": {
"tags": [
"MasterAgreementAssetConnection"
],
"description": "This endpoint will create a new Master Agreement Asset Connection if the ID is null or zero, or update an existing one if a valid ID is provided.\n\n\nFor creation, do not include an ID or set the ID to zero in the request body.\n\n\nFor updating, include the existing Master Agreement Asset Connection ID and the updated data in the request body.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlagDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlagDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlagDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Updated or created Master Agreement Asset Connections.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterAgreementAssetConnection/UpdateCustomFieldValue": {
"post": {
"tags": [
"MasterAgreementAssetConnection"
],
"description": "Updates a specific custom field value for the provided Master Agreement Asset Connection IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.EntityCustomFieldMassUpdateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.EntityCustomFieldMassUpdateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.EntityCustomFieldMassUpdateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Updated Master Agreement Asset Connections with new custom field values.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetDealClassificationTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetPortfolioKindOptions": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetOrderItemsDynamicProperties": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetSettlementTimezoneOptions": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetOrderKindOptions": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetDealDeliveryTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetCommodityTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetDealDirectionTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetDealMarketTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetDealProfileTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetDealStatusTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetDealClassTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetIntervalPeriodTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetPriceTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetReferenceTypes": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetOrderItemStatus": {
"post": {
"tags": [
"MasterData"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetOrderStatus": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/MasterData/GetCashFlow": {
"post": {
"tags": [
"MasterData"
],
"description": "An array of ids and names of the API Master Data is returned for the specific enum type.",
"responses": {
"200": {
"description": "A list of Folders from the Portfolio Structure.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Order/GetByIds": {
"post": {
"tags": [
"Order"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Orders that match the ids.\n\n\nIn order to get all Orders, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Orders.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Order/Post": {
"post": {
"tags": [
"Order"
],
"description": "This endpoint will create a new Order if the ID is null or zero, or update an existing Order if a valid ID is provided.\n\n\nFor creation, do not include an ID or set the ID to zero in the request body.\n\n\nFor updating, include the existing Order ID and the updated data in the request body.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 0,
"orderKind": 2,
"status": {
"id": 1,
"name": "Draft",
"description": "Draft order by ETRM",
"order": 1,
"statusCategory": 1,
"statusCategoryName": "Draft",
"color": "#007BFF"
},
"orderTypeId": null,
"externalId": null,
"description": null,
"registrationDate": "2026-09-04T20:38:41.4580839+03:00",
"dueDate": "0001-01-01T00:00:00",
"totalAmount": 0,
"commodityId": null,
"documentDate": "0001-01-01T00:00:00",
"erpCode": null,
"contractCode": null
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 0,
"orderKind": 2,
"status": {
"id": 1,
"name": "Draft",
"description": "Draft order by ETRM",
"order": 1,
"statusCategory": 1,
"statusCategoryName": "Draft",
"color": "#007BFF"
},
"orderTypeId": null,
"externalId": null,
"description": null,
"registrationDate": "2026-09-04T20:38:41.4580839+03:00",
"dueDate": "0001-01-01T00:00:00",
"totalAmount": 0,
"commodityId": null,
"documentDate": "0001-01-01T00:00:00",
"erpCode": null,
"contractCode": null
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 0,
"orderKind": 2,
"status": {
"id": 1,
"name": "Draft",
"description": "Draft order by ETRM",
"order": 1,
"statusCategory": 1,
"statusCategoryName": "Draft",
"color": "#007BFF"
},
"orderTypeId": null,
"externalId": null,
"description": null,
"registrationDate": "2026-09-04T20:38:41.4580839+03:00",
"dueDate": "0001-01-01T00:00:00",
"totalAmount": 0,
"commodityId": null,
"documentDate": "0001-01-01T00:00:00",
"erpCode": null,
"contractCode": null
}
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Orders.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"304": {
"description": "Not Modified."
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Order/Delete": {
"post": {
"tags": [
"Order"
],
"description": "This endpoint will delete the Orders with the provided IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Deleted Orders.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Order/GetAllOrderTypes": {
"post": {
"tags": [
"Order"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Order/GetAllOrderStatuses": {
"post": {
"tags": [
"Order"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Order/GetOrdersByInvoiceIds": {
"post": {
"tags": [
"Order"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderByInvoiceIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderByInvoiceIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderByInvoiceIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Order/UpdateCustomFieldValue": {
"post": {
"tags": [
"Order"
],
"description": "Updates a specific custom field value for the provided Order IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.EntityCustomFieldMassUpdateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.EntityCustomFieldMassUpdateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.EntityCustomFieldMassUpdateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Updated Orders with new custom field values.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Order/GetOrderActivities": {
"post": {
"tags": [
"Order"
],
"description": "Returns the activity timeline (created, status changed, sent to external system, external events)\nfor the provided Order IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Order activities.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderActivityDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderActivityDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderActivityDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Order/LogOrderActivity": {
"post": {
"tags": [
"Order"
],
"description": "Logs an activity for an Order. Used by external systems to record actions performed on behalf of an Order\n(e.g. \"order received by SAP\", \"invoice approved by external system\").",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.OrderActivityLogRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.OrderActivityLogRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.OrderActivityLogRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Logged successfully.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/OrderItem/GetByIds": {
"post": {
"tags": [
"OrderItem"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Order Items that match the ids.\n\n\nIn order to get all Order Items, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Orders.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/OrderItem/Post": {
"post": {
"tags": [
"OrderItem"
],
"description": "This endpoint will create a new Order Item if the ID is null or zero, or update an existing Order Item if a valid ID is provided.\n\n\nFor creation, do not include an ID or set the ID to zero in the request body.\n\n\nFor updating, include the existing Order Item ID and the updated data in the request body.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 0,
"externalId": null,
"dealTimeZone": 0,
"counterPartyId": 0,
"masterAgreementSelfBilling": null,
"masterAgreementSelfBillingName": null,
"iban": null,
"glAccount": null,
"dealIbanBankSwift": null,
"status": 0,
"cashflow": null,
"startCompensation": "2026-09-04T20:38:41.4608177+03:00",
"endCompensation": "2026-10-04T20:38:41.4608178+03:00",
"notional": null,
"volume": 0,
"mtm": null,
"pl": null,
"amount": 0,
"amountAfterVat": null,
"vat": null,
"averagePrice": null,
"paymentDate": "0001-01-01T00:00:00",
"reference": null,
"createdTime": "2026-09-04T20:38:41.4608171+03:00",
"settlementOrder": 0,
"balancing": false,
"netAmount": 0,
"paidAmount": 0,
"balance": [
0
],
"vatCalculationOption": 2,
"dealIsSoftDeleted": false
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 0,
"externalId": null,
"dealTimeZone": 0,
"counterPartyId": 0,
"masterAgreementSelfBilling": null,
"masterAgreementSelfBillingName": null,
"iban": null,
"glAccount": null,
"dealIbanBankSwift": null,
"status": 0,
"cashflow": null,
"startCompensation": "2026-09-04T20:38:41.4608177+03:00",
"endCompensation": "2026-10-04T20:38:41.4608178+03:00",
"notional": null,
"volume": 0,
"mtm": null,
"pl": null,
"amount": 0,
"amountAfterVat": null,
"vat": null,
"averagePrice": null,
"paymentDate": "0001-01-01T00:00:00",
"reference": null,
"createdTime": "2026-09-04T20:38:41.4608171+03:00",
"settlementOrder": 0,
"balancing": false,
"netAmount": 0,
"paidAmount": 0,
"balance": [
0
],
"vatCalculationOption": 2,
"dealIsSoftDeleted": false
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"id": 0,
"externalId": null,
"dealTimeZone": 0,
"counterPartyId": 0,
"masterAgreementSelfBilling": null,
"masterAgreementSelfBillingName": null,
"iban": null,
"glAccount": null,
"dealIbanBankSwift": null,
"status": 0,
"cashflow": null,
"startCompensation": "2026-09-04T20:38:41.4608177+03:00",
"endCompensation": "2026-10-04T20:38:41.4608178+03:00",
"notional": null,
"volume": 0,
"mtm": null,
"pl": null,
"amount": 0,
"amountAfterVat": null,
"vat": null,
"averagePrice": null,
"paymentDate": "0001-01-01T00:00:00",
"reference": null,
"createdTime": "2026-09-04T20:38:41.4608171+03:00",
"settlementOrder": 0,
"balancing": false,
"netAmount": 0,
"paidAmount": 0,
"balance": [
0
],
"vatCalculationOption": 2,
"dealIsSoftDeleted": false
}
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Order Items.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"304": {
"description": "Not Modified."
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/OrderItem/Delete": {
"post": {
"tags": [
"OrderItem"
],
"description": "This endpoint will delete the Order Items with the provided IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Deleted Order Items.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/OrderItem/GetByOrderIds": {
"post": {
"tags": [
"OrderItem"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/OrderItem/GetByInvoiceIds": {
"post": {
"tags": [
"OrderItem"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemByInvoiceIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemByInvoiceIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemByInvoiceIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Payment/GetByIds": {
"post": {
"tags": [
"Payment"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Payments that match the ids.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of Payments.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Payment/GetByExternalIds": {
"post": {
"tags": [
"Payment"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Payment/GetByOrderIds": {
"post": {
"tags": [
"Payment"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Payment/GetByInvoiceIds": {
"post": {
"tags": [
"Payment"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Payment/Post": {
"post": {
"tags": [
"Payment"
],
"description": "This endpoint will create a new Payment if the ID is null or zero, or update an existing Payment if a valid ID is provided.\n\n\nFor creation, do not include an ID or set the ID to zero in the request body.\n\n\nFor updating, include the existing Payment ID and the updated data in the request body.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.PaymentCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.PaymentCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.PaymentCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "A list of Payments.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"304": {
"description": "Not Modified."
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Payment/Delete": {
"post": {
"tags": [
"Payment"
],
"description": "This endpoint will delete the Payments with the provided IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Deleted Payments.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/PaymentTerm/GetByIds": {
"post": {
"tags": [
"PaymentTerm"
],
"description": "An array of ids should be passed in the request body, and the API returns a list of Payment Terms that match the ids.\n\n\nIn order to get all Payment Terms, pass an empty array.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "A list of PaymentTerms.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/PaymentTerm/Post": {
"post": {
"tags": [
"PaymentTerm"
],
"description": "This endpoint will create a new Payment Term if the ID is null or zero, or update an existing Payment Term if a valid ID is provided.\n\n\nFor creation, do not include an ID or set the ID to zero in the request body.\n\n\nFor updating, include the existing Payment Term ID and the updated data in the request body.\n\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "A list of PaymentTerms.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotOrders/GetOrdersByDateRange": {
"post": {
"tags": [
"Bidding Spot Orders"
],
"description": "Returns saved Hybrid and Block orders whose dispatch day is within the requested range. XBID, balancing, reserve, forecast, and nomination orders are excluded from this Spot workflow.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.DateRangeBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.DateRangeBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.DateRangeBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotOrders/SubmitOrders": {
"post": {
"tags": [
"Bidding Spot Orders"
],
"description": "Submits saved Hybrid or Block orders by their Bidding order IDs. Bidding retrieves current server-side orders before submitting, so callers do not need to reproduce the full internal order model. The response contains status changes recorded for each order; a successful API call does not imply exchange acceptance.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotOrders/CancelOrders": {
"post": {
"tags": [
"Bidding Spot Orders"
],
"description": "Cancels saved Hybrid or Block orders by their Bidding order IDs. Bidding retrieves current server-side orders before requesting exchange cancellation. XBID orders must be cancelled through the XBID endpoint.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotOrders/GetBlockOrdersByDateAndMarket": {
"post": {
"tags": [
"Bidding Spot Orders"
],
"description": "Returns every eligible entity for a dispatch day, Spot market, and market party together with its saved Block orders, capacity, dispatch-period bounds, period duration, and bidding-zone price limits.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.EntityBlockOrdersDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.EntityBlockOrdersDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.EntityBlockOrdersDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotOrders/PostBlockOrders": {
"post": {
"tags": [
"Bidding Spot Orders"
],
"description": "Creates or updates the supplied Block orders for one entity, dispatch day, Spot market, and market party. Sending an empty orders list soft-deletes all matching Block orders, so first retrieve the current set before editing.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.BlockOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.BlockOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.BlockOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotOrders/GetHybridOrdersByDateAndMarket": {
"post": {
"tags": [
"Bidding Spot Orders"
],
"description": "Returns the complete editable Hybrid or Stepwise order grid for a dispatch day, Spot market, and market party, populated with the latest saved values and current entity and market constraints.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotOrders/ValidateHybridOrderConstraintByEntityIdsAndHybridOrders": {
"post": {
"tags": [
"Bidding Spot Orders"
],
"description": "Checks proposed Hybrid or Stepwise orders against configured block-order relationships before saving. Use the same payload as PostHybridOrders. An empty response means no constraint violations; returned strings explain business-rule failures.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotOrders/PostHybridOrders": {
"post": {
"tags": [
"Bidding Spot Orders"
],
"description": "Creates or updates the supplied Hybrid or Stepwise order values. Bidding resolves read-only market schedules, bidding-zone price limits, and internal identifiers before validating and saving. A row whose first step has a null value removes the matching saved order for that entity, period, side, market, and day. This saves orders only; call SubmitOrders separately to send them to the exchange.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotReference/GetAvailableSpotMarkets": {
"post": {
"tags": [
"Bidding Spot Reference Data"
],
"description": "Returns the Spot markets that exist in the active Bidding configuration. Use the returned IDs when requesting orders, market parties, entities, gates, or dispatch periods.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotReference/GetSpotMarketInfo": {
"post": {
"tags": [
"Bidding Spot Reference Data"
],
"description": "Returns the Spot exchange, enabled order types, quantity unit, supported granularities, maximum hybrid steps, and maximum block orders for the requested date. Use this before constructing an order payload.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.Configuration.SpotMarketInfo, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.Configuration.SpotMarketInfo, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.Configuration.SpotMarketInfo, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotReference/GetMarketGateInformation": {
"post": {
"tags": [
"Bidding Spot Reference Data"
],
"description": "Returns each Spot market's next applicable trading window and whether its gate is currently open. Gate open and close timestamps determine when orders may be submitted or cancelled.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Bidding.MarketGateInfoDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Bidding.MarketGateInfoDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Bidding.MarketGateInfoDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotReference/GetMarketPartiesBySpotOrderTypeAndDate": {
"post": {
"tags": [
"Bidding Spot Reference Data"
],
"description": "Returns market parties configured for Hybrid, Block, or XBID orders on the target date. Use the selected party ID in subsequent entity and order requests.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.MarketPartiesBySpotOrderTypeAndDateRequest, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.MarketPartiesBySpotOrderTypeAndDateRequest, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.MarketPartiesBySpotOrderTypeAndDateRequest, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.ForwardMarket.MarketPartyInfoDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.ForwardMarket.MarketPartyInfoDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.ForwardMarket.MarketPartyInfoDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotReference/GetEntityOptionsByMarketPartyId": {
"post": {
"tags": [
"Bidding Spot Reference Data"
],
"description": "Returns the assets that the selected market party may bid for on the requested Spot market and dispatch date, including each entity's trading side.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketPartyEntitySimpleDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketPartyEntitySimpleDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketPartyEntitySimpleDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/SpotReference/GetDispatchDayPeriodTimestampMetadata": {
"post": {
"tags": [
"Bidding Spot Reference Data"
],
"description": "Returns the timestamp represented by each dispatch period for a market, date, and optional entity. Use it to handle market granularity, entity-specific granularity, and daylight-saving transitions without calculating period timestamps locally.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Timeseries/Post": {
"post": {
"tags": [
"Timeseries"
],
"description": "Creates, fully replaces, or partially patches timeseries — one call, mixed batch.\nEach item is EXACTLY ONE of:\n\n\n\"entity\": a full timeseries record — Id 0/omitted creates a new one; an existing Id fully\nreplaces it (every field you don't include is cleared, not left as-is).\n\n\n\"patch\": { id, operations } — partially updates an EXISTING timeseries via a single RFC 6902\nJSON Patch document. operations[0] MUST be a \"test\" on \"/contentHash\" (the optimistic\nconcurrency check, enforced server-side) using the ContentHash value you last read for that\ntimeseries — timeseries has no native ModifiedAt, so this hash of its current fields stands\nin for one. \"/id\", \"/guid\" and \"/contentHash\" itself cannot be targeted by anything else. If\nthe record was changed since that test value, the ENTIRE call is rejected (no item in the\nbatch is written, not even the \"entity\" full-replace items) and the response's Data field\ncarries the CURRENT stored record(s) for the conflicting patch item(s) instead of your\nintended change, so you can inspect what happened and retry with a fresh test value.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"entity": {
"id": 0,
"externalId": null,
"name": "<>",
"module": null,
"guid": null,
"granularityName": null,
"granularity": 3,
"upsamplingName": null,
"upsampling": null,
"downsamplingName": null,
"downsampling": null,
"typeName": null,
"type": 1,
"source": "<>",
"unitName": null,
"unit": 7,
"isActive": false,
"isCalculated": false,
"tags": "{\"your_key\": \"your_value\"}",
"contentHash": null
},
"patch": null
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"entity": {
"id": 0,
"externalId": null,
"name": "<>",
"module": null,
"guid": null,
"granularityName": null,
"granularity": 3,
"upsamplingName": null,
"upsampling": null,
"downsamplingName": null,
"downsampling": null,
"typeName": null,
"type": 1,
"source": "<>",
"unitName": null,
"unit": 7,
"isActive": false,
"isCalculated": false,
"tags": "{\"your_key\": \"your_value\"}",
"contentHash": null
},
"patch": null
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"entity": {
"id": 0,
"externalId": null,
"name": "<>",
"module": null,
"guid": null,
"granularityName": null,
"granularity": 3,
"upsamplingName": null,
"upsampling": null,
"downsamplingName": null,
"downsampling": null,
"typeName": null,
"type": 1,
"source": "<>",
"unitName": null,
"unit": 7,
"isActive": false,
"isCalculated": false,
"tags": "{\"your_key\": \"your_value\"}",
"contentHash": null
},
"patch": null
}
]
}
}
}
},
"responses": {
"200": {
"description": "The saved timeseries records, or the current conflicting records and Success=false on conflict.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Timeseries/SearchByName": {
"post": {
"tags": [
"Timeseries"
],
"description": "Searches for timeseries by name. Name supports wildcard search using the '*' character.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesSearchByNameRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"name": "<>",
"limit": 10,
"offset": 1
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesSearchByNameRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"name": "<>",
"limit": 10,
"offset": 1
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesSearchByNameRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"name": "<>",
"limit": 10,
"offset": 1
}
}
}
}
},
"responses": {
"200": {
"description": "Searches for timeseries by name. Name supports wildcard search using the '*' character.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Timeseries/PostValues": {
"post": {
"tags": [
"Timeseries"
],
"description": "Updates values of a specific timeseries based on the provided request parameters. \n\n \nTimeseries in ATLAS ETRM follow a date from convention where the date from is inclusive and the date to is exclusive.\nThis means that in an hourly timeseries the value in timestamp 2022-01-01 00:00:00 refers to the time period between 2022-01-01 00:00:00 and 2022-01-01 01:00:00.\n\n \nIf the passed timestamp includes an offset, the offset will be applied and the timezone parameter will be ignored.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.UpdateTimeseriesExternalRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"id": 1,
"timezone": 0,
"values": [
{
"timestamp": "2022-01-01T00:00:00Z",
"value": 5
},
{
"timestamp": "2022-01-01T01:00:00Z",
"value": 10
}
]
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.UpdateTimeseriesExternalRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"id": 1,
"timezone": 0,
"values": [
{
"timestamp": "2022-01-01T00:00:00Z",
"value": 5
},
{
"timestamp": "2022-01-01T01:00:00Z",
"value": 10
}
]
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.UpdateTimeseriesExternalRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"id": 1,
"timezone": 0,
"values": [
{
"timestamp": "2022-01-01T00:00:00Z",
"value": 5
},
{
"timestamp": "2022-01-01T01:00:00Z",
"value": 10
}
]
}
}
}
}
},
"responses": {
"200": {
"description": "Returns true if the update was successful, otherwise false.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Timeseries/GetValues": {
"post": {
"tags": [
"Timeseries"
],
"description": "Gets timeseries values by ID with an offset specified in the request. \n\n\nTimeseries in ATLAS ETRM follow a date from convention where the date from is inclusive and the date to is exclusive. \nThis means that in an hourly timeseries the value in timestamp 2022-01-01 00:00:00 refers to the time period between 2022-01-01 00:00:00 and 2022-01-01 01:00:00.\nThe timezone property in the request body refers to the timezone of the requested date-range and response timeseries.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.DateRangeTimeseriesExternalRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"dateFrom": "2022-01-01T00:00:00",
"dateTo": "2022-01-02T00:00:00",
"id": 1,
"timezone": 0,
"fill": false,
"openLeft": false,
"openRight": true
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.DateRangeTimeseriesExternalRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"dateFrom": "2022-01-01T00:00:00",
"dateTo": "2022-01-02T00:00:00",
"id": 1,
"timezone": 0,
"fill": false,
"openLeft": false,
"openRight": true
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.DateRangeTimeseriesExternalRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"example": {
"data": {
"dateFrom": "2022-01-01T00:00:00",
"dateTo": "2022-01-02T00:00:00",
"id": 1,
"timezone": 0,
"fill": false,
"openLeft": false,
"openRight": true
}
}
}
}
},
"responses": {
"200": {
"description": "Returns timeseries data including potential null values if no data exists for the specified range.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesOffsetValue, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesOffsetValue, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesOffsetValue, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Timeseries/Delete": {
"post": {
"tags": [
"Timeseries"
],
"description": "Updates an existing timeseries with the provided timeseries information.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.DeleteIdsRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.DeleteIdsRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.DeleteIdsRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"204": {
"description": "Indicates that the update was successfully executed, no content to return."
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Timeseries/PostFormula": {
"post": {
"tags": [
"Timeseries"
],
"description": "Creates, fully replaces, or partially patches math-editor formulas — one call, mixed batch.\nEach item is EXACTLY ONE of:\n\n\n\"entity\": a full formula record — id 0/omitted creates a new formula-based timeseries; an\nexisting id FULLY REPLACES its definition (every field you don't include is cleared, not\nleft as-is) and recalculates the underlying timeseries values.\n\n\n\"patch\": { id, operations } — partially updates an EXISTING formula via a single RFC 6902\nJSON Patch document. operations[0] MUST be a \"test\" on \"/modified\" (the optimistic\nconcurrency check, enforced server-side) using the modified value you last read for that\nformula. \"/id\" and \"/formulaId\" cannot be targeted by anything else. If the record was\nchanged since that test value, the ENTIRE call is rejected (no item in the batch is\nwritten) and the response's Data field carries the CURRENT stored record(s) for the\nconflicting patch item(s) instead of your intended change.\n\n\nNote: \"id\" here is the TIMESERIES id the formula produces, not an internal formula id.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"entity": {
"id": 0,
"formulaId": 0,
"name": "<>",
"comments": null,
"formula": "<>",
"unitOfMeasure": "MW",
"type": "Quantity",
"decimals": 0,
"calculateNulls": false,
"modified": null
},
"patch": null
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"entity": {
"id": 0,
"formulaId": 0,
"name": "<>",
"comments": null,
"formula": "<>",
"unitOfMeasure": "MW",
"type": "Quantity",
"decimals": 0,
"calculateNulls": false,
"modified": null
},
"patch": null
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
{
"entity": {
"id": 0,
"formulaId": 0,
"name": "<>",
"comments": null,
"formula": "<>",
"unitOfMeasure": "MW",
"type": "Quantity",
"decimals": 0,
"calculateNulls": false,
"modified": null
},
"patch": null
}
]
}
}
}
},
"responses": {
"200": {
"description": "The saved formula record(s), or the current conflicting records and Success=false on conflict.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Timeseries/GetFormulaByTimeseriesId": {
"post": {
"tags": [
"Timeseries"
],
"description": "Retrieves the formula associated with a specific timeseries ID.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "Returns the formula associated with the specified timeseries ID.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Timeseries ID not found or has no underlying formula.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/Timeseries/MathEditorTemplate/GetByIds": {
"post": {
"tags": [
"Timeseries"
],
"description": "Retrieves math editor templates by a list of IDs. Pass an empty list to return all templates.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "Returns the math editor templates matching the requested IDs.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/TimeseriesCollection/GetTimeseriesCollectionByIds": {
"post": {
"tags": [
"TimeseriesCollection"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/TimeseriesCollection/PostTimeseriesCollection": {
"post": {
"tags": [
"TimeseriesCollection"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/TimeseriesCollection/DeleteTimeseriesCollection": {
"post": {
"tags": [
"TimeseriesCollection"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/GetContracts": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns the continuous-market products available from Bidding, including delivery start and end, trading phase, and contract state. Use the contract ID in XBID market-data, analysis, draft, and order operations.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDContractsQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDContractsQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDContractsQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDContractDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDContractDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDContractDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/GetATC": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns available transmission capacity used when assessing whether an XBID position can be traded across connected areas.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/PublicTradesByContractId": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns the market's published executions for one delivery contract. Use this trade tape to analyse recent traded prices and volumes; it does not contain the user's private orders.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDTradeListItemDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDTradeListItemDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDTradeListItemDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/BestBidOfferCurveByContractId": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns the current buy and sell price levels for one delivery contract. Use it to analyse available liquidity and the spread before choosing an order price.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferCurveDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferCurveDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferCurveDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/GetHistoricalPublicTrades": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns stored public trades for the requested contract, delivery, or execution-time range. These are market-wide executions, not the user's private orders or fills.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradesQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradesQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradesQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradeHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradeHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradeHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/GetHistoricalBestBidOfferSnapshots": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns stored best-bid-offer snapshots. Set DepthLevels to return only the requested number of buy and sell levels per snapshot.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalDataQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalDataQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalDataQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferSnapshotDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferSnapshotDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferSnapshotDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/GetSuggestedOrderByContractId": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Builds an order suggestion for an entity and contract from the entity forecast, market schedule, and quantities already submitted. A null recommendation means the available inputs do not currently justify an order; it is not an exchange rejection.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderRequestDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderRequestDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderRequestDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderResponseDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderResponseDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderResponseDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/PostOrders": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Validates and sends the supplied orders to the continuous exchange immediately. A single order is submitted independently; multiple orders are grouped into baskets by entity and market party using the requested basket execution type. Use SaveDraftOrders when exchange submission is not yet intended.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrdersRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrdersRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrdersRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/SaveDraftOrders": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Creates or updates internal XBID orders in To Be Approved status without sending them to the exchange. The response contains the persisted orders needed for later retrieval, editing, or submission.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/CancelOrdersByXBIDOrderId": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Requests exchange cancellation for one XBID order and records the resulting status. The input is the XBID order ID returned by the XBID endpoints, not the generic orderItemId.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": 1
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/CancelOrdersByXBIDOrderIds": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Requests exchange cancellation for multiple XBID orders in one call. This is suitable for cancelling an algorithm's active order book during shutdown.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"example": {
"data": [
1,
2,
3
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiResponse"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/GetOrdersByContractId": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns submitted and draft orders associated with one XBID delivery contract, including execution, cancellation, and remaining-volume information.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/GetCurrentOrders": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns submitted and draft XBID orders whose delivery starts today or tomorrow in the configured XBID trading timezone. Use GetOrdersByContractId for a specific contract outside that rolling view.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/GetHistoricalOrders": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns all XBID orders, optionally limited to one entity, across a UTC contract delivery-start range, including execution and cancellation information.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalOrdersQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalOrdersQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalOrdersQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/api/XBID/SpotMarketPricesByContractId": {
"post": {
"tags": [
"Bidding XBID"
],
"description": "Returns Spot auction prices whose delivery period overlaps the selected XBID contract. Use them as reference prices when analysing or pricing a continuous-market order.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.ApiRequest`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSpotMarketPriceDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSpotMarketPriceDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSpotMarketPriceDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"400": {
"description": "Bad request - The request contains malformed data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Bad or expired token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions to access the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Helpers.WebAPI.Documentation.ApiErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
}
},
"components": {
"schemas": {
"Atlas.SDK.Bidding.Models.Configuration.SpotMarketInfo": {
"type": "object",
"properties": {
"defaultExchange": {
"$ref": "#/components/schemas/Helpers.Enumerations.Exchange"
},
"defaultExchangeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"hybridOrdersName": {
"type": "string",
"nullable": true
},
"hybridOrdersEnabled": {
"type": "boolean"
},
"blockOrdersName": {
"type": "string",
"nullable": true
},
"blockOrdersEnabled": {
"type": "boolean"
},
"energyOffersQuantitiesAdded": {
"type": "boolean"
},
"maxHybridSteps": {
"type": "integer",
"format": "int32"
},
"maxBlocksPerEntity": {
"type": "integer",
"format": "int32"
},
"blockOrdersExclusiveGroupsEnabled": {
"type": "boolean"
},
"blockOrdersCircularGroupsEnabled": {
"type": "boolean"
},
"supportedGranularities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Enumerations.GranularityEnum"
},
"nullable": true
},
"xbidHistoricalDeliveryAreaId": {
"type": "string",
"nullable": true
},
"xbidHistoricalRetentionMonths": {
"type": "integer",
"format": "int32"
},
"defaultQuantityUnit": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"defaultQuantityUnitName": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Enum.OrderItemStatus": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18
],
"type": "integer",
"description": "1=To Be Approved, 2=Scheduled, 3=Submitted, 4=Rejected, 5=Revoked, 6=Cancelled, 7=Cleared, 8=Partially Cleared, 9=Deleted, 10=Not Cleared, 11=Not Released, 12=Inactive, 13=Pending Approval, 14=Unconfirmed, 15=Transit, 16=Pending XBID Activation, 17=Pending XBID Hibernation, 18=Pending XBID Basket",
"format": "int32"
},
"Atlas.SDK.Bidding.Models.Enum.OrderTypeEnum": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
],
"type": "integer",
"description": "1=Hybrid/Stepwise, 2=Block, 3=RR Bid, 4=RR Nomination, 5=XBID Regular, 6=XBID Block, 7=XBID Iceberg, 8=Forward Contract Nomination, 9=Physical Delivery/Offtake Nomination, 10=RES Injection Forecast",
"format": "int32"
},
"Atlas.SDK.Bidding.Models.Enum.PositionCloseAlgoEvaluationStatus": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"description": "1=Within tolerance, 2=Blocked: gate closure, 3=Blocked: price limit, 4=No liquidity, 5=Submitted, 6=Discarded: inputs changed, 7=Submission failed, 8=Blocked: position cap",
"format": "int32"
},
"Atlas.SDK.Bidding.Models.Enum.SpotOrderType": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=Hybrid, 2=Block, 3=XBID",
"format": "int32"
},
"Atlas.SDK.Bidding.Models.ForwardMarket.MarketPartyInfoDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"counterPartyId": {
"type": "integer",
"format": "int32"
},
"eic": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.BlockOrderDetailDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"quantity": {
"type": "number",
"format": "double"
},
"timestampFrom": {
"type": "string",
"format": "date-time"
},
"timestampTo": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.BlockOrderDto": {
"type": "object",
"properties": {
"customBlockOrderId": {
"type": "integer",
"format": "int32"
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityKindEnum"
},
"price": {
"type": "number",
"format": "double"
},
"mar": {
"type": "number",
"format": "double"
},
"exclusiveGroup": {
"type": "integer",
"format": "int32",
"nullable": true
},
"linkedOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"circularGroupId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderItemId": {
"type": "integer",
"format": "int32"
},
"blockOrderDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.BlockOrderDetailDto"
},
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.BlockOrdersPostRequestBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"entityId": {
"type": "integer",
"format": "int32"
},
"marketPartyId": {
"type": "integer",
"format": "int32"
},
"market": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"maxPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"minPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.BlockOrderDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.EntityBlockOrdersDto": {
"type": "object",
"properties": {
"entityId": {
"type": "integer",
"format": "int32"
},
"entityCode": {
"type": "string",
"nullable": true
},
"entitySide": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityKindEnum"
},
"capacity": {
"type": "number",
"format": "double"
},
"minCapacity": {
"type": "number",
"format": "double"
},
"entityName": {
"type": "string",
"nullable": true
},
"dispatchDay": {
"type": "string",
"format": "date-time"
},
"market": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"marketName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"marketPartyId": {
"type": "integer",
"format": "int32"
},
"marketPartyName": {
"type": "string",
"nullable": true
},
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"periodDuration": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maxPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"minPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.BlockOrderDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.EntityCapacityHistory": {
"type": "object",
"properties": {
"validFrom": {
"type": "string",
"format": "date-time"
},
"capacity": {
"type": "number",
"format": "double"
},
"minCapacity": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.EntityDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"biddingZoneId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"biddingZoneName": {
"type": "string",
"nullable": true
},
"entityKind": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityKindEnum"
},
"entityKindName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"eic": {
"type": "string",
"nullable": true
},
"portfolioId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"portfolioName": {
"type": "string",
"nullable": true
},
"assetId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"moduleId": {
"$ref": "#/components/schemas/Helpers.Enumerations.Module"
},
"moduleName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"type": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Enumerations.AssetType"
},
"typeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"entityId": {
"type": "string",
"nullable": true
},
"entityName": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"isPortfolio": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"capacity": {
"type": "number",
"format": "double",
"nullable": true
},
"minCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"forecastingTimeseries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
},
"availabilityTimeseries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
},
"rrUpCap": {
"type": "number",
"format": "double",
"nullable": true
},
"rrDownCap": {
"type": "number",
"format": "double",
"nullable": true
},
"marketPartyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"marketPartyName": {
"type": "string",
"nullable": true
},
"marketPartyEIC": {
"type": "string",
"nullable": true
},
"counterpartyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"counterpartyName": {
"type": "string",
"nullable": true
},
"counterpartyEIC": {
"type": "string",
"nullable": true
},
"countryFromName": {
"type": "string",
"nullable": true
},
"countryFromEIC": {
"type": "string",
"nullable": true
},
"countryToName": {
"type": "string",
"nullable": true
},
"countryToEIC": {
"type": "string",
"nullable": true
},
"countryFromCode": {
"type": "string",
"nullable": true
},
"countryToCode": {
"type": "string",
"nullable": true
},
"areaFromId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"areaToId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"areaFromName": {
"type": "string",
"nullable": true
},
"areaFromEIC": {
"type": "string",
"nullable": true
},
"areaToName": {
"type": "string",
"nullable": true
},
"areaToEIC": {
"type": "string",
"nullable": true
},
"coupled": {
"type": "boolean",
"nullable": true
},
"submitsStepwiseOrders": {
"type": "boolean"
},
"submitsBlockOrders": {
"type": "boolean"
},
"submitsRrNominations": {
"type": "boolean"
},
"submitsForwardMarket": {
"type": "boolean"
},
"submitsResInjectionsNominations": {
"type": "boolean"
},
"granularityOverride": {
"$ref": "#/components/schemas/Helpers.Enumerations.GranularityEnum"
},
"granularityOverrideDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"entityHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.EntityHistoryDto"
},
"nullable": true
},
"entityCapacityHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.EntityCapacityHistory"
},
"nullable": true
},
"assetConnections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.PortfolioAssetConnectionDto"
},
"nullable": true
},
"positionCloseAlgoConfiguration": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.PositionCloseAlgoConfigurationDto"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.EntityHistoryDto": {
"type": "object",
"properties": {
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.HybridOrderDto": {
"type": "object",
"properties": {
"dispatchDay": {
"type": "string",
"format": "date-time"
},
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"tradingTimezone": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"periodDuration": {
"type": "integer",
"format": "int32",
"nullable": true
},
"timestampFrom": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"timestampTo": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"id": {
"type": "integer",
"format": "int32"
},
"entityId": {
"type": "integer",
"format": "int32"
},
"entityCode": {
"type": "string",
"nullable": true
},
"entitySide": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityKindEnum"
},
"capacity": {
"type": "number",
"format": "double"
},
"minCapacity": {
"type": "number",
"format": "double"
},
"availability": {
"type": "number",
"format": "double"
},
"physicalQuantity": {
"type": "number",
"format": "double"
},
"rrNomination": {
"type": "number",
"format": "double"
},
"currentMarketSchedule": {
"type": "number",
"format": "double"
},
"acceptedBlockQuantity": {
"type": "number",
"format": "double"
},
"margin": {
"type": "number",
"format": "double",
"readOnly": true
},
"entityName": {
"type": "string",
"nullable": true
},
"market": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"marketName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"marketPartyId": {
"type": "integer",
"format": "int32"
},
"marketPartyName": {
"type": "string",
"nullable": true
},
"marketPartyCode": {
"type": "string",
"nullable": true
},
"biddingStrategyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"step": {
"type": "integer",
"format": "int32"
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityKindEnum"
},
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"maxPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"minPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"expectedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"orderItemId": {
"type": "integer",
"format": "int32"
},
"version": {
"type": "integer",
"format": "int32"
},
"isDraft": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.HybridOrderPostItem": {
"type": "object",
"properties": {
"entityId": {
"type": "integer",
"format": "int32"
},
"dispatchDay": {
"type": "string",
"format": "date-time"
},
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"market": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"marketPartyId": {
"type": "integer",
"format": "int32"
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityKindEnum"
},
"step": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.HybridOrdersPostRequestBody": {
"type": "object",
"properties": {
"biddingExecutionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.HybridOrderPostItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.MarketOrderDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"dispatchDay": {
"type": "string",
"format": "date-time"
},
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"entityId": {
"type": "integer",
"format": "int32"
},
"entityName": {
"type": "string",
"nullable": true
},
"entitySide": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityKindEnum"
},
"capacity": {
"type": "number",
"format": "double"
},
"minCapacity": {
"type": "number",
"format": "double"
},
"entityEIC": {
"type": "string",
"nullable": true
},
"marketPartyId": {
"type": "integer",
"format": "int32"
},
"marketPartyName": {
"type": "string",
"nullable": true
},
"marketPartyEIC": {
"type": "string",
"nullable": true
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityKindEnum"
},
"sideName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderType": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Enum.OrderTypeEnum"
},
"orderTypeName": {
"type": "string",
"nullable": true
},
"market": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"marketName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"version": {
"type": "integer",
"format": "int32",
"nullable": true
},
"exchangeId": {
"type": "integer",
"format": "int32"
},
"exchangeName": {
"type": "string",
"nullable": true
},
"auctionIdentification": {
"type": "string",
"nullable": true
},
"minPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"maxPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"executedPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"weightedAveragePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"minQuantity": {
"type": "number",
"format": "double"
},
"maxQuantity": {
"type": "number",
"format": "double"
},
"quantity": {
"type": "number",
"format": "double"
},
"clearedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"canceledQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"numberOfSteps": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customBlockOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"linkedOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"exclusiveGroup": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastStatusUpdate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"biddingZoneId": {
"type": "integer",
"format": "int32"
},
"biddingZoneName": {
"type": "string",
"nullable": true
},
"biddingZoneEIC": {
"type": "string",
"nullable": true
},
"creator": {
"type": "string",
"nullable": true
},
"approver": {
"type": "string",
"nullable": true
},
"lastStatus": {
"type": "string",
"nullable": true
},
"lastStatusId": {
"type": "integer",
"format": "int32"
},
"allStatuses": {
"type": "string",
"nullable": true
},
"timestampFrom": {
"type": "string",
"format": "date-time"
},
"timestampTo": {
"type": "string",
"format": "date-time"
},
"direction": {
"$ref": "#/components/schemas/Helpers.Enumerations.Direction"
},
"directionName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"externalOrderId": {
"type": "string",
"nullable": true
},
"externalBatchId": {
"type": "string",
"nullable": true
},
"inferred": {
"type": "boolean"
},
"xbidContractId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"xbidContractName": {
"type": "string",
"nullable": true
},
"xbidOrderType": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDOrderType"
},
"xbidOrderTypeDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"xbidExecutionState": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDOrderState"
},
"xbidExecutionStateDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"xbidExecType": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDExecType"
},
"xbidExecTypeDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"xbidValidity": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDValidityRestriction"
},
"xbidValidityDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"xbidValidityDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"xbidBlockTotalContracts": {
"type": "integer",
"format": "int64",
"nullable": true
},
"xbidIcePeakPriceDelta": {
"type": "number",
"format": "double",
"nullable": true
},
"xbidIceVolumeDisplay": {
"type": "number",
"format": "double",
"nullable": true
},
"xbidTotalVolume": {
"type": "number",
"format": "double",
"nullable": true
},
"counterpartyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"counterpartyName": {
"type": "string",
"nullable": true
},
"counterpartyEIC": {
"type": "string",
"nullable": true
},
"marketAgreementId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.MarketOrderHistoryDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"orderItemId": {
"type": "integer",
"format": "int32"
},
"dateUpdated": {
"type": "string",
"format": "date-time"
},
"orderItemStatus": {
"type": "integer",
"format": "int32"
},
"orderItemStatusText": {
"type": "string",
"nullable": true
},
"user": {
"type": "string",
"nullable": true
},
"log": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.MarketPartiesBySpotOrderTypeAndDateRequest": {
"type": "object",
"properties": {
"spotOrderType": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Enum.SpotOrderType"
},
"targetDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.MarketPartyEntitySimpleDto": {
"required": [
"entityCode",
"entityId",
"entityName"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"entityId": {
"type": "string",
"nullable": true
},
"entityCode": {
"type": "string",
"nullable": true
},
"entityName": {
"type": "string",
"nullable": true
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityKindEnum"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.Spot.PortfolioAssetConnectionDto": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"format": "int32"
},
"assetName": {
"type": "string",
"nullable": true
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.PositionCloseAlgoConfigurationDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"entityId": {
"type": "integer",
"format": "int32"
},
"isEnabled": {
"type": "boolean"
},
"toleranceBand": {
"type": "number",
"format": "double",
"nullable": true
},
"maxBuyPriceEurMwh": {
"type": "number",
"format": "double",
"nullable": true
},
"maxBuyPriceTimeseriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maxBuyPriceTimeseriesName": {
"type": "string",
"nullable": true
},
"minSellPriceEurMwh": {
"type": "number",
"format": "double",
"nullable": true
},
"minSellPriceTimeseriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minSellPriceTimeseriesName": {
"type": "string",
"nullable": true
},
"gateClosureBlockMinutes": {
"type": "integer",
"format": "int32",
"nullable": true
},
"exposureThreshold": {
"type": "number",
"format": "double",
"nullable": true
},
"maxOrderQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"enableForecastTrigger": {
"type": "boolean"
},
"cancelOrdersOnDisable": {
"type": "boolean"
},
"lastEvaluationAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastEvaluationStatus": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Enum.PositionCloseAlgoEvaluationStatus"
},
"lastEvaluationStatusDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastEvaluationMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoCapItemDto": {
"type": "object",
"properties": {
"areaId": {
"type": "string",
"nullable": true
},
"inCap": {
"type": "number",
"format": "double",
"nullable": true
},
"outCap": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoDto": {
"type": "object",
"properties": {
"deliveryStart": {
"type": "string",
"format": "date-time"
},
"deliveryEnd": {
"type": "string",
"format": "date-time"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"sourceHubsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoItemDto"
},
"nullable": true
},
"messageTimestamp": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoItemDto": {
"required": [
"areaId"
],
"type": "object",
"properties": {
"areaId": {
"type": "string",
"nullable": true
},
"capacity": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoCapItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferCurveDto": {
"required": [
"buy",
"sell"
],
"type": "object",
"properties": {
"contractId": {
"type": "integer",
"format": "int64"
},
"buy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDOfferCurveItemDto"
},
"nullable": true
},
"sell": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDOfferCurveItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferSnapshotDto": {
"type": "object",
"properties": {
"contractId": {
"type": "integer",
"format": "int64"
},
"dateUpdated": {
"type": "string",
"format": "date-time"
},
"buy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDOfferCurveItemDto"
},
"nullable": true
},
"sell": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDOfferCurveItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDContractDto": {
"type": "object",
"properties": {
"contractId": {
"type": "integer",
"format": "int64"
},
"revisionNo": {
"type": "integer",
"format": "int32"
},
"product": {
"type": "string",
"nullable": true
},
"productRevisionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"longName": {
"type": "string",
"nullable": true
},
"deliveryStart": {
"type": "string",
"format": "date-time"
},
"deliveryStartCET": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"deliveryEnd": {
"type": "string",
"format": "date-time"
},
"deliveryEndCET": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"predefined": {
"type": "boolean"
},
"state": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDOrderState"
},
"stateDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"tradingPhase": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDTradingPhase"
},
"tradingPhaseDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"durationMinutes": {
"type": "number",
"format": "double"
},
"activationPoint": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expirationPoint": {
"type": "string",
"format": "date-time",
"nullable": true
},
"volumeWeightedAveragePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"priceHigh": {
"type": "number",
"format": "double",
"nullable": true
},
"priceLow": {
"type": "number",
"format": "double",
"nullable": true
},
"turnover": {
"type": "number",
"format": "double",
"nullable": true
},
"bestBuyPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"bestBuyQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"bestSellPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"bestSellQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"lastTradePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"lastTradeQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"lastTradeTimestamp": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUpdateDT": {
"type": "string",
"format": "date-time"
},
"messageTimestamp": {
"type": "string",
"format": "date-time"
},
"spotMarketPrices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDSpotMarketPriceDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDContractGranularity": {
"enum": [
15,
30,
60
],
"type": "integer",
"description": "15=QuarterHour, 30=HalfHour, 60=Hour",
"format": "int32"
},
"Atlas.SDK.Bidding.Models.XBID.XBIDContractsQueryDto": {
"type": "object",
"properties": {
"granularities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDContractGranularity"
},
"description": "Contract durations to include. Empty uses 15, 30, and 60 minutes.",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDOrderState"
},
"deliveryDateFrom": {
"type": "string",
"description": "UTC start of the delivery range.",
"format": "date-time",
"nullable": true
},
"deliveryDateTo": {
"type": "string",
"description": "UTC end of the delivery range.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalDataQueryDto": {
"type": "object",
"properties": {
"contractIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Contracts to include.",
"nullable": true
},
"deliveryDateFrom": {
"type": "string",
"description": "UTC start of the contract delivery range.",
"format": "date-time",
"nullable": true
},
"deliveryDateTo": {
"type": "string",
"description": "UTC end of the contract delivery range.",
"format": "date-time",
"nullable": true
},
"snapshotDateFrom": {
"type": "string",
"description": "UTC start of the snapshot change range.",
"format": "date-time",
"nullable": true
},
"snapshotDateTo": {
"type": "string",
"description": "UTC end of the snapshot change range.",
"format": "date-time",
"nullable": true
},
"depthLevels": {
"type": "integer",
"description": "Maximum buy and sell levels per snapshot.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalOrdersQueryDto": {
"type": "object",
"properties": {
"entityId": {
"type": "integer",
"description": "Optional entity that owns the XBID orders.",
"format": "int32",
"nullable": true
},
"deliveryDateFrom": {
"type": "string",
"description": "UTC start of the contract delivery-start range.",
"format": "date-time",
"nullable": true
},
"deliveryDateTo": {
"type": "string",
"description": "UTC end of the contract delivery-start range.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDOfferCurveItemDto": {
"type": "object",
"properties": {
"price": {
"type": "number",
"format": "double"
},
"quantity": {
"type": "number",
"format": "double"
},
"orderCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"entityId": {
"type": "integer",
"format": "int32"
},
"entityCode": {
"type": "string",
"nullable": true
},
"marketPartyId": {
"type": "integer",
"format": "int32"
},
"marketPartyName": {
"type": "string",
"nullable": true
},
"marketPartyCode": {
"type": "string",
"nullable": true
},
"contractId": {
"type": "integer",
"format": "int32"
},
"orderType": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDOrderType"
},
"orderTypeDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"executionState": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDOrderState"
},
"executionStateDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"execType": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDExecType"
},
"execTypeDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"validity": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDValidityRestriction"
},
"validityDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"validityDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.Side"
},
"sideDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"externalOrderId": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double"
},
"totalVolume": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double"
},
"executedPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"blockTotalContracts": {
"type": "integer",
"format": "int64",
"nullable": true
},
"icePeakPriceDelta": {
"type": "number",
"format": "double",
"nullable": true
},
"iceVolumeDisplay": {
"type": "number",
"format": "double",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
},
"orderItemId": {
"type": "integer",
"format": "int32"
},
"volumeExecuted": {
"type": "number",
"format": "double",
"nullable": true
},
"volumeCanceled": {
"type": "number",
"format": "double",
"nullable": true
},
"orderItemStatus": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Enum.OrderItemStatus"
},
"orderItemStatusDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"contractName": {
"type": "string",
"nullable": true
},
"deliveryStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"deliveryEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"log": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDOrdersRequestBody": {
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto"
},
"nullable": true
},
"executionType": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDExecutionInstruction"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradeHistoryDto": {
"type": "object",
"properties": {
"contractId": {
"type": "integer",
"format": "int64"
},
"tradeId": {
"type": "integer",
"format": "int32"
},
"state": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDOrderState"
},
"quantity": {
"type": "number",
"format": "double"
},
"price": {
"type": "number",
"format": "double"
},
"value": {
"type": "number",
"format": "double"
},
"tradeExecutedTime": {
"type": "string",
"format": "date-time"
},
"buyDeliveryAreaId": {
"type": "string",
"nullable": true
},
"sellDeliveryAreaId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradesQueryDto": {
"type": "object",
"properties": {
"deliveryDateFrom": {
"type": "string",
"description": "UTC start of the contract delivery range.",
"format": "date-time",
"nullable": true
},
"deliveryDateTo": {
"type": "string",
"description": "UTC end of the contract delivery range.",
"format": "date-time",
"nullable": true
},
"contractIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Contracts to include.",
"nullable": true
},
"tradeExecutionDateFrom": {
"type": "string",
"description": "UTC start of the trade execution range.",
"format": "date-time",
"nullable": true
},
"tradeExecutionDateTo": {
"type": "string",
"description": "UTC end of the trade execution range.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDSpotMarketPriceDto": {
"type": "object",
"properties": {
"marketId": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"marketName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDSubmittedQuantityDto": {
"type": "object",
"properties": {
"marketId": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"marketName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.Side"
},
"quantity": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderRequestDto": {
"type": "object",
"properties": {
"contractId": {
"type": "integer",
"format": "int32"
},
"entityId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderResponseDto": {
"type": "object",
"properties": {
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.Side"
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"marketSchedule": {
"type": "number",
"format": "double",
"nullable": true
},
"optimalQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"submittedQuantities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDSubmittedQuantityDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Bidding.Models.XBID.XBIDTradeListItemDto": {
"type": "object",
"properties": {
"contractId": {
"type": "integer",
"format": "int64"
},
"tradeId": {
"type": "integer",
"format": "int32"
},
"revisionNo": {
"type": "integer",
"format": "int32"
},
"state": {
"$ref": "#/components/schemas/Helpers.Enumerations.XBIDOrderState"
},
"stateDescription": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantity": {
"type": "number",
"format": "double"
},
"price": {
"type": "number",
"format": "double"
},
"value": {
"type": "number",
"format": "double"
},
"priceChange": {
"type": "number",
"format": "double",
"nullable": true
},
"priceChangePercent": {
"type": "number",
"format": "double",
"nullable": true
},
"tradeExecutedTime": {
"type": "string",
"format": "date-time"
},
"buyDeliveryAreaId": {
"type": "string",
"nullable": true
},
"sellDeliveryAreaId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.PortfolioManagement.Enumerations.OrderActivityType": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "1=Created, 2=Status changed, 3=Sent to external system, 4=External",
"format": "int32"
},
"Atlas.SDK.PortfolioManagement.Models.EntitySearchByNameLikeRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"entityType": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityTypeMCP"
},
"limit": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Atlas.SDK.PortfolioManagement.Models.Ui.CreateDealsByClusterSingleAssetDto": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"format": "int32"
},
"dealClusterId": {
"type": "integer",
"format": "int32"
},
"masterAgreementId": {
"type": "integer",
"format": "int32"
},
"includeInSettlement": {
"type": "boolean",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"indexId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"stepsForward": {
"type": "integer",
"format": "int32"
},
"stepsBackward": {
"type": "integer",
"format": "int32"
},
"resolution": {
"$ref": "#/components/schemas/Helpers.Enumerations.Resolution"
},
"resolutionName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"timeZone": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"timeZoneName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fireDelaySeconds": {
"type": "integer",
"format": "int32",
"nullable": true
},
"resolveDelaySeconds": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdBy": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean",
"readOnly": true
},
"thresholds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.Alerts.AlertRuleThresholdDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Timeseries.Models.Alerts.AlertRuleThresholdDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"alertRuleId": {
"type": "integer",
"format": "int32"
},
"operator": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.Enums.AlertOperator"
},
"operatorName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"value": {
"type": "number",
"format": "double"
},
"criticality": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.Enums.AlertLevel"
},
"criticalityName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Timeseries.Models.Enums.AlertLevel": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "1=Low, 2=Medium, 3=High, 4=Extreme",
"format": "int32"
},
"Atlas.SDK.Timeseries.Models.Enums.AlertOperator": {
"enum": [
1,
2,
3,
4,
5
],
"type": "integer",
"description": "1=> (greater than), 2=< (less than), 3=>= (greater than or equal), 4=<= (less than or equal), 5== (equal)",
"format": "int32"
},
"Atlas.SDK.Timeseries.Models.Enums.StandingDataFieldType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"description": "1=Decimal, 2=Int, 3=Boolean, 4=Timeseries, 5=DateTime, 6=String, 7=Entity, 8=List",
"format": "int32"
},
"Atlas.SDK.Timeseries.Models.Enums.StandingDataType": {
"enum": [
1,
2,
3,
4,
5
],
"type": "integer",
"description": "1=Deal, 2=Asset, 3=Counterparty, 4=Bidding Entity, 5=Balancing Service Provider",
"format": "int32"
},
"Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateDto": {
"required": [
"formula"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"module": {
"$ref": "#/components/schemas/Helpers.Enumerations.Module"
},
"description": {
"type": "string",
"nullable": true
},
"formula": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
},
"isSimulation": {
"type": "boolean"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateInputDto"
},
"nullable": true
},
"inputRepresentation": {
"type": "string",
"nullable": true,
"readOnly": true
},
"output": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateOutputDto"
}
},
"additionalProperties": false
},
"Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateInputDto": {
"type": "object",
"properties": {
"fieldType": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.Enums.StandingDataFieldType"
},
"fieldTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"objectType": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.Enums.StandingDataType"
},
"objectTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unitOfMeasurement": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"unitOfMeasurementName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"isRequired": {
"type": "boolean"
},
"defaultValue": {
"nullable": true
}
},
"additionalProperties": false
},
"Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateOutputDto": {
"type": "object",
"properties": {
"fieldType": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.Enums.StandingDataFieldType"
},
"fieldTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"objectType": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.Enums.StandingDataType"
},
"objectTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unitOfMeasurement": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"unitOfMeasurementName": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Atlas.SDK.UserManagement.Enum.UserType": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=Member, 2=Admin, 3=IT Admin",
"format": "int32"
},
"Atlas.SDK.UserManagement.Models.ApplicationUserDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"displayName": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"passwordHash": {
"type": "string",
"nullable": true
},
"docusignUserId": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"twoFactorActivated": {
"type": "boolean"
},
"isLocked": {
"type": "boolean"
},
"failedLogins": {
"type": "integer",
"format": "int32"
},
"passwordChangeDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"locked": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastLogin": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastPasswordChange": {
"type": "string",
"format": "date-time"
},
"modified": {
"type": "string",
"format": "date-time"
},
"created": {
"type": "string",
"format": "date-time"
},
"comments": {
"type": "string",
"nullable": true
},
"concurrentDeviceLimit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isServiceAccount": {
"type": "boolean"
},
"userType": {
"$ref": "#/components/schemas/Atlas.SDK.UserManagement.Enum.UserType"
},
"userTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.UserManagement.Models.RoleDto"
},
"nullable": true
},
"rolesString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Atlas.SDK.UserManagement.Models.RoleDto": {
"required": [
"description",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isSystemic": {
"type": "boolean"
},
"entraId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BackOffice.AssetManagement.Interface.Enumerations.AssetTimeseriesTypeCategory": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17
],
"type": "integer",
"description": "1=Forecast, 2=SCADA, 3=Non-Certified, 4=Certified, 5=Theoretical, 6=Availability, 7=Dispatching KPI, 8=Dispatching Signal, 9=Dispatching Loss Factor, 10=Telecommunication Signal, 11=Curtailments, 12=Spot Market, 13=Balancing Market, 14=Climatic Data, 15=State of Charge (SoC), 16=Flexibility, 17=Cost Data",
"format": "int32"
},
"BackOffice.AssetManagement.Interface.Enumerations.AssetType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28
],
"type": "integer",
"description": "1=RES Wind, 2=RES Solar, 3=Hydro, 4=Pumping, 5=Nuclear, 6=Thermal, 7=Battery Storage, 8=DR, 9=Load, 10=Virtual Thermal, 11=Interconnection, 12=RES Hydro, 13=RES Biomass, 14=RES Cogeneration, 15=RES Portfolio, 16=Hybrid Station, 17=EV Charger, 18=LNG Terminal, 19=LNG Vessel, 20=LNG Storage, 21=Pipeline Entry Point, 22=Pipeline Exit Point, 23=Virtual Trading Point (VTP), 24=LNG Tank, 25=Regas Unit, 26=Boil-Off Gas (BOG) Unit, 27=Jetty, 28=Berth",
"format": "int32"
},
"BackOffice.AssetManagement.Interface.Enumerations.ThermalState": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0=Hot, 1=Warm, 2=Cold",
"format": "int32"
},
"BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto": {
"type": "object",
"properties": {
"sourceAssetId": {
"type": "integer",
"format": "int32"
},
"sourceAssetType": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Enumerations.AssetType"
},
"sourceAssetTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"targetAssetId": {
"type": "integer",
"format": "int32"
},
"targetAssetType": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Enumerations.AssetType"
},
"targetAssetTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"assetRelationshipTypeId": {
"type": "integer",
"format": "int32"
},
"assetRelationshipTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BackOffice.AssetManagement.Interface.Models.AssetRelationshipTypeDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"isSystemic": {
"type": "boolean"
}
},
"additionalProperties": false
},
"BackOffice.AssetManagement.Interface.Models.AssetTimeseriesDto": {
"type": "object",
"properties": {
"timeseriesId": {
"type": "integer",
"format": "int32"
},
"timeseriesName": {
"type": "string",
"nullable": true
},
"timeseriesUnitOfMeasurement": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"timeseriesUnitOfMeasurementName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"timeseriesSource": {
"type": "string",
"nullable": true
},
"timeseriesGranularity": {
"$ref": "#/components/schemas/Helpers.Enumerations.GranularityEnum"
},
"timeseriesGranularityName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"assetId": {
"type": "integer",
"format": "int32"
},
"validityOrder": {
"type": "integer",
"format": "int32"
},
"assetTimeseriesTypeId": {
"type": "integer",
"format": "int32"
},
"assetTimeseriesTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BackOffice.AssetManagement.Interface.Models.AssetTimeseriesTypeDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32",
"nullable": true
},
"includeInDeal": {
"type": "boolean",
"nullable": true
},
"assetTimeseriesTypeCategory": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Enumerations.AssetTimeseriesTypeCategory"
},
"assetTimeseriesTypeCategoryName": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"BackOffice.AssetManagement.Interface.Models.TechnoeconomicInfoDto": {
"type": "object",
"properties": {
"validFrom": {
"type": "string",
"format": "date-time"
},
"capacity": {
"type": "number",
"format": "double",
"nullable": true
},
"minCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"licensedCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"installedCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"isContracted": {
"type": "boolean",
"nullable": true
},
"isDispatchable": {
"type": "boolean",
"nullable": true
},
"cerTimeseriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"carTimeseriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rampUpAGC": {
"type": "number",
"format": "double",
"nullable": true
},
"rampDownAGC": {
"type": "number",
"format": "double",
"nullable": true
},
"expectedRampUpAGC": {
"type": "number",
"format": "double",
"nullable": true
},
"expectedRampDownAGC": {
"type": "number",
"format": "double",
"nullable": true
},
"coldStartupCost": {
"type": "number",
"format": "double",
"nullable": true
},
"warmStartupCost": {
"type": "number",
"format": "double",
"nullable": true
},
"hotStartupCost": {
"type": "number",
"format": "double",
"nullable": true
},
"shutdownCost": {
"type": "number",
"format": "double",
"nullable": true
},
"fcrUpCap": {
"type": "number",
"format": "double",
"nullable": true
},
"fcrDownCap": {
"type": "number",
"format": "double",
"nullable": true
},
"afrrUpCap": {
"type": "number",
"format": "double",
"nullable": true
},
"afrrDownCap": {
"type": "number",
"format": "double",
"nullable": true
},
"mfrrUpCap": {
"type": "number",
"format": "double",
"nullable": true
},
"mfrrDownCap": {
"type": "number",
"format": "double",
"nullable": true
},
"rrUpCap": {
"type": "number",
"format": "double",
"nullable": true
},
"rrDownCap": {
"type": "number",
"format": "double",
"nullable": true
},
"fcrUpMaxPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"fcrDownMaxPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"afrrUpMaxPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"afrrDownMaxPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"mfrrUpMaxPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"mfrrDownMaxPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"rrUpMaxPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"rrDownMaxPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"minUpTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minDownTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"chargingEfficiency": {
"type": "number",
"format": "double",
"nullable": true
},
"dischargingEfficiency": {
"type": "number",
"format": "double",
"nullable": true
},
"maxStoredEnergy": {
"type": "number",
"format": "double",
"nullable": true
},
"minStoredEnergy": {
"type": "number",
"format": "double",
"nullable": true
},
"storageCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"maxLimitedEnergyFlag": {
"type": "boolean"
},
"maxDailyEnergy": {
"type": "number",
"format": "double",
"nullable": true
},
"minLimitedEnergyFlag": {
"type": "boolean"
},
"minDailyEnergy": {
"type": "number",
"format": "double",
"nullable": true
},
"batteryManagementSystemPowerConsumption": {
"type": "number",
"format": "double",
"nullable": true
},
"hvacBaselinePower": {
"type": "number",
"format": "double",
"nullable": true
},
"auxiliarySystemsPower": {
"type": "number",
"format": "double",
"nullable": true
},
"safetySystemsStandbyPower": {
"type": "number",
"format": "double",
"nullable": true
},
"pcsStandbyLosses": {
"type": "number",
"format": "double",
"nullable": true
},
"transformerNoLoadLosses": {
"type": "number",
"format": "double",
"nullable": true
},
"referenceCop": {
"type": "number",
"format": "double",
"nullable": true
},
"copDegradationCoefficient": {
"type": "number",
"format": "double",
"nullable": true
},
"referenceTemperature": {
"type": "number",
"format": "double",
"nullable": true
},
"coolingActivationTemperature": {
"type": "number",
"format": "double",
"nullable": true
},
"containerThermalTransmittance": {
"type": "number",
"format": "double",
"nullable": true
},
"totalContainerSurfaceArea": {
"type": "number",
"format": "double",
"nullable": true
},
"batteryRoundTripEfficiency": {
"type": "number",
"format": "double",
"nullable": true
},
"pcsLossCoefficient0": {
"type": "number",
"format": "double",
"nullable": true
},
"pcsLossCoefficient1": {
"type": "number",
"format": "double",
"nullable": true
},
"pcsLossCoefficient2": {
"type": "number",
"format": "double",
"nullable": true
},
"totalPcsCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"transformerCopperLosses": {
"type": "number",
"format": "double",
"nullable": true
},
"transformerRating": {
"type": "number",
"format": "double",
"nullable": true
},
"solarHeatGain": {
"type": "number",
"format": "double",
"nullable": true
},
"solarAbsorptivity": {
"type": "number",
"format": "double",
"nullable": true
},
"hvacSetpointTemperature": {
"type": "number",
"format": "double",
"nullable": true
},
"totalFixedLosses": {
"type": "number",
"format": "double",
"nullable": true
},
"minUpChargingTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minUpDischargingTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minDownChargingTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minDownDischargingTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minRestingTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"bessDischargePower": {
"type": "number",
"format": "double",
"nullable": true
},
"bessChargePower": {
"type": "number",
"format": "double",
"nullable": true
},
"maximumDepthOfDischarge": {
"type": "number",
"format": "double",
"nullable": true
},
"selfDischargeRatePerMonth": {
"type": "number",
"format": "double",
"nullable": true
},
"maxCyclesPerDay": {
"type": "number",
"format": "double",
"nullable": true
},
"tariff": {
"type": "number",
"format": "double",
"nullable": true
},
"rampUp": {
"type": "number",
"format": "double",
"nullable": true
},
"rampDown": {
"type": "number",
"format": "double",
"nullable": true
},
"agcMax": {
"type": "number",
"format": "double",
"nullable": true
},
"agcMin": {
"type": "number",
"format": "double",
"nullable": true
},
"heatRateA": {
"type": "number",
"format": "double",
"nullable": true
},
"heatRateB": {
"type": "number",
"format": "double",
"nullable": true
},
"heatRateC": {
"type": "number",
"format": "double",
"nullable": true
},
"mustRunWeight": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cO2Emissions": {
"type": "number",
"format": "double",
"nullable": true
},
"fuelLowerHeatingValue": {
"type": "number",
"format": "double",
"nullable": true
},
"carbonContent": {
"type": "number",
"format": "double",
"nullable": true
},
"cO2TonneCoefficientA": {
"type": "number",
"format": "double",
"nullable": true
},
"cO2TonneCoefficientB": {
"type": "number",
"format": "double",
"nullable": true
},
"cO2TonneCoefficientC": {
"type": "number",
"format": "double",
"nullable": true
},
"syncTimeHot": {
"type": "integer",
"format": "int32",
"nullable": true
},
"syncTimeWarm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"syncTimeCold": {
"type": "integer",
"format": "int32",
"nullable": true
},
"soakTimeHot": {
"type": "integer",
"format": "int32",
"nullable": true
},
"soakTimeWarm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"soakTimeCold": {
"type": "integer",
"format": "int32",
"nullable": true
},
"desyncTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"idleTimeHotToWarm": {
"type": "integer",
"format": "int32",
"nullable": true
},
"idleTimeWarmToCold": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maintenanceAddVarCost": {
"type": "number",
"format": "double",
"nullable": true
},
"humanResAddVarCost": {
"type": "number",
"format": "double",
"nullable": true
},
"improvementAddVarCost": {
"type": "number",
"format": "double",
"nullable": true
},
"thermalSoakFunctions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Models.ThermalSoakFunctionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"BackOffice.AssetManagement.Interface.Models.ThermalSoakFunctionDto": {
"type": "object",
"properties": {
"thermalState": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Enumerations.ThermalState"
},
"steps": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.CategoryItemDto": {
"type": "object",
"properties": {
"entityType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.CategoryResultsDto": {
"type": "object",
"properties": {
"categoryId": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"sign": {
"type": "string",
"description": "+ for sell entities, - for buy entities",
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.EntityPeriodValues": {
"type": "object",
"properties": {
"entityId": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.EntityTypeAndDateBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"type": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesDto": {
"type": "object",
"properties": {
"entityId": {
"type": "integer",
"format": "int32"
},
"entityName": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityPeriodValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.EntityWithCategoryValuesDto": {
"type": "object",
"properties": {
"entityId": {
"type": "integer",
"format": "int32"
},
"entityName": {
"type": "string",
"nullable": true
},
"categoryId": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue": {
"type": "object",
"properties": {
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.ZonePeriodValues": {
"type": "object",
"properties": {
"zoneId": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesDto": {
"type": "object",
"properties": {
"zoneName": {
"type": "string",
"nullable": true
},
"zoneId": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesMarketPayload": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.ZonePeriodValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrderDto": {
"type": "object",
"properties": {
"entityId": {
"type": "integer",
"format": "int32"
},
"entityName": {
"type": "string",
"nullable": true
},
"entityType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"upperPriceCap": {
"type": "number",
"format": "double"
},
"lowerPriceCap": {
"type": "number",
"format": "double"
},
"zoneId": {
"type": "integer",
"format": "int32"
},
"zoneName": {
"type": "string",
"nullable": true
},
"pMax": {
"type": "number",
"format": "double"
},
"pMin": {
"type": "number",
"format": "double"
},
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrderMasterDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrderMasterDto": {
"type": "object",
"properties": {
"blockId": {
"type": "integer",
"format": "int32"
},
"linkedOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"exclusiveGroupId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mar": {
"type": "number",
"format": "double"
},
"price": {
"type": "number",
"format": "double"
},
"detail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrdersPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"scenarioId": {
"type": "integer",
"format": "int32"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrderDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.CBlockOrderScenarioDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"scenarioList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"nullable": true
},
"selectedScenario": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrderDto"
},
"nullable": true
},
"categoryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.CategoryItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.CHybridOfferScenarioDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"scenarioList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"nullable": true
},
"selectedScenario": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.HybridOfferDto"
},
"nullable": true
},
"categoryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.CategoryItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.CLoadForecastDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"scenarioList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"nullable": true
},
"selectedScenario": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.CorridorPeriodValues": {
"type": "object",
"properties": {
"corridorId": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesDto": {
"type": "object",
"properties": {
"corridorId": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"corridorName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesMarketPayload": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.CorridorPeriodValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.HybridOfferDto": {
"type": "object",
"properties": {
"entityId": {
"type": "integer",
"format": "int32"
},
"entityName": {
"type": "string",
"nullable": true
},
"entityType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"upperPriceCap": {
"type": "number",
"format": "double"
},
"lowerPriceCap": {
"type": "number",
"format": "double"
},
"zoneId": {
"type": "integer",
"format": "int32"
},
"zoneName": {
"type": "string",
"nullable": true
},
"pMax": {
"type": "number",
"format": "double"
},
"pMin": {
"type": "number",
"format": "double"
},
"offers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.HybridOfferPeriodValue"
},
"nullable": true
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.Side"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.HybridOfferPeriodValue": {
"type": "object",
"properties": {
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double"
},
"availability": {
"type": "number",
"format": "double"
},
"rrNomination": {
"type": "number",
"format": "double"
},
"physicalNomination": {
"type": "number",
"format": "double"
},
"damMargin": {
"type": "number",
"format": "double"
},
"block": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.HybridOffersPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"scenarioId": {
"type": "integer",
"format": "int32"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.HybridOfferDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportPeriodValues": {
"type": "object",
"properties": {
"importExportId": {
"type": "integer",
"format": "int32"
},
"interconnectionId": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"importExportId": {
"type": "integer",
"format": "int32"
},
"importExportName": {
"type": "string",
"nullable": true
},
"interconnectionId": {
"type": "integer",
"format": "int32"
},
"interconnectionName": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesMarketPayload": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportPeriodValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionPeriodValues": {
"type": "object",
"properties": {
"interconnectionId": {
"type": "integer",
"format": "int32"
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.Side"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionValuesDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"side": {
"$ref": "#/components/schemas/Helpers.Enumerations.Side"
},
"interconnectionId": {
"type": "integer",
"format": "int32"
},
"interconnectionName": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionValuesMarketPayload": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionValuesDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionsPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionPeriodValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.DAM.LoadForecastPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"scenarioId": {
"type": "integer",
"format": "int32"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.ZonePeriodValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Enum.GenericConstraintTypeEnum": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=INTERV_EQ, 2=INTERV_GE, 3=INTERV_LE",
"format": "int32"
},
"EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CForwardMarketContractDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"categoryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
},
"unitData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityWithCategoryValuesDto"
},
"nullable": true
},
"published": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.CategoryResultsDto"
},
"nullable": true
},
"current": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.CategoryResultsDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CRRAwardsDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ForwardMarket.RRAwardDto"
},
"nullable": true
},
"categoryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.CategoryItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ForwardMarket.ForwardMarketContractsPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"type": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityPeriodValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ForwardMarket.RRAwardDto": {
"type": "object",
"properties": {
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"entityId": {
"type": "integer",
"format": "int32"
},
"entityName": {
"type": "string",
"nullable": true
},
"entityType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"value": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ForwardMarket.RRAwardsPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ForwardMarket.RRAwardDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.BalancingEnergyOfferDto": {
"type": "object",
"properties": {
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double"
},
"entityId": {
"type": "integer",
"format": "int32"
},
"entityName": {
"type": "string",
"nullable": true
},
"entityType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"zoneId": {
"type": "integer",
"format": "int32"
},
"zoneName": {
"type": "string",
"nullable": true
},
"direction": {
"$ref": "#/components/schemas/Helpers.Enumerations.Direction"
},
"block": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.BalancingEnergyOffersPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"scenarioId": {
"type": "integer",
"format": "int32"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.BalancingEnergyOfferDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.CBalancingEnergyOfferScenarioDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"scenarioList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"nullable": true
},
"selectedScenario": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.BalancingEnergyOfferDto"
},
"nullable": true
},
"categoryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.CategoryItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.GenericConstraintDto"
},
"nullable": true
},
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
},
"constraintTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"scenarioList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"nullable": true
},
"selectedScenario": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.IniConditionsDto"
},
"nullable": true
},
"startupTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.CReserveOfferDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date-time"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ReserveOfferDto"
},
"nullable": true
},
"categoryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.CategoryItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.GenericConstraintDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Enum.GenericConstraintTypeEnum"
},
"entityIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"timeStart": {
"type": "string",
"format": "date-time"
},
"timeEnd": {
"type": "string",
"format": "date-time"
},
"enforce": {
"type": "boolean"
},
"powerCoeff": {
"type": "number",
"format": "double"
},
"fcrUpCoeff": {
"type": "number",
"format": "double"
},
"fcrDownCoeff": {
"type": "number",
"format": "double"
},
"afrrUpCoeff": {
"type": "number",
"format": "double"
},
"afrrDownCoeff": {
"type": "number",
"format": "double"
},
"mfrrUpCoeff": {
"type": "number",
"format": "double"
},
"mfrrDownCoeff": {
"type": "number",
"format": "double"
},
"rrUpCoeff": {
"type": "number",
"format": "double"
},
"rrDownCoeff": {
"type": "number",
"format": "double"
},
"limit": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementDetailDto": {
"type": "object",
"properties": {
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"loadForecast": {
"type": "number",
"format": "double",
"nullable": true
},
"demandMarketSchedule": {
"type": "number",
"format": "double",
"nullable": true
},
"resForecast": {
"type": "number",
"format": "double",
"nullable": true
},
"resMarketSchedule": {
"type": "number",
"format": "double",
"nullable": true
},
"unitsCommissioningSchedules": {
"type": "number",
"format": "double",
"nullable": true
},
"unitsCommissioningMarketSchedules": {
"type": "number",
"format": "double",
"nullable": true
},
"zonalLossesForecast": {
"type": "number",
"format": "double",
"nullable": true
},
"zonalLossesMarketSchedule": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementDto": {
"type": "object",
"properties": {
"zoneId": {
"type": "integer",
"format": "int32"
},
"zoneName": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementDetailDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"scenarioId": {
"type": "integer",
"format": "int32"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.IniConditionsDto": {
"type": "object",
"properties": {
"entityId": {
"type": "integer",
"format": "int32"
},
"entityName": {
"type": "string",
"nullable": true
},
"powerOutput": {
"type": "number",
"format": "double"
},
"operatingTime": {
"type": "integer",
"format": "int32"
},
"desyncState": {
"type": "boolean",
"nullable": true
},
"startupType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.ThermalState"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.ReserveOfferDto": {
"type": "object",
"properties": {
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double"
},
"entityId": {
"type": "integer",
"format": "int32"
},
"entityName": {
"type": "string",
"nullable": true
},
"entityType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"zoneId": {
"type": "integer",
"format": "int32"
},
"zoneName": {
"type": "string",
"nullable": true
},
"direction": {
"$ref": "#/components/schemas/Helpers.Enumerations.Direction"
},
"block": {
"type": "integer",
"format": "int32"
},
"reserveType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomReserveType"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.ReserveOffersPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ReserveOfferDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.ZonalReservePostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReservePeriodValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReservePeriodValues": {
"type": "object",
"properties": {
"zoneId": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
},
"reserveTypeId": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomReserveType"
},
"directionId": {
"$ref": "#/components/schemas/Helpers.Enumerations.Direction"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReserveValuesDto": {
"type": "object",
"properties": {
"zoneName": {
"type": "string",
"nullable": true
},
"zoneId": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.PeriodValue"
},
"nullable": true
},
"reserveTypeId": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomReserveType"
},
"directionId": {
"$ref": "#/components/schemas/Helpers.Enumerations.Direction"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReserveValuesMarketPayload": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReserveValuesDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.MarketResults.CEntityMarketResultsDto": {
"type": "object",
"properties": {
"minDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"maxDispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestep": {
"type": "integer",
"format": "int32"
},
"categoryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
},
"unitData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityWithCategoryValuesDto"
},
"nullable": true
},
"categoryResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.CategoryResultsDto"
},
"nullable": true
},
"selectedCategory": {
"type": "integer",
"format": "int32",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsGetBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"market": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"type": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsPostBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"market": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"type": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityPeriodValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody": {
"required": [
"scenarioName"
],
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"scenarioName": {
"type": "string",
"nullable": true
},
"basedOnId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto": {
"type": "object",
"properties": {
"scenarioId": {
"type": "integer",
"format": "int32"
},
"scenarioName": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"scenarioId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.StandingData.CorridorStandingDataDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"interconnectionIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.StandingData.EntityStandingDataDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"entityType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType"
},
"zoneId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"zoneName": {
"type": "string",
"nullable": true
},
"capacity": {
"type": "number",
"format": "double",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.StandingData.InterconnectionStandingDataDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fromZoneId": {
"type": "integer",
"format": "int32"
},
"fromZoneName": {
"type": "string",
"nullable": true
},
"toZoneId": {
"type": "integer",
"format": "int32"
},
"toZoneName": {
"type": "string",
"nullable": true
},
"capacity": {
"type": "number",
"format": "double",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ATLASi.StandingData.ZoneStandingDataDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.AssetManagement.AssetDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The asset's unique identifier. Use 0 for new assets.",
"format": "int32"
},
"name": {
"type": "string",
"description": "The friendly name of the asset.",
"nullable": true
},
"code": {
"type": "string",
"description": "A unique code (e.g. plant code) for this asset.",
"nullable": true
},
"externalId": {
"type": "string",
"description": "The source system ID of the asset.",
"nullable": true
},
"parseExternally": {
"type": "boolean",
"description": "If true, the asset's metadata are derived from the ExternalBaseUrl interface"
},
"externalBaseUrl": {
"type": "string",
"description": "The base URL of the external system that provides the asset's metadata. Needed only if ParseExternally is true.",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Enumerations.AssetType"
},
"typeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"location": {
"type": "string",
"description": "The asset's location friendly name, if available.",
"nullable": true
},
"longitude": {
"type": "number",
"description": "The asset's location longitude, if available.",
"format": "double",
"nullable": true
},
"latitude": {
"type": "number",
"description": "The asset's location latitude, if available.",
"format": "double",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"technoeconomicInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Models.TechnoeconomicInfoDto"
},
"description": "The asset's technoeconomic information with its history, using ValidFrom",
"nullable": true
},
"assetTimeseries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Models.AssetTimeseriesDto"
},
"description": "The asset's timeseries data for all available timeseries types (e.g. consumption/production, forecasts etc.).",
"nullable": true
},
"customFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CustomFieldValueDto"
},
"description": "The asset's custom field values.",
"nullable": true
},
"assetRelationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto"
},
"description": "The asset's relationships to other assets, including the type of relationship and the target asset.",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.AssetManagement.AssetEndRepresentationDto": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"description": "The asset's unique identifier. If this id is pass the External Id will not be used.",
"format": "int32",
"nullable": true
},
"externalId": {
"type": "string",
"description": "The source system ID of the asset. This is used to identify the asset in external systems. This Id will be used only if AssetId is empty or 0.",
"nullable": true
},
"assetEndRepresentationDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.AssetManagement.AssetStartRepresentationDto": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"description": "The asset's unique identifier. If this id is pass the External Id will not be used.",
"format": "int32",
"nullable": true
},
"externalId": {
"type": "string",
"description": "The source system ID of the asset. This is used to identify the asset in external systems. This Id will be used only if AssetId is empty or 0.",
"nullable": true
},
"assetStartRepresentationDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto": {
"type": "object",
"properties": {
"timeseriesId": {
"type": "integer",
"format": "int32"
},
"assetId": {
"type": "integer",
"format": "int32"
},
"validityOrder": {
"type": "integer",
"format": "int32"
},
"assetTimeseriesTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionDeleteDto": {
"type": "object",
"properties": {
"timeseriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"assetId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.CounterPartyCreationDto": {
"required": [
"legalName"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"legalName": {
"type": "string",
"description": "The legal name of the counterparty.",
"nullable": true
},
"shortName": {
"type": "string",
"description": "The short name of the counterparty, a user friendly name for the counterparty.",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"zipCode": {
"type": "string",
"nullable": true
},
"countryId": {
"$ref": "#/components/schemas/Helpers.Enumerations.Country"
},
"phone": {
"type": "string",
"nullable": true
},
"vat": {
"type": "string",
"nullable": true
},
"glAccount": {
"type": "string",
"nullable": true
},
"taxOffice": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT/BIC code of the counterparty when the counterparty is of type Credit Institution.",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"eic": {
"type": "string",
"nullable": true
},
"registryAccount": {
"type": "string",
"nullable": true
},
"selfBilling": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.SelfBillingTypeEnum"
},
"creditShortTermRating": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.CreditShortTermRatingEnum"
},
"creditLongTermRating": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.CreditLongTermRatingEnum"
},
"counterPartyTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyTypeIds"
},
"description": "The types of the counterparty.",
"nullable": true
},
"customFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CustomFieldValueDto"
},
"description": "The custom field values for the counterparty.",
"nullable": true
},
"counterPartyTimeseries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesDto"
},
"description": "Timeseries connections for the counterparty.",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.CounterPartyDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"legalName": {
"type": "string",
"nullable": true
},
"shortName": {
"type": "string",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"zipCode": {
"type": "string",
"nullable": true
},
"countryId": {
"$ref": "#/components/schemas/Helpers.Enumerations.Country"
},
"country": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"vat": {
"type": "string",
"nullable": true
},
"glAccount": {
"type": "string",
"nullable": true
},
"taxOffice": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"swiftBic": {
"type": "string",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"eic": {
"type": "string",
"nullable": true
},
"selfBilling": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.SelfBillingTypeEnum"
},
"selfBillingName": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"creditShortTermRating": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.CreditShortTermRatingEnum"
},
"creditShortTermRatingName": {
"type": "string",
"nullable": true
},
"creditLongTermRating": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.CreditLongTermRatingEnum"
},
"creditLongTermRatingName": {
"type": "string",
"nullable": true
},
"numberOfLinkedDocuments": {
"type": "integer",
"format": "int32",
"nullable": true
},
"registryAccount": {
"type": "string",
"nullable": true
},
"counterPartyTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
},
"counterPartyTimeseries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesDto"
},
"nullable": true
},
"customFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CustomFieldValueDto"
},
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto": {
"type": "object",
"properties": {
"timeseriesId": {
"type": "integer",
"format": "int32"
},
"counterPartyId": {
"type": "integer",
"format": "int32"
},
"validityOrder": {
"type": "integer",
"format": "int32"
},
"counterPartyTimeseriesTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionDeleteDto": {
"type": "object",
"properties": {
"timeseriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"counterPartyId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesDto": {
"type": "object",
"properties": {
"timeseriesId": {
"type": "integer",
"format": "int32"
},
"timeseriesName": {
"type": "string",
"nullable": true
},
"timeseriesUnitOfMeasurement": {
"type": "integer",
"format": "int32",
"nullable": true
},
"timeseriesUnitOfMeasurementName": {
"type": "string",
"nullable": true
},
"timeseriesSource": {
"type": "string",
"nullable": true
},
"timeseriesGranularity": {
"type": "integer",
"format": "int32",
"nullable": true
},
"timeseriesGranularityName": {
"type": "string",
"nullable": true
},
"counterPartyId": {
"type": "integer",
"format": "int32"
},
"validityOrder": {
"type": "integer",
"format": "int32"
},
"counterPartyTimeseriesTypeId": {
"type": "integer",
"format": "int32"
},
"counterPartyTimeseriesTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32",
"nullable": true
},
"counterPartyTimeseriesTypeCategory": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.CounterPartyTimeseriesTypeCategory"
},
"counterPartyTimeseriesTypeCategoryName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.CounterPartyTypeIds": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Helpers.Enumerations.CounterPartyType"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.CustomFieldValueDto": {
"required": [
"customFieldId",
"customFieldName",
"customFieldType"
],
"type": "object",
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"customFieldName": {
"type": "string",
"nullable": true
},
"customFieldType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.CustomFieldType"
},
"validFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.EntityCustomFieldMassUpdateDto": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"customField": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CustomFieldValueDto"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.Enums.CounterPartyTimeseriesTypeCategory": {
"enum": [
1
],
"type": "integer",
"description": "1=General",
"format": "int32"
},
"EtrmApiGateway.DTOs.BackOffice.Enums.CreditLongTermRatingEnum": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26
],
"type": "integer",
"description": "0=Not Rated, 1=D, 2=C-, 3=C, 4=C+, 5=CC-, 6=CC, 7=CC+, 8=CCC-, 9=CCC, 10=CCC+, 11=B-, 12=B, 13=B+, 14=BB-, 15=BB, 16=BB+, 17=BBB-, 18=BBB, 19=BBB+, 20=A-, 21=A, 22=A+, 23=AA-, 24=AA, 25=AA+, 26=AAA",
"format": "int32"
},
"EtrmApiGateway.DTOs.BackOffice.Enums.CreditShortTermRatingEnum": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "0=Not Rated, 1=C, 2=B, 3=A-3, 4=A-2, 5=A-1, 6=A-1+",
"format": "int32"
},
"EtrmApiGateway.DTOs.BackOffice.Enums.CustomFieldType": {
"enum": [
1,
2,
3,
4,
5,
6,
10,
11
],
"type": "integer",
"description": "1=Text, value format -> 'text', 2=Integer, value format -> '1', 3=Decimal, value format -> '1.0', 4=Date, value format -> '2021-01-01', 5=Date Time, value format -> '2021-01-01T00:00:00', 6=Boolean, value format -> 'true' or 'false', 10=Single Option, value format -> '[{\\\"id\\\":1,\\\"name\\\":\\\"Option 1\\\"}]', 11=Multiple Options, value format -> '[{\\\"id\\\":1,\\\"name\\\":\\\"Option 1\\\"}, {\\\"id\\\":2,\\\"name\\\":\\\"Option 2\\\"}]'",
"format": "int32"
},
"EtrmApiGateway.DTOs.BackOffice.Enums.MasterAgreementStatus": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "1=Pending, 2=In Progress, 3=Active, 4=Terminated",
"format": "int32"
},
"EtrmApiGateway.DTOs.BackOffice.Enums.MasterAgreementStatusCategory": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "1=Draft, 2=Active, 3=Ongoing, 4=Terminated",
"format": "int32"
},
"EtrmApiGateway.DTOs.BackOffice.Enums.SelfBillingTypeEnum": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=Pending, 2=No, 3=Yes",
"format": "int32"
},
"EtrmApiGateway.DTOs.BackOffice.FeeDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"kind": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.FeeKind"
},
"kindName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vat": {
"type": "number",
"format": "double"
},
"brokerFee": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.InvoiceDto": {
"required": [
"amount"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"orderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"invoiceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isPaid": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"masterAgreementId": {
"type": "integer",
"format": "int32"
},
"assetId": {
"type": "integer",
"format": "int32"
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"masterAgreementId": {
"type": "integer",
"format": "int32"
},
"assetId": {
"type": "integer",
"format": "int32"
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"customFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CustomFieldValueDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlag": {
"type": "object",
"properties": {
"masterAgreementAssetConnections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto"
},
"nullable": true
},
"updateFromConnection": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlagDto": {
"type": "object",
"properties": {
"masterAgreementAssetConnections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto"
},
"nullable": true
},
"updateFromConnection": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"counterPartyId": {
"type": "integer",
"format": "int32"
},
"counterPartyName": {
"type": "string",
"nullable": true
},
"masterAgreementStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"statusName": {
"type": "string",
"nullable": true
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.MasterAgreementStatus"
}
],
"description": "⚠️ **DEPRECATED**: Use MasterAgreementStatusId property instead. This property will be removed in two months.",
"deprecated": true
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"memo": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"numberOfLinkedDocuments": {
"type": "integer",
"format": "int32",
"nullable": true
},
"masterAgreementTypeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"customFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CustomFieldValueDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.MasterAgreementStatusDocumentConnectionDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"masterAgreementStatusId": {
"type": "integer",
"format": "int32"
},
"masterAgreementActionTypeId": {
"type": "integer",
"format": "int32"
},
"masterAgreementActionTypeName": {
"type": "string",
"nullable": true
},
"documentStatus": {
"$ref": "#/components/schemas/Helpers.Enumerations.DocumentStatus"
},
"documentStatusName": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.MasterAgreementStatusDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"statusCategory": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.MasterAgreementStatusCategory"
},
"statusCategoryName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"color": {
"type": "string",
"nullable": true
},
"default": {
"type": "boolean"
},
"documentConnections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementStatusDocumentConnectionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderActivityDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"orderId": {
"type": "integer",
"format": "int32"
},
"activityType": {
"type": "integer",
"format": "int32"
},
"activityTypeName": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"systemName": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderActivityLogRequestDto": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"activityType": {
"$ref": "#/components/schemas/Atlas.SDK.PortfolioManagement.Enumerations.OrderActivityType"
},
"message": {
"type": "string",
"nullable": true
},
"systemName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderByInvoiceIdDto": {
"type": "object",
"properties": {
"invoiceId": {
"type": "integer",
"format": "int32"
},
"order": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderDto"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderCreationDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"orderKind": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderKind"
},
"status": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderStatusDto"
},
"orderTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"registrationDate": {
"type": "string",
"format": "date-time"
},
"dueDate": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time"
},
"totalAmount": {
"type": "number",
"format": "double"
},
"commodityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentDate": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time"
},
"erpCode": {
"type": "string",
"nullable": true
},
"contractCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"orderKind": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderKind"
},
"orderKindName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"status": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderStatusDto"
},
"orderTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderTypeName": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"registrationDate": {
"type": "string",
"format": "date-time"
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"totalAmount": {
"type": "number",
"format": "double"
},
"commodityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"commodityName": {
"type": "string",
"nullable": true
},
"counterPartyName": {
"type": "string",
"nullable": true
},
"counterPartyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentDate": {
"type": "string",
"format": "date-time"
},
"erpCode": {
"type": "string",
"nullable": true
},
"contractCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderItemByInvoiceIdDto": {
"type": "object",
"properties": {
"invoiceId": {
"type": "integer",
"format": "int32"
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderItemCreationDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"dealTimeZone": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"counterPartyId": {
"type": "integer",
"format": "int32"
},
"masterAgreementSelfBilling": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.SelfBillingTypeEnum"
},
"masterAgreementSelfBillingName": {
"type": "string",
"nullable": true
},
"iban": {
"type": "string",
"nullable": true
},
"glAccount": {
"type": "string",
"nullable": true
},
"dealIbanBankSwift": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderItemStatus"
},
"cashflow": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderCashflow"
},
"startCompensation": {
"type": "string",
"format": "date-time"
},
"endCompensation": {
"type": "string",
"format": "date-time"
},
"notional": {
"type": "number",
"format": "double",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"mtm": {
"type": "number",
"format": "double",
"nullable": true
},
"pl": {
"type": "number",
"format": "double",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"amountAfterVat": {
"type": "number",
"format": "double",
"nullable": true
},
"vat": {
"type": "number",
"format": "double",
"nullable": true
},
"averagePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"paymentDate": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time"
},
"reference": {
"type": "string",
"nullable": true
},
"createdTime": {
"type": "string",
"format": "date-time"
},
"settlementOrder": {
"type": "integer",
"format": "int32"
},
"balancing": {
"type": "boolean"
},
"netAmount": {
"type": "number",
"format": "double",
"readOnly": true
},
"paidAmount": {
"type": "number",
"format": "double"
},
"balance": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"vatCalculationOption": {
"$ref": "#/components/schemas/Helpers.Enumerations.VatCalculationOption"
},
"dealIsSoftDeleted": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderItemDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"dealId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assetId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"dealTimeZone": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"counterPartyId": {
"type": "integer",
"format": "int32"
},
"masterAgreementSelfBilling": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.SelfBillingTypeEnum"
},
"masterAgreementSelfBillingName": {
"type": "string",
"nullable": true
},
"iban": {
"type": "string",
"nullable": true
},
"glAccount": {
"type": "string",
"nullable": true
},
"dealIbanBankSwift": {
"type": "string",
"nullable": true
},
"info": {
"type": "string",
"nullable": true
},
"feeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderItemStatus"
},
"statusName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"cashflow": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderCashflow"
},
"cashflowName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"startCompensation": {
"type": "string",
"format": "date-time"
},
"endCompensation": {
"type": "string",
"format": "date-time"
},
"notional": {
"type": "number",
"format": "double",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"mtm": {
"type": "number",
"format": "double",
"nullable": true
},
"pl": {
"type": "number",
"format": "double",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"amountAfterVat": {
"type": "number",
"format": "double",
"nullable": true
},
"vat": {
"type": "number",
"format": "double",
"nullable": true
},
"averagePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"paymentDate": {
"type": "string",
"format": "date-time"
},
"reference": {
"type": "string",
"nullable": true
},
"createdTime": {
"type": "string",
"format": "date-time"
},
"settlementOrder": {
"type": "integer",
"format": "int32"
},
"balancing": {
"type": "boolean"
},
"netAmount": {
"type": "number",
"format": "double",
"readOnly": true
},
"paidAmount": {
"type": "number",
"format": "double"
},
"balance": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"vatCalculationOption": {
"$ref": "#/components/schemas/Helpers.Enumerations.VatCalculationOption"
},
"vatCalculationOptionName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dealIsSoftDeleted": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderStatusDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"statusCategory": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderStatusCategory"
},
"statusCategoryName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"color": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.OrderTypeDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"shortName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.PaymentCreationDto": {
"required": [
"amount"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"orderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"paymentDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.PaymentDto": {
"required": [
"amount"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"orderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"paymentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.PaymentTermsCreationDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"settlementPeriod": {
"$ref": "#/components/schemas/Helpers.Enumerations.GranularityEnum"
},
"settlementPeriodName": {
"type": "string",
"nullable": true
},
"offsetPeriod": {
"type": "integer",
"format": "int32"
},
"offsetDays": {
"type": "integer",
"format": "int32"
},
"dayType": {
"$ref": "#/components/schemas/Helpers.Enumerations.DayType"
},
"dayTypeName": {
"type": "string",
"nullable": true
},
"reference": {
"$ref": "#/components/schemas/Helpers.Enumerations.ReferenceType"
},
"referenceName": {
"type": "string",
"nullable": true
},
"decimalPoints": {
"type": "integer",
"format": "int32"
},
"memo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.BackOffice.PaymentTermsDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"settlementPeriod": {
"$ref": "#/components/schemas/Helpers.Enumerations.GranularityEnum"
},
"settlementPeriodName": {
"type": "string",
"nullable": true
},
"offsetPeriod": {
"type": "integer",
"format": "int32"
},
"offsetDays": {
"type": "integer",
"format": "int32"
},
"dayType": {
"$ref": "#/components/schemas/Helpers.Enumerations.DayType"
},
"dayTypeName": {
"type": "string",
"nullable": true
},
"reference": {
"$ref": "#/components/schemas/Helpers.Enumerations.ReferenceType"
},
"referenceName": {
"type": "string",
"nullable": true
},
"decimalPoints": {
"type": "integer",
"format": "int32"
},
"memo": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Bidding.DateRangeBody": {
"type": "object",
"properties": {
"dateStart": {
"type": "string",
"description": "First dispatch day to include.",
"format": "date-time"
},
"dateEnd": {
"type": "string",
"description": "Last dispatch day to include.",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataDto": {
"type": "object",
"properties": {
"dispatchDay": {
"type": "string",
"format": "date-time"
},
"dispatchPeriod": {
"type": "integer",
"format": "int32"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataRequest": {
"type": "object",
"properties": {
"market": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"targetDate": {
"type": "string",
"description": "Dispatch day whose periods are required.",
"format": "date-time"
},
"useOfferStep": {
"type": "boolean",
"description": "When true, use the market's offer-step granularity."
},
"entityId": {
"type": "integer",
"description": "Optional entity ID. When supplied, entity-specific granularity is applied.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Bidding.MarketGateInfoDto": {
"type": "object",
"properties": {
"marketId": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"marketName": {
"type": "string",
"nullable": true
},
"gateOpen": {
"type": "string",
"format": "date-time"
},
"gateClose": {
"type": "string",
"format": "date-time"
},
"isOpen": {
"type": "boolean"
},
"referencePeriodStart": {
"type": "string",
"format": "date-time"
},
"referencePeriodEnd": {
"type": "string",
"format": "date-time"
},
"gateTimeZone": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"tradingTimeZone": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Bidding.SpotMarketRequest": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Dispatch day for which orders or entities are requested.",
"format": "date-time"
},
"market": {
"$ref": "#/components/schemas/Helpers.Enumerations.MarketEnum"
},
"marketPartyId": {
"type": "integer",
"description": "Market party ID returned by GetMarketPartiesBySpotOrderTypeAndDate.",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.CounterPartyCustomFieldTypeDependencyDto": {
"type": "object",
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"customFieldName": {
"type": "string",
"nullable": true
},
"counterPartyTypeId": {
"$ref": "#/components/schemas/Helpers.Enumerations.CounterPartyType"
},
"counterPartyTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.CustomFieldDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.Enums.CustomFieldType"
},
"typeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"required": {
"type": "boolean"
},
"defaultValue": {
"type": "string",
"nullable": true
},
"isTimeSliced": {
"type": "boolean"
},
"timeZoneInfo": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"timeZoneInfoName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"parseExternally": {
"type": "boolean",
"nullable": true
},
"externalEndpoint": {
"type": "string",
"nullable": true
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.CustomFields.CustomFieldOptionsDto"
},
"nullable": true
},
"masterAgreementCustomFieldTypeDependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.CustomFields.MasterAgreementCustomFieldTypeDependencyDto"
},
"nullable": true
},
"assetCustomFieldTypeDependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.CustomFields.AssetTypeCustomFieldDependencyDto"
},
"nullable": true
},
"counterPartyCustomFieldTypeDependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.CounterPartyCustomFieldTypeDependencyDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.CustomFields.AssetTypeCustomFieldDependencyDto": {
"type": "object",
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"customFieldName": {
"type": "string",
"nullable": true
},
"assetTypeId": {
"type": "integer",
"format": "int32"
},
"assetTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.CustomFields.CustomFieldOptionsDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"customFieldName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.CustomFields.MasterAgreementCustomFieldTypeDependencyDto": {
"type": "object",
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"customFieldName": {
"type": "string",
"nullable": true
},
"masterAgreementTypeId": {
"type": "integer",
"format": "int32"
},
"masterAgreementTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Dataroom.Enum.DataroomEntityType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
1001,
1002
],
"type": "integer",
"description": "1=Thermal, 2=Hydro, 3=VirtualThermal, 4=VirtualHydro, 5=RES, 6=Pumping, 7=RESPortfolios, 8=DemandEntities, 1001=Imports, 1002=Exports",
"format": "int32"
},
"EtrmApiGateway.DTOs.Dataroom.Enum.DataroomReserveType": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "1=mFRR, 2=aFRR, 3=FCR, 4=RR",
"format": "int32"
},
"EtrmApiGateway.DTOs.Dataroom.Enum.ThermalState": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=Cold, 2=Warm, 3=Hot",
"format": "int32"
},
"EtrmApiGateway.DTOs.DateRangeRequestDto": {
"type": "object",
"properties": {
"dateFrom": {
"type": "string",
"format": "date-time"
},
"dateTo": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.DocumentManager.CheckDocumentResponseDto": {
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityType"
},
"entityId": {
"type": "string",
"nullable": true
},
"hasDocument": {
"type": "boolean"
},
"numberOfLinkedDocuments": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.DocumentManager.CheckDocumentsRequestDto": {
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityType"
},
"entityIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.DocumentManager.DocumentDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"externalUrl": {
"type": "string",
"nullable": true
},
"documentSource": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentSourceDisplay": {
"type": "string",
"nullable": true,
"readOnly": true
},
"documentStatus": {
"$ref": "#/components/schemas/Helpers.Enumerations.DocumentStatus"
},
"documentStatusDisplay": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fileVersion": {
"type": "integer",
"format": "int32"
},
"fileName": {
"type": "string",
"nullable": true
},
"fileExtension": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int32"
},
"fileSizeDisplay": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"uniqueId": {
"type": "string",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"folderYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"folderMonth": {
"type": "integer",
"format": "int32",
"nullable": true
},
"folderDay": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"documentEntityType": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityType"
},
"documentEntityTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"module": {
"$ref": "#/components/schemas/Helpers.Enumerations.Module"
},
"moduleName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"entityId": {
"type": "string",
"nullable": true
},
"keywords": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
},
"documentVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DocumentManager.DocumentVersionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.DocumentManager.DocumentTypeDto": {
"type": "object",
"properties": {
"documentEntityType": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityType"
},
"entityId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.DocumentManager.DocumentVersionDto": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
},
"fileVersion": {
"type": "integer",
"format": "int32"
},
"fileName": {
"type": "string",
"nullable": true
},
"fileExtension": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int32"
},
"storageName": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.DocumentManager.UpdateDocumentStatusByExternalIdDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.DocumentManager.VersionRequestDto": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
},
"fileVersion": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"description": "Target asset identifier in ATLAS ETRM.",
"format": "int32"
},
"timestamp": {
"type": "string",
"description": "Timestamp for the measured data point.",
"format": "date-time"
},
"kind": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Ems.EmsMeasurementKind"
},
"value": {
"type": "number",
"description": "Measured numeric value for this data point.",
"format": "double"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Ems.EmsMeasurementKind": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"type": "integer",
"description": "1=Active power or energy measurement (in kW). Send positive values for production and negative values for consumption., 2=State of charge for storage assets in percentage. Send values between 0 and 1, where 1 means 100%., 3=Availability signal or available capacity for the asset in kW. Send values between 0 and the maximum capacity of the asset., 4=Curtailment flag. Send 0 or 1 values., 5=Telecommunication signal flag. Send 0 or 1 values., 6=State of health for storage assets in percentage. Send values between 0 and 1, where 1 means 100%., 7=Realtime availability factor. Send values between 0 and 1, where 1 means 100%., 8=Reactive power control value in kVAR., 9=Cos phi / power factor control value. Send values between -1 and 1, where 1 means full capacitive, -1 means full inductive and 0 means no reactive power., 10=Active Power Setpoint in kW., 11=Active Power Setpoint Feedback in kW.",
"format": "int32"
},
"EtrmApiGateway.DTOs.Forecasting.Enum.ScalarMeasurementType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"type": "integer",
"description": "1=WI-WD-ST, 2=SU-WE-ST, 3=WI-WE-ST, 4=SU-WD-ST, 5=SU-WD-EC, 6=WI-WD-EC, 7=SU-WE-EC, 8=WI-WE-EC, 9=24H-EXP, 10=PROD, 11=TOTAL",
"format": "int32"
},
"EtrmApiGateway.DTOs.Forecasting.ScalarMeasurementDto": {
"required": [
"customerId",
"customerName",
"measurementTypeName",
"sequence"
],
"type": "object",
"properties": {
"customerName": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "string",
"nullable": true
},
"loadConsumerId": {
"type": "integer",
"format": "int32"
},
"startDateTime": {
"type": "string",
"format": "date-time"
},
"endDateTime": {
"type": "string",
"format": "date-time"
},
"startMeasurement": {
"type": "number",
"format": "double"
},
"endMeasurement": {
"type": "number",
"format": "double"
},
"quantity": {
"type": "number",
"format": "double",
"readOnly": true
},
"measurementType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Forecasting.Enum.ScalarMeasurementType"
},
"measurementTypeName": {
"type": "string",
"nullable": true
},
"sequence": {
"type": "string",
"nullable": true
},
"badgeNumber": {
"type": "string",
"nullable": true
},
"serialNumber": {
"type": "string",
"nullable": true
},
"sqi": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"format": "date-time"
},
"externalId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.InvoiceCreationDto": {
"required": [
"amount"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"orderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"invoiceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isPaid": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PagingDto": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"offset": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PatchRequestDto": {
"required": [
"id",
"operations"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"operations": { }
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.BookApiDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"folderId": {
"type": "integer",
"format": "int32"
},
"memo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.BusinessUnitApiDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32"
},
"memo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.CompanyApiDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"counterPartyId": {
"type": "integer",
"format": "int32"
},
"memo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto": {
"required": [
"commodity",
"counterPartyId",
"dealClass",
"dealDelivery",
"dealDirection",
"dealStatus",
"priceType",
"timeZoneInfo",
"validFrom",
"validTo"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"dealClass": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealClass"
},
"commodity": {
"$ref": "#/components/schemas/Helpers.Enumerations.Commodity"
},
"dealDirection": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealDirection"
},
"dealStatus": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealStatus"
},
"dealDelivery": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealDelivery"
},
"timeZoneInfo": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"companyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"businessUnitId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"bookId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"folderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"portfolioId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"counterPartyId": {
"type": "integer",
"format": "int32"
},
"validFrom": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time"
},
"validTo": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time"
},
"profiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealProfileRequestDto"
},
"nullable": true
},
"totalQuantity": {
"type": "number",
"description": "This is a parameter to declare the total quantity in MWh of the Deal that corresponds to the whole delivery range of the Deal.
This property should be left blank in most cases since it is calculated by the system. Only when we need to override the system's calculation, we should provide a value.",
"format": "double",
"nullable": true
},
"priceType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.PriceType"
},
"currency": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"legs1": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealPriceRequestDto"
},
"description": "The prices of the Deal.
These are the prices that the ETRM users provide for the different periods that they are valid.",
"nullable": true
},
"mtmDataseriesId": {
"type": "integer",
"description": "The MtM (Mark-to-Market) data series of the Deal.",
"format": "int32",
"nullable": true
},
"transactionTime": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time",
"nullable": true
},
"exchangeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"traderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"masterAgreementId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"includedInSettlement": {
"type": "boolean"
},
"calendar": {
"$ref": "#/components/schemas/Helpers.Enumerations.Calendar"
},
"ibanId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"vatLevel": {
"type": "number",
"format": "double",
"nullable": true
},
"deliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"consumptionStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"consumptionEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"productionEntityExternalId": {
"type": "string",
"nullable": true
},
"consumptionEntityExternalId": {
"type": "string",
"nullable": true
},
"technology": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntsoeProductionCategories"
},
"country": {
"$ref": "#/components/schemas/Helpers.Enumerations.Country"
},
"counterPartyRegistryAccount": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"dealClusterId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"dealTemplateId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"linkedDeals": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "The linked Deal Ids of the Deal.",
"nullable": true
},
"memo": {
"type": "string",
"nullable": true
},
"memo2": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto": {
"required": [
"commodity",
"counterPartyId",
"dealClass",
"dealDelivery",
"dealDirection",
"granularityId",
"name",
"priceType",
"validFrom",
"validTo"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"dealClass": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealClass"
},
"dealClassName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"commodity": {
"$ref": "#/components/schemas/Helpers.Enumerations.Commodity"
},
"commodityName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dealDirection": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealDirection"
},
"dealDirectionName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dealStatus": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealStatus"
},
"dealStatusName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"dealDelivery": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealDelivery"
},
"dealDeliveryName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"timeZoneInfo": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"timeZoneInfoName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"companyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"businessUnitId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"bookId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"folderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"portfolioId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assetId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"counterPartyId": {
"type": "integer",
"format": "int32"
},
"counterPartyName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"validFrom": {
"type": "string",
"description": "The start-date/valid-from of the Deal’s delivery date range.",
"format": "date-time"
},
"validTo": {
"type": "string",
"description": "The end-date/valid-to of the Deal’s delivery date range.",
"format": "date-time"
},
"granularityId": {
"$ref": "#/components/schemas/Helpers.Enumerations.IntervalPeriodEnum"
},
"granularityName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantity": {
"type": "number",
"description": "The quantity of the Deal.
This property refers to the quantity of the Deals profile when the Deal is forward-standard.In any other case, this property is null.",
"format": "double",
"nullable": true
},
"totalQuantity": {
"type": "number",
"description": "The total quantity of the Deal.
This property refers to the total quantity of the Deals profile. When the Deal's commodity is Power or Gas the TotalQuantity's UOM is MWh, regardless of the UOM of the Deal.",
"format": "double",
"nullable": true
},
"uom": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"uomName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"profileDataseriesId": {
"type": "integer",
"description": "The final profile timeseries of the Deal.
This is the timeseries that the ETRM is creating to represent the Deal's profile. It is a product of the multiple profiles, provided by the ETRM users, in the different periods that they are valid.",
"format": "int32",
"nullable": true
},
"profiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealProfileDto"
},
"nullable": true
},
"priceType": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.PriceType"
},
"priceTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"priceDataseriesId": {
"type": "integer",
"description": "The final price timeseries of the Deal.
This is the timeseries that the ETRM is creating to represent the Deal's price. It is a product of the multiple prices, provided by the ETRM users, in the different periods that they are valid.",
"format": "int32",
"nullable": true
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealPriceDto"
},
"description": "The prices of the Deal.
These are the prices that the ETRM users provide for the different periods that they are valid.",
"nullable": true
},
"dealMultiplier": {
"type": "number",
"description": "The currently valid multiplier of the price of the Deal.
This value is derived from the most recent valid price or the earliest available price if the deal refers to future delivery date range.",
"format": "double",
"nullable": true,
"readOnly": true
},
"dealUpfront": {
"type": "number",
"description": "The currently valid upfront of the price of the Deal.
This value is derived from the most recent valid price or the earliest available price if the deal refers to future delivery date range.",
"format": "double",
"nullable": true,
"readOnly": true
},
"dealUpfront2": {
"type": "number",
"description": "The currently valid upfront 2 of the price of the Deal.
This value is derived from the most recent valid price or the earliest available price if the deal refers to future delivery date range.",
"format": "double",
"nullable": true,
"readOnly": true
},
"mtmDataseriesId": {
"type": "integer",
"description": "The final MTM (Mark to market) timeseries of the Deal.",
"format": "int32",
"nullable": true
},
"currency": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"currencyName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"transactionTime": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time",
"nullable": true
},
"exchangeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"traderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"masterAgreementId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"masterAgreementName": {
"type": "string",
"nullable": true
},
"paymentTermsId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paymentTermsName": {
"type": "string",
"nullable": true
},
"decimalPoints": {
"type": "integer",
"format": "int32"
},
"includedInSettlement": {
"type": "boolean"
},
"settlementPeriod": {
"$ref": "#/components/schemas/Helpers.Enumerations.GranularityEnum"
},
"settlementPeriodName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"calendar": {
"$ref": "#/components/schemas/Helpers.Enumerations.Calendar"
},
"calendarName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deliveryDate": {
"type": "string",
"description": "The GO delivery date of the Deal.
This is a GO specific property. When the Deal is not a GO Deal, this property is null.",
"format": "date-time",
"nullable": true
},
"consumptionStart": {
"type": "string",
"description": "The GO consumption start time of the Deal.
This is a GO specific property. When the Deal is not a GO Deal, this property is null.",
"format": "date-time",
"nullable": true
},
"consumptionEnd": {
"type": "string",
"description": "The GO consumption end time of the Deal.
This is a GO specific property. When the Deal is not a GO Deal, this property is null.",
"format": "date-time",
"nullable": true
},
"productionEntityExternalId": {
"type": "string",
"description": "The GO production start time of the Deal.
This is a GO specific property. When the Deal is not a GO Deal, this property is null.",
"nullable": true
},
"consumptionEntityExternalId": {
"type": "string",
"description": "The GO production end time of the Deal.
This is a GO specific property. When the Deal is not a GO Deal, this property is null.",
"nullable": true
},
"technology": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntsoeProductionCategories"
},
"technologyName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"country": {
"$ref": "#/components/schemas/Helpers.Enumerations.Country"
},
"countryName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"counterPartyRegistryAccount": {
"type": "string",
"description": "The GO counter party registry account of the Deal.
This is a GO specific property. When the Deal is not a GO Deal, this property is null.",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount of the Deal.
This property is used when the Deal is an Amount Deal.",
"format": "double",
"nullable": true
},
"dealClusterId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"dealClusterName": {
"type": "string",
"nullable": true
},
"dealTemplateId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"dealTemplateName": {
"type": "string",
"nullable": true
},
"memo": {
"type": "string",
"nullable": true
},
"memo2": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealClusterRequestDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionRequestDto": {
"required": [
"dealCollectionStatusId",
"dealCollectionTypeId",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"dealCollectionTypeId": {
"type": "integer",
"format": "int32"
},
"dealCollectionStatusId": {
"type": "integer",
"format": "int32"
},
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionResponseDto": {
"required": [
"dealCollectionTypeId",
"dealIds",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"dealCollectionTypeId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"dealCollectionTypeName": {
"type": "string",
"nullable": true
},
"dealCollectionStatusId": {
"type": "integer",
"format": "int32"
},
"dealCollectionStatusName": {
"type": "string",
"nullable": true
},
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionTypeResponseDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealPriceDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"dealMultiplier": {
"type": "number",
"format": "double",
"nullable": true
},
"dealUpfront": {
"type": "number",
"format": "double"
},
"dealUpfront2": {
"type": "number",
"format": "double"
},
"priceDataseriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"priceDataseriesName": {
"type": "string",
"nullable": true
},
"dealId": {
"type": "integer",
"format": "int32"
},
"validFrom": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealPriceRequestDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"dealUpfront": {
"type": "number",
"description": "The currency of the Deal.
This property is required when the Deal's price type is Fixed.",
"format": "double"
},
"dealUpfront2": {
"type": "number",
"description": "The currency of the Deal.
This property is required when the Deal's price type is Fixed.",
"format": "double"
},
"dealMultiplier": {
"type": "number",
"description": "The DealMultiplier of the Deal's Price.
This property is not required when the Deal's price type is Fixed.",
"format": "double",
"nullable": true
},
"priceDataseriesId": {
"type": "integer",
"description": "The currency of the Deal.
This property is not required when the Deal's price type is Indexed.",
"format": "int32",
"nullable": true
},
"validFrom": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealProfileDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"timeseriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealProfile"
},
"typeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"uom": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"uomName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"granularity": {
"$ref": "#/components/schemas/Helpers.Enumerations.IntervalPeriodEnum"
},
"granularityName": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.DealProfileRequestDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"timeseriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealProfile"
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"uom": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"granularity": {
"$ref": "#/components/schemas/Helpers.Enumerations.IntervalPeriodEnum"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.EntityGetRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"entityType": {
"$ref": "#/components/schemas/Helpers.Enumerations.EntityTypeMCP"
},
"limit": {
"type": "integer",
"description": "Max entities to return. 0 = unlimited. Default 20.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Extends the SDK's Atlas.SDK.PortfolioManagement.Models.EntitySearchByNameRequest with a gateway-side\nEtrmApiGateway.DTOs.PortfolioManagement.EntityGetRequest.Limit. The SDK type (and the downstream MCPHelper endpoint) has no concept of\npaging for exact-id/name/all lookups, so the limit is applied to the response after the\nbackend call returns rather than being forwarded downstream."
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealClass": {
"enum": [
1,
3,
4,
5,
6,
11
],
"type": "integer",
"description": "1=Forward-Standard, 3=Forward-Custom, 4=Futures, 5=Swap-Standard, 6=Swap-Custom, 11=Amount",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealDelivery": {
"enum": [
1,
2
],
"type": "integer",
"description": "1=Physical, 2=Financial",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealDirection": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=Sell, 2=Buy, 3=Mixed",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealProfile": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "1=Baseload, 2=Peakload, 3=Off-peakload, 4=Custom",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealStatus": {
"enum": [
10,
20,
30,
40,
50,
60
],
"type": "integer",
"description": "10=Pending, 20=Active, 30=Approved, 40=Rejected, 50=Confirmed, 60=Terminated",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.FeeKind": {
"enum": [
1,
2
],
"type": "integer",
"description": "1=Per Unit (€/MWh), 2=Percentage of Value",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderCashflow": {
"enum": [
0,
1
],
"type": "integer",
"description": "0=Active, 1=Passive",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderItemStatus": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0=Calculated, 1=Edited, 2=In Order",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderKind": {
"enum": [
1,
2
],
"type": "integer",
"description": "1=Sale, 2=Purchase",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.OrderStatusCategory": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"description": "1=Draft, 2=Approved, 3=Forwarded to ERP, 4=ERP Processed, 5=Rejected, 6=Approved for Payment, 7=Settlement",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.Enums.PriceType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0=Fixed Price, 1=Indexed Price",
"format": "int32"
},
"EtrmApiGateway.DTOs.PortfolioManagement.FolderApiDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"businessUnitId": {
"type": "integer",
"format": "int32"
},
"memo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealClusterDto": {
"required": [
"dealIds"
],
"type": "object",
"properties": {
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"dealClusterId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealCollectionsDto": {
"type": "object",
"properties": {
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"collectionIds": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealExternalIdDto": {
"type": "object",
"properties": {
"dealId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1MultiplierDto": {
"required": [
"dealIds",
"multiplier"
],
"type": "object",
"properties": {
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"multiplier": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1UpfrontDto": {
"required": [
"dealIds",
"upfront"
],
"type": "object",
"properties": {
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"upfront": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemo2Dto": {
"required": [
"dealIds"
],
"type": "object",
"properties": {
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"memo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemoDto": {
"required": [
"dealIds"
],
"type": "object",
"properties": {
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"memo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealStatusDto": {
"required": [
"dealIds",
"dealStatus"
],
"type": "object",
"properties": {
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"dealStatus": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.DealStatus"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealValidRangeDto": {
"required": [
"dealIds"
],
"type": "object",
"properties": {
"dealIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"validFrom": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time",
"nullable": true
},
"validTo": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.ReportParameterDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The template-tag variable name as defined in the Metabase SQL query (e.g. \"start_date\").",
"nullable": true
},
"value": {
"type": "string",
"description": "The value to inject into the variable.\nDates must be formatted as yyyy-MM-dd (e.g. \"2024-01-01\").",
"nullable": true
},
"type": {
"type": "string",
"description": "Metabase parameter type. Common values:\n\"date/single\" — basic Date variable,\n\"category\" — basic Text variable,\n\"number/=\" — basic Number variable.",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Timeseries.DateRangeTimeseriesExternalRequest": {
"required": [
"dateFrom",
"dateTo",
"id",
"timezone"
],
"type": "object",
"properties": {
"dateFrom": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time"
},
"dateTo": {
"type": "string",
"description": "The date-time notation as defined by the ISO 8601 standard in the extended format without a time zone offset, represented as YYYY-MM-DDThh:mm:ss.",
"format": "date-time"
},
"id": {
"type": "integer",
"format": "int32"
},
"timezone": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"fill": {
"type": "boolean",
"description": "This boolean flag defines if the timeseries should be returned with missing values filled with nulls.
If false, the timeseries will be returned with missing timestamps in missing values.
Default value is false."
},
"openLeft": {
"type": "boolean",
"description": "This boolean flag defines if the timeseries should be returned with the left side open.
If false, the timeseries will be returned with the left side closed.
Default value is false."
},
"openRight": {
"type": "boolean",
"description": "This boolean flag defines if the timeseries should be returned with the right side open.
If false, the timeseries will be returned with the right side closed.
Default value is true."
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Timeseries.DeleteIdsRequest": {
"required": [
"ids"
],
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"formulaId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"formula": {
"type": "string",
"nullable": true
},
"unitOfMeasure": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"decimals": {
"type": "integer",
"format": "int32"
},
"calculateNulls": {
"type": "boolean"
},
"modified": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"isPublic": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"timeseries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionRequestDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"isPublic": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"timeseries": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"module": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"nullable": true
},
"granularityName": {
"type": "string",
"nullable": true
},
"granularity": {
"$ref": "#/components/schemas/Helpers.Enumerations.GranularityEnum"
},
"upsamplingName": {
"type": "string",
"nullable": true
},
"upsampling": {
"$ref": "#/components/schemas/Helpers.Enumerations.UpsampleMethod"
},
"downsamplingName": {
"type": "string",
"nullable": true
},
"downsampling": {
"$ref": "#/components/schemas/Helpers.Enumerations.DownsampleMethod"
},
"typeName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeseriesType"
},
"source": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"unit": {
"$ref": "#/components/schemas/Helpers.Enumerations.UnitOfMeasurement"
},
"isActive": {
"type": "boolean"
},
"isCalculated": {
"type": "boolean"
},
"tags": {
"type": "string",
"nullable": true
},
"contentHash": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Timeseries.TimeseriesOffsetValue": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"value": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Timeseries.TimeseriesSearchByNameRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"offset": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.Timeseries.UpdateTimeseriesExternalRequest": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"timezone": {
"$ref": "#/components/schemas/Helpers.Enumerations.TimeZoneInfoEnum"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.TimeseriesOffsetValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.AssetManagement.AssetDto"
},
"patch": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PatchRequestDto"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto"
},
"patch": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PatchRequestDto"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto"
},
"patch": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PatchRequestDto"
}
},
"additionalProperties": false
},
"EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto"
},
"patch": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PatchRequestDto"
}
},
"additionalProperties": false
},
"Helpers.Enumerations.Calendar": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
],
"type": "integer",
"description": "1=Greek, 2=German, 3=French, 4=Italian, 5=Hungarian, 6=EEX, 7=ICIS, 8=Belgian, 9=Cypriot, 10=NoHolidays",
"format": "int32"
},
"Helpers.Enumerations.Commodity": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19
],
"type": "integer",
"description": "0=Power, 1=Gas, 2=Green Certificates, 3=Interconnection Capacity, 4=Guarantees Of Origin, 5=Currencies, 6=Power Capacity (PTR), 7=Gas Capacity, 8=EUA, 9=Power Production, 10=Power Consumption, 11=Gas Consumption, 12=Oil, 13=HEAVY FUEL OIL - 1%, 14=HEAVY FUEL OIL - 0,5%, 15=GAS OIL- 0,1%, 16=EURODIESEL, 17=LNG Gas EQ, 18=Regas, 19=Transmission",
"format": "int32"
},
"Helpers.Enumerations.CounterPartyType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34
],
"type": "integer",
"description": "1=Balance Responsible Party, 2=Trade Responsible Party, 3=Storage System Operator, 4=Capacity Trader, 5=Energy Supplier, 6=Balance Group Responsible Party, 7=Customer, 8=Producer, 9=Grid Operator, 10=Distribution System Operator, 11=Consumption Responsible Party, 12=Market Operator, 13=Production Responsible Party, 14=Party Connected To Grid, 15=Information Provider, 16=System Operator, 17=Balancing Service Provider, 18=Coordination Center Operator, 19=Platform Operator, 20=Imbalance Settlement Responsible, 21=Transmission Capacity Allocator, 22=Resource Provider, 23=LNG System Operator, 24=Market Area Operator, 25=Interconnection Trade Responsible, 26=Resource Aggregator, 27=Trading Company, 28=Exchange, 29=Transmission System Operator, 30=Renewable Energy Source Producer, 31=Supply Customer, 32=Credit Institution, 33=Broker, 34=Agent",
"format": "int32"
},
"Helpers.Enumerations.Country": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
42,
43
],
"type": "integer",
"description": "1=Albania, 2=Bulgaria, 3=North Macedonia, 4=Italy, 5=Turkey, 6=Greece, 7=Hungary, 8=Serbia, 9=Romania, 10=France, 11=Slovenia, 12=Slovakia, 13=Austria, 14=Germany, 15=Czech Republic, 16=Croatia, 17=Switzerland, 18=Poland, 19=Belgium, 20=Netherlands, 21=Spain, 22=Portugal, 23=Bosnia and Herzegovina, 24=Denmark, 25=Sweden, 26=Norway, 27=Ukraine, 28=Lithuania, 29=United Kingdom, 30=Montenegro, 31=Kosovo, 32=Estonia, 33=Latvia, 34=Ireland, 35=Finland, 36=Luxembourg, 37=Iceland, 38=Cyprus, 39=Moldova, 40=Belarus, 42=Russia, 43=Georgia",
"format": "int32"
},
"Helpers.Enumerations.DayType": {
"enum": [
1,
2
],
"type": "integer",
"description": "1=Calendar Day, 2=Business Day",
"format": "int32"
},
"Helpers.Enumerations.Direction": {
"enum": [
1,
2
],
"type": "integer",
"description": "1=Up, 2=Down",
"format": "int32"
},
"Helpers.Enumerations.DocumentStatus": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"type": "integer",
"description": "1=All recipients have finished signing., 2=Opened by sender for correction; signing is paused., 3=Draft state, not sent for signing., 4=Declined by a recipient., 5=Legacy status, no longer used., 6=All recipients have viewed the envelope., 7=Notification sent to at least one recipient., 8=All recipients have signed; temporary before completed., 9=The envelope is a template., 10=Legacy status, no longer used., 11=Voided by sender or expired.",
"format": "int32"
},
"Helpers.Enumerations.DownsampleMethod": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"description": "1=Average, 2=Sum, 3=Min, 4=Max, 5=Median, 6=First, 7=Last",
"format": "int32"
},
"Helpers.Enumerations.EntityKindEnum": {
"enum": [
1,
2
],
"type": "integer",
"description": "1=Buy, 2=Sell",
"format": "int32"
},
"Helpers.Enumerations.EntityType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17
],
"type": "integer",
"description": "1=Master Agreement, 2=Master Agreement Action, 3=Company, 4=IBAN, 5=Order, 6=Order Item, 7=Deal, 8=Invoice, 9=Pledge, 10=Asset, 11=Dashboard Widget, 12=TimeSeries, 13=Math Editor Template, 14=Job, 15=Deal Limit, 16=Internal Deal Configuration, 17=Alert",
"format": "int32"
},
"Helpers.Enumerations.EntityTypeMCP": {
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "1=Deal, 2=Order, 3=Deal Cluster, 4=Counterparty, 5=Asset, 6=Master Agreement",
"format": "int32"
},
"Helpers.Enumerations.EntsoeProductionCategories": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20
],
"type": "integer",
"description": "0=Biomass, 1=Fossil Brown coal/Lignite, 2=Fossil Coal-derived gas, 3=Fossil Gas, 4=Fossil Hard coal, 5=Fossil Oil, 6=Fossil Oil shale, 7=Fossil Peat, 8=Geothermal, 9=Hydro Pumped Storage, 10=Hydro Run-of-river and poundage, 11=Hydro Water Reservoir, 12=Marine, 13=Nuclear, 14=Other renewable, 15=Solar, 16=Waste, 17=Wind Offshore, 18=Wind Onshore, 19=Other, 20=Any",
"format": "int32"
},
"Helpers.Enumerations.Exchange": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "1=Hellenic Energy Exchange, 2=Transmission System Operator Cyprus, 3=European Energy Exchange, 4=Independent Power Transmission Operator",
"format": "int32"
},
"Helpers.Enumerations.GranularityEnum": {
"enum": [
-6,
-5,
-4,
-3,
-2,
-1,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"description": "-6=50-Milliseconds, -5=1-Second, -4=20-Minute, -3=1-Minute, -2=5-Minute, -1=10-Minute, 1=Quarter-Hour, 2=Half-Hour, 3=Hour, 4=Day, 5=Month, 6=Year, 7=Week, 8=Quarter, 9=Winter, 10=Summer, 11=Gas Year, 12=Season",
"format": "int32"
},
"Helpers.Enumerations.IntervalPeriodEnum": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
],
"type": "integer",
"description": "1=Quarter-Hourly, 2=Half-Hourly, 3=Hourly, 4=Daily, 5=Weekly, 6=Monthly, 7=Quarterly, 8=Yearly, 9=Seasonal, 10=Min1, 11=Min5, 12=Min10, 13=Min20, 14=OneSec, 15=50-Milliseconds",
"format": "int32"
},
"Helpers.Enumerations.MarketEnum": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
],
"type": "integer",
"description": "1=DAM, 2=IDA1, 3=IDA2, 4=IDA3, 5=XBID, 6=RTBM, 7=ISP, 8=Forward Market OTC Registration, 9=Forward Market OTC Nomination, 10=JAO LT Nominations, 11=JAO ST Nominations, 12=SEE CAO LT Nominations, 13=SEE CAO ST Nominations",
"format": "int32"
},
"Helpers.Enumerations.Module": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27
],
"type": "integer",
"description": "1=Load Forecasting, 2=RES Forecasting, 3=Portfolio Management, 4=Data Room, 5=Curve Builder, 6=Back Office, 7=Risk Management, 8=Scheduling, 9=Job Manager, 10=System Load Forecasting, 11=Dashboards, 12=Forecasting, 13=Data Series, 14=Math Editor, 15=Client Data Import, 16=Notifications, 17=ATLASi, 18=Administration, 19=User Management, 20=Balancing Market Simulation, 21=Dispatching, 22=Reports, 23=AtlasML, 24=Document Manager, 25=Energy Management System, 26=MDMS, 27=Imbalance Forecasting",
"format": "int32"
},
"Helpers.Enumerations.ReferenceType": {
"enum": [
1,
2,
3,
4,
5
],
"type": "integer",
"description": "1=Delivery Period, 2=Transaction Day, 3=Start Delivery, 4=End Delivery, 5=Delivery Date",
"format": "int32"
},
"Helpers.Enumerations.Resolution": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"description": "1=Minutes, 2=Hours, 3=Days, 4=Weeks, 5=Quarters, 6=Years, 7=Months, 8=5 Minutes, 9=10 Minutes, 10=Quarter Hour, 11=Half Hour, 12=Seconds",
"format": "int32"
},
"Helpers.Enumerations.Side": {
"enum": [
1,
2
],
"type": "integer",
"description": "1=Buy, 2=Sell",
"format": "int32"
},
"Helpers.Enumerations.TimeZoneInfoEnum": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "0=UTC, 1=CET/CEST, 2=EET/EEST, 3=GAS",
"format": "int32"
},
"Helpers.Enumerations.TimeseriesType": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=Quantity, 2=Price, 3=Value",
"format": "int32"
},
"Helpers.Enumerations.UnitOfMeasurement": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
25,
26,
27,
28,
29,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90
],
"type": "integer",
"description": "1=Dimensionless, 2=Percentage, 3=Euro, 4=Dollar, 5=Watt, 6=Kilowatt, 7=Megawatt, 8=Gigawatt, 9=Watt-Hour, 10=Kilowatt-Hour, 11=Megawatt-Hour, 12=Gigawatt-Hour, 13=Terawatt-Hour, 14=Tonne, 15=Standard Cubic Meter, 16=Normal Cubic Meter, 17=Litre, 18=British Thermal Unit, 19=1 million British Thermal Units, 20=Barrel, 21=1 million Barrels, 22=Joule, 23=Gigajoule, 25=Euros per Killowatt-Hour, 26=Euros per Megawatt-Hour, 27=Euros per Tonne, 28=Euros per Standard Cubic Meter, 29=Euros per Normal Cubic Meter, 31=Dollars per Killowatt-Hour, 32=Dollars per Megawatt-Hour, 33=Dollars per Tonne, 34=Dollars per Standard Cubic Meter, 35=Dollars per Normal Cubic Meter, 36=Gigajoule per Megawatt-Hour, 37=Euros per Thousand Litres, 38=Gigajoule per Tonne, 39=Gigajoule per Thousand Litres, 40=Gigajoule per Normal Cubic Meter, 41=Tonne per Megawatt-Hour, 42=United States Dollars per 1 million British Thermal Units, 43=Dollars per Barrel, 44=Dollars per million Barrels, 45=KiloWatts per Second, 46=KilloWatt per Hertz, 47=Volt-Ampere Hour, 48=Volt-Ampere Reactive Hour, 49=Celsius, 50=Kelvin, 51=Knot, 52=Meters per Second, 53=Bar, 54=Pascal, 55=Degrees Wind, 56=Watt per Square Meter, 57=Euros per Megawatt, 58=Euros per Kilowatt, 59=Seconds, 60=Pound, 61=Pounds per Megawatt-Hour, 62=Pence per Therm, 63=Hertz, 64=Volt, 65=Ampere, 66=Volt-Ampere, 67=Volt-Ampere Reactive, 68=Ohm, 69=KiloOhm, 70=Litres per Minute, 71=kiloVolt-Ampere Reactive, 72=Milliseconds, 73=Square Meter, 74=Per Degree Celsius, 75=Watt per Square Meter per Kelvin, 76=Mega Volt Ampere, 77=kiloVolt-Ampere, 78=Rounds per Minute, 79=Pulses, 80=Percent Relative Humidity, 81=Yuan, 82=Romanian Leu, 83=Romanian Leu per Megawatt-Hour, 84=Romanian Leu per Killowatt-Hour, 85=Romanian Leu per Tonne, 86=Romanian Leu per Standard Cubic Meter, 87=Romanian Leu per Normal Cubic Meter, 88=Romanian Leu per Megawatt, 89=Romanian Leu per Kilowatt, 90=Romanian Leu per Thousand Litres",
"format": "int32"
},
"Helpers.Enumerations.UpsampleMethod": {
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "1=Linear, 2=Back-Fill, 3=Front-Fill, 4=Division, 5=Linear with Quadratic Programming, 6=Division with Quadratic Programming",
"format": "int32"
},
"Helpers.Enumerations.VatCalculationOption": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=Pre-VAT, 2=After-VAT, 3=VAT",
"format": "int32"
},
"Helpers.Enumerations.XBIDExecType": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "1=No restriction, 2=Fill or kill, 3=Immediate or cancel, 4=All or Nothing",
"format": "int32"
},
"Helpers.Enumerations.XBIDExecutionInstruction": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=None, 2=Linked, 3=Valid",
"format": "int32"
},
"Helpers.Enumerations.XBIDOrderState": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "0=Hibernated, 1=Active, 2=Inactive, 3=Cancelled, 4=RREQ, 5=RREJ, 6=RGRA",
"format": "int32"
},
"Helpers.Enumerations.XBIDOrderType": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "1=Regular, 2=Block, 3=Iceberg",
"format": "int32"
},
"Helpers.Enumerations.XBIDTradingPhase": {
"enum": [
1,
2
],
"type": "integer",
"description": "1=Closed, 2=Continuous",
"format": "int32"
},
"Helpers.Enumerations.XBIDValidityRestriction": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0=No restriction, 1=Good for trading, 2=Good till date",
"format": "int32"
},
"Helpers.Models.RequestEntity": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.BlockOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.BlockOrdersPostRequestBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrdersPostRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.HybridOrdersPostRequestBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.Spot.MarketPartiesBySpotOrderTypeAndDateRequest, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.MarketPartiesBySpotOrderTypeAndDateRequest"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDContractsQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDContractsQueryDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalDataQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalDataQueryDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalOrdersQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDHistoricalOrdersQueryDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrdersRequestBody, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDOrdersRequestBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradesQueryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradesQueryDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderRequestDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderRequestDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[Atlas.SDK.PortfolioManagement.Models.EntitySearchByNameLikeRequest, Atlas.SDK.PortfolioManagement, Version=1.2.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Atlas.SDK.PortfolioManagement.Models.EntitySearchByNameLikeRequest"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityTypeAndDateBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityTypeAndDateBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrdersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.BlockOrdersPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.HybridOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.HybridOffersPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionsPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.DAM.LoadForecastPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.LoadForecastPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.ForwardMarketContractsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ForwardMarket.ForwardMarketContractsPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.RRAwardsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ForwardMarket.RRAwardsPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.BalancingEnergyOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.BalancingEnergyOffersPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ImbalanceRequirementPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ReserveOffersPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ReserveOffersPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ZonalReservePostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ZonalReservePostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsGetBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.MarketResults.MarketResultsPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.NewScenarioPostBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioRequestGetBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionDeleteDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionDeleteDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionDeleteDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionDeleteDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.EntityCustomFieldMassUpdateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.EntityCustomFieldMassUpdateDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlag, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlag"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlagDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionsWithFlagDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.BackOffice.OrderActivityLogRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderActivityLogRequestDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.DateRangeBody, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Bidding.DateRangeBody"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataRequest"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Bidding.SpotMarketRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Bidding.SpotMarketRequest"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.CustomFieldDto[], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.CustomFieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.DateRangeRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DateRangeRequestDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.DocumentManager.UpdateDocumentStatusByExternalIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DocumentManager.UpdateDocumentStatusByExternalIdDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PagingDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PagingDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.EntityGetRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.EntityGetRequest"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.Enums.FeeKind, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.Enums.FeeKind"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealClusterDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealClusterDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealCollectionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealCollectionsDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1MultiplierDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1MultiplierDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1UpfrontDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealLeg1UpfrontDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemo2Dto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemo2Dto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemoDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealMemoDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealStatusDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealValidRangeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealValidRangeDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.DateRangeTimeseriesExternalRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.DateRangeTimeseriesExternalRequest"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.DeleteIdsRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.DeleteIdsRequest"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesSearchByNameRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.TimeseriesSearchByNameRequest"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[EtrmApiGateway.DTOs.Timeseries.UpdateTimeseriesExternalRequest, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.UpdateTimeseriesExternalRequest"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.EntityDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.PortfolioManagement.Models.Ui.CreateDealsByClusterSingleAssetDto, Atlas.SDK.PortfolioManagement, Version=1.2.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.PortfolioManagement.Models.Ui.CreateDealsByClusterSingleAssetDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetEndRepresentationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.AssetManagement.AssetEndRepresentationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetStartRepresentationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.AssetManagement.AssetStartRepresentationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyCreationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderCreationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderItemCreationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.PaymentCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.PaymentCreationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.PaymentTermsCreationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.CheckDocumentsRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DocumentManager.CheckDocumentsRequestDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DocumentManager.DocumentTypeDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.VersionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DocumentManager.VersionRequestDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.InvoiceCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.InvoiceCreationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealClusterRequestDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionRequestDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealExternalIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.MassiveUpdates.DealExternalIdDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionRequestDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.UpsertItem`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.ICollection`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Collections.Generic.List`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.DateOnly, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Int32[], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiRequest`1[[System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CBalancingEnergyOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.CBalancingEnergyOfferScenarioDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.CGenericConstraintsDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.CImbalanceRequirementScenarioDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.CIniConditionsDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.CReserveOfferDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.CReserveOfferDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReserveValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ISP.ZoneReserveValuesMarketPayload"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DocumentManager.DocumentDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesOffsetValue, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.TimeseriesOffsetValue"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.CustomFieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.CheckDocumentResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DocumentManager.CheckDocumentResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.DocumentManager.DocumentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.DocumentManager.DocumentDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.TimeseriesCollectionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.ICollection`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.MathEditor.MathEditorTemplateDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.UserManagement.Models.ApplicationUserDto, Atlas.SDK.UserManagement, Version=1.2.2.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.UserManagement.Models.ApplicationUserDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Ems.EmsMeasuredDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Int32, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.ApiResponse`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"warningMessage": {
"type": "string",
"nullable": true
},
"infoMessage": {
"type": "string",
"nullable": true
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiErrorResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"default": false
},
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.Configuration.SpotMarketInfo, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Configuration.SpotMarketInfo"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferCurveDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferCurveDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderResponseDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderResponseDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.EntityValuesMarketPayload"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Common.ZoneValuesMarketPayload"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CBlockOrderScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.CBlockOrderScenarioDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CHybridOfferScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.CHybridOfferScenarioDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CLoadForecastDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.CLoadForecastDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.CorridorValuesMarketPayload"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.ImportExportValuesMarketPayload"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionValuesMarketPayload, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.DAM.InterconnectionValuesMarketPayload"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CForwardMarketContractDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CForwardMarketContractDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CRRAwardsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.ForwardMarket.CRRAwardsDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[EtrmApiGateway.DTOs.ATLASi.MarketResults.CEntityMarketResultsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.MarketResults.CEntityMarketResultsDto"
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.EntityBlockOrdersDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.EntityBlockOrdersDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.HybridOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.HybridOrderDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.MarketOrderHistoryDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.Spot.MarketPartyEntitySimpleDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.MarketPartyEntitySimpleDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDATCInfoDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferSnapshotDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDBestBidOfferSnapshotDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDContractDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDContractDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDOrderDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradeHistoryDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDPublicTradeHistoryDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDSpotMarketPriceDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDSpotMarketPriceDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[Atlas.SDK.Bidding.Models.XBID.XBIDTradeListItemDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.XBID.XBIDTradeListItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.BackOffice.OrderDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.ICollection`1[[EtrmApiGateway.DTOs.CustomFieldDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.CustomFieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Bidding.Models.Spot.EntityDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.EntityDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto, Atlas.SDK.Timeseries, Version=1.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Timeseries.Models.Alerts.AlertRuleDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Atlas.SDK.UserManagement.Models.ApplicationUserDto, Atlas.SDK.UserManagement, Version=1.2.2.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.UserManagement.Models.ApplicationUserDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Models.AssetRelationshipDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetRelationshipTypeDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Models.AssetRelationshipTypeDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[BackOffice.AssetManagement.Interface.Models.AssetTimeseriesTypeDto, BackOffice.AssetManagement.Interface, Version=2.5.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackOffice.AssetManagement.Interface.Models.AssetTimeseriesTypeDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.Scenario.ScenarioDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.CorridorStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.StandingData.CorridorStandingDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.EntityStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.StandingData.EntityStandingDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.InterconnectionStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.StandingData.InterconnectionStandingDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.ATLASi.StandingData.ZoneStandingDataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.ATLASi.StandingData.ZoneStandingDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.AssetManagement.AssetDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.AssetManagement.AssetTimeseriesConnectionCreateDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesConnectionCreateDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.CounterPartyTimeseriesTypeDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.FeeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.FeeDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.InvoiceDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.InvoiceDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementAssetConnectionCreateDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.MasterAgreementStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.MasterAgreementStatusDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderActivityDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderActivityDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderByInvoiceIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderByInvoiceIdDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderCreationDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderCreationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemByInvoiceIdDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderItemByInvoiceIdDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderItemDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderStatusDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderStatusDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.OrderTypeDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.OrderTypeDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.PaymentDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.BackOffice.PaymentTermsDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.BackOffice.PaymentTermsDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BookApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.BookApiDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.BusinessUnitApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.BusinessUnitApiDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.CompanyApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.CompanyApiDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealApiRequestDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealApiResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealClusterResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionTypeResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.DealCollectionTypeResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.PortfolioManagement.FolderApiDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.PortfolioManagement.FolderApiDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.FormulaEntityExternalResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Timeseries.TimeseriesEntityExternalResponseDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.IEnumerable`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.ForwardMarket.MarketPartyInfoDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.ForwardMarket.MarketPartyInfoDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Atlas.SDK.Bidding.Models.Spot.MarketOrderDto, Atlas.SDK.Bidding, Version=2.1.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Atlas.SDK.Bidding.Models.Spot.MarketOrderDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Bidding.DispatchDayPeriodTimestampMetadataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Bidding.MarketGateInfoDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Bidding.MarketGateInfoDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[EtrmApiGateway.DTOs.Forecasting.ScalarMeasurementDto, EtrmApiGateway, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EtrmApiGateway.DTOs.Forecasting.ScalarMeasurementDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[Helpers.Models.RequestEntity, Helpers, Version=2.2.33.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Helpers.Models.RequestEntity"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.Object, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"Helpers.WebAPI.Documentation.ApiSuccessResponse`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"recordCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "JWT Authorization header using the Bearer scheme. Enter your token including the 'Bearer ' prefix (e.g. 'Bearer eyJ...').",
"name": "Authorization",
"in": "header"
},
"Basic": {
"type": "http",
"description": "Basic authentication. Credentials are Base64-encoded username:password sent in the Authorization header.",
"scheme": "basic"
}
}
},
"security": [
{ }
],
"tags": [
{
"name": "Account"
},
{
"name": "AlertRule"
},
{
"name": "Assets"
},
{
"name": "ATLASi DAM"
},
{
"name": "ATLASi Forward Market"
},
{
"name": "ATLASi ISP"
},
{
"name": "ATLASi Market Results"
},
{
"name": "ATLASi RTBEM"
},
{
"name": "ATLASi Standing Data"
},
{
"name": "Bidding Spot Entities"
},
{
"name": "Bidding Spot Orders"
},
{
"name": "Bidding Spot Reference Data"
},
{
"name": "Bidding XBID"
},
{
"name": "BiReports"
},
{
"name": "Book"
},
{
"name": "BusinessUnit"
},
{
"name": "Company"
},
{
"name": "Counterparty"
},
{
"name": "CustomFields"
},
{
"name": "Deal"
},
{
"name": "DealCluster"
},
{
"name": "DealCollection"
},
{
"name": "DocumentManager"
},
{
"name": "EmsMeasurements"
},
{
"name": "Entity"
},
{
"name": "Fee"
},
{
"name": "Folder"
},
{
"name": "Forecasting"
},
{
"name": "Invoice"
},
{
"name": "MasterAgreement"
},
{
"name": "MasterAgreementAssetConnection"
},
{
"name": "MasterData"
},
{
"name": "Order"
},
{
"name": "OrderItem"
},
{
"name": "Payment"
},
{
"name": "PaymentTerm"
},
{
"name": "Timeseries"
},
{
"name": "TimeseriesCollection"
},
{
"name": "XBID",
"description": "Bidding XBID"
}
]
}