{"items":[{"type":"link","label":"Virtual Scenarios","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios","content":{"contentType":"overview","meta":{"name":"Virtual Scenarios"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Virtual Scenarios Spec","url":"https://developer.slb.com/fdplan/FDPlan-Virtual-Scenarios.yaml"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://customersupport.digital.slb.com","url":"https://customersupport.digital.slb.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Virtual Scenarios (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"fence","attributes":{"content":"prod-nam-services-fdplan.slbservice.com\nprod-eu-services-fdplan.slbservice.com\nprod-au-services-fdplan.slbservice.com\nprod-id-services-fdplan.slbservice.com\nproduction-services-fdplan.slbservice.com\n","language":"plain","title":"Client ID"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"prod-nam-services-fdplan.slbservice.com\nprod-eu-services-fdplan.slbservice.com\nprod-au-services-fdplan.slbservice.com\nprod-id-services-fdplan.slbservice.com\nproduction-services-fdplan.slbservice.com\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Virtual Scenarios API provides an optimized, high-volume interface to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the FDPlan evaluation platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A virtual scenario is a server-managed way to evaluate a study workflow that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bypasses the interactive decision and choice framing process. Each virtual scenario"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"starts from a single workflow-input data source that supplies every input node"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the study workflow, and the platform creates it automatically when a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workflow-input data source job succeeds. Virtual scenarios are typically driven"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by external controllers and optimization engines to run sensitivity analyses"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and other large realization sweeps, and they are not shown in the FDPlan user"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interface as regular scenarios."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API has no POST endpoint. To create virtual scenarios, submit a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workflow-input data source job through the Data Sources API. Use this API to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list virtual scenarios, set the realizations to evaluate, monitor the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per-realization result states, promote a high-performing virtual scenario to a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regular scenario, and remove virtual scenarios."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"VirtualScenarios","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios","items":[{"label":"Get virtual scenarios","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios/getvirtualscenarios","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios/getvirtualscenarios","metadata":{"seo":{"title":"Get virtual scenarios","description":"Get a paginated list of virtual scenarios for a study."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVirtualScenarios","name":"Get virtual scenarios","isWebhook":false,"pointer":"/paths/~1v1~1virtual-scenarios/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get virtual scenarios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a paginated list of virtual scenarios for a study."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StudyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tag is mandatory. Narrow the results further by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inputDataSourceIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the workflow-input data sources that the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"virtual scenarios were created from."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"state","in":"query","schemaId":"schema_0","description":"The virtual scenario state to filter for."},{"name":"tags","in":"query","style":"form","explode":false,"schemaId":"schema_1","description":"The tags for the virtual scenarios to get. Virtual scenarios whose tags match the provided tags are\nreturned. The StudyId tag is mandatory, for example StudyId:01JY6FMJMY0F6AJFV05V831SB4.\n","required":true},{"name":"inputDataSourceIds","in":"query","style":"form","explode":false,"schemaId":"schema_2","description":"The identifiers of the workflow-input data sources associated with the virtual scenarios to get. Virtual\nscenarios whose input data source identifier matches any of the provided identifiers are returned. Provide a maximum\nof 100 identifiers, separated by commas, for example 01JY70N7ZGAQ02RZF2BTHDKRN8,01HKMNGN05NYGWD90BQD9JC6KH.\n"},{"name":"pageNumber","in":"query","schemaId":"schema_3","description":"The number of the page in the list of virtual scenarios."},{"name":"pageSize","in":"query","schemaId":"schema_4","description":"The number of virtual scenarios per page. The maximum allowed page size is 200."},{"name":"includeCount","in":"query","schemaId":"schema_5","description":"Returns the quota and total count alongside the virtual scenarios."},{"name":"onlyCount","in":"query","schemaId":"schema_5","description":"Returns the quota, the total count, and an empty list of virtual scenarios."}],"pointer":"/paths/~1v1~1virtual-scenarios/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_6","description":"Data partition identifier.","required":true}],"pointer":"/paths/~1v1~1virtual-scenarios/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/virtual-scenarios","servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"state","in":"query","schemaId":"schema_0"},{"name":"tags","in":"query","required":true,"schemaId":"schema_1","style":"form","explode":false},{"name":"inputDataSourceIds","in":"query","schemaId":"schema_2","style":"form","explode":false},{"name":"pageNumber","in":"query","schemaId":"schema_3"},{"name":"pageSize","in":"query","schemaId":"schema_4"},{"name":"includeCount","in":"query","schemaId":"schema_5"},{"name":"onlyCount","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_6"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","default"],"pointer":"/v1/virtual-scenarios","href":"virtualscenarios/getvirtualscenarios","openApiOperationId":"getVirtualScenarios","summary":"Get virtual scenarios"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieved virtual scenarios successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualScenarioCollection"}},"schemaId":"components/schemas/VirtualScenarioCollection"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1virtual-scenarios/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualScenarioCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualScenarioCollection"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtualscenarios/getvirtualscenarios"}],"panels":[]}]},"httpPath":"/v1/virtual-scenarios"},{"label":"Update virtual scenarios","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios/patchvirtualscenarios","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios/patchvirtualscenarios","metadata":{"seo":{"title":"Update virtual scenarios","description":"Update properties of the virtual scenarios specified in the request, using JSON Patch operations against the collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchVirtualScenarios","name":"Update virtual scenarios","isWebhook":false,"pointer":"/paths/~1v1~1virtual-scenarios/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update virtual scenarios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update properties of the virtual scenarios specified in the request, using JSON Patch operations against the collection."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"realizationFilters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" triggers an evaluation of the provided realizations and transitions the virtual scenario to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stopping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cancels the evaluation of virtual scenarios that are still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation is allowed with the path "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{virtualScenarioId}/name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{virtualScenarioId}/realizationFilters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{virtualScenarioId}/state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation is allowed with the path "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{virtualScenarioId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any of the supplied virtual scenarios is not found during "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then no changes are applied and a not-found response is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A 400 Bad request response is returned if you:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"try to replace the value of any property in the path other than name, realization filters, and state; or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provide no realization filters for a virtual scenario; or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provide realization filters that contain duplicate realizations; or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attempt to update a virtual scenario that is not in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state; or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provide more than 200 virtual scenario identifiers in the request payload; or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provide more than 100 realization filters for a single virtual scenario; or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provide both state and realization filters for the same virtual scenario; or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provide an illegal value to cancel or stop a virtual scenario, where only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stopping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is allowed; or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tags","in":"query","style":"form","explode":false,"schemaId":"schema_1","description":"The tags for the virtual scenarios to patch. Virtual scenarios whose tags match the provided tags are\npatched. The StudyId tag is mandatory, for example StudyId:01JY6FMJMY0F6AJFV05V831SB4.\n","required":true}],"pointer":"/paths/~1v1~1virtual-scenarios/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_6","description":"Data partition identifier.","required":true}],"pointer":"/paths/~1v1~1virtual-scenarios/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchVirtualScenarioParamsCollection"}},"schemaId":"components/schemas/PatchVirtualScenarioParamsCollection","pointer":"/paths/~1v1~1virtual-scenarios/patch/requestBody","description":"The parameters to update virtual scenarios."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/virtual-scenarios","servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"tags","in":"query","required":true,"schemaId":"schema_1","style":"form","explode":false}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_6"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchVirtualScenarioParamsCollection"}},"responseCodes":["200","400","401","404","default"],"pointer":"/v1/virtual-scenarios","href":"virtualscenarios/patchvirtualscenarios","openApiOperationId":"patchVirtualScenarios","summary":"Update virtual scenarios"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/PatchVirtualScenarioParamsCollection","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchVirtualScenarioParamsCollection"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Patched virtual scenarios.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualScenarioCollection"}},"schemaId":"components/schemas/VirtualScenarioCollection"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Virtual scenario is not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1virtual-scenarios/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualScenarioCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualScenarioCollection"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtualscenarios/patchvirtualscenarios"}],"panels":[]}]},"httpPath":"/v1/virtual-scenarios"},{"label":"Update a virtual scenario","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios/patchvirtualscenario","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios/patchvirtualscenario","metadata":{"seo":{"title":"Update a virtual scenario","description":"Promote a single virtual scenario to a regular scenario."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchVirtualScenario","name":"Update a virtual scenario","isWebhook":false,"pointer":"/paths/~1v1~1virtual-scenarios~1{virtualScenarioId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a virtual scenario","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promote a single virtual scenario to a regular scenario."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotion turns a high-performing virtual scenario into a regular scenario that is visible in the FDPlan user interface, with its data sources materialized from the realization inputs. The only allowed operation is to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the path "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/promotion/state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". While promotion runs, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promotion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is present on the virtual scenario resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualScenarioId","in":"path","schemaId":"schema_7","description":"The identifier of the virtual scenario to patch.","required":true}],"pointer":"/paths/~1v1~1virtual-scenarios~1{virtualScenarioId}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tags","in":"query","style":"form","explode":false,"schemaId":"schema_1","description":"The tags of the virtual scenario to patch. The StudyId tag is mandatory, for example StudyId:01JY6FMJMY0F6AJFV05V831SB4.","required":true}],"pointer":"/paths/~1v1~1virtual-scenarios~1{virtualScenarioId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_6","description":"Data partition identifier.","required":true}],"pointer":"/paths/~1v1~1virtual-scenarios~1{virtualScenarioId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchSingleVirtualScenarioParamsCollection"}},"schemaId":"components/schemas/PatchSingleVirtualScenarioParamsCollection","pointer":"/paths/~1v1~1virtual-scenarios~1{virtualScenarioId}/patch/requestBody","description":"The parameters to update a single virtual scenario."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/virtual-scenarios/{virtualScenarioId}","servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"virtualScenarioId","in":"path","required":true,"schemaId":"schema_7"}],"query":[{"name":"tags","in":"query","required":true,"schemaId":"schema_1","style":"form","explode":false}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_6"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchSingleVirtualScenarioParamsCollection"}},"responseCodes":["200","400","401","404","default"],"pointer":"/v1/virtual-scenarios/{virtualScenarioId}","href":"virtualscenarios/patchvirtualscenario","openApiOperationId":"patchVirtualScenario","summary":"Update a virtual scenario"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/PatchSingleVirtualScenarioParamsCollection","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchSingleVirtualScenarioParamsCollection"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The patched virtual scenario.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualScenario"}},"schemaId":"components/schemas/VirtualScenario"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Virtual scenario is not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1virtual-scenarios~1{virtualScenarioId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualScenario","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualScenario"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtualscenarios/patchvirtualscenario"}],"panels":[]}]},"httpPath":"/v1/virtual-scenarios/{virtualScenarioId}"},{"label":"Get results states","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios/getresultsstates","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/virtualscenarios/getresultsstates","metadata":{"seo":{"title":"Get results states","description":"Get the per-realization result states for the specified virtual scenarios."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getResultsStates","name":"Get results states","isWebhook":false,"pointer":"/paths/~1v1~1virtual-scenarios~1results-states/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get results states","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the per-realization result states for the specified virtual scenarios."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to monitor the evaluation progress of each realization in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"realizationStates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the result-processing progress in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSourceProcessingState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The ensemble-results data source is returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSourceProcessingState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CompletedSuccessfully"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tags","in":"query","style":"form","explode":false,"schemaId":"schema_1","description":"The tags of the virtual scenarios. The StudyId tag is mandatory, for example StudyId:01JY6FMJMY0F6AJFV05V831SB4.","required":true},{"name":"virtualScenarioIds","in":"query","style":"form","explode":false,"schemaId":"schema_2","description":"The identifiers of the virtual scenarios. Provide a maximum of 100 identifiers in a comma-separated\nlist.\n","required":true}],"pointer":"/paths/~1v1~1virtual-scenarios~1results-states/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_6","description":"Data partition identifier.","required":true}],"pointer":"/paths/~1v1~1virtual-scenarios~1results-states/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/virtual-scenarios/results-states","servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"tags","in":"query","required":true,"schemaId":"schema_1","style":"form","explode":false},{"name":"virtualScenarioIds","in":"query","required":true,"schemaId":"schema_2","style":"form","explode":false}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_6"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","default"],"pointer":"/v1/virtual-scenarios/results-states","href":"virtualscenarios/getresultsstates","openApiOperationId":"getResultsStates","summary":"Get results states"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualScenarioResultsStateCollection"}},"schemaId":"components/schemas/VirtualScenarioResultsStateCollection"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"One or more of the virtual scenarios were not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1virtual-scenarios~1results-states/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualScenarioResultsStateCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualScenarioResultsStateCollection"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtualscenarios/getresultsstates"}],"panels":[]}]},"httpPath":"/v1/virtual-scenarios/results-states"}],"content":{"contentType":"group","meta":{"name":"VirtualScenarios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VirtualScenarios","showPageActions":true},{"nodeType":"markdoc","content":"Getting and updating virtual scenarios."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/virtual-scenarios","summary":"Get virtual scenarios","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtualscenarios/getvirtualscenarios","deprecated":false},{"title":"/v1/virtual-scenarios","summary":"Update virtual scenarios","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/virtualscenarios/patchvirtualscenarios","deprecated":false},{"title":"/v1/virtual-scenarios/{virtualScenarioId}","summary":"Update a virtual scenario","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/virtualscenarios/patchvirtualscenario","deprecated":false},{"title":"/v1/virtual-scenarios/results-states","summary":"Get results states","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtualscenarios/getresultsstates","deprecated":false}]}]}]}]}},{"type":"group","label":"Schema Definitions","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions","items":[{"type":"link","label":"Error","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/error","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/error","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Error"},"seo":{"title":"Error"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Error","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Error"},"children":[]}]}]}},{"type":"link","label":"PatchVirtualScenarioParamsCollection","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/patchvirtualscenarioparamscollection","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/patchvirtualscenarioparamscollection","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchVirtualScenarioParamsCollection"},"seo":{"title":"PatchVirtualScenarioParamsCollection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchVirtualScenarioParamsCollection","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchVirtualScenarioParamsCollection"},"children":[]}]}]}},{"type":"link","label":"PatchVirtualScenarioParams","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/patchvirtualscenarioparams","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/patchvirtualscenarioparams","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchVirtualScenarioParams"},"seo":{"title":"PatchVirtualScenarioParams"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchVirtualScenarioParams","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchVirtualScenarioParams"},"children":[]}]}]}},{"type":"link","label":"PatchSingleVirtualScenarioParamsCollection","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/patchsinglevirtualscenarioparamscollection","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/patchsinglevirtualscenarioparamscollection","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchSingleVirtualScenarioParamsCollection"},"seo":{"title":"PatchSingleVirtualScenarioParamsCollection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchSingleVirtualScenarioParamsCollection","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchSingleVirtualScenarioParamsCollection"},"children":[]}]}]}},{"type":"link","label":"PatchSingleVirtualScenarioParams","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/patchsinglevirtualscenarioparams","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/patchsinglevirtualscenarioparams","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchSingleVirtualScenarioParams"},"seo":{"title":"PatchSingleVirtualScenarioParams"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchSingleVirtualScenarioParams","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchSingleVirtualScenarioParams"},"children":[]}]}]}},{"type":"link","label":"RealizationFilter","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/realizationfilter","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/realizationfilter","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RealizationFilter"},"seo":{"title":"RealizationFilter"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RealizationFilter","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RealizationFilter"},"children":[]}]}]}},{"type":"link","label":"RealizationOutcome","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/realizationoutcome","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/realizationoutcome","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RealizationOutcome"},"seo":{"title":"RealizationOutcome"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RealizationOutcome","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RealizationOutcome"},"children":[]}]}]}},{"type":"link","label":"VirtualScenarioCollection","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenariocollection","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenariocollection","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VirtualScenarioCollection"},"seo":{"title":"VirtualScenarioCollection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VirtualScenarioCollection","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VirtualScenarioCollection"},"children":[]}]}]}},{"type":"link","label":"VirtualScenario","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenario","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenario","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VirtualScenario"},"seo":{"title":"VirtualScenario"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VirtualScenario","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VirtualScenario"},"children":[]}]}]}},{"type":"link","label":"VersionId","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/versionid","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/versionid","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VersionId"},"seo":{"title":"VersionId"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VersionId","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VersionId"},"children":[]}]}]}},{"type":"link","label":"VirtualScenarioResultsStateCollection","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenarioresultsstatecollection","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenarioresultsstatecollection","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VirtualScenarioResultsStateCollection"},"seo":{"title":"VirtualScenarioResultsStateCollection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VirtualScenarioResultsStateCollection","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VirtualScenarioResultsStateCollection"},"children":[]}]}]}},{"type":"link","label":"VirtualScenarioResultsState","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenarioresultsstate","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenarioresultsstate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VirtualScenarioResultsState"},"seo":{"title":"VirtualScenarioResultsState"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VirtualScenarioResultsState","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VirtualScenarioResultsState"},"children":[]}]}]}},{"type":"link","label":"RealizationState","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/realizationstate","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/realizationstate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RealizationState"},"seo":{"title":"RealizationState"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RealizationState","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RealizationState"},"children":[]}]}]}},{"type":"link","label":"RunState","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/runstate","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/runstate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RunState"},"seo":{"title":"RunState"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RunState","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RunState"},"children":[]}]}]}},{"type":"link","label":"ResultsError","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/resultserror","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/resultserror","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ResultsError"},"seo":{"title":"ResultsError"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ResultsError","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ResultsError"},"children":[]}]}]}},{"type":"link","label":"ComputationState","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/computationstate","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/computationstate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationState"},"seo":{"title":"ComputationState"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationState","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationState"},"children":[]}]}]}},{"type":"link","label":"VirtualScenarioPromotion","link":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenariopromotion","routeSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios/schema-definitions/virtualscenariopromotion","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VirtualScenarioPromotion"},"seo":{"title":"VirtualScenarioPromotion"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VirtualScenarioPromotion","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VirtualScenarioPromotion"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Schema Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schema Definitions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Error","link":"/schema-definitions/error","deprecated":false},{"title":"PatchVirtualScenarioParamsCollection","link":"/schema-definitions/patchvirtualscenarioparamscollection","deprecated":false},{"title":"PatchVirtualScenarioParams","link":"/schema-definitions/patchvirtualscenarioparams","deprecated":false},{"title":"PatchSingleVirtualScenarioParamsCollection","link":"/schema-definitions/patchsinglevirtualscenarioparamscollection","deprecated":false},{"title":"PatchSingleVirtualScenarioParams","link":"/schema-definitions/patchsinglevirtualscenarioparams","deprecated":false},{"title":"RealizationFilter","link":"/schema-definitions/realizationfilter","deprecated":false},{"title":"RealizationOutcome","link":"/schema-definitions/realizationoutcome","deprecated":false},{"title":"VirtualScenarioCollection","link":"/schema-definitions/virtualscenariocollection","deprecated":false},{"title":"VirtualScenario","link":"/schema-definitions/virtualscenario","deprecated":false},{"title":"VersionId","link":"/schema-definitions/versionid","deprecated":false},{"title":"VirtualScenarioResultsStateCollection","link":"/schema-definitions/virtualscenarioresultsstatecollection","deprecated":false},{"title":"VirtualScenarioResultsState","link":"/schema-definitions/virtualscenarioresultsstate","deprecated":false},{"title":"RealizationState","link":"/schema-definitions/realizationstate","deprecated":false},{"title":"RunState","link":"/schema-definitions/runstate","deprecated":false},{"title":"ResultsError","link":"/schema-definitions/resultserror","deprecated":false},{"title":"ComputationState","link":"/schema-definitions/computationstate","deprecated":false},{"title":"VirtualScenarioPromotion","link":"/schema-definitions/virtualscenariopromotion","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"description":"Generic error response.","required":["data"],"type":"object","properties":{"data":{"required":["code"],"type":"object","properties":{"code":{"format":"int32","description":"The HTTP status code.","type":"integer","example":500},"message":{"description":"The error message.","type":"string","example":"internal server error"}}}},"example":{"data":{"code":500,"message":"internal server error"}}}},"components/schemas/PatchVirtualScenarioParamsCollection":{"id":"components/schemas/PatchVirtualScenarioParamsCollection","kind":"json-schema","title":"PatchVirtualScenarioParamsCollection","data":{"description":"List of parameters to patch virtual scenarios.","type":"array","items":{"$ref":"#/components/schemas/PatchVirtualScenarioParams"},"example":[{"op":"replace","path":"/01JY70N8TE9DG79NTQZDFMGEW3/name","value":"Price sensitivity - Base case"},{"op":"replace","path":"/01JY70N8TE9DG79NTQZDFMGEW3/realizationFilters","value":{"items":[{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"Base","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]},{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"Low","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]}]}},{"op":"replace","path":"/01JY70N8TE64GJ0CZE6M900M99/name","value":"Price sensitivity - Low case"},{"op":"replace","path":"/01JY70N8TE9DG79NTQZDFMGEW3/state","value":"Stopping"},{"op":"remove","path":"/01JY70N8TE9DG79NTQZDFMGEW3"}]}},"components/schemas/PatchVirtualScenarioParams":{"id":"components/schemas/PatchVirtualScenarioParams","kind":"json-schema","title":"PatchVirtualScenarioParams","data":{"description":"Parameters to patch a virtual scenario.","required":["op","path"],"type":"object","properties":{"op":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation to apply for the patch. The only allowed operations are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["replace","remove"],"type":"string"},"path":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path to patch. It identifies a property within a virtual scenario and has two sections divided by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a forward slash. The first section is the virtual scenario identifier, the second is the virtual scenario property"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name. Allowed property names are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"realizationFilters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^\\/[0-7][0-9A-HJKMNP-TV-Z]{25}(\\/(name|state|realizationFilters)){0,1}$","type":"string"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value to patch. It is a name, the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stopping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a list of realization filters."},"children":[]}]}]}]}},"example":{"op":"replace","path":"/01JY70N8TE9DG79NTQZDFMGEW3/realizationFilters","value":{"items":[{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"Base","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]},{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"Low","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]}]}}}},"components/schemas/PatchSingleVirtualScenarioParamsCollection":{"id":"components/schemas/PatchSingleVirtualScenarioParamsCollection","kind":"json-schema","title":"PatchSingleVirtualScenarioParamsCollection","data":{"description":"List of parameters to patch a single virtual scenario.","maxItems":1,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PatchSingleVirtualScenarioParams"},"example":[{"op":"replace","path":"/promotion/state","value":"Running"}]}},"components/schemas/PatchSingleVirtualScenarioParams":{"id":"components/schemas/PatchSingleVirtualScenarioParams","kind":"json-schema","title":"PatchSingleVirtualScenarioParams","data":{"description":"Parameters to patch a single virtual scenario.","required":["op","path","value"],"type":"object","properties":{"op":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation to apply for the patch. The only allowed operation is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["replace"],"type":"string"},"path":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path to patch. It identifies a property within a virtual scenario. The only allowed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/promotion/state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["/promotion/state"],"type":"string"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value to patch. To patch the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/promotion/state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property, the only allowed value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Running"],"type":"string"}},"example":{"op":"replace","path":"/promotion/state","value":"Running"}}},"components/schemas/RealizationFilter":{"id":"components/schemas/RealizationFilter","kind":"json-schema","title":"RealizationFilter","data":{"description":"The set of outcomes that define one realization. Each item selects one data-provider outcome for one workflow-input node.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RealizationOutcome"}}},"example":{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Low","nodeAddress":"0:2:2"}]}}},"components/schemas/RealizationOutcome":{"id":"components/schemas/RealizationOutcome","kind":"json-schema","title":"RealizationOutcome","data":{"description":"A single workflow-input choice: the data-provider outcome to use for one input node of the realization.\n","required":["name","nodeAddress"],"type":"object","properties":{"name":{"description":"The data-provider outcome name to include for the node. It matches a data provider name on the workflow-input\ndata source, for example Base or Low.\n","type":"string"},"nodeAddress":{"description":"The address of the workflow input node, in column:row:depth form. The row is always 2 for input nodes.","pattern":"^\\d+:2:\\d+$","type":"string","example":"0:2:0"}},"example":{"name":"Base","nodeAddress":"0:2:0"}}},"components/schemas/VirtualScenarioCollection":{"id":"components/schemas/VirtualScenarioCollection","kind":"json-schema","title":"VirtualScenarioCollection","data":{"description":"A page of virtual scenarios that match the query.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VirtualScenario"}},"quota":{"format":"int32","description":"The maximum number of virtual scenarios allowed per study.","type":["integer","null"],"example":10000},"total":{"format":"int32","description":"The total number of virtual scenarios matching the filters provided.","type":["integer","null"],"example":6}},"example":{"total":4,"items":[{"id":"01JY70N8TE9DG79NTQZDFMGEW3","name":"","inputDataSource":{"id":"01JY70N7ZGAQ02RZF2BTHDKRN8","version":1},"state":"Ready","tags":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"],"lastUpdatedAt":"2025-06-20T15:52:32.000Z"},{"id":"01JY70N8TE64GJ0CZE6M900M99","name":"Price sensitivity - Low case","inputDataSource":{"id":"01JY70N7ZGAQ02RZF2BTHDKRN8","version":1},"state":"Running","tags":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"],"realizationFilters":{"items":[{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"Base","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]},{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"Low","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]}]},"lastUpdatedAt":"2025-06-20T15:55:18.000Z"},{"id":"01JY70N8TE7C2K9F4ZB1RM5QPA","name":"Price sensitivity - Base case","inputDataSource":{"id":"01JY70N7ZGAQ02RZF2BTHDKRN8","version":1},"resultDataSource":{"id":"01JY70ZMBEECJH58ZQ1K9K19DH","version":1},"state":"CompletedSuccessfully","tags":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"],"realizationFilters":{"items":[{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"Base","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]}]},"lastUpdatedAt":"2025-06-20T15:57:24.000Z"},{"id":"01JY70N8TE8H3D0YJ6P2WQ4XYZ","name":"Price sensitivity - High case","inputDataSource":{"id":"01JY70N7ZGAQ02RZF2BTHDKRN8","version":1},"state":"CompletedWithErrors","tags":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"],"realizationFilters":{"items":[{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"High","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]}]},"errorMessages":["data provider name 'Base' is duplicated on address '0:2:0'"],"lastUpdatedAt":"2025-06-20T15:58:12.000Z"}]}}},"components/schemas/VirtualScenario":{"id":"components/schemas/VirtualScenario","kind":"json-schema","title":"VirtualScenario","data":{"description":"A server-managed evaluation of a study workflow, created from a single workflow-input data source.","required":["id","name","inputDataSource","state","tags","lastUpdatedAt"],"type":"object","properties":{"id":{"description":"The identifier of the virtual scenario.","type":"string","example":"01JY70N8TE9DG79NTQZDFMGEW3"},"name":{"description":"The display name of the virtual scenario. It is optional and empty by default.","type":"string"},"inputDataSource":{"$ref":"#/components/schemas/VersionId"},"resultDataSource":{"$ref":"#/components/schemas/VersionId"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the virtual scenario."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown - State is invalid or unknown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ready - The virtual scenario is ready to run an evaluation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running - The evaluation of the virtual scenario is running. The Running state is set when the virtual scenario is assigned realization filters with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v1/virtual-scenarios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CompletedSuccessfully - The evaluation of the virtual scenario has completed successfully. Results are provided in the associated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resultDataSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CompletedWithErrors - The evaluation of the virtual scenario has completed with errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stopping - The evaluation of the virtual scenario is being stopped."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stopped - The evaluation of the virtual scenario has been stopped."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Queued - The evaluation of the virtual scenario has been queued and runs when resources become available. The Queued state is set when the virtual scenario is assigned realization filters with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v1/virtual-scenarios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and too many virtual scenario realizations are already running."},"children":[]}]}]}]}],"enum":["Unknown","Ready","Running","CompletedSuccessfully","CompletedWithErrors","Stopping","Stopped","Queued"],"type":"string","example":"Ready"},"tags":{"description":"List of tags associated with the virtual scenario. The StudyId tag is mandatory on every query. The platform\nalso adds an EnsembleId tag for the ensemble that holds the realizations, and the workflow-input job typically propagates\nIteration and Case tags.\n","type":"array","items":{"type":"string"},"example":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"]},"realizationFilters":{"description":"The realizations to evaluate. Each outer item is one realization, and each inner item selects one data-provider\noutcome for one workflow-input node address. Setting realization filters transitions the virtual scenario to Running\nor Queued.\n","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RealizationFilter"}}}},"errorMessages":{"description":"List of error messages associated with the virtual scenario, populated when the state is CompletedWithErrors.","type":"array","items":{"type":"string"},"example":["data provider name 'Base' is duplicated on address '0:2:0'"]},"lastUpdatedAt":{"format":"date-time","description":"The time when the virtual scenario was last updated.","type":["string","null"],"example":"2025-06-20T15:52:32.000Z"},"promotion":{"$ref":"#/components/schemas/VirtualScenarioPromotion"}},"example":{"id":"01JY70N8TE9DG79NTQZDFMGEW3","name":"Price sensitivity - Base case","inputDataSource":{"id":"01JY70N7ZGAQ02RZF2BTHDKRN8","version":1},"resultDataSource":{"id":"01JY70ZMBEECJH58ZQ1K9K19DH","version":1},"state":"CompletedSuccessfully","tags":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"],"realizationFilters":{"items":[{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"Base","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]},{"items":[{"name":"Base","nodeAddress":"0:2:0"},{"name":"Cost Profile.xlsx","nodeAddress":"0:2:1"},{"name":"Low","nodeAddress":"0:2:2"},{"name":"Base","nodeAddress":"0:2:3"}]}]},"errorMessages":[],"lastUpdatedAt":"2025-06-20T15:57:24.000Z","promotion":{"state":"Running"}}}},"components/schemas/VersionId":{"id":"components/schemas/VersionId","kind":"json-schema","title":"VersionId","data":{"description":"An identifier and version pair.","required":["id","version"],"type":"object","properties":{"id":{"description":"The identifier of the resource.","type":"string","example":"01JY70N7ZGAQ02RZF2BTHDKRN8"},"version":{"format":"int64","description":"The version of the resource.","type":"integer","example":1}},"example":{"id":"01JY70N7ZGAQ02RZF2BTHDKRN8","version":1}}},"components/schemas/VirtualScenarioResultsStateCollection":{"id":"components/schemas/VirtualScenarioResultsStateCollection","kind":"json-schema","title":"VirtualScenarioResultsStateCollection","data":{"description":"List of virtual scenario results states.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VirtualScenarioResultsState"}}},"example":{"items":[{"virtualScenarioId":"01JY70N8TE9DG79NTQZDFMGEW3","dataSource":{"id":"01JY70ZMBEECJH58ZQ1K9K19DH","version":1},"dataSourceProcessingErrors":[],"dataSourceProcessingState":"CompletedSuccessfully","tags":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"],"realizationStates":{"items":[{"uri":"01JY6FMJMY0F6AJFV05V831SB4/realizations/01JY70TF3Q64GJ0CZE6M900M99","version":5,"state":"CompletedSuccessfully","computationStates":{"items":[{"address":"0:1:0","runState":"CompletedSuccessfully"},{"address":"1:1:0","runState":"CompletedSuccessfully"}]},"lastUpdatedAt":"2025-06-20T15:57:24.000Z"}]}},{"virtualScenarioId":"01JY70N8TE64GJ0CZE6M900M99","dataSource":{"id":"01JY70ZMBEECJH58ZQ1K9K19DH","version":1},"dataSourceProcessingErrors":["first error message","second error message"],"dataSourceProcessingState":"CompletedWithErrors","tags":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"],"realizationStates":{"items":[{"uri":"01JY6FMJMY0F6AJFV05V831SB4/realizations/01JY70TF3Q5957VSF9Q7MG0B3D","version":2,"state":"CompletedWithErrors","computationStates":{"items":[{"address":"0:1:0","runState":"CompletedSuccessfully"},{"address":"1:1:0","runState":"CompletedWithErrors","errors":{"items":[{"message":"first error message","addresses":["1:2:0","1:1:0"]},{"message":"second error message","addresses":["1:2:1","1:1:0"]}]}}]},"lastUpdatedAt":"2025-06-20T15:57:24.000Z"},{"uri":"01JY6FMJMY0F6AJFV05V831SB4/realizations/01JY70TF3Q5957VSF9Q7MG0B3E","version":2,"state":"Running","computationStates":{"items":[{"address":"0:1:0","runState":"Running"},{"address":"1:1:0","runState":"Running"}]},"lastUpdatedAt":"2025-06-20T15:55:24.000Z"}]}}]}}},"components/schemas/VirtualScenarioResultsState":{"id":"components/schemas/VirtualScenarioResultsState","kind":"json-schema","title":"VirtualScenarioResultsState","data":{"description":"The result state of a virtual scenario, including its per-realization states.","required":["virtualScenarioId","tags","realizationStates","dataSourceProcessingState"],"type":"object","properties":{"virtualScenarioId":{"description":"The identifier of the virtual scenario.","type":"string"},"tags":{"description":"List of tags associated with the virtual scenario.","type":"array","items":{"type":"string"},"example":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"]},"realizationStates":{"description":"A list of realizations with their corresponding states.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RealizationState"}}}},"dataSourceProcessingState":{"$ref":"#/components/schemas/RunState"},"dataSourceProcessingErrors":{"description":"A list of data source processing errors.","type":"array","items":{"type":"string"}},"dataSource":{"$ref":"#/components/schemas/VersionId"}},"example":{"virtualScenarioId":"01JY70N8TE9DG79NTQZDFMGEW3","dataSource":{"id":"01JY70ZMBEECJH58ZQ1K9K19DH","version":1},"dataSourceProcessingErrors":["first error message"],"dataSourceProcessingState":"CompletedWithErrors","tags":["StudyId:01JY6FMJMY0F6AJFV05V831SB4","Iteration:Iteration1","Case:case1","EnsembleId:01JY70N8V117GD9G75EP3BP5GW"],"realizationStates":{"items":[{"uri":"01JY6FMJMY0F6AJFV05V831SB4/realizations/01JY70TF3Q64GJ0CZE6M900M99","version":3,"state":"CompletedSuccessfully","computationStates":{"items":[{"address":"0:1:0","runState":"CompletedSuccessfully"},{"address":"1:1:0","runState":"CompletedSuccessfully"}]},"lastUpdatedAt":"2025-06-20T15:57:24.000Z"},{"uri":"01JY6FMJMY0F6AJFV05V831SB4/realizations/01JY70TF3Q5957VSF9Q7MG0B3D","version":2,"state":"Running","computationStates":{"items":[{"address":"0:1:0","runState":"Running"},{"address":"1:1:0","runState":"CompletedWithErrors","errors":{"items":[{"message":"first error message","addresses":["1:2:0","1:1:0"]}]}}]},"lastUpdatedAt":"2025-06-20T15:55:24.000Z"}]}}}},"components/schemas/RealizationState":{"id":"components/schemas/RealizationState","kind":"json-schema","title":"RealizationState","data":{"description":"The state of a single realization within a virtual scenario.","required":["uri","version","state"],"type":"object","properties":{"uri":{"description":"The URI of the realization.","type":"string","example":"01JY6FMJMY0F6AJFV05V831SB4/realizations/01JY70TF3Q5957VSF9Q7MG0B3D"},"version":{"format":"int32","description":"The version of the realization.","type":"integer","example":4},"state":{"description":"The state of the realization.","enum":["Unknown","InsufficientData","Running","CompletedSuccessfully","CompletedWithErrors","Stopping","Stopped"],"type":"string","example":"CompletedWithErrors"},"lastUpdatedAt":{"format":"date-time","description":"The time when the realization was last updated.","type":["string","null"],"example":"2025-06-20T15:55:24.000Z"},"resultsErrors":{"description":"The errors produced by the realization results.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ResultsError"}}}},"computationStates":{"description":"List of computation run states for the realization.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ComputationState"}}}}}}},"components/schemas/RunState":{"id":"components/schemas/RunState","kind":"json-schema","title":"RunState","data":{"description":"Run state of a process.","enum":["Unknown","InsufficientData","Running","CompletedSuccessfully","CompletedWithErrors","CompletedWithRetryableErrors","Stopping","Stopped"],"type":"string"}},"components/schemas/ResultsError":{"id":"components/schemas/ResultsError","kind":"json-schema","title":"ResultsError","data":{"description":"An error produced while computing realization results.","required":["message"],"type":"object","properties":{"message":{"description":"A user-friendly message about the error that you can present to users to help them correct the error.","type":"string","example":"An error has occurred"},"addresses":{"description":"A list of workflow specification addresses that describe the parts of a workflow that produced the error.","type":"array","items":{"pattern":"^\\d+:\\d+:\\d+$","type":"string"},"example":["0:1:0","1:2:1"]}}}},"components/schemas/ComputationState":{"id":"components/schemas/ComputationState","kind":"json-schema","title":"ComputationState","data":{"description":"The run state of a single computation within a realization.","required":["address","runState"],"type":"object","properties":{"address":{"description":"The workflow specification address of the computation.","pattern":"^\\d+:\\d+:\\d+$","type":"string"},"runState":{"description":"The run state of the computation.","enum":["Unknown","InsufficientData","Running","CompletedSuccessfully","CompletedWithErrors","Stopping","Stopped"],"type":"string","example":"CompletedWithErrors"},"errors":{"description":"The errors produced by the computation.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ResultsError"}}}}}}},"components/schemas/VirtualScenarioPromotion":{"id":"components/schemas/VirtualScenarioPromotion","kind":"json-schema","title":"VirtualScenarioPromotion","data":{"description":"The promotion of a virtual scenario into a regular scenario.","required":["state"],"type":"object","properties":{"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the virtual scenario promotion."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown - State is invalid or unknown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running - Creating a regular scenario from the virtual scenario is running."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CompletedSuccessfully - Creating a regular scenario from the virtual scenario has completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CompletedWithErrors - Creating a regular scenario from the virtual scenario has completed with errors."},"children":[]}]}]}]}],"enum":["Unknown","Running","CompletedSuccessfully","CompletedWithErrors"],"type":"string","example":"Running"},"errorMessages":{"description":"List of error messages associated with the virtual scenario promotion.","type":"array","items":{"type":"string"},"example":["not allowed to promote a virtual scenario in the running state"]}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","enum":["Unknown","Ready","Running","CompletedSuccessfully","CompletedWithErrors","Stopping","Stopped","Queued"]},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","pattern":"^([a-zA-Z]+):([a-zA-Z0-9-:\\.\\|]+)$"},"minItems":1,"maxItems":10},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$"},"minItems":1,"maxItems":100},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"integer","maximum":100000,"default":0},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":200,"default":200},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$"},"id":"schema_7"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"apiKey","in":"header","paramName":"Authorization"},"appkey":{"id":"appkey","type":"apiKey","in":"header","paramName":"appkey"}},"specVersion":"3.2.0","servers":[{"url":"https://api.delfi.slb.com/planning/virtual-scenarios"},{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"schemaDefinitionsTagName":"Schema Definitions","downloadUrls":[{"title":"Virtual Scenarios Spec","url":"https://developer.slb.com/fdplan/FDPlan-Virtual-Scenarios.yaml"}],"mockServer":{"url":"/_mock/solutions/fdplan/apis/fdplan-virtual-scenarios","position":"last","description":"Mock server"},"disableRouter":true,"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Virtual Scenarios","description":"```plain {% title=\"Client ID\" %}\nprod-nam-services-fdplan.slbservice.com\nprod-eu-services-fdplan.slbservice.com\nprod-au-services-fdplan.slbservice.com\nprod-id-services-fdplan.slbservice.com\nproduction-services-fdplan.slbservice.com\n```\n\nThe Virtual Scenarios API provides an optimized, high-volume interface to\nthe FDPlan evaluation platform.\n\nA virtual scenario is a server-managed way to evaluate a study workflow that\nbypasses the interactive decision and choice framing process. Each virtual scenario\nstarts from a single workflow-input data source that supplies every input node\nof the study workflow, and the platform creates it automatically when a\nworkflow-input data source job succeeds. Virtual scenarios are typically driven\nby external controllers and optimization engines to run sensitivity analyses\nand other large realization sweeps, and they are not shown in the FDPlan user\ninterface as regular scenarios.\n\nThis API has no POST endpoint. To create virtual scenarios, submit a\nworkflow-input data source job through the Data Sources API. Use this API to\nlist virtual scenarios, set the realizations to evaluate, monitor the\nper-realization result states, promote a high-performing virtual scenario to a\nregular scenario, and remove virtual scenarios.\n"}},"baseSlug":"/solutions/fdplan/apis/fdplan-virtual-scenarios","routesMapping":{}}