{"items":[{"type":"link","label":"Uncertainty API","link":"/solutions/fdplan/apis/fdplan-uncertainty","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty","content":{"contentType":"overview","meta":{"name":"Uncertainty API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Uncertainty Spec","url":"https://developer.slb.com/fdplan/FDPlan-Uncertainty.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/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Uncertainty API (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 Uncertainty API exposes the ensembles, realizations, and per-realization"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"results that FDPlan produces when a scenario or virtual scenario is evaluated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A study's uncertainty method controls how realizations are produced for each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ensemble. With MonteCarlo, realizations are created automatically by Monte"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carlo sampling of the input data sources, and the study's number of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"realizations controls how many are generated per scenario. With Deterministic,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you provide the outcomes directly in the input data sources and choose which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"realizations to evaluate, for example a curated set of P10, P50, and P90 cases"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from an external domain study. Evaluation results are then presented as a range of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outcomes that you can use to interpret uncertainty in the key performance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicators (KPIs) of decision alternatives."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ensemble is a collection of realizations produced for a single scenario or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"virtual scenario, scoped to a version of a workflow specification. Each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"realization pins one container reference per workflow-specification node so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that downstream computations and visualizations read deterministic inputs and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outputs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this API to retrieve an ensemble and its realizations, update an ensemble,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read the per-realization indicator values produced by an evaluation, and read"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the computation-event log of a single realization."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Ensembles","link":"/solutions/fdplan/apis/fdplan-uncertainty/ensembles","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/ensembles","items":[{"label":"Get an ensemble","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-uncertainty/ensembles/getensemble","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/ensembles/getensemble","metadata":{"seo":{"title":"Get an ensemble","description":"Get an ensemble by its identifier, including the realizations it holds and the container references that each realization pins for every workflow-specification node."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnsemble","name":"Get an ensemble","isWebhook":false,"pointer":"/paths/~1v1~1ensembles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an ensemble","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an ensemble by its identifier, including the realizations it holds and\nthe container references that each realization pins for every\nworkflow-specification node."},{"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":"id","in":"path","schemaId":"schema_0","description":"The identifier of the ensemble to get.","required":true}],"pointer":"/paths/~1v1~1ensembles~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1ensembles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/ensembles/{id}","servers":[{"url":"https://api.delfi.slb.com/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"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","451","default"],"pointer":"/v1/ensembles/{id}","href":"ensembles/getensemble","openApiOperationId":"getEnsemble","summary":"Get an ensemble"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","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":"The ensemble was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ensemble"}},"schemaId":"components/schemas/Ensemble"},{"code":"400","description":"Invalid 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":"The ensemble was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","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~1ensembles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ensemble","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ensemble"}}},{"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":"451","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":"/ensembles/getensemble"}],"panels":[]}]},"httpPath":"/v1/ensembles/{id}"},{"label":"Update an ensemble","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-uncertainty/ensembles/patchensemble","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/ensembles/patchensemble","metadata":{"seo":{"title":"Update an ensemble","description":"Update an existing ensemble. The request body is a JSON Patch document, and only the replace operation is supported. Use it to change mutable fields, such as the realizations selected for evaluation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEnsemble","name":"Update an ensemble","isWebhook":false,"pointer":"/paths/~1v1~1ensembles~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an ensemble","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing ensemble. The request body is a JSON Patch document, and\nonly the replace operation is supported. Use it to change mutable fields,\nsuch as the realizations selected for evaluation."},{"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":"id","in":"path","schemaId":"schema_0","description":"The identifier of the ensemble to update.","required":true}],"pointer":"/paths/~1v1~1ensembles~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1ensembles~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"schemaId":"components/schemas/PatchReq","pointer":"/paths/~1v1~1ensembles~1{id}/patch/requestBody","description":"The patches to apply to the ensemble. Only the replace operation is supported."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/ensembles/{id}","servers":[{"url":"https://api.delfi.slb.com/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"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/PatchReq"}},"responseCodes":["200","400","401","403","404","default"],"pointer":"/v1/ensembles/{id}","href":"ensembles/patchensemble","openApiOperationId":"patchEnsemble","summary":"Update an ensemble"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/PatchReq","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The ensemble was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ensemble"}},"schemaId":"components/schemas/Ensemble"},{"code":"400","description":"Invalid request body.","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":"403","description":"The request is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The ensemble was 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~1ensembles~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ensemble","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ensemble"}}},{"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":"403","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":"/ensembles/patchensemble"}],"panels":[]}]},"httpPath":"/v1/ensembles/{id}"}],"content":{"contentType":"group","meta":{"name":"Ensembles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ensembles","showPageActions":true},{"nodeType":"markdoc","content":"Getting and updating ensembles."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/ensembles/{id}","summary":"Get an ensemble","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ensembles/getensemble","deprecated":false},{"title":"/v1/ensembles/{id}","summary":"Update an ensemble","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ensembles/patchensemble","deprecated":false}]}]}]}]}},{"type":"group","label":"RealizationEvents","link":"/solutions/fdplan/apis/fdplan-uncertainty/realizationevents","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/realizationevents","items":[{"label":"Get realization computation events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-uncertainty/realizationevents/getrealizationevents","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/realizationevents/getrealizationevents","metadata":{"seo":{"title":"Get realization computation events","description":"Get the computation-event log for a single realization, identified by its URI. The log records each computation event, including its status, timestamp, and any generated log files."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRealizationEvents","name":"Get realization computation events","isWebhook":false,"pointer":"/paths/~1v1~1realization-events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get realization computation events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the computation-event log for a single realization, identified by its\nURI. The log records each computation event, including its status,\ntimestamp, and any generated log files."},{"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":"realizationURI","in":"query","schemaId":"schema_0","description":"The URI of the realization to get the computation events for, for example 01J55K2V6T77MRHGT1EZ60KMJ2/realizations/01J55M7D63XFJM64GS1N2NNE5V.","required":true}],"pointer":"/paths/~1v1~1realization-events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1realization-events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/realization-events","servers":[{"url":"https://api.delfi.slb.com/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"realizationURI","in":"query","required":true,"schemaId":"schema_0"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"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/realization-events","href":"realizationevents/getrealizationevents","openApiOperationId":"getRealizationEvents","summary":"Get realization computation events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","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":"The realization computation events were retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RealizationEvents"}},"schemaId":"components/schemas/RealizationEvents"},{"code":"400","description":"Invalid 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":"The realization was 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~1realization-events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RealizationEvents","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RealizationEvents"}}},{"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":"/realizationevents/getrealizationevents"}],"panels":[]}]},"httpPath":"/v1/realization-events"}],"content":{"contentType":"group","meta":{"name":"RealizationEvents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RealizationEvents","showPageActions":true},{"nodeType":"markdoc","content":"Getting the computation-event log of a realization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/realization-events","summary":"Get realization computation events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/realizationevents/getrealizationevents","deprecated":false}]}]}]}]}},{"type":"group","label":"Results","link":"/solutions/fdplan/apis/fdplan-uncertainty/results","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/results","items":[{"label":"Get realization indicators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-uncertainty/results/getrealizationindicators","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/results/getrealizationindicators","metadata":{"seo":{"title":"Get realization indicators","description":"Get the per-realization indicator values produced by the evaluation of the ensemble. Each entry is keyed on a realization URI and groups its results by workflow-specification node address. Results are returned in pages controlled by offset and limit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRealizationIndicators","name":"Get realization indicators","isWebhook":false,"pointer":"/paths/~1v1~1ensembles~1{id}~1realization-indicators/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get realization indicators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the per-realization indicator values produced by the evaluation of the\nensemble. Each entry is keyed on a realization URI and groups its results by\nworkflow-specification node address. Results are returned in pages controlled\nby offset and limit."},{"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":"id","in":"path","schemaId":"schema_0","description":"The identifier of the ensemble to get the realization indicators for.","required":true}],"pointer":"/paths/~1v1~1ensembles~1{id}~1realization-indicators/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_1","description":"The number of realizations to skip before returning indicator results.","required":true},{"name":"limit","in":"query","schemaId":"schema_2","description":"The maximum number of realizations for which to return indicator results after the offset.","required":true}],"pointer":"/paths/~1v1~1ensembles~1{id}~1realization-indicators/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_0","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1ensembles~1{id}~1realization-indicators/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/ensembles/{id}/realization-indicators","servers":[{"url":"https://api.delfi.slb.com/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"offset","in":"query","required":true,"schemaId":"schema_1"},{"name":"limit","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"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","451","default"],"pointer":"/v1/ensembles/{id}/realization-indicators","href":"results/getrealizationindicators","openApiOperationId":"getRealizationIndicators","summary":"Get realization indicators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","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":"The realization indicators were retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RealizationIndicatorCollection"}},"schemaId":"components/schemas/RealizationIndicatorCollection"},{"code":"400","description":"Invalid 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":"The ensemble was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","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~1ensembles~1{id}~1realization-indicators/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RealizationIndicatorCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RealizationIndicatorCollection"}}},{"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":"451","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":"/results/getrealizationindicators"}],"panels":[]}]},"httpPath":"/v1/ensembles/{id}/realization-indicators"}],"content":{"contentType":"group","meta":{"name":"Results"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Results","showPageActions":true},{"nodeType":"markdoc","content":"Getting per-realization indicator results."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/ensembles/{id}/realization-indicators","summary":"Get realization indicators","prefix":{"name":"get","color":"get"},"badges":[],"link":"/results/getrealizationindicators","deprecated":false}]}]}]}]}},{"type":"group","label":"Schema Definitions","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions","items":[{"type":"link","label":"Ensemble","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/ensemble","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/ensemble","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Ensemble"},"seo":{"title":"Ensemble"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ensemble","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Ensemble"},"children":[]}]}]}},{"type":"link","label":"Realization","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/realization","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/realization","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Realization"},"seo":{"title":"Realization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Realization","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Realization"},"children":[]}]}]}},{"type":"link","label":"VersionId","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/versionid","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/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":"SpecAddress","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/specaddress","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/specaddress","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SpecAddress"},"seo":{"title":"SpecAddress"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SpecAddress","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SpecAddress"},"children":[]}]}]}},{"type":"link","label":"ContainerReference","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/containerreference","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/containerreference","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ContainerReference"},"seo":{"title":"ContainerReference"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ContainerReference","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ContainerReference"},"children":[]}]}]}},{"type":"link","label":"PatchReq","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/patchreq","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/patchreq","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchReq"},"seo":{"title":"PatchReq"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchReq","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchReq"},"children":[]}]}]}},{"type":"link","label":"PatchItem","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/patchitem","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/patchitem","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchItem"},"seo":{"title":"PatchItem"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchItem","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchItem"},"children":[]}]}]}},{"type":"link","label":"Error","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/error","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/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":"Case","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/case","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/case","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Case"},"seo":{"title":"Case"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Case","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Case"},"children":[]}]}]}},{"type":"link","label":"RealizationIndicatorCollection","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/realizationindicatorcollection","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/realizationindicatorcollection","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RealizationIndicatorCollection"},"seo":{"title":"RealizationIndicatorCollection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RealizationIndicatorCollection","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RealizationIndicatorCollection"},"children":[]}]}]}},{"type":"link","label":"RealizationIndicators","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/realizationindicators","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/realizationindicators","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RealizationIndicators"},"seo":{"title":"RealizationIndicators"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RealizationIndicators","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RealizationIndicators"},"children":[]}]}]}},{"type":"link","label":"Indicators","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/indicators","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/indicators","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Indicators"},"seo":{"title":"Indicators"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Indicators","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Indicators"},"children":[]}]}]}},{"type":"link","label":"Indicator","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/indicator","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/indicator","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Indicator"},"seo":{"title":"Indicator"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Indicator","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Indicator"},"children":[]}]}]}},{"type":"link","label":"RealizationEvents","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/realizationevents","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/realizationevents","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RealizationEvents"},"seo":{"title":"RealizationEvents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RealizationEvents","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RealizationEvents"},"children":[]}]}]}},{"type":"link","label":"ComputationEvents","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/computationevents","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/computationevents","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationEvents"},"seo":{"title":"ComputationEvents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationEvents","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationEvents"},"children":[]}]}]}},{"type":"link","label":"ComputationEvent","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/computationevent","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/computationevent","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationEvent"},"seo":{"title":"ComputationEvent"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationEvent","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationEvent"},"children":[]}]}]}},{"type":"link","label":"GeneratedFile","link":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/generatedfile","routeSlug":"/solutions/fdplan/apis/fdplan-uncertainty/schema-definitions/generatedfile","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"GeneratedFile"},"seo":{"title":"GeneratedFile"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GeneratedFile","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/GeneratedFile"},"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":"Ensemble","link":"/schema-definitions/ensemble","deprecated":false},{"title":"Realization","link":"/schema-definitions/realization","deprecated":false},{"title":"VersionId","link":"/schema-definitions/versionid","deprecated":false},{"title":"SpecAddress","link":"/schema-definitions/specaddress","deprecated":false},{"title":"ContainerReference","link":"/schema-definitions/containerreference","deprecated":false},{"title":"PatchReq","link":"/schema-definitions/patchreq","deprecated":false},{"title":"PatchItem","link":"/schema-definitions/patchitem","deprecated":false},{"title":"Error","link":"/schema-definitions/error","deprecated":false},{"title":"Case","link":"/schema-definitions/case","deprecated":false},{"title":"RealizationIndicatorCollection","link":"/schema-definitions/realizationindicatorcollection","deprecated":false},{"title":"RealizationIndicators","link":"/schema-definitions/realizationindicators","deprecated":false},{"title":"Indicators","link":"/schema-definitions/indicators","deprecated":false},{"title":"Indicator","link":"/schema-definitions/indicator","deprecated":false},{"title":"RealizationEvents","link":"/schema-definitions/realizationevents","deprecated":false},{"title":"ComputationEvents","link":"/schema-definitions/computationevents","deprecated":false},{"title":"ComputationEvent","link":"/schema-definitions/computationevent","deprecated":false},{"title":"GeneratedFile","link":"/schema-definitions/generatedfile","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Ensemble":{"id":"components/schemas/Ensemble","kind":"json-schema","title":"Ensemble","data":{"description":"A collection of realizations produced for a single scenario or virtual scenario, scoped to a version of a workflow specification.","required":["Id","workflowSpecId","version","realizations"],"type":"object","properties":{"Id":{"description":"The identifier of the ensemble.","type":"string","example":"01J55M2WX7Z2NM9APBZ92NTNXY"},"version":{"format":"int32","description":"The version of the ensemble.","type":"integer","example":3},"workflowSpecId":{"$ref":"#/components/schemas/VersionId"},"realizations":{"description":"The list of realizations associated with the ensemble.","type":"array","items":{"$ref":"#/components/schemas/Realization"}},"uncertaintyMethod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The methodology used to produce the realizations of the ensemble."},"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":"MonteCarlo - Realizations are created automatically by Monte Carlo sampling of the input data sources."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deterministic - You provide the outcomes directly in the input data sources and choose which realizations to evaluate."},"children":[]}]}]}]}],"default":"MonteCarlo","enum":["MonteCarlo","Deterministic"],"type":"string","example":"Deterministic"},"tags":{"description":"The list of tags associated with the ensemble, such as StudyId and ScenarioId, that link it back to its scenario.","type":"array","items":{"type":"string"},"example":["StudyId:01J55K2V6T77MRHGT1EZ60KMJ2","ScenarioId:01J55M2W4BJA6CGBRCNCK412XZ"]},"cases":{"description":"The cases that the ensemble is associated with.","type":"array","items":{"$ref":"#/components/schemas/Case"}}},"example":{"Id":"01J55M2WX7Z2NM9APBZ92NTNXY","version":3,"workflowSpecId":{"Id":"01E86SDT0780JMFFZHPBV3KVHV","version":1},"uncertaintyMethod":"Deterministic","tags":["StudyId:01J55K2V6T77MRHGT1EZ60KMJ2","ScenarioId:01J55M2W4BJA6CGBRCNCK412XZ"],"cases":[],"realizations":[{"Id":"01J55K2V6T77MRHGT1EZ60KMJ2/realizations/01J55M7D63XFJM64GS1N2NNE5V","status":"Active","version":7,"containers":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"dataType":{"Id":"production-forecast","version":1},"labels":{"name":"Field_Profile Upside Base.xlsx"},"uri":"01J55K2V6T77MRHGT1EZ60KMJ2/containers/production-forecast/01J55M6YHKR877H2M7C31F3MQY"},{"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0},"dataType":{"Id":"peep-output","version":1},"uri":"01J55K2V6T77MRHGT1EZ60KMJ2/containers/peep-output/01J55MH0FYX437F6RDK87BF434"}]}]}}},"components/schemas/Realization":{"id":"components/schemas/Realization","kind":"json-schema","title":"Realization","data":{"description":"One concrete execution of a study's workflow specification for a given scenario or virtual scenario, that is, a single combination of inputs drawn from the ensemble.","required":["Id"],"type":"object","properties":{"Id":{"description":"The URI of the realization, of the shape scenarioId/realizations/realizationId.","type":"string","example":"01J55K2V6T77MRHGT1EZ60KMJ2/realizations/01J55M7D63XFJM64GS1N2NNE5V"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the realization."},"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":"Active - The realization is added for evaluation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proposed - The realization is a candidate that is not set for evaluation."},"children":[]}]}]}]}],"enum":["Active","Proposed"],"type":"string","example":"Active"},"containers":{"description":"The container references pinned by the realization, one per workflow-specification node, so that every computation reads deterministic inputs and outputs.","type":"array","items":{"$ref":"#/components/schemas/ContainerReference"}},"version":{"format":"int32","description":"The version of the realization.","type":"integer","example":7}}}},"components/schemas/VersionId":{"id":"components/schemas/VersionId","kind":"json-schema","title":"VersionId","data":{"description":"An identifier and version pair used to reference a specific version of a resource, such as a workflow specification or a data type.","required":["Id","version"],"type":"object","properties":{"Id":{"description":"The identifier of the resource.","type":"string","example":"01DV2RPKYS5NYBAR6TNMJ8TNT9"},"version":{"format":"int64","description":"The version of the resource.","minimum":1,"type":"integer","example":1}},"example":{"Id":"01E86SDT0780JMFFZHPBV3KVHV","version":1}}},"components/schemas/SpecAddress":{"id":"components/schemas/SpecAddress","kind":"json-schema","title":"SpecAddress","data":{"description":"An address that describes the location of a node within a workflow specification.","required":["type","computationIndex","dataTypeIndex"],"type":"object","properties":{"type":{"description":"The type of node that the address refers to, for example a data type input, a data type output, or a computation specification.","enum":["Invalid","Computation","DataTypeInput","DataTypeOutput","Workflow"],"type":"string","example":"DataTypeInput"},"computationIndex":{"description":"The zero-based index of the computation specification.","type":["integer","null"],"example":0},"dataTypeIndex":{"description":"The zero-based index of a data type with respect to a computation specification. Inputs and outputs are treated as separate ordered lists.","type":["integer","null"],"example":0}}}},"components/schemas/ContainerReference":{"id":"components/schemas/ContainerReference","kind":"json-schema","title":"ContainerReference","data":{"description":"A reference to the container that a realization pins for a single workflow-specification node address.","required":["uri","address"],"type":"object","properties":{"address":{"$ref":"#/components/schemas/SpecAddress"},"uri":{"description":"The URI of the container.","type":"string","example":"01J55K2V6T77MRHGT1EZ60KMJ2/containers/production-forecast/01J55M6YHKR877H2M7C31F3MQY"},"dataType":{"$ref":"#/components/schemas/VersionId"},"labels":{"description":"The labels of the container.","additionalProperties":{"type":"string"},"type":"object","example":{"name":"Field_Profile Upside Base.xlsx"}}}}},"components/schemas/PatchReq":{"id":"components/schemas/PatchReq","kind":"json-schema","title":"PatchReq","data":{"description":"A JSON Patch document as defined by RFC 6902.","type":"array","items":{"$ref":"#/components/schemas/PatchItem"},"example":[{"op":"replace","path":"01K21TCP8YRHJP29K3WXACFPKP/realizations/01K21TRKZG07FYG68EW3Y45X7B/status","value":"Active"}]}},"components/schemas/PatchItem":{"id":"components/schemas/PatchItem","kind":"json-schema","title":"PatchItem","data":{"description":"A single JSON Patch operation as defined by RFC 6902.","required":["op","path"],"properties":{"op":{"description":"The operation to perform. Only the replace operation is supported.","enum":["replace"],"type":"string","example":"replace"},"path":{"description":"A JSON Pointer to the field to update.","type":"string","example":"01K21TCP8YRHJP29K3WXACFPKP/realizations/01K21TRKZG07FYG68EW3Y45X7B/status"},"value":{"description":"The value to use within the operation.","example":"Active"}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"description":"A 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/Case":{"id":"components/schemas/Case","kind":"json-schema","title":"Case","data":{"description":"A case that a realization is associated with.","required":["name"],"type":"object","properties":{"name":{"description":"The name of the case.","maxLength":50,"type":"string","example":"case1"}}}},"components/schemas/RealizationIndicatorCollection":{"id":"components/schemas/RealizationIndicatorCollection","kind":"json-schema","title":"RealizationIndicatorCollection","data":{"description":"A page of per-realization indicator values produced by the evaluation of an ensemble.","required":["items"],"type":"object","properties":{"items":{"description":"The list of realization indicators.","type":"array","items":{"$ref":"#/components/schemas/RealizationIndicators"}}},"example":{"items":[{"realizationURI":"01J55K2V6T77MRHGT1EZ60KMJ2/realizations/01J55M7D63XFJM64GS1N2NNE5V","results":[{"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0},"indicators":[{"name":"NPV","unit":"M$","value":"83.59"},{"name":"Total CAPEX","unit":"M$","value":"9.33"},{"name":"First Oil","value":"2020 01"}]}]}]}}},"components/schemas/RealizationIndicators":{"id":"components/schemas/RealizationIndicators","kind":"json-schema","title":"RealizationIndicators","data":{"description":"The indicator values for a single realization, grouped by workflow-specification node address.","required":["realizationURI","results"],"type":"object","properties":{"realizationURI":{"description":"The URI of the realization.","type":"string","example":"01J55K2V6T77MRHGT1EZ60KMJ2/realizations/01J55M7D63XFJM64GS1N2NNE5V"},"results":{"description":"The indicator results of each computation in the realization.","type":"array","items":{"$ref":"#/components/schemas/Indicators"}}}}},"components/schemas/Indicators":{"id":"components/schemas/Indicators","kind":"json-schema","title":"Indicators","data":{"description":"The indicator results produced at a single workflow-specification node address.","required":["address","indicators"],"type":"object","properties":{"address":{"$ref":"#/components/schemas/SpecAddress"},"indicators":{"description":"The list of indicator results.","type":"array","items":{"$ref":"#/components/schemas/Indicator"}}}}},"components/schemas/Indicator":{"id":"components/schemas/Indicator","kind":"json-schema","title":"Indicator","data":{"description":"A single named indicator value produced by a realization.","required":["name","value"],"type":"object","properties":{"name":{"description":"The name of the indicator.","type":"string","example":"NPV"},"secondaryName":{"description":"The secondary name of the indicator.","type":"string"},"unit":{"description":"The unit of the indicator.","type":"string","example":"M$"},"value":{"description":"The value of the indicator.","type":"string","example":"83.59"},"entityName":{"description":"The name of the entity.","type":"string"},"entityType":{"description":"The type of the entity.","type":"string"},"caseName":{"description":"The name of the case.","type":"string"}}}},"components/schemas/RealizationEvents":{"id":"components/schemas/RealizationEvents","kind":"json-schema","title":"RealizationEvents","data":{"description":"The list of computation events related to a realization.","type":"object","properties":{"computationEvents":{"description":"The computation events grouped by computation.","type":"array","items":{"$ref":"#/components/schemas/ComputationEvents"}}},"example":{"computationEvents":[{"computationID":"8eec8a4a52b64d540bdfbf6f534995ea73fb449771d2626e42c36be339bbd315","computationName":"economics","cases":[],"computationEvent":[{"eventType":"computation required","status":"Running","message":"Running","timestamp":"2024-08-13T10:28:49.038Z","generatedFiles":[]},{"eventType":"computation completed","status":"CompletedSuccessfully","message":"Completed successfully","timestamp":"2024-08-13T10:28:56.155Z","generatedFiles":[]}]}]}}},"components/schemas/ComputationEvents":{"id":"components/schemas/ComputationEvents","kind":"json-schema","title":"ComputationEvents","data":{"description":"The computation events related to a specific computation.","type":"object","properties":{"computationID":{"description":"The identifier of the computation.","type":"string","example":"8eec8a4a52b64d540bdfbf6f534995ea73fb449771d2626e42c36be339bbd315"},"computationName":{"description":"The name of the computation.","type":"string","example":"economics"},"cases":{"description":"The cases that the events are related to.","type":"array","items":{"$ref":"#/components/schemas/Case"}},"computationEvent":{"description":"The list of events recorded for the computation.","type":"array","items":{"$ref":"#/components/schemas/ComputationEvent"}}}}},"components/schemas/ComputationEvent":{"id":"components/schemas/ComputationEvent","kind":"json-schema","title":"ComputationEvent","data":{"description":"A single event recorded for a specific computation.","type":"object","properties":{"source":{"description":"The source that produced the event.","type":"string"},"status":{"description":"The status reported by the event.","type":"string","example":"CompletedSuccessfully"},"eventType":{"description":"The type of the event.","type":"string","example":"computation completed"},"timestamp":{"format":"date-time","description":"The time when the event was recorded.","type":"string","example":"2024-08-13T10:28:56.155Z"},"message":{"description":"The message associated with the event.","type":"string","example":"Completed successfully"},"generatedFiles":{"description":"The log files generated and stored with the event.","type":"array","items":{"$ref":"#/components/schemas/GeneratedFile"}}}}},"components/schemas/GeneratedFile":{"id":"components/schemas/GeneratedFile","kind":"json-schema","title":"GeneratedFile","data":{"description":"A log file generated and stored in an event related to a specific computation.","type":"object","properties":{"description":{"description":"The description of the generated file.","type":"string"},"link":{"description":"The link to the generated file.","type":"string"}}}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100},"id":"schema_2"}},"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/fdplan/uncertainty"},{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"schemaDefinitionsTagName":"Schema Definitions","downloadUrls":[{"title":"Uncertainty Spec","url":"https://developer.slb.com/fdplan/FDPlan-Uncertainty.yaml"}],"mockServer":{"url":"/_mock/solutions/fdplan/apis/fdplan-uncertainty","position":"last","description":"Mock server"},"disableRouter":true,"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Uncertainty API","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 Uncertainty API exposes the ensembles, realizations, and per-realization\nresults that FDPlan produces when a scenario or virtual scenario is evaluated.\n\nA study's uncertainty method controls how realizations are produced for each\nensemble. With MonteCarlo, realizations are created automatically by Monte\nCarlo sampling of the input data sources, and the study's number of\nrealizations controls how many are generated per scenario. With Deterministic,\nyou provide the outcomes directly in the input data sources and choose which\nrealizations to evaluate, for example a curated set of P10, P50, and P90 cases\nfrom an external domain study. Evaluation results are then presented as a range of\noutcomes that you can use to interpret uncertainty in the key performance\nindicators (KPIs) of decision alternatives.\n\nAn ensemble is a collection of realizations produced for a single scenario or\nvirtual scenario, scoped to a version of a workflow specification. Each\nrealization pins one container reference per workflow-specification node so\nthat downstream computations and visualizations read deterministic inputs and\noutputs.\n\nUse this API to retrieve an ensemble and its realizations, update an ensemble,\nread the per-realization indicator values produced by an evaluation, and read\nthe computation-event log of a single realization.\n"}},"baseSlug":"/solutions/fdplan/apis/fdplan-uncertainty","routesMapping":{}}