---
title: "DCleaR - Risk Simulator API - v1"
url: "https://apiportal-qa.np.six-group.com/apis/simulator-ch-qa-v1/versions/c729661a-062a-4141-9704-f637226fa5f0"
---

# DCleaR - Risk Simulator API - v1

OpenAPI specification document.

```json
{"openapi":"3.0.2","info":{"title":"DCleaR - Risk Simulator API - v1","description":"Simulator","contact":{"url":"https://this.is.demo.com","email":"dclear@six-group.com"},"license":{"name":"Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)","url":"https://creativecommons.org/licenses/by-nd/4.0/"},"version":"1.0.0"},"servers":[{"url":"https://api-qa.np.six-group.com/clearing/risk/simulator/dev/v1"},{"url":"https://api-qa.np.p2p.six-group.com/clearing/risk/simulator/dev/v1"},{"url":"https://api-qa.np.fip.six-group.com/clearing/risk/simulator/dev/v1"}],"tags":[{"name":"Simulations","description":"Simulation management endpoints"},{"name":"Calculations","description":"Calculations management endpoints"},{"name":"Results","description":"Results management endpoints"},{"name":"Open-Positions","description":"Open positions management endpoints"},{"name":"Reports","description":"Report management endpoints"},{"name":"Download","description":"Document download endpoints"}],"paths":{"/simulations":{"summary":"Operations on Simulations collection","description":"**Simulation** is the mandatory minimun data structure needed for the calculation of IM under mock conditions. It will apply the same **Calculation** process available in the real platform, but using simulated scenario. The user will apply the mock changes that will generate a margin result that could be used to estimate the cost of the real portfolio. \n\nIt constains the basic framework to include the users´ **Open-Positions**.","post":{"tags":["Simulations"],"summary":"Creates a new object of in the Simulations collection.","description":"Creates a new object of in the **Simulations** collection.","operationId":"createSimulation","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SimulationJsonApiType"},"examples":{"Simulation":{"value":{"data":{"attributes":{"date":"2023-09-15","name":"Simulation-1","simulationType":"GUARANTEE","calculationType":"MODEL","algorithmType":"IM"},"type":"simulation"}}}}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/201OkSimulationCreated"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"415":{"$ref":"#/components/responses/415ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}}},"/simulations/search":{"summary":"Advanced Search for Simulations","description":"Search endpoint that represents the avanced search for **Simulations** collection. It returns the list of parameters that matches the query criteria.","post":{"tags":["Simulations"],"summary":"Advanced search for Simulations collection","description":"**SEARCH** is an experience/resource type API designed to provide support to the search of **Simulations** collection. This is part of the advanced query search.\n\nThe operation uses the next query objects:\n  * Filters: every filter applied **MUST** be present with the provided value set.\n  * Restrictions: every object returned in the collection **MUST** be validated on the restriction. \n\nEvery restriction and filter is applied with **AND** operation. As example:\n\n    POST simulations\n    {\n        \"filters\": [\n            {\n                \"attribute\": \"attributeId\",\n                \"values\": [\n                    \"attributeValue\"\n                ]\n            }\n\n        ], \n        \"restrictions\": [\n            {\n              \"attribute\": \"numericAttributeId\",\n              \"type\": \"decimal\",\n              \"operator\": \"and\",\n              \"values\": [\n                  {\n                    \"restriction\": \"lte\",\n                    \"value\": \"2.0\"\n                },\n                {\n                    \"restriction\": \"gte\",\n                    \"value\": \"1.0\"\n                }\n            ]\n          }\n        ]\n    }\n\nThis is equivalent to: **WHERE** attributeId **IN** (\"attributeValue\") **AND** numericAttributeId **>** 1.0 **AND** numericAttributeId **<** 2.0\n\nResults could be ordered by any field.","operationId":"searchSimulations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryType"},"examples":{"QuerySearch":{"value":{"filters":[{"attribute":"attributeId","values":["attributeValue"]}],"restrictions":[{"attribute":"numericAttributeId","type":"decimal","operator":"and","values":[{"restriction":"lte","value":"2.0"},{"restriction":"gte","value":"1.0"}]}]}}}}}},"responses":{"200":{"$ref":"#/components/responses/200OkSimulations"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"page[size]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page size = 20":{"value":20}}},{"name":"page[number]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page number = 3":{"value":3}}},{"name":"sort","in":"query","description":"Sort query parameter permits the sorting of the collection by the values of the attribute provided in the parameter:\n\n    GET simulations?sort=+attribute\n\nThe type of sort:\n\n * (+) Indicates ascending order. +attribute\n * (-) Indicates descending order. -attribute\n * If no symbol is provided, any default order could be returned\n\n**If sort is not provided, the collection is returned in a default order by ID.**\n\nThe name of the attribute should exists in the object. If the name does not exists, it returns **400 Bad Request**.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"examples":{"Sort by attribute":{"value":"attribute"},"Sort by attribute, ascending":{"value":"+attribute"},"Sort by attribute, descending":{"value":"-attribute"},"Sort by attribute ascending, something descending":{"value":"+attribute,-something"}}}]},"/simulations/{simulationId}/calculations":{"summary":"Operations on Calculations collection","description":"Operations on **Calculations** collection","get":{"tags":["Calculations"],"summary":"Retrieves the collection of Calculations","description":"Retrieves the collection of **Calculations**. This collection is paginated.","operationId":"readCalculations","parameters":[{"name":"page[size]","in":"query","description":"The page size requested by the client. \n\nThe default value is 20. The maximal value is 200.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page size = 20":{"value":20}}},{"name":"page[number]","in":"query","description":"The page number the client requests. \n\nThe first page is always page[number]=1.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page number = 3":{"value":3}}},{"name":"sort","in":"query","description":"Sort query parameter permits the sorting of the collection by the values of the attribute provided in the parameter:\n\n    GET /calculations?sort=+attribute\n\nThe type of sort:\n\n * (+) Indicates ascending order. +attribute\n * (-) Indicates descending order. -attribute\n * If no symbol is provided, any default order could be returned\n\n**If sort is not provided, the collection is returned in a default order by ID.**\n\nThe name of the attribute should exists in the object. If the name does not exists, it returns **400 Bad Request**.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"examples":{"Sort by attribute":{"value":"attribute"},"Sort by attribute, ascending":{"value":"+attribute"},"Sort by attribute, descending":{"value":"-attribute"},"Sort by attribute ascending, something descending":{"value":"+attribute,-something"}}}],"responses":{"200":{"$ref":"#/components/responses/200OkCalculations"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"post":{"tags":["Calculations"],"summary":"Creates a new object of in the collection Calculations","description":"Creates a new object of in the collection **Calculations** ","operationId":"createCalculation","responses":{"201":{"$ref":"#/components/responses/201OkCalculationCreated"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"415":{"$ref":"#/components/responses/415ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}]},"/simulations/{simulationId}/calculations/{calculationId}":{"summary":"Retrieves one specific Calculation","description":"Retrieves one specific **Calculations**","get":{"tags":["Calculations"],"summary":"Retrieves one specific object from collection Calculations","description":"Retrieves one specific object from collection **Calculations**","operationId":"readCalculation","responses":{"200":{"$ref":"#/components/responses/200OkCalculation"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}},{"name":"calculationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}]},"/simulations/{simulationId}":{"summary":"Operations on specific Simulation","description":"Customization of the **Simulation** framework.","get":{"tags":["Simulations"],"summary":"Retrieves one specific object from Simulations collection","description":"Retrieves one specific object from **Simulations** collection","operationId":"readSimulation","responses":{"200":{"$ref":"#/components/responses/200OkSimulation"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"delete":{"tags":["Simulations"],"summary":"Delete an object from Simulations collection","description":"Delete an object from **Simulations** collection","operationId":"deleteSimulation","responses":{"204":{"$ref":"#/components/responses/204OkNoContent"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"patch":{"tags":["Simulations"],"summary":"Modify the object in Simulations collection","description":"Modify an object present in **Simulations** collection","operationId":"modifySimulation","requestBody":{"description":"Simulation","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SimulationJsonApiType"},"examples":{"Simulation":{"value":{"data":{"attributes":{"date":"2023-09-15","name":"Simulation-1","simulationType":"GUARANTEE","calculationType":"MODEL","algorithmType":"IM"},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"simulation"}}}}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/200OkSimulation"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}]},"/simulations/{simulationId}/open-positions/search":{"summary":"Operations on Open-Positions","description":"Operations on Open-Positions","post":{"tags":["Open-Positions"],"summary":"Advanced search for Open Position collection","description":"**SEARCH** is an experience/resource type API designed to provide support to the search of **OPEN-POSITION** collection. This is part of the advanced query search.\n\nThe operation uses the next query objects:\n  * Filters: every filter applied **MUST** be present with the provided value set.\n  * Restrictions: every object returned in the collection **MUST** be validated on the restriction. \n\nEvery restriction and filter is applied with **AND** operation. As example:\n\n    POST simulations/{simulationId}/open-positions/search\n    {\n        \"filters\": [\n            {\n                \"attribute\": \"attributeId\",\n                \"values\": [\n                    \"attributeValue\"\n                ]\n            }\n\n        ], \n        \"restrictions\": [\n            {\n              \"attribute\": \"numericAttributeId\",\n              \"type\": \"decimal\",\n              \"operator\": \"and\",\n              \"values\": [\n                  {\n                    \"restriction\": \"lte\",\n                    \"value\": \"2.0\"\n                },\n                {\n                    \"restriction\": \"gte\",\n                    \"value\": \"1.0\"\n                }\n            ]\n          }\n        ]\n    }\n\nThis is equivalent to: **WHERE** attributeId **IN** (\"attributeValue\") **AND** numericAttributeId **>** 1.0 **AND** numericAttributeId **<** 2.0\n\nResults could be ordered by any field.","operationId":"searchOpenPositions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryType"},"examples":{"QuerySearch":{"value":{"filters":[{"attribute":"attributeId","values":["attributeValue"]}],"restrictions":[{"attribute":"numericAttributeId","type":"decimal","operator":"and","values":[{"restriction":"lte","value":"2.0"},{"restriction":"gte","value":"1.0"}]}]}}}}}},"responses":{"200":{"$ref":"#/components/responses/200OkOpenPositions"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}},{"name":"page[size]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page size = 20":{"value":20}}},{"name":"page[number]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page number = 3":{"value":3}}},{"name":"sort","in":"query","description":"Sort query parameter permits the sorting of the collection by the values of the attribute provided in the parameter:\n\n    GET simulations?sort=+attribute\n\nThe type of sort:\n\n * (+) Indicates ascending order. +attribute\n * (-) Indicates descending order. -attribute\n * If no symbol is provided, any default order could be returned\n\n**If sort is not provided, the collection is returned in a default order by ID.**\n\nThe name of the attribute should exists in the object. If the name does not exists, it returns **400 Bad Request**.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"examples":{"Sort by attribute":{"value":"attribute"},"Sort by attribute, ascending":{"value":"+attribute"},"Sort by attribute, descending":{"value":"-attribute"},"Sort by attribute ascending, something descending":{"value":"+attribute,-something"}}}]},"/simulations/{simulationId}/import-open-positions":{"summary":"Import open-positions","description":"Given an organization (every user should belong to one) on the m2m API (this is provided in the X-Token header), import the current open-positions of the organization from the real calculation system.","post":{"tags":["Open-Positions"],"summary":"Import current organization´s open positions","description":"Every API client belongs to an organization. This operation imports to the simulator the existing open posistions for the given date.","operationId":"importOpenPositions","requestBody":{"description":"Import Open Positions","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ImportOpenPositionsJsonApiType"},"examples":{"Import Open Positions":{"value":{"data":{"attributes":{"date":"2022-01-02","portfolio":"SAN0001C10","riskGroupId":"C1","compensationMemberId":"A2","guaranteeAccount":"G00001A23S","contract":"CLE93211A2"},"type":"import-open-positions"}}}}}}},"responses":{"204":{"$ref":"#/components/responses/204OkNoContent"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"415":{"$ref":"#/components/responses/415ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}]},"/simulations/{simulationId}/open-positions/{openPositionId}":{"summary":"Operations done at specific Open-Positions","description":"The user should be able to modify the open positions in specific simulation, once it exists and have unique id.","patch":{"tags":["Open-Positions"],"summary":"Modify specific Open-Position","description":"Modify existing Open-Position","operationId":"modifyOpenPosition","requestBody":{"description":"Open-Position","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OpenPositionJsonApiType"},"examples":{"Open Position":{"value":{"data":{"attributes":{"date":"2022-01-02","riskGroupId":"C1","compensationMemberId":"A2","guaranteeAccount":"G00001A23S","contract":"CLE93211A2","buyVolume":190003.0434,"sellVolume":73882.1234,"price":1.234543},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"open-position"}}}}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/200OkOpenPosition"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"415":{"$ref":"#/components/responses/415ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}},{"name":"openPositionId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}]},"/simulations/{simulationId}/open-positions/bulk-add":{"description":"Following https://confluence.six-group.net/display/CITSSTB/Bulk+Operations+on+Collections, import the given set of elements in open-position collection","post":{"tags":["Open-Positions"],"summary":"Bulk add a list of Open-Positions","description":"Given a list of Open-Positions (initially, with no limit), it inserts and update (similar to PUT) the elements in the array","operationId":"bulkAddOpenPositions","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OpenPositionsInputJsonApiType"},"examples":{"List Open-Positions":{"value":{"data":[{"attributes":{"date":"2022-01-02","riskGroupId":"C1","compensationMemberId":"A2","guaranteeAccount":"G00001A23S","contract":"CLE93211A2","buyVolume":190003.0434,"sellVolume":73882.1234,"price":1.234543},"id":"ffc8ace6-611e-4e85-83d9-234814fd5fd6","type":"open-position"},{"attributes":{"date":"2022-01-03","riskGroupId":"C1","compensationMemberId":"A2","guaranteeAccount":"G00001A23S","contract":"CLE93211A2","buyVolume":190003.0434,"sellVolume":73882.1234,"price":1.234543},"id":"7813cb2b-0b37-4488-ba4d-c1a6181b1ec8","type":"open-position"}]}}}}},"required":true},"responses":{"204":{"$ref":"#/components/responses/204OkNoContent"},"400":{"$ref":"#/components/responses/400ImportOpenPositionsErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"415":{"$ref":"#/components/responses/415ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"examples":{"UUID":{"value":"95b1b467-bd69-4436-8181-96c16408c230"}}}]},"/simulations/{simulationId}/results/search":{"summary":"Search over Result collection using the query structured.","description":"Retrieves specific set of values based on the input query request.","post":{"tags":["Results"],"summary":"Advanced search for Result collection","description":"**SEARCH** is an experience/resource type API designed to provide support to the search of **RESULT** collection. This is part of the advanced query search.\n\nThe operation uses the next query objects:\n  * Filters: every filter applied **MUST** be present with the provided value set.\n  * Restrictions: every object returned in the collection **MUST** be validated on the restriction. \n\nEvery restriction and filter is applied with **AND** operation. As example:\n\n    POST /simulations/{simulationsId}/results/search\n    {\n        \"filters\": [\n            {\n                \"attribute\": \"attributeId\",\n                \"values\": [\n                    \"attributeValue\"\n                ]\n            }\n\n        ], \n        \"restrictions\": [\n            {\n              \"attribute\": \"numericAttributeId\",\n              \"type\": \"decimal\",\n              \"operator\": \"and\",\n              \"values\": [\n                  {\n                    \"restriction\": \"lte\",\n                    \"value\": \"2.0\"\n                },\n                {\n                    \"restriction\": \"gte\",\n                    \"value\": \"1.0\"\n                }\n            ]\n          }\n        ]\n    }\n\nThis is equivalent to: **WHERE** attributeId **IN** (\"attributeValue\") **AND** numericAttributeId **>** 1.0 **AND** numericAttributeId **<** 2.0\n\nResults could be ordered by any field.","operationId":"searchResults","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryType"},"examples":{"QuerySearch":{"value":{"filters":[{"attribute":"attributeId","values":["attributeValue"]}],"restrictions":[{"attribute":"numericAttributeId","type":"decimal","operator":"and","values":[{"restriction":"lte","value":"2.0"},{"restriction":"gte","value":"1.0"}]}]}}}}}},"responses":{"200":{"$ref":"#/components/responses/200OkResults"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}},{"name":"page[size]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page size = 20":{"value":20}}},{"name":"page[number]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page number = 3":{"value":3}}},{"name":"sort","in":"query","description":"Sort query parameter permits the sorting of the collection by the values of the attribute provided in the parameter:\n\n    GET simulations?sort=+attribute\n\nThe type of sort:\n\n * (+) Indicates ascending order. +attribute\n * (-) Indicates descending order. -attribute\n * If no symbol is provided, any default order could be returned\n\n**If sort is not provided, the collection is returned in a default order by ID.**\n\nThe name of the attribute should exists in the object. If the name does not exists, it returns **400 Bad Request**.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"examples":{"Sort by attribute":{"value":"attribute"},"Sort by attribute, ascending":{"value":"+attribute"},"Sort by attribute, descending":{"value":"-attribute"},"Sort by attribute ascending, something descending":{"value":"+attribute,-something"}}}]},"/simulations/{simulationId}/results/{resultId}/details/search":{"post":{"tags":["Results"],"summary":"Advanced search for Result-Details collection","description":"**SEARCH** is an experience/resource type API designed to provide support to the search of **RESULT-DETAILS** collection. This is part of the advanced query search.\n\nThe operation uses the next query objects:\n  * Filters: every filter applied **MUST** be present with the provided value set.\n  * Restrictions: every object returned in the collection **MUST** be validated on the restriction. \n\nEvery restriction and filter is applied with **AND** operation. As example:\n\n    POST simulations/{simulationId}/result/{resultId}/details/search\n    {\n        \"filters\": [\n            {\n                \"attribute\": \"attributeId\",\n                \"values\": [\n                    \"attributeValue\"\n                ]\n            }\n\n        ], \n        \"restrictions\": [\n            {\n              \"attribute\": \"numericAttributeId\",\n              \"type\": \"decimal\",\n              \"operator\": \"and\",\n              \"values\": [\n                  {\n                    \"restriction\": \"lte\",\n                    \"value\": \"2.0\"\n                },\n                {\n                    \"restriction\": \"gte\",\n                    \"value\": \"1.0\"\n                }\n            ]\n          }\n        ]\n    }\n\nThis is equivalent to: **WHERE** attributeId **IN** (\"attributeValue\") **AND** numericAttributeId **>** 1.0 **AND** numericAttributeId **<** 2.0\n\nResults could be ordered by any field.","operationId":"searchResultDetails","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryType"},"examples":{"QuerySearch":{"value":{"filters":[{"attribute":"attributeId","values":["attributeValue"]}],"restrictions":[{"attribute":"numericAttributeId","type":"decimal","operator":"and","values":[{"restriction":"lte","value":"2.0"},{"restriction":"gte","value":"1.0"}]}]}}}}}},"responses":{"200":{"$ref":"#/components/responses/200OkResultDetails"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}},{"name":"page[size]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page size = 20":{"value":20}}},{"name":"page[number]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page number = 3":{"value":3}}},{"name":"sort","in":"query","description":"Sort query parameter permits the sorting of the collection by the values of the attribute provided in the parameter:\n\n    GET simulations?sort=+attribute\n\nThe type of sort:\n\n * (+) Indicates ascending order. +attribute\n * (-) Indicates descending order. -attribute\n * If no symbol is provided, any default order could be returned\n\n**If sort is not provided, the collection is returned in a default order by ID.**\n\nThe name of the attribute should exists in the object. If the name does not exists, it returns **400 Bad Request**.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"examples":{"Sort by attribute":{"value":"attribute"},"Sort by attribute, ascending":{"value":"+attribute"},"Sort by attribute, descending":{"value":"-attribute"},"Sort by attribute ascending, something descending":{"value":"+attribute,-something"}}},{"name":"resultId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}]},"/simulations/{simulationId}/reports/search":{"summary":"Operations on Reports","description":"Operations on Reports","post":{"tags":["Reports"],"summary":"Advanced search for Reports collection","description":"**SEARCH** is an experience/resource type API designed to provide support to the search of **Reports** collection. This is part of the advanced query search.\n\nThe operation uses the next query objects:\n  * Filters: every filter applied **MUST** be present with the provided value set.\n  * Restrictions: every object returned in the collection **MUST** be validated on the restriction. \n\nEvery restriction and filter is applied with **AND** operation. As example:\n\n    POST simulations/{simulationId}/open-positions/search\n    {\n        \"filters\": [\n            {\n                \"attribute\": \"attributeId\",\n                \"values\": [\n                    \"attributeValue\"\n                ]\n            }\n\n        ], \n        \"restrictions\": [\n            {\n              \"attribute\": \"numericAttributeId\",\n              \"type\": \"decimal\",\n              \"operator\": \"and\",\n              \"values\": [\n                  {\n                    \"restriction\": \"lte\",\n                    \"value\": \"2.0\"\n                },\n                {\n                    \"restriction\": \"gte\",\n                    \"value\": \"1.0\"\n                }\n            ]\n          }\n        ]\n    }\n\nThis is equivalent to: **WHERE** attributeId **IN** (\"attributeValue\") **AND** numericAttributeId **>** 1.0 **AND** numericAttributeId **<** 2.0\n\nResults could be ordered by any field.","operationId":"searchReports","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryType"},"examples":{"QuerySearch":{"value":{"filters":[{"attribute":"attributeId","values":["attributeValue"]}],"restrictions":[{"attribute":"numericAttributeId","type":"decimal","operator":"and","values":[{"restriction":"lte","value":"2.0"},{"restriction":"gte","value":"1.0"}]}]}}}}}},"responses":{"200":{"$ref":"#/components/responses/200OkReports"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}},"parameters":[{"name":"simulationId","in":"path","description":"Resource ID in **UUID** format","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}},{"name":"page[size]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page size = 20":{"value":20}}},{"name":"page[number]","in":"query","description":"Pagination options for the collection search. It permits the next modifiers:\r\n  * page[size]\r\n  * page[number]\r\n\r\nDefault values defined are page[number]=1 and page[size]=20","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"examples":{"Page number = 3":{"value":3}}},{"name":"sort","in":"query","description":"Sort query parameter permits the sorting of the collection by the values of the attribute provided in the parameter:\n\n    GET simulations?sort=+attribute\n\nThe type of sort:\n\n * (+) Indicates ascending order. +attribute\n * (-) Indicates descending order. -attribute\n * If no symbol is provided, any default order could be returned\n\n**If sort is not provided, the collection is returned in a default order by ID.**\n\nThe name of the attribute should exists in the object. If the name does not exists, it returns **400 Bad Request**.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"examples":{"Sort by attribute":{"value":"attribute"},"Sort by attribute, ascending":{"value":"+attribute"},"Sort by attribute, descending":{"value":"-attribute"},"Sort by attribute ascending, something descending":{"value":"+attribute,-something"}}}]},"/download":{"summary":"Download endpoint","description":"For every specific document generated in this platform, it enables one single endpoint to download it.","get":{"tags":["Download"],"summary":"Download operation for documents in different formats","description":"This endpoint downloads any document present in the platform using path parameters. \n\nFor **document** downloading, we will proceed as:\n\n    GET /download?id=2e3d0448-5bf5-4fd3-926e-36f43c24162a&type=REPORT\n\nThe user should provide the type of document to download, **report** and the ID of the report to download. \n\nTo retrieve the document ID, it is present in the operation **search** available for **reports**. Please, check the documentation available for document query.","operationId":"download","parameters":[{"name":"id","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/UUIDType"}},{"name":"type","in":"query","description":"Document type to download","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["REPORT"]},"examples":{"Report download":{"value":"REPORT"}}}],"responses":{"200":{"$ref":"#/components/responses/200OkBinary"},"400":{"$ref":"#/components/responses/400ErrorResponse"},"401":{"$ref":"#/components/responses/401SecurityLayerErrorResponse"},"403":{"$ref":"#/components/responses/403SecurityLayerErrorResponse"},"404":{"$ref":"#/components/responses/404ErrorResponse"},"500":{"$ref":"#/components/responses/500ErrorResponse"}}}}},"components":{"schemas":{"QueryType":{"type":"object","properties":{"filters":{"type":"array","description":"Filters restricting the search. All of the values in the Array represent AND operation.","items":{"$ref":"#/components/schemas/FilterType"}},"restrictions":{"type":"array","description":"List of restrictions applied to the collection","items":{"$ref":"#/components/schemas/RestrictionRootType"}}}},"FilterType":{"type":"object","properties":{"attribute":{"type":"string","description":"Name of the attribute to be restricted, filtered or searched","example":"sessionDate"},"values":{"type":"array","description":"Value of the filter or restriction done.","example":["20200101","20200102"],"items":{"type":"string"}}}},"UUIDType":{"pattern":"^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$","type":"string","description":"UUID type implementing the [RFC 4122](https://www.ietf.org/rfc/rfc4122.txt).","format":"string","example":"95b1b467-bd69-4436-8181-96c16408c230"},"LinksPaginationType":{"required":["first","last"],"type":"object","properties":{"first":{"type":"string","description":"First position of the collection","example":"https://api.domain.com/resources?page[number]=1"},"last":{"type":"string","description":"Last page of the collection","example":"https://api.domain.com/resources?page[number]=50"},"prev":{"type":"string","description":"Navigates to the previous page on the list provided. If the page is the first one, prev should be null or not be present","example":"https://api.domain.com/resources?page[number]=1"},"next":{"type":"string","description":"Navigates to the next page on the list provided. If the page is the last one, prev should be null or not be present","example":"https://api.domain.com/resources?page[number]=3"}}},"PaginationType":{"title":"PaginationType","type":"object","properties":{"totalEntities":{"type":"integer","description":"Total of the entities returned in the collection. Depending of the operation pattern:\n * SEARCH: return the number of elements of the search criteria\n * GET: return all the elements or the search criteria","format":"int32"},"totalPages":{"type":"integer","description":"Total of the pages that the collection could return. Last page = to totalPages. ","format":"int32"},"pageSize":{"type":"integer","description":"Size of the page.","format":"int32"},"page":{"type":"integer","description":"Current Page of the return collection","format":"int32"}}},"MetaType":{"type":"object","properties":{"history":{"$ref":"#/components/schemas/MetaHistoryType"},"pagination":{"$ref":"#/components/schemas/PaginationType"}}},"MetaHistoryType":{"title":"MetaHistoryType","required":["created"],"type":"object","properties":{"created":{"type":"string","description":"When the JSON:API Object has been created","format":"date-time","example":"2022-01-02T18:25:43.511Z"},"createdBy":{"type":"string","description":"Who created the JSON:API object. This should not share login information (by example, use email)","example":"chris.doe@sixgroup.com"},"lastModified":{"type":"string","description":"When the object has been modified by the last time. This is optional value.","format":"date-time","example":"2022-01-02T18:25:43.511Z"},"lastModifiedBy":{"type":"string","description":"Who modified the JSON:API object.","example":"michael.rodriguez@sixgroup.com"},"version":{"type":"string","description":"This is the version of the object. Should contain hash of the object to detect if this has changed before commit again new changes.","example":"AF9e94334rr44"}},"description":"Contains the historical information object"},"DERBase64Certificate":{"type":"string","description":"Client certificate presented by the client when connecting to the API Platform. Is a PEM\r\nBase64-encoded.\r\n\r\n*Only present for APIs secured by Mutual TLS  flow on the API Platform.*\r\n\r\nOne of 'X-Token' or 'X-SSL-Client-DER' must be provided.","format":"byte","example":"VEZNd2RFeFRNVU5TVldSS1ZHbENSRkpXU2xWVFZWcEtVVEJHVlZKVE1IUk1VekIwUTJzeFNsTlZhR3hXUlU1RVVXeGtTRm93UmpOVFZVcENXakJzVmxKR1dsVlNNalZZVmtkd1dWUllRVFZPUkU1V1UycEdSazVYVlRCa01uQnVaVlJKTkdRd1VsSlhWWEJNWWpGd1NtRklXbXBVYTBaU1VsVjNTMUZzUmtKa01XaEZVbFY0VGxGWGRFaFJWRVpXVWxWS2IxUlZUbEpOUjJRMFVteFNRbFpGU201VWJGcERVVmM1VlZKRldrOVRiR1JFVVd0b2FtSlVhM2haTUU1RFVXeEtObEpYVms1UmJtUklVVlJHVmxKUmNFUmxSVEZYVlZSSk5XVlhUa2hQV0d4YVYwWktjMU5WVm1GTlYwcDBWR3BDYUZaNmJERlRWVlp6VmxVeFUxZFlaRWRSVm14RlZteEdVbEpGVmpOTlZsSlVWbTFrYmxaVVRuTmxiVkpJVm01U1NsSlZOVU5EYXpGRFRrWm9SVlpGYkRaVVZWSmFaVlV4VlZGVVZrNVdSbFY0VkZWYWRsZEZVbFZUVkVwT1VrWnNOVlJXVWtKT1ZURlZWbFJHVGxKdE9UTlhibkJHVkVVeFFtRXdaRUpOVmxaR1VXMW9UbEV4UlhkYU0yZExVbXhTUWxaRlNtNVViRnBEVVZjNVZWSkZXazlUYkdSRVVXdG9hbUpVYTNoWk1FNURVV3hLTmxKWFZrNVJibVJJVVZSR1ZsSlZUalJVVmxwU1RXcHNOVmt3WXpWbFZteFpWVzE0U2xKV2IzaFpiVEZQVFVGd2FGWjZiREZUVlZaelZsVXhWRkpZWkVsa01XeEZWbXhHVWxKRlVrTmhSMmhxVWpKNE0xUkdhRmRrTWsxNlZXNXNZVll3V2pCWk0ydDRaRWRTU0dWSWNFMVhSVW8xV1dwS1VtUXlaRzVTVjJ4T1VWUkNTRU5yVGxSalZXUlVVMWRKZWxKR1JrWlJhMFpTVmxWR1FrNUZiRU5TU0dSQ1pESmtibEpWZEVKaU1HeERVVlpHUkU1V2F6QmthMmhNVmxac1ZsSXdZM3BYU0UweFRrUkdjV0pxWkRGaVdFNUtaVlJLU0dGcVJVdGhWRXBaVGpCU2IxWnJTa3hsYVhNMVZFVk5NazF0YUhGVlZ6bHBWMjFHV0U5WVRqWlNNV2Q0WTBkd1dXVklTa3hhTUdSaFpWUkNTRmRVV2xWU2JWSnJZMGN4Y2xWRlVrMVVNbk4zVjFaUk1GRldjSFZXVVhCd1ZrVndObGt3T0RGYVYwWXdUVEZrYjFGcll6SmlSMncwWkdwV01WVXdWblJXV0ZadVRUQnNjR1JIT1ZCaFIyeFJXbXN3ZWxSSWFGWk5SVkp4VXpKc2FtRnRPWGhaZWs1eFdXdFZlV1ZIUmxaamExVTBRMjF3UjFWclJrdFhia0oyVlcxV2IxSXhTalpqYlZaNFZtNWtNbGRZYkZabFJFWjFWRlpvYkdGVmNIVlJWRWw2VjFWS2IwOUZSblZSTVVaUFpGWk9Wa3g2U21oaFYxSk5ZMWhHU0U1R2IzWk5SbWhaWVd4TlMySnFVbTFsVjNBd1lrWldWMUZyV25WWmJVNDFZMGRHZDFwdFZuSk9SR2QyWW5wV1VGZEZlRXhTUkVwR1lVaE9kR1ZJVGpaVGFsVnlZVlprTlU5RVNrMWtSVnAyVmxSU1QxZFlUblJrTW1SS1ZtNW9kVkZSY0dwaVJWcHRXV3hzY0ZKcmRGWldWVko0VVZaU1dFNXFiR2hoYkZKSFZsYzVjV0pyT1Zoak0yaDBUbGhyTldKclJsWlVNa294VlZkd1JrOUhiSFpQVnpWTFkxUlpOR1ZVYkhoaVJVWnVWRlZLUWxGVlpIRkRiV1J1VkZjeFRsTlZiRVZUVjNCRVVXMDFVbGRWYkV4a01XeERVV3hHVmxORlJsSlNWVlp1VjJ0R00xb3hhM2RrTURWU1YxVnNUR1F4YkVOUmJFWldVMFV4UWxNd1pFeFdNbWQzV2tWb1FrNXJlRFZQVjJkTFdWWmtSbVJYVFhsaVJGSk5WakpTTlZscVRsZGtNSGgwVGxkNGExRjZiRzlaVm1SR1pHeFZlbUpJY0d0U01Wb3dWVlJDUm1SV2EzcFRha0pPVW14R1NGRXdUbnBTTUVaU1ZsVmFRMlZyUmtOaFIzUnZZbmR3YTFOR1NqTlVNbXMwWkcxSmVWUnVjR3BSZWxZMldWWm9ibVJHYjNwVGJscHJWMFZHTVZsdE1WZE5SWGQ1VDFkd2FrMHdSakpaZWtwelltMUtjRTlFU2xKTlJYQkVWRzV3VjFJd09WUk5WVXBQVmxaYVJVTnJlRlZWVkVwUFpXeFdNRlZYY0VOU1ZURndUVVJHVWsxR1JqVlZiWFJhVFdzMU5sSlVWazlXVmxZeldqRndWbEl3UlhoV1YxSktVVlpPUTJGc1VrUlJiV3h4VVRCS2IyUXhiRXRYVld4WFRVVktWR013U1V0UldHUkdVV3N4U1dJelpFOVJWbXhLVXpOa1dsRnJTbEpXVldoQ1dqQldXRk13Wkc5TlIxSkpVVzV3VUdGVWFESlhWRTVEWld0NGRWUnVRbXhSZWtaMVdUSXdOVTFYVGtST1dGWmhWMFpHTWxkVVRrTmxaM0JOVFRCS01sbHJaSE5oYlZaVVRsaGtZVkl4YkROVlYyUmFVMVYwTTFkVlNrTlZWbFpKVVZka1NtUXdOVzlYVkVKVVYwVTFObHBHWkZkaE1HeElVbTVXWVZFd1NqQlhWbU14WVVadmVWWnRkRXBTTUZweFEyeHJlVTlZYkdGU01uZ3hWMjVzUTAxSFNqVlJha0pvVWpGV2JsWlVRbk5YVld4R1draHNhVTB4V2pOVFZWWlBWVlYzZDFSc1JsWmxhMDVFVVZaU1VsSXdSWGhXVjFKSlpERk9SRkZXVG5wa01tUnVVbGMwUzFSVlZuQmFNVXA0VVd0V2IyRXdjSFphUldoVFpESk9ObUl6V2sxTk1FcDVXVlpOTVdWdFJsbGFNMUpoVFRCd01scEdhRUprVjBwMFZtcENUVTFyTlhKWk1FMDBaVlpHTmxwRlpFNVNWV3QzVkZkcmVGSm5jRTVsYldONlZFWlNVbVZyT1ZaVFdGSlNZVEJ3UlZSV1RYZGtNRGxHVTFST1VGWkZjRWhVVlZaT1pXc3hjVmRZWkZOT2EwcEhZakJXVUZJeFJsaGhSRUpyVTBWRk1sUklhelZoYlU1MFpETldhazF0ZHpCRGEzaFlXa2hzYVUweFdqTlVSekF4WWtkU1JFOVhjR0ZUUlVZeVZGZDBUazB4U25GUmEwNVBVa1ZzTUZWc1VrNU9SVFUxVFVSQ1RtVnRlRVJVUmxaTFVURkdObEpZVWs1U1IyaEVWRzV3Y21WV1NuRlJhMUZMVkZod1NrMXJNVVpoVjJSVFkxVktSbUZIZEV0aU1sSkpWVzVrVUdGVWFESlhWRTVMWXpBeFZFNVljR2hYUjJRd1YycE9TMlJ0VWxsUldGWnBZbFpaZDFSRVNrOWhNazVFVDBoc1VtVnRVa2hVVlZaS1RVRndUbUZVUmtkVVdIQnVUVEI0VlZWWWNGQldWV3d3VlZkMFMxSkZNVlJOU0dSUVVsVnJlbFF4VWt0U01ERkdWRmh3VG1Gc2JETlZNSFJEVWpJNVJsVXdaRkppVjJkM1drVm9RazVyZURWUFYzQnFZbGhrTlVOcmVIVlVia0pzVVhwR2RWa3lNRFZOVjA1RVRsaFdZVmRHUmpKWFZFcFRaREI0TmxOclVrOU5SbXd6VlZkd1VtVlZlRlpXV0hCUVVrZE9NRlJyVWs1T1ZrWndUVlZPVW1Fd01UUlVSbEpDVGtaR2NWbDZWVXRVVjNSYVpERkdObFJZYkU5aGEwWnJVVzFrVDFacmFGUldWVlpIWVd0R1ZsRnRaRzVqYTBwdVVsVmFRMVZYVGtWUlZrWmFVMVYwTTFkVlNrTlZWbFpKVVZoa1NtUXdVbTVYVlZKWFZXcENVVkZXUmtsTWQzQkRVVlpHUlZGWFpGQmlNREZHVWxWa1FrMVdWbXRTVmtaU1Rtc3hSV0ZWVGtoU01Gb3pXVlpvUW1SSFVsbFJibkJyVTBWd2MxZFdZM2hsYTNoWVRWUkNhVk5GTVRCWk1HaExaR3h3U2xKWFRscFhSVXAzUTJ4bmVVMVhhR2xpVlZwMVYyeGplR0pIU25WVmEwWnFUVzEzTUZSR1pHdGxWMGw2Vm01a1RXSlZOVEpaYkZKQ1drVktibFJzV2tsVlZGSkdVbTFrVWxaVVJsVlVia1V4WkVkV1IwdDZVakZXUnpVMFlVaFpTMW96VFhaamJYaE5ZakpLVW1Fd1JqTlRTR1JhVWtaYVUwMUhjRU5SYldRelVtMDVRbFpXWkU1Tk1sSnlVMU4wZWs5VldsSlNNV1JIVmtWa1NsUXlNWGxXUkdoeVlucG5kMVpZWkVWVlZteExVekk1WVZOUmNHOWtiVTVQVVZaR1JsUkZTbEpSVlZKdVdqQnNRMUZWVGtOU1F6aHlaREpGZUZkSVJsQldNblIyVTJ0emQxcEdiR2hVTWtwdVZsUmFXV1ZxU2xaWFZrWlRWMjF2TlZORVFUQldWRkpWVWxVNU5GRXljelZEYkZFellVVm9OVlJ0Y0ZCaGJWcHhXa1pTUW1JelNucFNiRlkyWTBkR1dFd3dXakpVYlVaVVZFWk9SbFZXU25kTE1FVjJZa1ZzTlZFelFrOVpXRkp5WTIweFMyRXdTakZUVkdoT1V6RkpkMVl5TVROUk1VMUxUV3BvZFZZd1p6TmlSWFJRVVZaRk5VMXVXWHBPVlRsWVRrWndjR1ZHYUhabFNFMDBWVlU1YlZOcGRHRk9SRUp6WkZaR1UwNUVTazVqUlRCNFkwVldWRlV6UmpGVFdGbDRURE5uZWsxRVRrNVRWVGxQVmtGdk5FNUZUbXRpUjNoWlVraFJNV05yTlVwbFJsWkRXakF4VmxJelNuWmtTRVpIVTBWb2FGVjVPVEZTYTJ4TFZsVlNUMVpJUWpWVVYwWk5UbFJzUTFKdWJFeFRWRTVwWTFoa1NGRnVSWHBQVkUxMlpGZEtNRU5zU25WaE1GbDVVMnhTYTA1R2FIQlphVGxGVVRKa1lWUldWa1pUUlZaT1ZYcENjVlpYUmpSUmJGWkZWRlJzVlU1c1JqQk5WRlpEWTFoS1VHUkhOVWRVUm04d1lUSnNWV0ZIVmt0TmJHeHlZa1JzU2xOc1RVdGFWRVpvVWpOS1dtSlVUa05YUkVweFl6RndWbEV6Ykc1aWVrMTVXakk1ZFZSdE9VVlhWVXBHVTJwT1EyUlZTblJaVm1SWlZVaHNjMU5JYkRKbFdFSjBWV3BhTW1FeGJGZGxiVGxQWlZSQ2JGTlhkSEpqVVhCVldXeFNkV0ZWZURaUlZFSkdZMGR2TkZKSFRrcGxWV2hLVkcxV2NsTXlTbWhPTUZKcVZHMUZNR1J0YzNKWmJXaDFUMFpGTlZKclRqRlNNR1IwVm14T1RGUnROWHBhV0ZZeVUydE9kRkpWTVdGYWVsSnRRMjVXVjJOc2FIQlVSbTk0VDFoQ01VMUlTblJrVlhoNldrWktjRTB4UWtkU01rb3lUakZrU1ZKRmVFSlRWRTR6VFc1c2ExTklTbnBqUXpneFpXNU9iV1JJY0VkTGVrWjFZMWR3TTJOc2J6UlNWbFo2WWtkalMxWlZjR3BqTTJjeVVsVktRbVJ1YkRaYU1HaGFVVE5TYzJGcVJqUlJNazVPVFZSS1JFNUhiSFJOVmxvMVYyeFpNbVJzYUROUlZURkxWRE5HZDFWRmFIaFNiRkpKWTFka2FXSXhjRlZaYkVwU1ZVVndWMVpuYjNwWlZXUjRVMnByZUZKWGNGTmpWbWN3VWpGU2RWSnROV3RYUmtaRFVXcFNWVk42YTNsVmJWSk1ZMnRzVVZaRlZqWlVSVVp1VEhsMGFsUXhTbk5OU0VwUlRIcENVbEY2YkdsaVZWWTJWVmRGY21ScldtcERhbHBHVFVkc1EwMVVRbkJqUTNSaFpWVm5NMDF1Y0UxU1JtUm9ZMFZ2Y2s1WVRrVlBSVFUxWVZWVk5Fc3dPWFJXTTBGNVZrZE9jMWxwZEd0a1JtaHpUREprUTFOSVZrbGpibXhMWVZaQ1JHUjNiM1JNVXpCMFRGVldUMUpEUWtSU1ZrcFZVMVZhU2xFd1JsVlNVekIwVEZNd2RFTm5QVDA9"},"AccessTokenPayload":{"type":"string","description":"Decrypted payload of the access token (Base64-encoded).\r\n\r\n*Only present for APIs secured by IDP Introspection or IDP Client Credentials flow on the API Platform.*\r\n\r\nOne of 'X-Token' or 'X-SSL-Client-DER' must be provided.","format":"byte","example":"WlhsQlowbERRV2RKUTBGblNVTkthRmt6VW5Ca2JWVnBUMjVTZVdSWFZYTkpRMEZuU1VOQlowbERRV2RKYld4NlkzbEpOa2xEU205a1NGSjNZM3B2ZGt3elpHeGplVEZ3V2toQmRHTlhSWFZpYmtGMVl6SnNORXhYWkhsaU0xWjNURzFPZG1KVE9XaGpSMnh1WkhsSmMwbERRV2RKUTBGblNVTkJaMGx1VGpGWmFVazJTVU5LYVZwcWJHdE9hbXN6VDBSRk5GbFhSWGxOYlUwMFQxUkthVmw2UVRKYVIwVjVXbXBDYUUxNlJUQk5VMGx6U1VOQlowbERRV2RKUTBGblNXMU9jMkZYVm5Wa1JqbHdXa05KTmtsRFNtbGFhbXhyVG1wck0wOUVSVFJaVjBWNVRXMU5ORTlVU21sWllVRXlXa2RGZVZwcVFtaE5la1V3VFZOSmMwbERRV2RKUTBGblNVTkJaMGx0VmpSalEwazJTVVJGTWs5RVkzcE9WRmt5VG1wVmMwbERRV2RKUTBGblNVTkJaMGx0Ykdoa1EwazJTVVJGTWs5RVkzcE9WRlV6VG1wVmMwbERRV2RKUTBGblNVTkJaMGx0TldsYWFVazJTVVJGTWs5RVkzcE9WRlV6VG1wVmMwbERRV2RKUTBGblNVTkJaMGx1VG1waU0wSnNTV3B2WjBscFNYTkpRMEZuU1VOQlowbERRV2RKYlU1ellWZFdkV1JEU1RaSlNITnBZMjA1YzFwWVRXbFBhVWw0VFVSRmRHUkhWbnBrUTBvNVNVTkJaMGxEUVdkSlEwRm5abEU5UFE9PQ=="},"RestrictionRootType":{"required":["operator"],"type":"object","properties":{"attribute":{"type":"string","description":"Name of the attribute to be restricted, filtered or searched","example":"high"},"type":{"type":"string","description":"Type of the value to be searched. This is used to validate the transformation done in the backend once the list is received","example":"decimal","enum":["integer","decimal","string","boolean"]},"operator":{"type":"string","description":"Operator applied in the value comparision.","example":"and","enum":["and","or"]},"values":{"type":"array","description":"List of restrictions to be applied with the operator in the attribute","items":{"$ref":"#/components/schemas/RestrictionType"}}}},"RestrictionType":{"type":"object","properties":{"restriction":{"type":"string","description":"Type of restriction to be set in the search, if applies","example":"lt","enum":["lt","lte","gt","gte","eqt","neqt","like"]},"value":{"type":"string","description":"Value of the filter or restriction done.","example":"2.3"}}},"Error":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human-readable explanation specific to this error.","example":"Unauthorized"},"errorDetail":{"description":"Additional information about the error.","allOf":[{"$ref":"#/components/schemas/ErrorDetail"}]}},"description":"Description of an error to help remediation."},"ParameterLocation":{"type":"string","description":"The location of the invalid parameter.","enum":["BODY","PATH","QUERY","HEADER"]},"InvalidParams":{"required":["in","name","value"],"type":"object","properties":{"in":{"$ref":"#/components/schemas/ParameterLocation"},"name":{"type":"string","description":"The name of the invalid parameter."},"reason":{"type":"string","description":"The reason why the parameter's value is invalid."},"code":{"$ref":"#/components/schemas/ServerErrorCode"},"value":{"type":"string","description":"The invalid value (as a string)."}},"description":"List of invalid parameters.\r\n\r\n***Please note that the API GW does syntax validation according to the OAS and will issue an error response in case of failure. Thus, this extension should only be used when the API server is not connected to via the API GW or if additional (to what is defined in the OAS) checks are performed.***","example":{"in":"PATH","name":"paramName","reason":"Internal functional validation has ended in failure","value":"23.3","code":"ERROR_INTERNAL"}},"MissingParams":{"type":"object","properties":{"in":{"$ref":"#/components/schemas/ParameterLocation"},"name":{"type":"string"},"reason":{"type":"string"},"code":{"$ref":"#/components/schemas/ServerErrorCode"}},"description":"List of missing parameters.\r\n\r\n***Please note that the API GW does syntax validation according to the OAS and will issue an error response in case of failure. Thus, this extension should only be used when the API server is not connected to via the API GW or if conditional presence conditions (that typically cannot be modeled in an OAS) are applicable.***","example":{"in":"PATH","name":"paramName","reason":"The parameter 'paramName' is not present in PATH","code":"ERROR_INTERNAL"}},"ErrorDetail":{"required":["status"],"type":"object","properties":{"type":{"type":"string","description":"A URI reference (RFC3986) that describes the problem type (in the context of the provided API).\n\nShould resolve to a human-readable document.","format":"uri","default":"about:blank"},"title":{"type":"string","description":"A short, human-readable summary of the problem type in English.","example":"Not Found"},"status":{"maximum":599,"minimum":100,"type":"integer","description":"The HTTP status code (RFC7231, Section 6) generated by the origin server for this occurrence of the problem.","format":"int32","example":400},"code":{"$ref":"#/components/schemas/ServerErrorCode"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","example":"ISIN 'US012071998' does not exist."},"instance":{"type":"string","description":"A URI reference (RFC3986) that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","format":"uri","example":"https://www.example.com/books/1234"},"missingParams":{"type":"array","items":{"$ref":"#/components/schemas/MissingParams"}},"invalidParams":{"type":"array","items":{"$ref":"#/components/schemas/InvalidParams"}}},"description":"Detailed description of an error to help remediation. It follows RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807)."},"ServerErrorCode":{"pattern":"^[0-9A-Z_]{1,125}$","type":"string","description":"An application specific error code that identifies univocally the error situation. ","example":"THIS_IS_ERROR_CODE"},"CalculationAttributesType":{"required":["status"],"type":"object","properties":{"date":{"type":"string","description":"Creation date of the calculation","format":"date-time","example":"2022-01-02T18:25:43.511Z"},"status":{"type":"string","description":"Status of the calculation process","example":"IN-PROGRESS","enum":["IN-PROGRESS","DONE"]}},"description":"Basic attributes of the object."},"SimulationType":{"type":"object","description":"Data structure for all operations.","allOf":[{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/SimulationAttributesType"}}},{"$ref":"#/components/schemas/BasicResourceType"}]},"CalculationType":{"type":"object","description":"Data structure for all operations.","allOf":[{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/CalculationAttributesType"}}},{"$ref":"#/components/schemas/BasicResourceType"}]},"OpenPositionType":{"type":"object","description":"Data structure for all operations.","allOf":[{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/OpenPositionAttributesType"}}},{"$ref":"#/components/schemas/BasicResourceType"}]},"SimulationAttributesType":{"required":["algorithmType","calculationType","name","simulationType"],"type":"object","properties":{"date":{"type":"string","description":"Simulation date. The value here represent the date that the algorithm should take in account for the margin calculations.","format":"date","example":"2023-09-15"},"name":{"maxLength":120,"minLength":1,"type":"string","description":"Simulation name, given by the user.","example":"Simulation-1"},"simulationType":{"type":"string","description":"Type of simulation done by the system.","enum":["GUARANTEE","POSITION"]},"calculationType":{"type":"string","description":"Type of calculation done in the simulation","enum":["MODEL","RISK-CONTROL"]},"algorithmType":{"type":"string","description":"Type of algorithm applied in the simulation.","enum":["IM","ST"]}},"description":"Basic attributes of the object."},"OpenPositionAttributesType":{"type":"object","properties":{"date":{"type":"string","description":"Creation date of the calculation","format":"date","example":"2022-01-02"},"riskGroupId":{"$ref":"#/components/schemas/RiskGroupIdType"},"compensationMemberId":{"pattern":"^[A-Z0-9]{2,3}$","type":"string","description":"Reference to compensation member","example":"A2"},"guaranteeAccount":{"pattern":"^[A-Z0-9]{10}$","type":"string","description":"Guarantee account reference","example":"G00001A23S"},"contract":{"pattern":"^[A-Z0-9]{10}$","type":"string","description":"Contract reference","example":"CLE93211A2"},"buyVolume":{"type":"number","description":"Buy Volume in traded currency defined in the account","format":"double","example":190003.0434},"sellVolume":{"type":"number","description":"Buy Volume in traded currency defined in the account","format":"double","example":73882.1234},"price":{"type":"number","description":"Contract price at date","format":"double","example":1.234543}},"description":"Basic attributes of the object."},"ImportOpenPositionsAttributesType":{"type":"object","properties":{"date":{"type":"string","description":"Creation date of the calculation","format":"date","example":"2022-01-02"},"portfolio":{"pattern":"^[A-Z0-9]{10}$","type":"string","description":"Reference to risk group","example":"SAN0001C10"},"riskGroupId":{"pattern":"^[A-Z0-9]{2,3}$","type":"string","description":"Reference to risk group","example":"C1"},"compensationMemberId":{"pattern":"^[A-Z0-9]{2,3}$","type":"string","description":"Reference to compensation member","example":"A2"},"guaranteeAccount":{"pattern":"^[A-Z0-9]{10}$","type":"string","description":"Guarantee account reference","example":"G00001A23S"},"contract":{"pattern":"^[A-Z0-9]{10}$","type":"string","description":"Contract reference","example":"CLE93211A2"}},"description":"Basic attributes of the object."},"ImportOpenPositionsType":{"type":"object","description":"Data structure for all operations.","allOf":[{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ImportOpenPositionsAttributesType"}}},{"$ref":"#/components/schemas/BasicResourceType"}]},"SimulationJsonApiType":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/SimulationType"}},"description":"Object in JSON:API format."},"SimulationsJsonApiType":{"required":["data","links","meta"],"type":"object","properties":{"links":{"$ref":"#/components/schemas/LinksPaginationType"},"data":{"type":"array","description":"List of **MESSAGES** present in the collection, resulting on the query request.","readOnly":true,"items":{"$ref":"#/components/schemas/SimulationType"}},"meta":{"$ref":"#/components/schemas/MetaType"}},"description":"Collection in JSON:API format. Collection is paginated"},"ImportOpenPositionsJsonApiType":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportOpenPositionsType"}},"description":"Collection in JSON:API format. Collection is paginated"},"CalculationJsonApiType":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/CalculationType"}},"description":"Object in JSON:API format."},"CalculationsJsonApiType":{"required":["data","links","meta"],"type":"object","properties":{"links":{"$ref":"#/components/schemas/LinksPaginationType"},"data":{"type":"array","description":"List of **MESSAGES** present in the collection, resulting on the query request.","readOnly":true,"items":{"$ref":"#/components/schemas/CalculationType"}},"meta":{"$ref":"#/components/schemas/MetaType"}},"description":"Collection in JSON:API format. Collection is paginated"},"OpenPositionsInputJsonApiType":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OpenPositionType"}}}},"OpenPositionsJsonApiType":{"required":["data","links","meta"],"type":"object","properties":{"links":{"$ref":"#/components/schemas/LinksPaginationType"},"data":{"type":"array","description":"List of **MESSAGES** present in the collection, resulting on the query request.","readOnly":true,"items":{"$ref":"#/components/schemas/OpenPositionType"}},"meta":{"$ref":"#/components/schemas/MetaType"}},"description":"Collection in JSON:API format. Collection is paginated"},"OpenPositionJsonApiType":{"required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/OpenPositionType"}}},"ResultAttributesType":{"required":["baseInitialMargin","finalInitialMargin","member","positionSizeAdjustment","wrongWayRisk"],"type":"object","properties":{"member":{"maxLength":50,"minLength":1,"type":"string","description":"Name of the member account for the IM group calculation","example":"Member-1"},"baseInitialMargin":{"type":"number","description":"Initial margin is the percentage of the purchase price of a security that must be covered by cash or collateral when using a margin account","format":"double","example":100},"positionSizeAdjustment":{"type":"number","description":"The number of units invested in a particular security by an investor or trader","format":"double","example":50},"wrongWayRisk":{"type":"number","description":"In the field of finance, a wrong way risk (WWR) occurs when credit exposure to a counterparty is negatively correlated with the credit quality of that counterparty","format":"double","example":45},"finalInitialMargin":{"type":"number","description":"Aggregated value of baseInitialMargin, positionSizeAdjustment and wrongWayRisk.","format":"double","example":195}},"description":"Basic attributes of the object."},"ResultType":{"type":"object","description":"Data structure for all operations.","allOf":[{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ResultAttributesType"}}},{"$ref":"#/components/schemas/BasicResourceType"}]},"ResultsJsonApiType":{"required":["data","links","meta"],"type":"object","properties":{"links":{"$ref":"#/components/schemas/LinksPaginationType"},"data":{"type":"array","description":"List of **MESSAGES** present in the collection, resulting on the query request.","readOnly":true,"items":{"$ref":"#/components/schemas/ResultType"}},"meta":{"$ref":"#/components/schemas/MetaType"}},"description":"Collection in JSON:API format. Collection is paginated"},"ResultDetailsType":{"type":"object","description":"Data structure for all operations.","allOf":[{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ResultDetailsAttributesType"}}},{"$ref":"#/components/schemas/BasicResourceType"}]},"ResultDetailsJsonApiType":{"required":["data","links","meta"],"type":"object","properties":{"links":{"$ref":"#/components/schemas/LinksPaginationType"},"data":{"type":"array","description":"List of **MESSAGES** present in the collection, resulting on the query request.","readOnly":true,"items":{"$ref":"#/components/schemas/ResultDetailsType"}},"meta":{"$ref":"#/components/schemas/MetaType"}},"description":"Collection in JSON:API format. Collection is paginated"},"RiskSubgroupIdType":{"pattern":"^[A-Z0-9]{2,3}$","type":"string","description":"Risk Group ID Identification in DClear system.","example":"C1"},"RiskGroupIdType":{"pattern":"^[A-Z0-9]{2}$","type":"string","description":"Risk Group ID Identification in DClear system.","example":"C1"},"IsoCurrencyType":{"pattern":"^([A-Z]){3}$","type":"string","description":"Alpha code of a currency as defined in ISO 4217","example":"USD"},"ResultDetailsAttributesType":{"required":["sessionDate"],"type":"object","properties":{"sessionDate":{"type":"string","description":"Date of the operation","format":"date","example":"2023-01-01"},"clearingMember":{"pattern":"^[A-Z0-9]{1,4}$","type":"string","description":"Clearing member name","example":"SAN"},"marginAccountMember":{"pattern":"^[A-Z0-9]{1,4}$","type":"string","description":"Margin Account Member","example":"ASAN"},"marginAccount":{"pattern":"^[A-Z0-9]{1,3}$","type":"string","description":"Margin Account","example":"SAN"},"marginCurrency":{"$ref":"#/components/schemas/IsoCurrencyType"},"accountType":{"type":"string","description":"Type of account","example":"NET","enum":["NET","GROSS"]},"riskGroupId":{"$ref":"#/components/schemas/RiskGroupIdType"},"riskSubgroupId":{"$ref":"#/components/schemas/RiskSubgroupIdType"},"accountCalcType":{"type":"string","description":"Type of calculation applied","example":"PD","enum":["PD","ND"]}},"description":"Basic attributes of the object."},"ReportAttributesType":{"type":"object","properties":{"name":{"maxLength":50,"minLength":1,"type":"string","description":"Name of the report","example":"IM-Results"},"format":{"type":"string","description":"Format of the document generated.","example":"CSV","enum":["CSV","JSON","XML"]},"type":{"maxLength":10,"minLength":1,"type":"string","description":"Type of the report generated","example":"IM-Results"},"date":{"type":"string","description":"Date of the report generation","format":"date","example":"2020-01-01"}},"description":"Basic attributes of the object."},"ReportType":{"type":"object","description":"Data structure for all operations.","allOf":[{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ReportAttributesType"}}},{"$ref":"#/components/schemas/BasicResourceType"}]},"ReportsJsonApiType":{"required":["data","links","meta"],"type":"object","properties":{"links":{"$ref":"#/components/schemas/LinksPaginationType"},"data":{"type":"array","description":"List of **MESSAGES** present in the collection, resulting on the query request.","readOnly":true,"items":{"$ref":"#/components/schemas/ReportType"}},"meta":{"$ref":"#/components/schemas/MetaType"}},"description":"Collection in JSON:API format. Collection is paginated"},"BasicResourceType":{"required":["type"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUIDType"},"type":{"type":"string","description":"Type of the resource attributes being represented","example":"simulation","enum":["simulation","calculation","result","open-position","import-open-positions","result-detail","report"]}}}},"responses":{"200OkCalculation":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CalculationJsonApiType"},"examples":{"200 Ok Calculation":{"value":{"data":{"attributes":{"date":"2022-01-02T18:25:43.511Z","status":"IN-PROGRESS"},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"calculation"}}}}}}},"201OkCalculationCreated":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CalculationJsonApiType"},"examples":{"201 Created Calculation":{"value":{"data":{"attributes":{"date":"2022-01-02T18:25:43.511Z","status":"IN-PROGRESS"},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"calculation"}}}}}}},"400ErrorResponse":{"description":"Bad Request","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"BadRequestMissingAttributes":{"value":{"message":"Bad Requet","errorDetail":{"type":"about:blank","title":"Bad Request","status":400,"code":"A123","detail":"Wrong input value","missingParams":[{"in":"PATH","name":"paramName","reason":"The parameter 'paramName' is not present in PATH","code":"ERROR_INTERNAL"}],"invalidParams":[{"in":"PATH","name":"paramName","reason":"Internal functional validation has ended in failure","value":"23.3","code":"ERROR_INTERNAL"}]}}}}}}},"401SecurityLayerErrorResponse":{"description":"Unauthorized","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"Unauthorized":{"value":{"message":"No required TLS certificate was sent","errorDetail":{"title":"Unauthorized","status":401,"detail":"Client is not authenticated."}}}}}}},"403SecurityLayerErrorResponse":{"description":"Forbidden","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"Forbidden":{"value":{"message":"Forbidden","errorDetail":{"title":"Forbidden","status":403,"detail":"Client is not authorized for this operation."}}}}}}},"404ErrorResponse":{"description":"Resource not found","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"NotFound":{"value":{"message":"Not Found","errorDetail":{"title":"Not Found","status":404,"detail":"Value provided not found"}}}}}}},"415ErrorResponse":{"description":"Unsupported Media Type","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"UnsupportedMediaType":{"value":{"message":"Unsupported Media Type","errorDetail":{"title":"Unsupported Media Type","status":415,"detail":"Content-Type is not compatible with application/vnd.api+json"}}}}}}},"500ErrorResponse":{"description":"Internal Server Error","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"ServerError":{"value":{"message":"Server error","errorDetail":{"title":"Internal Server Error","status":500,"detail":"Something went wrong."}}}}}}},"200OkSimulation":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SimulationJsonApiType"},"examples":{"200 OK Simulation":{"value":{"data":{"attributes":{"date":"2023-09-15","name":"Simulation-1","simulationType":"GUARANTEE","calculationType":"MODEL","algorithmType":"IM"},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"simulation"}}}}}}},"201OkSimulationCreated":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SimulationJsonApiType"},"examples":{"Simulation Created":{"value":{"data":{"attributes":{"date":"2023-09-15","name":"Simulation-1","simulationType":"GUARANTEE","calculationType":"MODEL","algorithmType":"IM"},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"simulation"}}}}}}},"204OkNoContent":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}}},"200OkCalculations":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CalculationsJsonApiType"},"examples":{"200 Ok Calculations":{"value":{"links":{"first":"https://api.domain.com/resources?page[number]=1","last":"https://api.domain.com/resources?page[number]=50","prev":"https://api.domain.com/resources?page[number]=1","next":"https://api.domain.com/resources?page[number]=3"},"data":[{"attributes":{"date":"2022-01-02T18:25:43.511Z","status":"IN-PROGRESS"},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"calculation"}],"meta":{"history":{"created":"2022-01-02T18:25:43.511Z","createdBy":"chris.doe@sixgroup.com","lastModified":"2022-01-02T18:25:43.511Z","lastModifiedBy":"michael.rodriguez@sixgroup.com","version":"AF9e94334rr44"},"pagination":{"totalEntities":0,"totalPages":0,"pageSize":0,"page":0}}}}}}}},"200OkSimulations":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SimulationsJsonApiType"},"examples":{"200 Ok Simulations":{"value":{"links":{"first":"https://api.domain.com/resources?page[number]=1","last":"https://api.domain.com/resources?page[number]=50","prev":"https://api.domain.com/resources?page[number]=1","next":"https://api.domain.com/resources?page[number]=3"},"data":[{"attributes":{"date":"2022-01-02","riskGroupId":"C1","compensationMemberId":"A2","guaranteeAccount":"G00001A23S","contract":"CLE93211A2","buyVolume":190003.0434,"sellVolume":73882.1234,"price":1.234543},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"simulation"}],"meta":{"history":{"created":"2022-01-02T18:25:43.511Z","createdBy":"chris.doe@sixgroup.com","lastModified":"2022-01-02T18:25:43.511Z","lastModifiedBy":"michael.rodriguez@sixgroup.com","version":"AF9e94334rr44"},"pagination":{"totalEntities":0,"totalPages":0,"pageSize":0,"page":0}}}}}}}},"200OkOpenPositions":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OpenPositionsJsonApiType"},"examples":{"200 Ok Open-Positions":{"value":{"links":{"first":"https://api.domain.com/resources?page[number]=1","last":"https://api.domain.com/resources?page[number]=50","prev":"https://api.domain.com/resources?page[number]=1","next":"https://api.domain.com/resources?page[number]=3"},"data":[{"attributes":{"date":"2022-01-02","riskGroupId":"C1","compensationMemberId":"A2","guaranteeAccount":"G00001A23S","contract":"CLE93211A2","buyVolume":190003.0434,"sellVolume":73882.1234,"price":1.234543},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"open-position"}],"meta":{"history":{"created":"2022-01-02T18:25:43.511Z","createdBy":"chris.doe@sixgroup.com","lastModified":"2022-01-02T18:25:43.511Z","lastModifiedBy":"michael.rodriguez@sixgroup.com","version":"AF9e94334rr44"},"pagination":{"totalEntities":0,"totalPages":0,"pageSize":0,"page":0}}}}}}}},"200OkOpenPosition":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OpenPositionJsonApiType"},"examples":{"200 Ok Open-Position":{"value":{"data":{"attributes":{"date":"2022-01-02","riskGroupId":"C1","compensationMemberId":"A2","guaranteeAccount":"G00001A23S","contract":"CLE93211A2","buyVolume":190003.0434,"sellVolume":73882.1234,"price":1.234543},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"open-position"}}}}}}},"400ImportOpenPositionsErrorResponse":{"description":"Bad Request","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"BadRequestMissingAttributes":{"value":{"message":"Bad Requet","errorDetail":{"type":"about:blank","title":"Bad Request","status":400,"code":"A123","detail":"Wrong input value","missingParams":[{"in":"PATH","name":"paramName","reason":"The parameter 'paramName' is not present in PATH","code":"ERROR_INTERNAL"}],"invalidParams":[{"in":"PATH","name":"paramName","reason":"Internal functional validation has ended in failure","value":"23.3","code":"ERROR_INTERNAL"}]}}}}}}},"200OkResults":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ResultsJsonApiType"},"examples":{"200 Ok Results":{"value":{"links":{"first":"https://api.domain.com/resources?page[number]=1","last":"https://api.domain.com/resources?page[number]=50","prev":"https://api.domain.com/resources?page[number]=1","next":"https://api.domain.com/resources?page[number]=3"},"data":[{"attributes":{"member":"Member-1","baseInitialMargin":100,"positionSizeAdjustment":50,"wrongWayRisk":45,"finalInitialMargin":195},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"result"}],"meta":{"history":{"created":"2022-01-02T18:25:43.511Z","createdBy":"chris.doe@sixgroup.com","lastModified":"2022-01-02T18:25:43.511Z","lastModifiedBy":"michael.rodriguez@sixgroup.com","version":"AF9e94334rr44"},"pagination":{"totalEntities":0,"totalPages":0,"pageSize":0,"page":0}}}}}}}},"200OkResultDetails":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ResultDetailsJsonApiType"},"examples":{"200 Ok Result-Details":{"value":{"links":{"first":"https://api.domain.com/resources?page[number]=1","last":"https://api.domain.com/resources?page[number]=50","prev":"https://api.domain.com/resources?page[number]=1","next":"https://api.domain.com/resources?page[number]=3"},"data":[{"attributes":{"sessionDate":"2023-01-01","clearingMember":"SAN","marginAccountMember":"ASAN","marginAccount":"SAN","marginCurrency":"USD","accountType":"NET","riskGroupId":"C1","riskSubgroupId":"C1","accountCalcType":"PD"},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"result-detail"}],"meta":{"history":{"created":"2022-01-02T18:25:43.511Z","createdBy":"chris.doe@sixgroup.com","lastModified":"2022-01-02T18:25:43.511Z","lastModifiedBy":"michael.rodriguez@sixgroup.com","version":"AF9e94334rr44"},"pagination":{"totalEntities":0,"totalPages":0,"pageSize":0,"page":0}}}}}}}},"200OkReports":{"description":"Ok","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ReportsJsonApiType"},"examples":{"200 Ok Reports":{"value":{"links":{"first":"https://api.domain.com/resources?page[number]=1","last":"https://api.domain.com/resources?page[number]=50","prev":"https://api.domain.com/resources?page[number]=1","next":"https://api.domain.com/resources?page[number]=3"},"data":[{"attributes":{"date":"2020-01-01","name":"IM-Results-2020","format":"CSV","type":"IM"},"id":"95b1b467-bd69-4436-8181-96c16408c230","type":"report"}],"meta":{"history":{"created":"2022-01-02T18:25:43.511Z","createdBy":"chris.doe@sixgroup.com","lastModified":"2022-01-02T18:25:43.511Z","lastModifiedBy":"michael.rodriguez@sixgroup.com","version":"AF9e94334rr44"},"pagination":{"totalEntities":0,"totalPages":0,"pageSize":0,"page":0}}}}}}}},"200OkBinary":{"description":"Download document in Base64","headers":{"X-Correlation-Id":{"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/UUIDType"}}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"},"examples":{"200 Ok":{"value":"PHhtbD48dmFsdWU+SGVsbG8gV29ybGQhPC92YWx1ZT48L3htbD4"}}}}}}}}
```