{"openapi":"3.0.4","info":{"title":"Preview a Scenario","description":"Preview what a scenario would do to a portfolio's market data, without running a valuation.\r\n            \r\nThe portfolio's market data dependencies are resolved through the given recipe and the scenario's\r\nshifts are applied; the response lists every market data target the shifts changed, with values\r\nbefore and after, plus any market data that matched a shift but could not honour it. Supply\r\neither a reference to a stored scenario, or inline shift definitions to test a definition before\r\nsaving it.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/scenarios/$preview":{"post":{"tags":["Scenarios"],"summary":"Preview a Scenario","description":"Preview what a scenario would do to a portfolio's market data, without running a valuation.\r\n            \r\nThe portfolio's market data dependencies are resolved through the given recipe and the scenario's\r\nshifts are applied; the response lists every market data target the shifts changed, with values\r\nbefore and after, plus any market data that matched a shift but could not honour it. Supply\r\neither a reference to a stored scenario, or inline shift definitions to test a definition before\r\nsaving it.","operationId":"PreviewScenario","requestBody":{"description":"The recipe, portfolios, effective date and scenario (stored reference or inline shifts) to preview","content":{"application/json-patch+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ScenarioPreviewRequest"},"example":{"recipeId":{"scope":"live","code":"default"},"portfolioEntityIds":[{"scope":"fund-a","code":"main","portfolioEntityType":"SinglePortfolio"}],"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","scenario":{"scope":"stress-tests","code":"rates-up-50"}}},"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ScenarioPreviewRequest"},"example":{"recipeId":{"scope":"live","code":"default"},"portfolioEntityIds":[{"scope":"fund-a","code":"main","portfolioEntityType":"SinglePortfolio"}],"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","scenario":{"scope":"stress-tests","code":"rates-up-50"}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ScenarioPreviewRequest"},"example":{"recipeId":{"scope":"live","code":"default"},"portfolioEntityIds":[{"scope":"fund-a","code":"main","portfolioEntityType":"SinglePortfolio"}],"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","scenario":{"scope":"stress-tests","code":"rates-up-50"}}},"application/*+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ScenarioPreviewRequest"},"example":{"recipeId":{"scope":"live","code":"default"},"portfolioEntityIds":[{"scope":"fund-a","code":"main","portfolioEntityType":"SinglePortfolio"}],"effectiveAt":"2026-01-01T00:00:00.0000000+00:00","scenario":{"scope":"stress-tests","code":"rates-up-50"}}}},"required":true},"responses":{"200":{"description":"The preview of the scenario's effect on the portfolio's market data, or any failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ScenarioPreviewResponse"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ScenarioPreviewResponse"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ScenarioPreviewResponse"}}}},"400":{"description":"The details of the input related failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidProblemDetails"}}}}},"security":[{"BearerAuth":[]}],"x-fbn-apistatus":"EarlyAccess"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}