{"openapi":"3.0.4","info":{"title":"[EARLY ACCESS] CreateScenarioFromTemplate","description":"Creates and stores a scenario built from a pre-defined parameterised template, for example a\r\nparallel rates shift or an equity crash. The template determines the scenario's shifts; the\r\nparameters supply the targets (e.g. currency or instrument) and optionally override the default\r\nshift size. The created scenario is stored in the given scope and behaves exactly like a\r\nhand-built scenario.\r\n            \r\nUse ListScenarioTemplates to discover the available templates and, for each, the parameters it\r\naccepts, their defaults and their units. A parameter the template does not read is rejected\r\nrather than ignored, and parameter names are case-sensitive.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/scenarios/{scope}/$fromTemplate":{"post":{"tags":["Scenarios"],"summary":"[EARLY ACCESS] CreateScenarioFromTemplate","description":"Creates and stores a scenario built from a pre-defined parameterised template, for example a\r\nparallel rates shift or an equity crash. The template determines the scenario's shifts; the\r\nparameters supply the targets (e.g. currency or instrument) and optionally override the default\r\nshift size. The created scenario is stored in the given scope and behaves exactly like a\r\nhand-built scenario.\r\n            \r\nUse ListScenarioTemplates to discover the available templates and, for each, the parameters it\r\naccepts, their defaults and their units. A parameter the template does not read is rejected\r\nrather than ignored, and parameter names are case-sensitive.","operationId":"CreateScenarioFromTemplate","parameters":[{"name":"scope","in":"path","description":"The scope in which to create the scenario","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}}],"requestBody":{"description":"The template, code and parameters to create the scenario from","content":{"application/json-patch+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateScenarioFromTemplateRequest"},"example":{"template":"RatesUp","code":"rates-up-50","displayName":"Rates +50bps Parallel","description":"Parallel shift of +50bps across all USD rate curves","parameters":{"ccy":"USD","amount":"50"}}},"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateScenarioFromTemplateRequest"},"example":{"template":"RatesUp","code":"rates-up-50","displayName":"Rates +50bps Parallel","description":"Parallel shift of +50bps across all USD rate curves","parameters":{"ccy":"USD","amount":"50"}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateScenarioFromTemplateRequest"},"example":{"template":"RatesUp","code":"rates-up-50","displayName":"Rates +50bps Parallel","description":"Parallel shift of +50bps across all USD rate curves","parameters":{"ccy":"USD","amount":"50"}}},"application/*+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateScenarioFromTemplateRequest"},"example":{"template":"RatesUp","code":"rates-up-50","displayName":"Rates +50bps Parallel","description":"Parallel shift of +50bps across all USD rate curves","parameters":{"ccy":"USD","amount":"50"}}}},"required":true},"responses":{"200":{"description":"The successfully created scenario or any failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertSingleStructuredDataResponse"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertSingleStructuredDataResponse"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertSingleStructuredDataResponse"}}}},"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"}}}}