{"items":[{"type":"link","label":"Evaluation","link":"/solutions/fdplan/apis/fdplan-evaluation","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation","content":{"contentType":"overview","meta":{"name":"Evaluation"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Evaluation Spec","url":"https://developer.slb.com/fdplan/FDPlan-Evaluation.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/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Evaluation (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 Evaluation API is responsible for evaluation workflows in FDPlan. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"key features of the API include:"},"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":"The ability to create custom evaluation workflows."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ability to drive custom evaluation workflows and computations."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key API concepts include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workflow-specs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A workflow-spec is a workflow specification defining"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all the computation specifications which form the workflow. A workflow"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specification also defines the edges which connect computations together"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a graph. These edges connect an output from one computation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specification to the input of another."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number of default 'system' workflow specifications are provided to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user. Details of these 'system' workflow specifications can be discovered"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by using the API to get all workflow specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"computation-specs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A computation-spec is a computation specification"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which defines all the input and output data-types for the computation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number of default 'system' computation specifications are provided to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the user.  Details of these 'system' computation specifications can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discovered by using the API to get all computation specifications."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data-types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A data-type is a specification for a data representation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is required as one of a computation-spec's inputs or produced as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one of a computation-spec's outputs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number of default 'system' data-types are provided to the user. Details"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of these 'system' data-types can be discovered by using the API to get all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data-types."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"computation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A computation is an instance of a computation-spec for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"running workflow. It encapsulates the state of the computation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(i.e. running, succeeded), input/output data containers which have been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with the computation and any errors which have occurred during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the running of the computation. The input and output data containers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with the computation can be accessed through the containers API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operations."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"container"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A container is a resource which holds all the data for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"given data-type definition."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A schema is a formal description of a data-type. It defines"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the structure of the data-type against which data can be validated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number of default schemas for 'system' data-types are provided for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently only JSON schemas are supported, for more information see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schemas defined in the OSDU schema service may be used to describe"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"evaluation data-types by using their unique identifiers in schema"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"references, e.g. osdu:wks:wellbore:1.0.0."},"children":[]}]}]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"WorkflowSpecs","link":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs","items":[{"label":"Get all workflow specifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/getworkflowspecs","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/getworkflowspecs","metadata":{"seo":{"title":"Get all workflow specifications","description":"Get all workflow specifications. The parameter 'IncludePreviousVersions' may be used to return either the most recent versions of the workflow specifications or all possible versions of each workflow specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowSpecs","name":"Get all workflow specifications","isWebhook":false,"pointer":"/paths/~1workflow-specs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all workflow specifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all workflow specifications. The parameter 'IncludePreviousVersions' may be used to return either the most recent versions of the workflow specifications or all possible versions of each workflow specification."},{"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":"includePreviousVersions","in":"query","schemaId":"schema_0","description":"Unless includePreviousVersions is true the response will return only the latest version of each specification."}],"pointer":"/paths/~1workflow-specs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1workflow-specs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflow-specs","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"includePreviousVersions","in":"query","schemaId":"schema_0"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","401","default"],"pointer":"/workflow-specs","href":"workflowspecs/getworkflowspecs","openApiOperationId":"getWorkflowSpecs","summary":"Get all workflow specifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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 workflow specifications successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpecs"}},"schemaId":"components/schemas/WorkflowSpecs"},{"code":"204","description":"No workflow specifications were found."},{"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/~1workflow-specs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowSpecs","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpecs"}}},{"code":"204"},{"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":"/workflowspecs/getworkflowspecs"}],"panels":[]}]},"httpPath":"/workflow-specs"},{"label":"Create workflow specification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/postworkflowspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/postworkflowspec","metadata":{"seo":{"title":"Create workflow specification","description":"Create workflow specification. The create request must contain all the computation specifications which are to make up the workflow specification. These computation specifications must have previously been created. The request must also contain all the edges which connect the computation specifications together. The edges describe the flow of data from one computation specifications output data-type to another computation specifications input data-type. As an example, a workflow specification could consist of two computation specifications connected together. The connection between the two computation specifications could consist of the first output data-type from the first computation specification being connected to the first input data-type of the second computation specification. If the two computation specifications being connected together were the 'ix' and 'peep' computation specifications, the output data-type 'production-forecast' of the 'ix' computation specification would be connected to the input data-type 'production-forecast' of the 'peep' computation specification. As the 'production-forecast' data-type is the first output data-type (zeroth index) in the 'ix' computation specification and the first input data-type (zeroth index) in the 'peep' computation specification, the workflow edge would be defined as going from the index zero output data-type of the computation specification with index zero (the 'ix' computation specification) to the index zero output data-type of the computation index with index one (the 'peep' computation index). The order of the computation specifications provided in the creation of the workflow specification is maintained in the created workflow specification and may only be changed through performing PATCH operations on the workflow specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postWorkflowSpec","name":"Create workflow specification","isWebhook":false,"pointer":"/paths/~1workflow-specs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create workflow specification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create workflow specification. The create request must contain all the computation specifications which are to make up the workflow specification. These computation specifications must have previously been created. The request must also contain all the edges which connect the computation specifications together. The edges describe the flow of data from one computation specifications output data-type to another computation specifications input data-type. As an example, a workflow specification could consist of two computation specifications connected together. The connection between the two computation specifications could consist of the first output data-type from the first computation specification being connected to the first input data-type of the second computation specification. If the two computation specifications being connected together were the 'ix' and 'peep' computation specifications, the output data-type 'production-forecast' of the 'ix' computation specification would be connected to the input data-type 'production-forecast' of the 'peep' computation specification. As the 'production-forecast' data-type is the first output data-type (zeroth index) in the 'ix' computation specification and the first input data-type (zeroth index) in the 'peep' computation specification, the workflow edge would be defined as going from the index zero output data-type of the computation specification with index zero (the 'ix' computation specification) to  the index zero output data-type of the computation index with index one (the 'peep' computation index). The order of the computation specifications provided in the creation of the workflow specification is maintained in the created workflow specification and may only be changed through performing PATCH operations on the workflow specification."},{"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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1workflow-specs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWorkflowSpec"}},"schemaId":"components/schemas/CreateWorkflowSpec","pointer":"/paths/~1workflow-specs/post/requestBody","description":"The workflow specification to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow-specs","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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/CreateWorkflowSpec"}},"responseCodes":["201","401","default"],"pointer":"/workflow-specs","href":"workflowspecs/postworkflowspec","openApiOperationId":"postWorkflowSpec","summary":"Create workflow specification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateWorkflowSpec","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWorkflowSpec"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Workflow specification created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}},"schemaId":"components/schemas/WorkflowSpec"},{"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/~1workflow-specs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WorkflowSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}}},{"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":"/workflowspecs/postworkflowspec"}],"panels":[]}]},"httpPath":"/workflow-specs"},{"label":"Get a workflow specification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/getworkflowspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/getworkflowspec","metadata":{"seo":{"title":"Get a workflow specification","description":"Get a workflow specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowSpec","name":"Get a workflow specification","isWebhook":false,"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a workflow specification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a workflow specification."},{"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":"workflowSpecId","in":"path","schemaId":"schema_1","description":"The workflow specification ID.","required":true}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_2","description":"The id of the data-type to get. If not specified, the latest version will be returned."}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflow-specs/{workflowSpecId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowSpecId","in":"path","required":true,"schemaId":"schema_1"}],"query":[{"name":"version","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/workflow-specs/{workflowSpecId}","href":"workflowspecs/getworkflowspec","openApiOperationId":"getWorkflowSpec","summary":"Get a workflow specification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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 workflow specification successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}},"schemaId":"components/schemas/WorkflowSpec"},{"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 workflow specification 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/~1workflow-specs~1{workflowSpecId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}}},{"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":"/workflowspecs/getworkflowspec"}],"panels":[]}]},"httpPath":"/workflow-specs/{workflowSpecId}"},{"label":"Create or update workflow specification","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/putworkflowspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/putworkflowspec","metadata":{"seo":{"title":"Create or update workflow specification","description":"Create or update workflow specification. The request must contain all the computation specifications which are to make up the workflow specification. These computation specifications must have previously been created. The request must also contain all the edges which connect the computation specifications together. The edges describe the flow of data from one computation specifications output data-type to another computation specifications input data-type. As an example, a workflow specification could consist of two computation specifications connected together. The connection between the two computation specifications could consist of the first output data-type from the first computation specification being connected to the first input data-type of the second computation specification. If the two computation specifications being connected together were the 'ix' and 'peep' computation specifications, the output data-type 'production-forecast' of the 'ix' computation specification would be connected to the input data-type 'production-forecast' of the 'peep' computation specification. As the 'production-forecast' data-type is the first output data-type (zeroth index) in the 'ix' computation specification and the first input data-type (zeroth index) in the 'peep' computation specification, the workflow edge would be defined as going from the index zero output data-type of the computation specification with index zero (the 'ix' computation specification) to the index zero output data-type of the computation index with index one (the 'peep' computation index). The order of the computation specifications provided in the creation of the workflow specification is maintained in the created workflow specification and may be changed through performing PATCH or PUT operations on the workflow specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putWorkflowSpec","name":"Create or update workflow specification","isWebhook":false,"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update workflow specification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update workflow specification. The request must contain all the computation specifications which are to make up the workflow specification. These computation specifications must have previously been created. The request must also contain all the edges which connect the computation specifications together. The edges describe the flow of data from one computation specifications output data-type to another computation specifications input data-type. As an example, a workflow specification could consist of two computation specifications connected together. The connection between the two computation specifications could consist of the first output data-type from the first computation specification being connected to the first input data-type of the second computation specification. If the two computation specifications being connected together were the 'ix' and 'peep' computation specifications, the output data-type 'production-forecast' of the 'ix' computation specification would be connected to the input data-type 'production-forecast' of the 'peep' computation specification. As the 'production-forecast' data-type is the first output data-type (zeroth index) in the 'ix' computation specification and the first input data-type (zeroth index) in the 'peep' computation specification, the workflow edge would be defined as going from the index zero output data-type of the computation specification with index zero (the 'ix' computation specification) to  the index zero output data-type of the computation index with index one (the 'peep' computation index). The order of the computation specifications provided in the creation of the workflow specification is maintained in the created workflow specification and may be changed through performing PATCH or PUT operations on the workflow specification."},{"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":"workflowSpecId","in":"path","schemaId":"schema_1","description":"The workflow specification ID.","required":true}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceWorkflowSpec"}},"schemaId":"components/schemas/ReplaceWorkflowSpec","pointer":"/paths/~1workflow-specs~1{workflowSpecId}/put/requestBody","description":"The workflow specification to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflow-specs/{workflowSpecId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowSpecId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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/ReplaceWorkflowSpec"}},"responseCodes":["200","201","400","401","default"],"pointer":"/workflow-specs/{workflowSpecId}","href":"workflowspecs/putworkflowspec","openApiOperationId":"putWorkflowSpec","summary":"Create or update workflow specification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ReplaceWorkflowSpec","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceWorkflowSpec"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workflow specification updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}},"schemaId":"components/schemas/WorkflowSpec"},{"code":"201","description":"Workflow specification created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}},"schemaId":"components/schemas/WorkflowSpec"},{"code":"400","description":"Unauthorized.","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/~1workflow-specs~1{workflowSpecId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}}},{"code":"201","schemaId":"components/schemas/WorkflowSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}}},{"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":"/workflowspecs/putworkflowspec"}],"panels":[]}]},"httpPath":"/workflow-specs/{workflowSpecId}"},{"label":"Update a workflow specification","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/patchworkflowspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/patchworkflowspec","metadata":{"seo":{"title":"Update a workflow specification","description":"Update a workflow specification. It is only possible to update the \"name\", \"description\", \"archived\", \"computationSpecs\", \"edges\" and \"annotations\" fields of the workflow specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchWorkflowSpec","name":"Update a workflow specification","isWebhook":false,"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a workflow specification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a workflow specification. It is only possible to update the \"name\", \"description\", \"archived\", \"computationSpecs\", \"edges\" and \"annotations\" fields of the workflow specification."},{"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":"workflowSpecId","in":"path","schemaId":"schema_1","description":"The workflow specification ID.","required":true}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}/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/~1workflow-specs~1{workflowSpecId}/patch/requestBody","description":"The patches to apply to the workflow specification. Only \"replace\" operations are supported with the exception of \"add\" and \"remove\" for \"annotations\" path. It is only possible to update the \"name\", \"description\", \"archived\", \"computationSpecs\", \"edges\" and \"annotations\" fields of the workflow specification."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/workflow-specs/{workflowSpecId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowSpecId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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","401","404","default"],"pointer":"/workflow-specs/{workflowSpecId}","href":"workflowspecs/patchworkflowspec","openApiOperationId":"patchWorkflowSpec","summary":"Update a workflow specification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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":"Workflow specification updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}},"schemaId":"components/schemas/WorkflowSpec"},{"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 workflow specification 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/~1workflow-specs~1{workflowSpecId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpec"}}},{"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":"/workflowspecs/patchworkflowspec"}],"panels":[]}]},"httpPath":"/workflow-specs/{workflowSpecId}"},{"label":"Create or update configuration for a computation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/putcomputationconfig","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/putcomputationconfig","metadata":{"seo":{"title":"Create or update configuration for a computation","description":"Create or update configuration properties for a computation. The parameters workflowSpecIdand computationIndex will be used to uniquely identify the configuration to be created or updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putComputationConfig","name":"Create or update configuration for a computation","isWebhook":false,"pointer":"/paths/~1workflow-specs~1{workflowSpecId}~1computation-config/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update configuration for a computation","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":"Create or update configuration properties for a computation. The parameters workflowSpecId"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and computationIndex will be used to uniquely identify the configuration to be created or updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": It is advised not to change the computation configurations while an evaluation is running. This might lead to unexpected evaluation results."},"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":"workflowSpecId","in":"path","schemaId":"schema_1","description":"The workflow specification ID.","required":true}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}~1computation-config/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"computationIndex","in":"query","schemaId":"schema_3","description":"The computation index in the workflow spec.","required":true}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}~1computation-config/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1workflow-specs~1{workflowSpecId}~1computation-config/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ComputationConfiguration"}},"schemaId":"components/schemas/ComputationConfiguration","pointer":"/paths/~1workflow-specs~1{workflowSpecId}~1computation-config/put/requestBody","description":"The configuration properties for a computation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflow-specs/{workflowSpecId}/computation-config","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowSpecId","in":"path","required":true,"schemaId":"schema_1"}],"query":[{"name":"computationIndex","in":"query","required":true,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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/ComputationConfiguration"}},"responseCodes":["204","400","401","default"],"pointer":"/workflow-specs/{workflowSpecId}/computation-config","href":"workflowspecs/putcomputationconfig","openApiOperationId":"putComputationConfig","summary":"Create or update configuration for a computation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ComputationConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ComputationConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Computation configuration created successfully."},{"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/~1workflow-specs~1{workflowSpecId}~1computation-config/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"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":"/workflowspecs/putcomputationconfig"}],"panels":[]}]},"httpPath":"/workflow-specs/{workflowSpecId}/computation-config"},{"label":"Get all input mappings that originates from the given workflow specification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/getworkflowspecmappings","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/getworkflowspecmappings","metadata":{"seo":{"title":"Get all input mappings that originates from the given workflow specification","description":"Get all input mappings that originates from the given workflow specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowSpecMappings","name":"Get all input mappings that originates from the given workflow specification","isWebhook":false,"pointer":"/paths/~1workflow-specs-mappings~1{workflowSpecId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all input mappings that originates from the given workflow specification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all input mappings that originates from the given workflow specification."},{"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":"workflowSpecId","in":"path","schemaId":"schema_1","description":"The ID of the workflow specification to return mappings for.","required":true}],"pointer":"/paths/~1workflow-specs-mappings~1{workflowSpecId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_4","description":"The version of the workflow specification to return mappings for.","required":true}],"pointer":"/paths/~1workflow-specs-mappings~1{workflowSpecId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1workflow-specs-mappings~1{workflowSpecId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflow-specs-mappings/{workflowSpecId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"workflowSpecId","in":"path","required":true,"schemaId":"schema_1"}],"query":[{"name":"version","in":"query","required":true,"schemaId":"schema_4"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/workflow-specs-mappings/{workflowSpecId}","href":"workflowspecs/getworkflowspecmappings","openApiOperationId":"getWorkflowSpecMappings","summary":"Get all input mappings that originates from the given workflow specification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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":"Workflow specification input mappings originating from the given workflow specification","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpecMappings"}},"schemaId":"components/schemas/WorkflowSpecMappings"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Workflow specification was not found"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow-specs-mappings~1{workflowSpecId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowSpecMappings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpecMappings"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflowspecs/getworkflowspecmappings"}],"panels":[]}]},"httpPath":"/workflow-specs-mappings/{workflowSpecId}"},{"label":"Create or update input mapping between two workflow specifications","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/putworkflowspecmapping","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/workflowspecs/putworkflowspecmapping","metadata":{"seo":{"title":"Create or update input mapping between two workflow specifications","description":"Create or update input mapping between two workflow specifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putWorkflowSpecMapping","name":"Create or update input mapping between two workflow specifications","isWebhook":false,"pointer":"/paths/~1workflow-specs-mappings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update input mapping between two workflow specifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update input mapping between two workflow specifications."},{"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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1workflow-specs-mappings/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowSpecMapping"}},"schemaId":"components/schemas/WorkflowSpecMapping","pointer":"/paths/~1workflow-specs-mappings/put/requestBody","description":"The request to create or update workflow specification input mapping."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflow-specs-mappings","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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/WorkflowSpecMapping"}},"responseCodes":["200","201","400","401","404","default"],"pointer":"/workflow-specs-mappings","href":"workflowspecs/putworkflowspecmapping","openApiOperationId":"putWorkflowSpecMapping","summary":"Create or update input mapping between two workflow specifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/WorkflowSpecMapping","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkflowSpecMapping"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workflow specification input mapping updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpecMapping"}},"schemaId":"components/schemas/WorkflowSpecMapping"},{"code":"201","description":"Workflow specification input mapping created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpecMapping"}},"schemaId":"components/schemas/WorkflowSpecMapping"},{"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":"Workflow specification was not found"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1workflow-specs-mappings/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkflowSpecMapping","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpecMapping"}}},{"code":"201","schemaId":"components/schemas/WorkflowSpecMapping","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkflowSpecMapping"}}},{"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"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflowspecs/putworkflowspecmapping"}],"panels":[]}]},"httpPath":"/workflow-specs-mappings"}],"content":{"contentType":"group","meta":{"name":"WorkflowSpecs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowSpecs","showPageActions":true},{"nodeType":"markdoc","content":"Creating, getting and updating workflow-specifications."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflow-specs","summary":"Get all workflow specifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflowspecs/getworkflowspecs","deprecated":false},{"title":"/workflow-specs","summary":"Create workflow specification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflowspecs/postworkflowspec","deprecated":false},{"title":"/workflow-specs/{workflowSpecId}","summary":"Get a workflow specification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflowspecs/getworkflowspec","deprecated":false},{"title":"/workflow-specs/{workflowSpecId}","summary":"Create or update workflow specification","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflowspecs/putworkflowspec","deprecated":false},{"title":"/workflow-specs/{workflowSpecId}","summary":"Update a workflow specification","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/workflowspecs/patchworkflowspec","deprecated":false},{"title":"/workflow-specs/{workflowSpecId}/computation-config","summary":"Create or update configuration for a computation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflowspecs/putcomputationconfig","deprecated":false},{"title":"/workflow-specs-mappings/{workflowSpecId}","summary":"Get all input mappings that originates from the given workflow specification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflowspecs/getworkflowspecmappings","deprecated":false},{"title":"/workflow-specs-mappings","summary":"Create or update input mapping between two workflow specifications","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflowspecs/putworkflowspecmapping","deprecated":false}]}]}]}]}},{"type":"group","label":"ComputationSpecs","link":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs","items":[{"label":"Get all computation specifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/getcomputationspecs","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/getcomputationspecs","metadata":{"seo":{"title":"Get all computation specifications","description":"Get all computation specifications. The parameter 'IncludePreviousVersions' may be used to return either the most recent versions of the computation specifications or all possible versions of each computation specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getComputationSpecs","name":"Get all computation specifications","isWebhook":false,"pointer":"/paths/~1computation-specs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all computation specifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all computation specifications. The parameter 'IncludePreviousVersions' may be used to return either the most recent versions of the computation specifications or all possible versions of each computation specification."},{"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":"includePreviousVersions","in":"query","schemaId":"schema_0","description":"Unless includePreviousVersions is true the response will return only the latest version of each specification."}],"pointer":"/paths/~1computation-specs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1computation-specs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/computation-specs","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"includePreviousVersions","in":"query","schemaId":"schema_0"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","401","default"],"pointer":"/computation-specs","href":"computationspecs/getcomputationspecs","openApiOperationId":"getComputationSpecs","summary":"Get all computation specifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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 computation specifications successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpecs"}},"schemaId":"components/schemas/ComputationSpecs"},{"code":"204","description":"No computation specifications were found."},{"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/~1computation-specs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ComputationSpecs","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpecs"}}},{"code":"204"},{"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":"/computationspecs/getcomputationspecs"}],"panels":[]}]},"httpPath":"/computation-specs"},{"label":"Create a computation specification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/postcomputationspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/postcomputationspec","metadata":{"seo":{"title":"Create a computation specification","description":"Create a computation specification. The create request must contain all the input and output data-type IDs which are used to define the computation specification. These data-types must have previously been created. As an example, a computation specification could be defined as a specification for a compute which takes two pieces of input data and calculates a single piece of output data. The specification for this compute would take two input data-types and output a single output data-type. The order of the input and output data-type IDs provided in the creation of the computation specification is maintained in the created computation specification and may only be changed through performing PATCH operations on the computation specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postComputationSpec","name":"Create a computation specification","isWebhook":false,"pointer":"/paths/~1computation-specs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a computation specification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a computation specification. The create request must contain all the input and output data-type IDs which are used to define the computation specification. These data-types must have previously been created. As an example, a computation specification could be defined as a specification for a compute which takes two pieces of input data and calculates a single piece of output data. The specification for this compute would take two input data-types and output a single output data-type. The order of the input and output data-type IDs provided in the creation of the computation specification is maintained in the created computation specification and may only be changed through performing PATCH operations on the computation specification."},{"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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1computation-specs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateComputationSpec"}},"schemaId":"components/schemas/CreateComputationSpec","pointer":"/paths/~1computation-specs/post/requestBody","description":"The computation specification to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/computation-specs","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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/CreateComputationSpec"}},"responseCodes":["201","401","default"],"pointer":"/computation-specs","href":"computationspecs/postcomputationspec","openApiOperationId":"postComputationSpec","summary":"Create a computation specification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateComputationSpec","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateComputationSpec"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Computation specification created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}},"schemaId":"components/schemas/ComputationSpec"},{"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/~1computation-specs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ComputationSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}}},{"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":"/computationspecs/postcomputationspec"}],"panels":[]}]},"httpPath":"/computation-specs"},{"label":"Get computation specification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/getcomputationspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/getcomputationspec","metadata":{"seo":{"title":"Get computation specification","description":"Get computation specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getComputationSpec","name":"Get computation specification","isWebhook":false,"pointer":"/paths/~1computation-specs~1{computationSpecId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get computation specification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get computation specification."},{"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":"computationSpecId","in":"path","schemaId":"schema_1","description":"The computation specification ID.","required":true}],"pointer":"/paths/~1computation-specs~1{computationSpecId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_2","description":"The id of the data-type to get. If not specified, the latest version will be returned."}],"pointer":"/paths/~1computation-specs~1{computationSpecId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1computation-specs~1{computationSpecId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/computation-specs/{computationSpecId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"computationSpecId","in":"path","required":true,"schemaId":"schema_1"}],"query":[{"name":"version","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/computation-specs/{computationSpecId}","href":"computationspecs/getcomputationspec","openApiOperationId":"getComputationSpec","summary":"Get computation specification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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 computation specification successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}},"schemaId":"components/schemas/ComputationSpec"},{"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 computation specification 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/~1computation-specs~1{computationSpecId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ComputationSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}}},{"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":"/computationspecs/getcomputationspec"}],"panels":[]}]},"httpPath":"/computation-specs/{computationSpecId}"},{"label":"Create or update a computation specification","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/putcomputationspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/putcomputationspec","metadata":{"seo":{"title":"Create or update a computation specification","description":"Create or update a computation specification. The request must contain all the input and output data-type IDs which are used to define the computation specification. These data-types must have previously been created. As an example, a computation specification could be defined as a specification for a compute which takes two pieces of input data and calculates a single piece of output data. The specification for this compute would take two input data-types and output a single output data-type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putComputationSpec","name":"Create or update a computation specification","isWebhook":false,"pointer":"/paths/~1computation-specs~1{computationSpecId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update a computation specification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a computation specification. The request must contain all the input and output data-type IDs which are used to define the computation specification. These data-types must have previously been created. As an example, a computation specification could be defined as a specification for a compute which takes two pieces of input data and calculates a single piece of output data. The specification for this compute would take two input data-types and output a single output data-type."},{"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":"computationSpecId","in":"path","schemaId":"schema_1","description":"The computation specification ID.","required":true}],"pointer":"/paths/~1computation-specs~1{computationSpecId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1computation-specs~1{computationSpecId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceComputationSpec"}},"schemaId":"components/schemas/ReplaceComputationSpec","pointer":"/paths/~1computation-specs~1{computationSpecId}/put/requestBody","description":"The computation specification to be created or updated."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/computation-specs/{computationSpecId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"computationSpecId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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/ReplaceComputationSpec"}},"responseCodes":["200","201","400","401","default"],"pointer":"/computation-specs/{computationSpecId}","href":"computationspecs/putcomputationspec","openApiOperationId":"putComputationSpec","summary":"Create or update a computation specification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ReplaceComputationSpec","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceComputationSpec"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Computation specification updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}},"schemaId":"components/schemas/ComputationSpec"},{"code":"201","description":"Computation specification created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}},"schemaId":"components/schemas/ComputationSpec"},{"code":"400","description":"Unauthorized.","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/~1computation-specs~1{computationSpecId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ComputationSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}}},{"code":"201","schemaId":"components/schemas/ComputationSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}}},{"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":"/computationspecs/putcomputationspec"}],"panels":[]}]},"httpPath":"/computation-specs/{computationSpecId}"},{"label":"Update computation specification","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/patchcomputationspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/computationspecs/patchcomputationspec","metadata":{"seo":{"title":"Update computation specification","description":"Update computation specification. It is only possible to update the \"name\", \"description\", \"archived\", \"inputDataTypeIds\", \"outputDataTypeIds\" and \"annotations\" fields of the computation specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchComputationSpec","name":"Update computation specification","isWebhook":false,"pointer":"/paths/~1computation-specs~1{computationSpecId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update computation specification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update computation specification. It is only possible to update the \"name\", \"description\", \"archived\", \"inputDataTypeIds\", \"outputDataTypeIds\" and \"annotations\" fields of the computation specification."},{"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":"computationSpecId","in":"path","schemaId":"schema_1","description":"The computation specification ID.","required":true}],"pointer":"/paths/~1computation-specs~1{computationSpecId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1computation-specs~1{computationSpecId}/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/~1computation-specs~1{computationSpecId}/patch/requestBody","description":"The patches to apply to the computation specification. Only \"replace\" operations are supported with the exception of \"add\" and \"remove\" for \"annotations\" path. It is only possible to update the \"name\", \"description\", \"archived\", \"inputDataTypeIds\", \"outputDataTypeIds\" and \"annotations\" fields of the computation specification."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/computation-specs/{computationSpecId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"computationSpecId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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","401","404","default"],"pointer":"/computation-specs/{computationSpecId}","href":"computationspecs/patchcomputationspec","openApiOperationId":"patchComputationSpec","summary":"Update computation specification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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":"Computation specification updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}},"schemaId":"components/schemas/ComputationSpec"},{"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 computation specification 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/~1computation-specs~1{computationSpecId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ComputationSpec","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComputationSpec"}}},{"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":"/computationspecs/patchcomputationspec"}],"panels":[]}]},"httpPath":"/computation-specs/{computationSpecId}"}],"content":{"contentType":"group","meta":{"name":"ComputationSpecs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationSpecs","showPageActions":true},{"nodeType":"markdoc","content":"Creating, getting and updating computation-specifications."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/computation-specs","summary":"Get all computation specifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/computationspecs/getcomputationspecs","deprecated":false},{"title":"/computation-specs","summary":"Create a computation specification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/computationspecs/postcomputationspec","deprecated":false},{"title":"/computation-specs/{computationSpecId}","summary":"Get computation specification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/computationspecs/getcomputationspec","deprecated":false},{"title":"/computation-specs/{computationSpecId}","summary":"Create or update a computation specification","prefix":{"name":"put","color":"put"},"badges":[],"link":"/computationspecs/putcomputationspec","deprecated":false},{"title":"/computation-specs/{computationSpecId}","summary":"Update computation specification","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/computationspecs/patchcomputationspec","deprecated":false}]}]}]}]}},{"type":"group","label":"DataTypes","link":"/solutions/fdplan/apis/fdplan-evaluation/datatypes","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/datatypes","items":[{"label":"Get all data-types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/getdatatypes","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/getdatatypes","metadata":{"seo":{"title":"Get all data-types","description":"Get all data-types. The parameter 'IncludePreviousVersions' may be used to return either the most recent versions of the data-types or all possible versions of each data-type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataTypes","name":"Get all data-types","isWebhook":false,"pointer":"/paths/~1data-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all data-types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all data-types. The parameter 'IncludePreviousVersions' may be used to return either the most recent versions of the data-types or all possible versions of each data-type."},{"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":"includePreviousVersions","in":"query","schemaId":"schema_0","description":"Unless includePreviousVersions is true the response will return only the latest version of each specification."}],"pointer":"/paths/~1data-types/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1data-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-types","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"includePreviousVersions","in":"query","schemaId":"schema_0"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","401","default"],"pointer":"/data-types","href":"datatypes/getdatatypes","openApiOperationId":"getDataTypes","summary":"Get all data-types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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 data-types successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataTypes"}},"schemaId":"components/schemas/DataTypes"},{"code":"204","description":"No data-types were found."},{"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/~1data-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataTypes","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataTypes"}}},{"code":"204"},{"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":"/datatypes/getdatatypes"}],"panels":[]}]},"httpPath":"/data-types"},{"label":"Create data-type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/postdatatype","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/postdatatype","metadata":{"seo":{"title":"Create data-type","description":"Create data-type. The create request must contain all the file types which are to be associated with the data-type. For example, if the data-type was to allow the use of JSON documents then the request would list it as a file specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postDataType","name":"Create data-type","isWebhook":false,"pointer":"/paths/~1data-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create data-type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create data-type. The create request must contain all the file types which are to be associated with the data-type. For example, if the data-type was to allow the use of JSON documents then the request would list it as a file specification."},{"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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1data-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDataType"}},"schemaId":"components/schemas/CreateDataType","pointer":"/paths/~1data-types/post/requestBody","description":"The data-type to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data-types","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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/CreateDataType"}},"responseCodes":["201","401","default"],"pointer":"/data-types","href":"datatypes/postdatatype","openApiOperationId":"postDataType","summary":"Create data-type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateDataType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDataType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Data-type created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}},"schemaId":"components/schemas/DataType"},{"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/~1data-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/DataType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}}},{"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":"/datatypes/postdatatype"}],"panels":[]}]},"httpPath":"/data-types"},{"label":"Get a data-type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/getdatatype","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/getdatatype","metadata":{"seo":{"title":"Get a data-type","description":"Get a data-type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataType","name":"Get a data-type","isWebhook":false,"pointer":"/paths/~1data-types~1{dataTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a data-type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a data-type."},{"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":"dataTypeId","in":"path","schemaId":"schema_1","description":"The data-type ID.","required":true}],"pointer":"/paths/~1data-types~1{dataTypeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_2","description":"The id of the data-type to get. If not specified, the latest version will be returned."}],"pointer":"/paths/~1data-types~1{dataTypeId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1data-types~1{dataTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data-types/{dataTypeId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataTypeId","in":"path","required":true,"schemaId":"schema_1"}],"query":[{"name":"version","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/data-types/{dataTypeId}","href":"datatypes/getdatatype","openApiOperationId":"getDataType","summary":"Get a data-type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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 data-type successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}},"schemaId":"components/schemas/DataType"},{"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 data-type 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/~1data-types~1{dataTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}}},{"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":"/datatypes/getdatatype"}],"panels":[]}]},"httpPath":"/data-types/{dataTypeId}"},{"label":"Create or update data-type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/putdatatype","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/putdatatype","metadata":{"seo":{"title":"Create or update data-type","description":"Create or update data-type. The request must contain all the file types which are to be associated with the data-type. For example, if the data-type was to allow the use of JSON documents then the request would list it as a file specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putDataType","name":"Create or update data-type","isWebhook":false,"pointer":"/paths/~1data-types~1{dataTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update data-type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update data-type. The request must contain all the file types\nwhich are to be associated with the data-type. For example, if\nthe data-type was to allow the use of JSON documents then the request\nwould list it as a file specification.\n"},{"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":"dataTypeId","in":"path","schemaId":"schema_1","description":"The data-type ID.","required":true}],"pointer":"/paths/~1data-types~1{dataTypeId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1data-types~1{dataTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceDataType"}},"schemaId":"components/schemas/ReplaceDataType","pointer":"/paths/~1data-types~1{dataTypeId}/put/requestBody","description":"The data-type to be updated or created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/data-types/{dataTypeId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataTypeId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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/ReplaceDataType"}},"responseCodes":["200","201","400","401","default"],"pointer":"/data-types/{dataTypeId}","href":"datatypes/putdatatype","openApiOperationId":"putDataType","summary":"Create or update data-type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ReplaceDataType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceDataType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data-type updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}},"schemaId":"components/schemas/DataType"},{"code":"201","description":"Data-type created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}},"schemaId":"components/schemas/DataType"},{"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/~1data-types~1{dataTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}}},{"code":"201","schemaId":"components/schemas/DataType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}}},{"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":"/datatypes/putdatatype"}],"panels":[]}]},"httpPath":"/data-types/{dataTypeId}"},{"label":"Update a data-type","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/patchdatatype","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/datatypes/patchdatatype","metadata":{"seo":{"title":"Update a data-type","description":"Update a data-type. It is only possible to update the \"name\", \"description\", \"archived\", and \"fileSpecs\" fields of the data-type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDataType","name":"Update a data-type","isWebhook":false,"pointer":"/paths/~1data-types~1{dataTypeId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a data-type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a data-type. It is only possible to update the \"name\", \"description\", \"archived\", and \"fileSpecs\" fields of the data-type."},{"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":"dataTypeId","in":"path","schemaId":"schema_1","description":"The data-type ID.","required":true}],"pointer":"/paths/~1data-types~1{dataTypeId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1data-types~1{dataTypeId}/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/~1data-types~1{dataTypeId}/patch/requestBody","description":"The patches to apply to the data-type. Only \"replace\" operations are supported. It is only possible to update the \"name\", \"description\", \"archived\" and \"fileSpecs\" fields of the data-type."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/data-types/{dataTypeId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"dataTypeId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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","401","404","default"],"pointer":"/data-types/{dataTypeId}","href":"datatypes/patchdatatype","openApiOperationId":"patchDataType","summary":"Update a data-type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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":"Data-type updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}},"schemaId":"components/schemas/DataType"},{"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 data-type 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/~1data-types~1{dataTypeId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataType"}}},{"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":"/datatypes/patchdatatype"}],"panels":[]}]},"httpPath":"/data-types/{dataTypeId}"}],"content":{"contentType":"group","meta":{"name":"DataTypes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataTypes","showPageActions":true},{"nodeType":"markdoc","content":"Creating, getting and updating data-types."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data-types","summary":"Get all data-types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/datatypes/getdatatypes","deprecated":false},{"title":"/data-types","summary":"Create data-type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/datatypes/postdatatype","deprecated":false},{"title":"/data-types/{dataTypeId}","summary":"Get a data-type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/datatypes/getdatatype","deprecated":false},{"title":"/data-types/{dataTypeId}","summary":"Create or update data-type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/datatypes/putdatatype","deprecated":false},{"title":"/data-types/{dataTypeId}","summary":"Update a data-type","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/datatypes/patchdatatype","deprecated":false}]}]}]}]}},{"type":"group","label":"Computations","link":"/solutions/fdplan/apis/fdplan-evaluation/computations","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/computations","items":[{"label":"Get a computation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/computations/getcomputation","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/computations/getcomputation","metadata":{"seo":{"title":"Get a computation","description":"Get a computation given the computation ID. The computation contains the state of the computation (i.e. running, succeeded), input/output data containers which has been associated with the computation and any errors which have occurred during the running of the computation. The input and output data containers associated with the computation can be accessed through the containers API operations.Computations external to FDPlan can discover when computations are required to be performed by querying the FDPlan Events API for events with the type 'com.slb.cloud.fdplan.evaluation.computation_required_{computation_spec_id}_v{computation_spec_version}.v1', for instance 'com.slb.cloud.fdplan.evaluation.computation_required_ix_v1.v1'. The data for this event type contains information on the computation which is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getComputation","name":"Get a computation","isWebhook":false,"pointer":"/paths/~1computations~1{computationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a computation","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 computation given the computation ID. The computation contains the state of the computation (i.e. running, succeeded), input/output data containers which has been associated with the computation and any errors which have occurred during the running of the computation. The input and output data containers associated with the computation can be accessed through the containers API operations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Computations external to FDPlan can discover when computations are required to be performed by querying the FDPlan Events API for events with the type 'com.slb.cloud.fdplan.evaluation.computation_required_{computation_spec_id}_v{computation_spec_version}.v1', for instance 'com.slb.cloud.fdplan.evaluation.computation_required_ix_v1.v1'. The data for this event type contains information on the computation which is required."},"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":"computationId","in":"path","schemaId":"schema_1","description":"The ID of the computation.","required":true}],"pointer":"/paths/~1computations~1{computationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeDataLinkContent","in":"query","schemaId":"schema_5","description":"Flag will include data-link.json content encoded as base64."},{"name":"includeSignedURL","in":"query","schemaId":"schema_5","description":"Flag will include signed url for data-types with file size limit greater than 20MB."}],"pointer":"/paths/~1computations~1{computationId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1computations~1{computationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/computations/{computationId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"computationId","in":"path","required":true,"schemaId":"schema_1"}],"query":[{"name":"includeDataLinkContent","in":"query","schemaId":"schema_5"},{"name":"includeSignedURL","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/computations/{computationId}","href":"computations/getcomputation","openApiOperationId":"getComputation","summary":"Get a computation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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 computation successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Computation"}},"schemaId":"components/schemas/Computation"},{"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 computation was not found."},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1computations~1{computationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Computation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Computation"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/computations/getcomputation"}],"panels":[]}]},"httpPath":"/computations/{computationId}"},{"label":"Set status of computation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/computations/postcomputationstatus","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/computations/postcomputationstatus","metadata":{"seo":{"title":"Set status of computation","description":"Set status of computation given the computation ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postComputationStatus","name":"Set status of computation","isWebhook":false,"pointer":"/paths/~1computations~1{computationId}~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set status of computation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set status of computation given the computation ID."},{"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":"computationId","in":"path","schemaId":"schema_1","description":"The ID of the computation.","required":true}],"pointer":"/paths/~1computations~1{computationId}~1status/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1computations~1{computationId}~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetComputationStatus"}},"schemaId":"components/schemas/SetComputationStatus","pointer":"/paths/~1computations~1{computationId}~1status/post/requestBody","description":"The details of the computation status to be set."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/computations/{computationId}/status","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"computationId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"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/SetComputationStatus"}},"responseCodes":["201","401","404","default"],"pointer":"/computations/{computationId}/status","href":"computations/postcomputationstatus","openApiOperationId":"postComputationStatus","summary":"Set status of computation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/SetComputationStatus","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetComputationStatus"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Computation status updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Computation"}},"schemaId":"components/schemas/Computation"},{"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 computation 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/~1computations~1{computationId}~1status/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Computation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Computation"}}},{"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":"/computations/postcomputationstatus"}],"panels":[]}]},"httpPath":"/computations/{computationId}/status"}],"content":{"contentType":"group","meta":{"name":"Computations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Computations","showPageActions":true},{"nodeType":"markdoc","content":"Managing computation state."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/computations/{computationId}","summary":"Get a computation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/computations/getcomputation","deprecated":false},{"title":"/computations/{computationId}/status","summary":"Set status of computation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/computations/postcomputationstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Containers","link":"/solutions/fdplan/apis/fdplan-evaluation/containers","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/containers","items":[{"label":"Get container","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/containers/getcontainer","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/containers/getcontainer","metadata":{"seo":{"title":"Get container","description":"Get container given the container ID. The container ID associated with a given computation can be accessed through the computations API operations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContainer","name":"Get container","isWebhook":false,"pointer":"/paths/~1containers~1{containerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get container","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get container given the container ID. The container ID associated with a given computation can be accessed through the computations API operations."},{"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":"containerId","in":"path","schemaId":"schema_1","description":"The ID of the container.","required":true}],"pointer":"/paths/~1containers~1{containerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeDataLinkContent","in":"query","schemaId":"schema_5","description":"Flag will include data-link.json content encoded as base64."}],"pointer":"/paths/~1containers~1{containerId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1containers~1{containerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/containers/{containerId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"containerId","in":"path","required":true,"schemaId":"schema_1"}],"query":[{"name":"includeDataLinkContent","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/containers/{containerId}","href":"containers/getcontainer","openApiOperationId":"getContainer","summary":"Get container"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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 container successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Container"}},"schemaId":"components/schemas/Container"},{"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 container was not found."},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1containers~1{containerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Container","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Container"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/containers/getcontainer"}],"panels":[]}]},"httpPath":"/containers/{containerId}"},{"label":"Upload file associated with a container","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/containers/postcontainerfile","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/containers/postcontainerfile","metadata":{"seo":{"title":"Upload file associated with a container","description":"Upload file associated with a container."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postContainerFile","name":"Upload file associated with a container","isWebhook":false,"pointer":"/paths/~1containers~1{containerId}~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload file associated with a container","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload file associated with a container."},{"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":"containerId","in":"path","schemaId":"schema_1","description":"The ID of the container","required":true}],"pointer":"/paths/~1containers~1{containerId}~1files/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1containers~1{containerId}~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_6"}},"schemaId":"schema_6","pointer":"/paths/~1containers~1{containerId}~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/containers/{containerId}/files","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"containerId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_6"}},"responseCodes":["201","401","default"],"pointer":"/containers/{containerId}/files","href":"containers/postcontainerfile","openApiOperationId":"postContainerFile","summary":"Upload file associated with a container"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"schemaId":"schema_6","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_6"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"File uploaded successfully.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/CreateContainerFileResponse"}},"schemaId":"components/schemas/CreateContainerFileResponse"},{"code":"401","description":"Unauthorized.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1containers~1{containerId}~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateContainerFileResponse","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/CreateContainerFileResponse"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/containers/postcontainerfile"}],"panels":[]}]},"httpPath":"/containers/{containerId}/files"},{"label":"Get a file associated with a container","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/containers/getcontainerfile","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/containers/getcontainerfile","metadata":{"seo":{"title":"Get a file associated with a container","description":"Get a file associated with a container. The MIME type will be set according to the data-type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContainerFile","name":"Get a file associated with a container","isWebhook":false,"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a file associated with a container","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a file associated with a container. The MIME type will be set according to the data-type."},{"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":"fileName","in":"path","schemaId":"schema_1","description":"The name of the file.","required":true},{"name":"containerId","in":"path","schemaId":"schema_1","description":"The ID of the container.","required":true}],"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/containers/{containerId}/files/{fileName}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"fileName","in":"path","required":true,"schemaId":"schema_1"},{"name":"containerId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","default"],"pointer":"/containers/{containerId}/files/{fileName}","href":"containers/getcontainerfile","openApiOperationId":"getContainerFile","summary":"Get a file associated with a container"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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":"File retrieved successfully.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_7"}},"schemaId":"schema_7"},{"code":"401","description":"Unauthorized.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_7","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_7"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/containers/getcontainerfile"}],"panels":[]}]},"httpPath":"/containers/{containerId}/files/{fileName}"},{"label":"Get a signed url which can be used to download a file.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/containers/getdownloadsignedurl","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/containers/getdownloadsignedurl","metadata":{"seo":{"title":"Get a signed url which can be used to download a file.","description":"Generate a signed url which can be used for downloading a specified file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDownloadSignedURL","name":"Get a signed url which can be used to download a file.","isWebhook":false,"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}~1download-url/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a signed url which can be used to download a file.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generate a signed url which can be used for downloading a specified file."},{"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":"fileName","in":"path","schemaId":"schema_1","description":"The name of the file.","required":true},{"name":"containerId","in":"path","schemaId":"schema_1","description":"The ID of the container.","required":true}],"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}~1download-url/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}~1download-url/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/containers/{containerId}/files/{fileName}/download-url","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"fileName","in":"path","required":true,"schemaId":"schema_1"},{"name":"containerId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/containers/{containerId}/files/{fileName}/download-url","href":"containers/getdownloadsignedurl","openApiOperationId":"getDownloadSignedURL","summary":"Get a signed url which can be used to download a file."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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":"Download Signed URL generation successful.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedURLResponse"}},"schemaId":"components/schemas/SignedURLResponse"},{"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 file was not found error.","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/~1containers~1{containerId}~1files~1{fileName}~1download-url/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignedURLResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedURLResponse"}}},{"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":"/containers/getdownloadsignedurl"}],"panels":[]}]},"httpPath":"/containers/{containerId}/files/{fileName}/download-url"},{"label":"Get a signed url which can be used to upload a file.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/containers/getuploadsignedurl","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/containers/getuploadsignedurl","metadata":{"seo":{"title":"Get a signed url which can be used to upload a file.","description":"Generate a signed url which can be used for uploading a specified file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUploadSignedURL","name":"Get a signed url which can be used to upload a file.","isWebhook":false,"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}~1upload-url/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a signed url which can be used to upload a file.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generate a signed url which can be used for uploading a specified file."},{"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":"fileName","in":"path","schemaId":"schema_1","description":"The name of the file.","required":true},{"name":"containerId","in":"path","schemaId":"schema_1","description":"The ID of the container","required":true}],"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}~1upload-url/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1containers~1{containerId}~1files~1{fileName}~1upload-url/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/containers/{containerId}/files/{fileName}/upload-url","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"fileName","in":"path","required":true,"schemaId":"schema_1"},{"name":"containerId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/containers/{containerId}/files/{fileName}/upload-url","href":"containers/getuploadsignedurl","openApiOperationId":"getUploadSignedURL","summary":"Get a signed url which can be used to upload a file."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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":"Upload signed URL generation successful.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedURLResponse"}},"schemaId":"components/schemas/SignedURLResponse"},{"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 container 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/~1containers~1{containerId}~1files~1{fileName}~1upload-url/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignedURLResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedURLResponse"}}},{"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":"/containers/getuploadsignedurl"}],"panels":[]}]},"httpPath":"/containers/{containerId}/files/{fileName}/upload-url"}],"content":{"contentType":"group","meta":{"name":"Containers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Containers","showPageActions":true},{"nodeType":"markdoc","content":"Getting and updating containers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/containers/{containerId}","summary":"Get container","prefix":{"name":"get","color":"get"},"badges":[],"link":"/containers/getcontainer","deprecated":false},{"title":"/containers/{containerId}/files","summary":"Upload file associated with a container","prefix":{"name":"post","color":"post"},"badges":[],"link":"/containers/postcontainerfile","deprecated":false},{"title":"/containers/{containerId}/files/{fileName}","summary":"Get a file associated with a container","prefix":{"name":"get","color":"get"},"badges":[],"link":"/containers/getcontainerfile","deprecated":false},{"title":"/containers/{containerId}/files/{fileName}/download-url","summary":"Get a signed url which can be used to download a file.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/containers/getdownloadsignedurl","deprecated":false},{"title":"/containers/{containerId}/files/{fileName}/upload-url","summary":"Get a signed url which can be used to upload a file.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/containers/getuploadsignedurl","deprecated":false}]}]}]}]}},{"type":"group","label":"Schemas","link":"/solutions/fdplan/apis/fdplan-evaluation/schemas","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schemas","items":[{"label":"Get schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-evaluation/schemas/getschema","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schemas/getschema","metadata":{"seo":{"title":"Get schema","description":"Get a schema given its schema ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchema","name":"Get schema","isWebhook":false,"pointer":"/paths/~1schemas~1{schemaId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get schema","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a schema given its schema ID."},{"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":"schemaId","in":"path","schemaId":"schema_1","description":"The ID of the schema.","required":true}],"pointer":"/paths/~1schemas~1{schemaId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_1","description":"Data partition id.","required":true}],"pointer":"/paths/~1schemas~1{schemaId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/schemas/{schemaId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"schemaId","in":"path","required":true,"schemaId":"schema_1"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/schemas/{schemaId}","href":"schemas/getschema","openApiOperationId":"getSchema","summary":"Get schema"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","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 schema successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Schema"}},"schemaId":"components/schemas/Schema"},{"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 schema was not found."},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1schemas~1{schemaId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Schema","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Schema"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schemas/getschema"}],"panels":[]}]},"httpPath":"/schemas/{schemaId}"}],"content":{"contentType":"group","meta":{"name":"Schemas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schemas","showPageActions":true},{"nodeType":"markdoc","content":"Getting schema for data-types."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/schemas/{schemaId}","summary":"Get schema","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schemas/getschema","deprecated":false}]}]}]}]}},{"type":"group","label":"Schema Definitions","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions","items":[{"type":"link","label":"Error","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/error","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/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":"PatchReq","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/patchreq","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/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-evaluation/schema-definitions/patchitem","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/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":"ReplaceSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/replacespec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/replacespec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ReplaceSpec"},"seo":{"title":"ReplaceSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ReplaceSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ReplaceSpec"},"children":[]}]}]}},{"type":"link","label":"Spec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/spec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/spec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Spec"},"seo":{"title":"Spec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Spec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Spec"},"children":[]}]}]}},{"type":"link","label":"DataTypes","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/datatypes","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/datatypes","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataTypes"},"seo":{"title":"DataTypes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataTypes","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataTypes"},"children":[]}]}]}},{"type":"link","label":"DataType","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/datatype","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/datatype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DataType"},"seo":{"title":"DataType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DataType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DataType"},"children":[]}]}]}},{"type":"link","label":"SchemaRef","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/schemaref","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/schemaref","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SchemaRef"},"seo":{"title":"SchemaRef"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SchemaRef","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SchemaRef"},"children":[]}]}]}},{"type":"link","label":"Schema","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/schema","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/schema","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Schema"},"seo":{"title":"Schema"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schema","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Schema"},"children":[]}]}]}},{"type":"link","label":"ComputationSpecs","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationspecs","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationspecs","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationSpecs"},"seo":{"title":"ComputationSpecs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationSpecs","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationSpecs"},"children":[]}]}]}},{"type":"link","label":"ComputationSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationspec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationSpec"},"seo":{"title":"ComputationSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationSpec"},"children":[]}]}]}},{"type":"link","label":"WorkflowSpecs","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowspecs","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowspecs","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowSpecs"},"seo":{"title":"WorkflowSpecs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowSpecs","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowSpecs"},"children":[]}]}]}},{"type":"link","label":"WorkflowSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowspec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowSpec"},"seo":{"title":"WorkflowSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowSpec"},"children":[]}]}]}},{"type":"link","label":"CreateSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createspec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateSpec"},"seo":{"title":"CreateSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateSpec"},"children":[]}]}]}},{"type":"link","label":"CreateDataType","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createdatatype","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createdatatype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateDataType"},"seo":{"title":"CreateDataType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateDataType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateDataType"},"children":[]}]}]}},{"type":"link","label":"ReplaceDataType","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/replacedatatype","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/replacedatatype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ReplaceDataType"},"seo":{"title":"ReplaceDataType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ReplaceDataType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ReplaceDataType"},"children":[]}]}]}},{"type":"link","label":"CreateComputationSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createcomputationspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createcomputationspec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateComputationSpec"},"seo":{"title":"CreateComputationSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateComputationSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateComputationSpec"},"children":[]}]}]}},{"type":"link","label":"ReplaceComputationSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/replacecomputationspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/replacecomputationspec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ReplaceComputationSpec"},"seo":{"title":"ReplaceComputationSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ReplaceComputationSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ReplaceComputationSpec"},"children":[]}]}]}},{"type":"link","label":"CreateWorkflowSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createworkflowspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createworkflowspec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateWorkflowSpec"},"seo":{"title":"CreateWorkflowSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateWorkflowSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateWorkflowSpec"},"children":[]}]}]}},{"type":"link","label":"ReplaceWorkflowSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/replaceworkflowspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/replaceworkflowspec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ReplaceWorkflowSpec"},"seo":{"title":"ReplaceWorkflowSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ReplaceWorkflowSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ReplaceWorkflowSpec"},"children":[]}]}]}},{"type":"link","label":"Edge","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/edge","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/edge","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Edge"},"seo":{"title":"Edge"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edge","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Edge"},"children":[]}]}]}},{"type":"link","label":"VersionId","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/versionid","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/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":"SetComputationStatus","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/setcomputationstatus","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/setcomputationstatus","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SetComputationStatus"},"seo":{"title":"SetComputationStatus"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SetComputationStatus","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SetComputationStatus"},"children":[]}]}]}},{"type":"link","label":"Computation","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computation","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Computation"},"seo":{"title":"Computation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Computation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Computation"},"children":[]}]}]}},{"type":"link","label":"Container","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/container","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/container","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Container"},"seo":{"title":"Container"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Container","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Container"},"children":[]}]}]}},{"type":"link","label":"CaseContainer","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/casecontainer","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/casecontainer","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CaseContainer"},"seo":{"title":"CaseContainer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CaseContainer","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CaseContainer"},"children":[]}]}]}},{"type":"link","label":"File","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/file","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/file","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"File"},"seo":{"title":"File"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/File"},"children":[]}]}]}},{"type":"link","label":"CreateContainerFileResponse","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createcontainerfileresponse","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/createcontainerfileresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateContainerFileResponse"},"seo":{"title":"CreateContainerFileResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateContainerFileResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateContainerFileResponse"},"children":[]}]}]}},{"type":"link","label":"FileSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/filespec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/filespec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FileSpec"},"seo":{"title":"FileSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FileSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FileSpec"},"children":[]}]}]}},{"type":"link","label":"ComputationError","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationerror","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationerror","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationError"},"seo":{"title":"ComputationError"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationError","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationError"},"children":[]}]}]}},{"type":"link","label":"SpecAddress","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/specaddress","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/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":"WorkflowComputationSpec","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowcomputationspec","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowcomputationspec","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowComputationSpec"},"seo":{"title":"WorkflowComputationSpec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowComputationSpec","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowComputationSpec"},"children":[]}]}]}},{"type":"link","label":"WorkflowDataType","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowdatatype","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowdatatype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowDataType"},"seo":{"title":"WorkflowDataType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowDataType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowDataType"},"children":[]}]}]}},{"type":"link","label":"Annotation","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/annotation","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/annotation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Annotation"},"seo":{"title":"Annotation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Annotation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Annotation"},"children":[]}]}]}},{"type":"link","label":"ComputationLogEvent","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationlogevent","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationlogevent","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationLogEvent"},"seo":{"title":"ComputationLogEvent"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationLogEvent","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationLogEvent"},"children":[]}]}]}},{"type":"link","label":"ComputationLog","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationlog","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationlog","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationLog"},"seo":{"title":"ComputationLog"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationLog","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationLog"},"children":[]}]}]}},{"type":"link","label":"ComputationProgressEventMessage","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationprogresseventmessage","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationprogresseventmessage","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationProgressEventMessage"},"seo":{"title":"ComputationProgressEventMessage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationProgressEventMessage","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationProgressEventMessage"},"children":[]}]}]}},{"type":"link","label":"ContainerLabels","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/containerlabels","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/containerlabels","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ContainerLabels"},"seo":{"title":"ContainerLabels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ContainerLabels","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ContainerLabels"},"children":[]}]}]}},{"type":"link","label":"ComputationConfiguration","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationconfiguration","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/computationconfiguration","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationConfiguration"},"seo":{"title":"ComputationConfiguration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationConfiguration","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationConfiguration"},"children":[]}]}]}},{"type":"link","label":"SignedURLResponse","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/signedurlresponse","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/signedurlresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SignedURLResponse"},"seo":{"title":"SignedURLResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SignedURLResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SignedURLResponse"},"children":[]}]}]}},{"type":"link","label":"WorkflowSpecMappings","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowspecmappings","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowspecmappings","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowSpecMappings"},"seo":{"title":"WorkflowSpecMappings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowSpecMappings","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowSpecMappings"},"children":[]}]}]}},{"type":"link","label":"WorkflowSpecMapping","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowspecmapping","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/workflowspecmapping","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkflowSpecMapping"},"seo":{"title":"WorkflowSpecMapping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkflowSpecMapping","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkflowSpecMapping"},"children":[]}]}]}},{"type":"link","label":"InputMapping","link":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/inputmapping","routeSlug":"/solutions/fdplan/apis/fdplan-evaluation/schema-definitions/inputmapping","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"InputMapping"},"seo":{"title":"InputMapping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"InputMapping","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/InputMapping"},"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":"PatchReq","link":"/schema-definitions/patchreq","deprecated":false},{"title":"PatchItem","link":"/schema-definitions/patchitem","deprecated":false},{"title":"ReplaceSpec","link":"/schema-definitions/replacespec","deprecated":false},{"title":"Spec","link":"/schema-definitions/spec","deprecated":false},{"title":"DataTypes","link":"/schema-definitions/datatypes","deprecated":false},{"title":"DataType","link":"/schema-definitions/datatype","deprecated":false},{"title":"SchemaRef","link":"/schema-definitions/schemaref","deprecated":false},{"title":"Schema","link":"/schema-definitions/schema","deprecated":false},{"title":"ComputationSpecs","link":"/schema-definitions/computationspecs","deprecated":false},{"title":"ComputationSpec","link":"/schema-definitions/computationspec","deprecated":false},{"title":"WorkflowSpecs","link":"/schema-definitions/workflowspecs","deprecated":false},{"title":"WorkflowSpec","link":"/schema-definitions/workflowspec","deprecated":false},{"title":"CreateSpec","link":"/schema-definitions/createspec","deprecated":false},{"title":"CreateDataType","link":"/schema-definitions/createdatatype","deprecated":false},{"title":"ReplaceDataType","link":"/schema-definitions/replacedatatype","deprecated":false},{"title":"CreateComputationSpec","link":"/schema-definitions/createcomputationspec","deprecated":false},{"title":"ReplaceComputationSpec","link":"/schema-definitions/replacecomputationspec","deprecated":false},{"title":"CreateWorkflowSpec","link":"/schema-definitions/createworkflowspec","deprecated":false},{"title":"ReplaceWorkflowSpec","link":"/schema-definitions/replaceworkflowspec","deprecated":false},{"title":"Edge","link":"/schema-definitions/edge","deprecated":false},{"title":"VersionId","link":"/schema-definitions/versionid","deprecated":false},{"title":"SetComputationStatus","link":"/schema-definitions/setcomputationstatus","deprecated":false},{"title":"Computation","link":"/schema-definitions/computation","deprecated":false},{"title":"Container","link":"/schema-definitions/container","deprecated":false},{"title":"CaseContainer","link":"/schema-definitions/casecontainer","deprecated":false},{"title":"File","link":"/schema-definitions/file","deprecated":false},{"title":"CreateContainerFileResponse","link":"/schema-definitions/createcontainerfileresponse","deprecated":false},{"title":"FileSpec","link":"/schema-definitions/filespec","deprecated":false},{"title":"ComputationError","link":"/schema-definitions/computationerror","deprecated":false},{"title":"SpecAddress","link":"/schema-definitions/specaddress","deprecated":false},{"title":"WorkflowComputationSpec","link":"/schema-definitions/workflowcomputationspec","deprecated":false},{"title":"WorkflowDataType","link":"/schema-definitions/workflowdatatype","deprecated":false},{"title":"Annotation","link":"/schema-definitions/annotation","deprecated":false},{"title":"ComputationLogEvent","link":"/schema-definitions/computationlogevent","deprecated":false},{"title":"ComputationLog","link":"/schema-definitions/computationlog","deprecated":false},{"title":"ComputationProgressEventMessage","link":"/schema-definitions/computationprogresseventmessage","deprecated":false},{"title":"ContainerLabels","link":"/schema-definitions/containerlabels","deprecated":false},{"title":"ComputationConfiguration","link":"/schema-definitions/computationconfiguration","deprecated":false},{"title":"SignedURLResponse","link":"/schema-definitions/signedurlresponse","deprecated":false},{"title":"WorkflowSpecMappings","link":"/schema-definitions/workflowspecmappings","deprecated":false},{"title":"WorkflowSpecMapping","link":"/schema-definitions/workflowspecmapping","deprecated":false},{"title":"InputMapping","link":"/schema-definitions/inputmapping","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/PatchReq":{"id":"components/schemas/PatchReq","kind":"json-schema","title":"PatchReq","data":{"type":"array","items":{"$ref":"#/components/schemas/PatchItem"},"example":[{"op":"replace","path":"description","value":"Description"},{"op":"replace","path":"archived","value":false}]}},"components/schemas/PatchItem":{"id":"components/schemas/PatchItem","kind":"json-schema","title":"PatchItem","data":{"description":"A JSON patch document as defined by RFC 6902.","required":["op","path"],"type":"object","properties":{"op":{"description":"The operation to be performed.","enum":["replace","add","remove"],"type":"string","example":"replace"},"path":{"description":"A JSON-Pointer.","type":"string","example":"description"},"value":{"description":"The value to be used within the operations.","example":"Description"},"from":{"description":"A string containing a JSON Pointer value.","type":"string"}},"example":{"op":"replace","path":"description","value":"Description"}}},"components/schemas/ReplaceSpec":{"id":"components/schemas/ReplaceSpec","kind":"json-schema","title":"ReplaceSpec","data":{"required":["id","name","description","version"],"type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the specification. The id should be of the form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'{authority}:{spec-type}:{id}', where '{authority}' is the owning"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authority of the specification, '{spec-type}' is one of 'data-types',"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'computation-specs' or 'workflow-specs'."},"children":[]}]}]}],"pattern":"^[a-z]([a-z0-9]|-)*[a-z0-9]:(data-types|computation-specs|workflow-specs):[a-z]([a-z0-9]|-)*[a-z0-9]$","type":"string","example":"slb:data-types:custom-specification"},"name":{"description":"The name of the specification.","type":"string","example":"A custom data-type"},"version":{"description":"The version of the specification definition.","type":"integer","example":1},"archived":{"description":"Whether this specification has been marked as archived.","type":"boolean","example":false},"description":{"description":"The description of the specification.","type":"string","example":"A specification"}},"example":{"id":"slb:data-types:custom-specification","name":"spec-type","version":1,"archived":false,"description":"A specification."}}},"components/schemas/Spec":{"id":"components/schemas/Spec","kind":"json-schema","title":"Spec","data":{"required":["id","name","version","latest","archived","description","createdBy","createdAt"],"type":"object","properties":{"id":{"description":"The ID of the specification.","type":"string","example":"01DV2RPKYS5NYBAR6TNMJ8TNT8"},"name":{"description":"The name of the specification.","type":"string","example":"A custom data-type"},"version":{"description":"The version of the specification definition.","type":"integer","example":1},"latest":{"description":"Whether this is the latest version of the given specification.","type":"boolean","example":true},"archived":{"description":"Whether this specification has been marked as archived.","type":"boolean","example":false},"description":{"description":"The description of the specification.","type":"string","example":"A specification"},"createdBy":{"description":"The ID of the user who created the specification.","type":"string","example":"user@slb.com"},"createdAt":{"format":"date-time","description":"The date the specification was created.","type":"string","example":"2020-01-01T00:00:00.000Z"}},"example":{"id":"01DV2RPKYS5NYBAR6TNMJ8TNT8","name":"spec-type","version":1,"latest":true,"archived":false,"description":"A specification.","createdBy":"user@slb.com","createdAt":"2020-01-01T00:00:00.000Z"}}},"components/schemas/DataTypes":{"id":"components/schemas/DataTypes","kind":"json-schema","title":"DataTypes","data":{"description":"A list of data-types.","type":"array","items":{"$ref":"#/components/schemas/DataType"},"example":[{"id":"decline-curves","name":"decline-curves","description":"Decline Curves","version":1,"latest":true,"archived":false,"createdBy":"system","createdAt":"2020-01-01T00:00:00.000Z","fileSpecs":[{"extension":"json"}]},{"id":"facility-constraints","name":"facility-constraints","description":"Facility Constraints","version":1,"latest":true,"archived":false,"createdBy":"system","createdAt":"2020-01-01T00:00:00.000Z","fileSpecs":[{"extension":"json"}]}]}},"components/schemas/DataType":{"id":"components/schemas/DataType","kind":"json-schema","title":"DataType","data":{"description":"An evaluation data-type.","allOf":[{"$ref":"#/components/schemas/Spec"},{"type":"object","properties":{"fileSpecs":{"description":"Specification of the file types allowed to be used with this container.","type":"array","items":{"$ref":"#/components/schemas/FileSpec"},"example":[{"extension":"xlsx"},{"extension":"json","schemaRef":{"id":"planning:fdplan:result-set:0.0.1","type":"JSON"},"defaultFilename":"filename.json"}]}}}],"example":{"id":"01DV2RPKYS5NYBAR6TNMJ8TNT8","name":"custom-data-type","version":1,"latest":true,"archived":false,"description":"Description","createdBy":"user@slb.com","createdAt":"2020-01-01T00:00:00.000Z","fileSpecs":[{"extension":"json","schemaRef":{"id":"planning:fdplan:result-set:0.0.1","type":"JSON"},"defaultFilename":"filename.json"},{"extension":"xlsx"}]}}},"components/schemas/SchemaRef":{"id":"components/schemas/SchemaRef","kind":"json-schema","title":"SchemaRef","data":{"description":"A schema reference.","required":["id","type"],"type":"object","properties":{"id":{"description":"The unique idenitifer for the schema.","type":"string","example":"planning:fdplan:result-set:0.0.1"},"type":{"description":"The type of schema, for instance JSON schema.","enum":["JSON"],"type":"string","example":"JSON"}},"example":{"id":"planning:fdplan:result-set:0.0.1","type":"JSON"}}},"components/schemas/Schema":{"id":"components/schemas/Schema","kind":"json-schema","title":"Schema","data":{"description":"A schema.","required":["id","type","definition"],"type":"object","properties":{"id":{"description":"The unique idenitifer for the schema.","type":"string","example":"planning:fdplan:result-set:0.0.1"},"type":{"description":"The type of schema, for instance JSON schema.","enum":["JSON"],"type":"string","example":"JSON"},"definition":{"description":"The schema definition.","type":"object","example":{}}},"example":{"id":"planning:fdplan:result-set:0.0.1","type":"JSON","definition":{}}}},"components/schemas/ComputationSpecs":{"id":"components/schemas/ComputationSpecs","kind":"json-schema","title":"ComputationSpecs","data":{"description":"A list of computation specifications.","type":"array","items":{"$ref":"#/components/schemas/ComputationSpec"},"example":[{"id":"ix","latest":true,"name":"ix","version":1,"archived":false,"description":"ix computation","createdBy":"system","createdAt":"2020-01-01T00:00:00.000Z","inputDataTypeIds":[{"id":"decline-curves","version":1},{"id":"drilling-constraints","version":1},{"id":"facility-constraints","version":1}],"outputDataTypeIds":[{"id":"production-forecast","version":1}]},{"id":"peep","latest":true,"name":"peep","version":1,"archived":false,"description":"peep computation","createdBy":"system","createdAt":"2020-01-01T00:00:00.000Z","inputDataTypeIds":[{"id":"production-forecast","version":1},{"id":"well-capex","version":1},{"id":"general-capex","version":1},{"id":"general-opex","version":1},{"id":"economic-framework","version":1}],"outputDataTypeIds":[{"id":"peep-output","version":1}]}]}},"components/schemas/ComputationSpec":{"id":"components/schemas/ComputationSpec","kind":"json-schema","title":"ComputationSpec","data":{"description":"An evaluation computation specification. The specification details the input data-types to the computation specification and the computed output data-types.","allOf":[{"$ref":"#/components/schemas/Spec"},{"required":["inputDataTypeIds","outputDataTypeIds"],"type":"object","properties":{"inputDataTypeIds":{"description":"The input data-type IDs for the computation specification.","type":"array","items":{"$ref":"#/components/schemas/VersionId"},"example":[{"id":"decline-curves","version":1},{"id":"drilling-constraints","version":1},{"id":"facility-constraints","version":1}]},"outputDataTypeIds":{"description":"The output data-type IDs for the computation specification. ","type":"array","items":{"$ref":"#/components/schemas/VersionId"},"example":[{"id":"production-forecast","version":1}]},"annotations":{"description":"The annotations for the computation specification. These annotations can be used to annotate the computation specification with useful information such as a 'name'.","type":"array","items":{"$ref":"#/components/schemas/Annotation"},"example":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1},"key":"name","value":"Drilling Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":2},"key":"name","value":"Facility Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Production Forecast","createdBy":"user@slb.com"}]}}}],"example":{"id":"01DV2RPKYS5NYBAR6TNMJ8TNT8","name":"custom-computation-spec","version":1,"latest":true,"archived":false,"description":"Description","createdBy":"user@slb.com","createdAt":"2020-01-01T00:00:00.000Z","inputDataTypeIds":[{"id":"decline-curves","version":1},{"id":"drilling-constraints","version":1},{"id":"facility-constraints","version":1}],"outputDataTypeIds":[{"id":"production-forecast","version":1}],"annotations":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1},"key":"name","value":"Drilling Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":2},"key":"name","value":"Facility Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Production Forecast","createdBy":"user@slb.com"}]}}},"components/schemas/WorkflowSpecs":{"id":"components/schemas/WorkflowSpecs","kind":"json-schema","title":"WorkflowSpecs","data":{"description":"A list of workflow specifications.","type":"array","items":{"$ref":"#/components/schemas/WorkflowSpec"},"example":[{"id":"id","name":"Well driven","description":"Well driven","latest":true,"version":1,"archived":false,"createdBy":"system","createdAt":"2020-01-01T00:00:00.000Z","computationSpecs":[{"id":"ix","name":"ix","description":"ix computation","latest":true,"archived":false,"createdBy":"system","createdAt":"2020-01-01T00:00:00.000Z","version":1,"address":{"computationIndex":0,"type":"Computation"},"inputDataTypeIds":[{"id":"decline-curves","version":1,"address":{"computationIndex":0,"dataTypeIndex":0,"type":"DataTypeInput"}},{"id":"drilling-constraints","version":1,"address":{"computationIndex":0,"dataTypeIndex":1,"type":"DataTypeInput"}},{"id":"facility-constraints","version":1,"address":{"computationIndex":0,"dataTypeIndex":2,"type":"DataTypeInput"}}],"outputDataTypeIds":[{"id":"production-forecast","version":1,"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0}}]},{"id":"peep","name":"peep","description":"peep computation","latest":true,"archived":false,"createdBy":"system","createdAt":"2020-01-01T00:00:00.000Z","version":1,"address":{"computationIndex":1,"type":"Computation"},"inputDataTypeIds":[{"id":"production-forecast","version":1,"address":{"computationIndex":1,"dataTypeIndex":0,"type":"DataTypeInput"}},{"id":"well-capex","version":1,"address":{"computationIndex":1,"dataTypeIndex":1,"type":"DataTypeInput"}},{"id":"general-capex","version":1,"address":{"computationIndex":1,"dataTypeIndex":2,"type":"DataTypeInput"}},{"id":"general-opex","version":1,"address":{"computationIndex":1,"dataTypeIndex":3,"type":"DataTypeInput"}},{"id":"economic-framework","version":1,"address":{"computationIndex":1,"dataTypeIndex":4,"type":"DataTypeInput"}}],"outputDataTypeIds":[{"id":"peep-output","version":1,"address":{"computationIndex":1,"dataTypeIndex":0,"type":"DataTypeOutput"}}]}],"edges":[{"fromAddressType":"DataTypeOutput","fromComputationIndex":0,"fromDataTypeIndex":0,"toComputationIndex":1,"toDataTypeIndex":0}]}]}},"components/schemas/WorkflowSpec":{"id":"components/schemas/WorkflowSpec","kind":"json-schema","title":"WorkflowSpec","data":{"description":"An evaluation workflow specification.","allOf":[{"$ref":"#/components/schemas/Spec"},{"required":["computationSpecs"],"type":"object","properties":{"computationSpecs":{"description":"The computation specifications which make up the workflow specification.","type":"array","items":{"$ref":"#/components/schemas/WorkflowComputationSpec"},"example":[{"id":"01DV2RPKYS5NYBAR6TNMJ8TNT8","name":"spec-type","version":1,"latest":true,"archived":false,"description":"A specification.","createdBy":"user@slb.com","createdAt":"2020-01-01T00:00:00.000Z","address":{"type":"Computation","computationIndex":0,"dataTypeIndex":0},"inputDataTypeIds":[{"id":"decline-curves","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0}},{"id":"facility-constraints","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}}],"outputDataTypeIds":[{"id":"production-forecast","version":1,"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0}}]}]},"edges":{"description":"A list of graph edges which describe the data flow from one computation specifications output data-type to the next computation specifications input data-type.","type":"array","items":{"$ref":"#/components/schemas/Edge"},"example":[{"fromAddressType":"DataTypeOutput","fromComputationIndex":0,"fromDataTypeIndex":0,"toComputationIndex":1,"toDataTypeIndex":0}]},"annotations":{"type":"array","items":{"$ref":"#/components/schemas/Annotation"},"example":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"}]}}}],"example":{"id":"01DV2RPKYS5NYBAR6TNMJ8TNT8","name":"custom-workflow-spec","version":1,"latest":true,"archived":false,"description":"Description","createdBy":"user@slb.com","createdAt":"2020-01-01T00:00:00.000Z","computationSpecs":[{"id":"ix","name":"ix","version":1,"latest":true,"archived":false,"description":"A specification.","createdBy":"system","createdAt":"2020-01-01T00:00:00.000Z","address":{"type":"Computation","computationIndex":0,"dataTypeIndex":0},"inputDataTypeIds":[{"id":"decline-curves","version":1,"address":[{"computationIndex":0,"dataTypeIndex":0,"type":"DataTypeInput"}]},{"id":"drilling-constraints","version":1,"address":[{"computationIndex":0,"dataTypeIndex":1,"type":"DataTypeInput"}]},{"id":"facility-constraints","version":1,"address":[{"computationIndex":0,"dataTypeIndex":2,"type":"DataTypeInput"}]}],"outputDataTypeIds":[{"id":"production-forecast","version":1,"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0}}]},{"id":"peep","name":"peep","version":1,"latest":true,"archived":false,"description":"A specification.","createdBy":"system","createdAt":"2020-01-01T00:00:00.000Z","address":{"type":"Computation","computationIndex":0,"dataTypeIndex":0},"inputDataTypeIds":[{"id":"production-forecast","version":1,"address":[{"computationIndex":1,"dataTypeIndex":0,"type":"DataTypeInput"}]},{"id":"well-capex","version":1,"address":[{"computationIndex":1,"dataTypeIndex":1,"type":"DataTypeInput"}]},{"id":"general-capex","version":1,"address":[{"computationIndex":1,"dataTypeIndex":2,"type":"DataTypeInput"}]},{"id":"general-opex","version":1,"address":[{"computationIndex":1,"dataTypeIndex":3,"type":"DataTypeInput"}]},{"id":"economic-framework","version":1,"address":[{"computationIndex":1,"dataTypeIndex":4,"type":"DataTypeInput"}]}],"outputDataTypeIds":[{"id":"peep-output","version":1,"address":{"type":"DataTypeOutput","computationIndex":1,"dataTypeIndex":0}}]}],"edges":[{"fromAddressType":"DataTypeOutput","fromComputationIndex":0,"fromDataTypeIndex":0,"toComputationIndex":1,"toDataTypeIndex":0}]}}},"components/schemas/CreateSpec":{"id":"components/schemas/CreateSpec","kind":"json-schema","title":"CreateSpec","data":{"required":["name","description"],"type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The optional id of the specification. The id should be of the form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'{authority}:{spec-type}:{id}', where '{authority}' is the owning"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authority of the specification, '{spec-type}' is one of 'data-types',"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'computation-specs' or 'workflow-specs'."},"children":[]}]}]}],"pattern":"^[a-z]([a-z0-9]|-)*[a-z0-9]:(data-types|computation-specs|workflow-specs):[a-z]([a-z0-9]|-)*[a-z0-9]$","type":"string","example":"slb:data-types:custom-specification"},"name":{"description":"The name of the specification.","type":"string","example":"custom-specification"},"description":{"description":"The description of the specification.","type":"string","example":"Custom specification."}},"example":{"name":"spec","description":"Description"}}},"components/schemas/CreateDataType":{"id":"components/schemas/CreateDataType","kind":"json-schema","title":"CreateDataType","data":{"description":"Create data-type request.","allOf":[{"$ref":"#/components/schemas/CreateSpec"},{"type":"object","properties":{"fileSpecs":{"type":"array","items":{"$ref":"#/components/schemas/FileSpec"},"example":[{"extension":"json","schemaRef":{"id":"planning:fdplan:result-set:0.0.1","type":"JSON"},"defaultFilename":"filename.json"},{"extension":"xlsx"}]}}}],"example":{"id":"slb:data-types:custom-data-type","name":"custom-data-type","description":"Description","fileSpecs":[{"extension":"json","schemaRef":{"id":"planning:fdplan:result-set:0.0.1","type":"JSON"},"defaultFilename":"filename.json"},{"extension":"xlsx"}]}}},"components/schemas/ReplaceDataType":{"id":"components/schemas/ReplaceDataType","kind":"json-schema","title":"ReplaceDataType","data":{"description":"Replace data-type request.","allOf":[{"$ref":"#/components/schemas/ReplaceSpec"},{"type":"object","properties":{"fileSpecs":{"type":"array","items":{"$ref":"#/components/schemas/FileSpec"},"example":[{"extension":"json","schemaRef":{"id":"planning:fdplan:result-set:0.0.1","type":"JSON"},"defaultFilename":"filename.json"},{"extension":"xlsx"}]}}}],"example":{"id":"slb:data-types:custom-data-type","version":1,"name":"custom-data-type","description":"Description","archived":false,"fileSpecs":[{"extension":"json","schemaRef":{"id":"planning:fdplan:result-set:0.0.1","type":"JSON"},"defaultFilename":"filename.json"},{"extension":"xlsx"}]}}},"components/schemas/CreateComputationSpec":{"id":"components/schemas/CreateComputationSpec","kind":"json-schema","title":"CreateComputationSpec","data":{"description":"Create computation specification request.","allOf":[{"$ref":"#/components/schemas/CreateSpec"},{"required":["inputDataTypeIds","outputDataTypeIds"],"type":"object","properties":{"inputDataTypeIds":{"description":"The input data-type IDs for the computation specification. These  data-types must have already been previously created. The order of the input data-type IDs is maintained in the created computation specification. Note that specific versions of a data-type can be specified by using the format 'id:version'.","type":"array","items":{"type":"string"},"example":["decline-curves","drilling-constraints","facility-constraints\""]},"outputDataTypeIds":{"description":"The output data-type IDs for the computation specification. These data-types must have already been previously created. The order of the output data-type IDs is maintained in the created computation specification. Note that specific versions of a data-type can be specified by using the format 'id:version'.","type":"array","items":{"type":"string"},"example":["production-forecast"]},"annotations":{"description":"The annotations for the computation specification.","type":"array","items":{"$ref":"#/components/schemas/Annotation"},"example":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1},"key":"name","value":"Drilling Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":2},"key":"name","value":"Facility Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Production Forecast","createdBy":"user@slb.com"}]}}}],"example":{"id":"slb:computation-specs:custom-computation-spec","name":"custom-computation-spec","description":"Description","inputDataTypeIds":["decline-curves","drilling-constraints","facility-constraints"],"outputDataTypeIds":["production-forecast"],"annotations":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1},"key":"name","value":"Drilling Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":2},"key":"name","value":"Facility Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Production Forecast","createdBy":"user@slb.com"}]}}},"components/schemas/ReplaceComputationSpec":{"id":"components/schemas/ReplaceComputationSpec","kind":"json-schema","title":"ReplaceComputationSpec","data":{"description":"Create or update computation specification request.","allOf":[{"$ref":"#/components/schemas/ReplaceSpec"},{"required":["inputDataTypeIds","outputDataTypeIds"],"type":"object","properties":{"inputDataTypeIds":{"description":"The input data-type IDs for the computation specification.","type":"array","items":{"$ref":"#/components/schemas/VersionId"},"example":[{"id":"decline-curves","version":1},{"id":"drilling-constraints","version":1},{"id":"facility-constraints","version":1}]},"outputDataTypeIds":{"description":"The output data-type IDs for the computation specification.","type":"array","items":{"$ref":"#/components/schemas/VersionId"},"example":[{"id":"production-forecast","version":1}]},"annotations":{"description":"The annotations for the computation specification.","type":"array","items":{"$ref":"#/components/schemas/Annotation"},"example":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1},"key":"name","value":"Drilling Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":2},"key":"name","value":"Facility Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Production Forecast","createdBy":"user@slb.com"}]}}}],"example":{"id":"slb:computation-specs:custom-computation-spec","name":"custom-computation-spec","description":"Description","inputDataTypeIds":[{"id":"decline-curves","version":1},{"id":"drilling-constraints","version":1},{"id":"facility-constraints","version":1}],"outputDataTypeIds":[{"id":"production-forecast","version":1}],"annotations":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1},"key":"name","value":"Drilling Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":2},"key":"name","value":"Facility Constraints","createdBy":"user@slb.com"},{"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Production Forecast","createdBy":"user@slb.com"}]}}},"components/schemas/CreateWorkflowSpec":{"id":"components/schemas/CreateWorkflowSpec","kind":"json-schema","title":"CreateWorkflowSpec","data":{"description":"Create workflow specification request.","allOf":[{"$ref":"#/components/schemas/CreateSpec"},{"required":["computationSpecIds"],"type":"object","properties":{"computationSpecIds":{"description":"The computation specification IDs which make up the workflow specification. These computation specifications must have already been previously created.  The order of the computation specifications is maintained in the created workflow specification. Note that specific versions of a computation-spec can be specified by using the format 'id:version'.","type":"array","items":{"type":"string"},"example":["ix","peep"]},"edges":{"description":"A list of edges which describe all the links in the workflow specification. The edges describe the flow of data from one  computation specifications output data-type to another computation specifications input data-type. The computation specifications referred to in the edges must have been previously created and be defined in the computationSpecIds property.","type":"array","items":{"$ref":"#/components/schemas/Edge"},"example":[{"fromAddressType":"DataTypeOutput","fromComputationIndex":0,"fromDataTypeIndex":0,"toComputationIndex":1,"toDataTypeIndex":0}]},"annotations":{"type":"array","items":{"$ref":"#/components/schemas/Annotation"},"example":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"}]}}}],"example":{"id":"slb:workflow-specs:custom-workflow-spec","name":"custom-workflow-spec","description":"Description","computationSpecIds":["ix","peep"],"edges":[{"fromAddressType":"DataTypeOutput","fromComputationIndex":0,"fromDataTypeIndex":0,"toComputationIndex":1,"toDataTypeIndex":0}]}}},"components/schemas/ReplaceWorkflowSpec":{"id":"components/schemas/ReplaceWorkflowSpec","kind":"json-schema","title":"ReplaceWorkflowSpec","data":{"description":"Replace workflow specification request.","allOf":[{"$ref":"#/components/schemas/ReplaceSpec"},{"required":["computationSpecs"],"type":"object","properties":{"computationSpecs":{"description":"The computation specifications which make up the workflow specification. These computation specifications must have already been previously created. The order of the computation specifications is maintained in the created/updated workflow specification.","type":"array","items":{"$ref":"#/components/schemas/VersionId"},"example":[{"id":"ix","version":1},{"id":"peep","version":1}]},"edges":{"description":"A list of edges which describe all the links in the workflow specification. The edges describe the flow of data from one  computation specifications output data-type to another computation specifications input data-type. The computation specifications referred to in the edges must have been previously created and be defined in the computationSpecIds property.","type":"array","items":{"$ref":"#/components/schemas/Edge"},"example":[{"fromAddressType":"DataTypeOutput","fromComputationIndex":0,"fromDataTypeIndex":0,"toComputationIndex":1,"toDataTypeIndex":0}]},"annotations":{"type":"array","items":{"$ref":"#/components/schemas/Annotation"},"example":[{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"}]}}}],"example":{"id":"slb:workflow-specs:custom-workflow-spec","name":"custom-workflow-spec","description":"Description","computationSpecs":[{"id":"ix","version":1},{"id":"peep","version":1}],"edges":[{"fromAddressType":"DataTypeOutput","fromComputationIndex":0,"fromDataTypeIndex":0,"toComputationIndex":1,"toDataTypeIndex":0}]}}},"components/schemas/Edge":{"id":"components/schemas/Edge","kind":"json-schema","title":"Edge","data":{"description":"A graph edge which describes a data flow from one computation specifications output data-type to the next computation specifications input data-type. The workflow specification must have the appropriate computation specifications and data-types or else the edge will not be considered valid by the API. As an example, a workflow specification could consist of two computation specifications connected together. The connection between the two computation specifications could consist of the first output data-type from the first computation specification being connected to the first input of the second computation specification. This edge would be describe as:\n  fromAddressType: DataTypeOutput,\n  fromComputationIndex: 0,\n  fromDataTypeIndex: 0,\n  toComputationIndex: 1,\n  toDataTypeIndex:0","type":"object","properties":{"fromAddressType":{"description":"Whether the address refers to a data-type input or data-type output  (defaults to output).","default":"DataTypeOutput","enum":["DataTypeInput","DataTypeOutput"],"type":"string","example":"DataTypeOutput"},"fromComputationIndex":{"description":"The zero based index of the computation specification which generates the data-type in the workflow specification.","type":"integer","example":1,"x-omitempty":false},"fromDataTypeIndex":{"description":"The zero based index of the data-type as listed as an output data-type in computation specification referred to in the 'fromComputationIndex' above.","type":"integer","example":0,"x-omitempty":false},"toComputationIndex":{"description":"The zero based index of the computation specification which consumes the data-type in the workflow specification.","type":"integer","example":1,"x-omitempty":false},"toDataTypeIndex":{"description":"The zero based index of the data-type as listed as an input data-type in the computation specification referred to in the 'toComputationIndex' above.","type":"integer","example":0,"x-omitempty":false}},"example":{"fromAddressType":"DataTypeOutput","fromComputationIndex":0,"fromDataTypeIndex":0,"toComputationIndex":1,"toDataTypeIndex":0}}},"components/schemas/VersionId":{"id":"components/schemas/VersionId","kind":"json-schema","title":"VersionId","data":{"description":"A specification reference which allows the API users to specify the version of a specification when creating or updating a parent specification.","required":["id","version"],"type":"object","properties":{"id":{"description":"The specification ID.","type":"string","example":"01DV2RPKYS5NYBAR6TNMJ8TNT8","x-omitempty":false},"version":{"description":"The version of the specification of the given ID.","type":"integer","example":1,"x-omitempty":false}},"example":{"id":"01DV2RPKYS5NYBAR6TNMJ8TNT8","version":1}}},"components/schemas/SetComputationStatus":{"id":"components/schemas/SetComputationStatus","kind":"json-schema","title":"SetComputationStatus","data":{"description":"The details of the computation status to be set.","type":"object","properties":{"status":{"description":"The computation status.","enum":["CompletedSuccessfully","CompletedWithErrors","Stopped","ProgressEvent","ComputationLogEvent"],"type":"string","example":"CompletedSuccessfully"},"computationErrors":{"description":"The computation errors. There should not be any computation errors if the status of the computation is being set to 'CompletedSuccessfully'.","type":"array","items":{"$ref":"#/components/schemas/ComputationError"},"example":[{"addresses":[{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}],"message":"Something went wrong."}]},"progressEvent":{"$ref":"#/components/schemas/ComputationProgressEventMessage"},"computationLogEvent":{"$ref":"#/components/schemas/ComputationLogEvent"}},"example":{"status":"CompletedWithErrors","computationErrors":[{"addresses":[{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}],"message":"Something went wrong."}]}}},"components/schemas/Computation":{"id":"components/schemas/Computation","kind":"json-schema","title":"Computation","data":{"description":"A computation is an instance of a computation specification which keeps track of a computation state as well as its input and output containers.","required":["id"],"type":"object","properties":{"id":{"description":"The computation ID.","type":"string","example":"0006803dc06c9bab3f82d4018287b8ccae575bd68eaa47f3c1797242e78daf03"},"status":{"description":"The computation status.","enum":["Running","CompletedSuccessfully","CompletedWithErrors","Stopping","Stopped"],"type":"string","example":"Running"},"computationSpec":{"$ref":"#/components/schemas/VersionId"},"inputContainers":{"description":"A list of containers for the computation inputs.","type":"array","items":{"$ref":"#/components/schemas/Container"},"example":[{"id":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/decline-curves/01CH0K76B5ANMW149TZZEGPZFV","dataType":{"id":"decline-curves","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0}},"fileNames":["decline_curves.json"],"files":[{"name":"decline_curves.json"}]},{"id":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/drilling-constraints/01CH0K76B5ANMW149TZZEGPZFV","dataType":{"id":"drilling-constraints","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}},"fileNames":["drilling-constraints.json"],"files":[{"name":"drilling-constraints.json"}]}]},"outputContainers":{"description":"A list of containers for the computation outputs.","type":"array","items":{"$ref":"#/components/schemas/Container"},"example":[{"id":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV","dataType":{"id":"production-forecast","version":1,"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0}},"fileNames":["production-forecast.json"],"files":[{"name":"production-forecast.json"}]}]},"logsContainer":{"$ref":"#/components/schemas/Container"},"computationErrors":{"description":"The error associated with the computation.","type":"array","items":{"$ref":"#/components/schemas/ComputationError"},"example":[{"addresses":[{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}],"message":"Something went wrong."}]},"computationConfiguration":{"description":"A computation configuration describes the configuration properties of the computation.","type":"object","properties":{"schemaRef":{"$ref":"#/components/schemas/SchemaRef"}},"example":{"schemaRef":{"id":"planning:fdplan:dataiku:0.0.1","type":"JSON"}}}},"example":{"id":"0006803dc06c9bab3f82d4018287b8ccae575bd68eaa47f3c1797242e78daf03","status":"CompletedWithErrors","computationSpec":{"id":"ix","version":1},"inputContainers":[{"id":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/decline-curves/01CH0K76B5ANMW149TZZEGPZFV","dataType":{"id":"decline-curves","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0}},"fileNames":["decline_curves.json"],"files":[{"name":"decline_curves.json"}]},{"id":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/drilling-constraints/01CH0K76B5ANMW149TZZEGPZFV","dataType":{"id":"drilling-constraints","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}},"fileNames":["drilling-constraints.json"],"files":[{"name":"drilling-constraints.json"}]}],"outputContainers":[{"id":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV","dataType":{"id":"production-forecast","version":1,"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0}},"fileNames":["production-forecast.json"],"files":[{"name":"production-forecast.json"}]}],"computationErrors":[{"addresses":[{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}],"message":"Something went wrong."}],"computationConfiguration":{"schemaRef":{"id":"planning:fdplan:dataiku:0.0.1","type":"JSON"}}}}},"components/schemas/Container":{"id":"components/schemas/Container","kind":"json-schema","title":"Container","data":{"description":"A container is an instance of a data-type which is used to obtain the location of files which are part of the container, along with input and output errors.","type":"object","properties":{"id":{"description":"The ID of the container.","type":"string","example":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV"},"dataType":{"$ref":"#/components/schemas/WorkflowDataType"},"store":{"description":"The data store where the data within the container is located.","type":"string","example":"fdplan"},"fileNames":{"description":"The file names which are part of the container. (marked for deprecation in favour of files).","type":"array","items":{"type":"string"},"example":["production-forecast.json"]},"files":{"description":"The files which are part of the container.","type":"array","items":{"$ref":"#/components/schemas/File"}},"labels":{"$ref":"#/components/schemas/ContainerLabels"},"caseContainers":{"description":"The containers for each case (only if the current container is a composite container)","type":"array","items":{"$ref":"#/components/schemas/CaseContainer"}}},"example":{"id":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV","dataType":{"id":"production-forecast","version":1,"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0}},"fileNames":["production-forecast.json"],"files":[{"name":"production-forecast.json"}],"labels":{"name":"p10"}}}},"components/schemas/CaseContainer":{"id":"components/schemas/CaseContainer","kind":"json-schema","title":"CaseContainer","data":{"required":["name","uri","dataType","version"],"type":"object","properties":{"name":{"description":"The name of the case.","type":"string"},"uri":{"description":"The uri of the container.","type":"string"},"dataType":{"description":"The data-type the container contains.","type":"string"},"version":{"format":"int32","description":"The version of the data-type to which the data container is associated.","type":"integer"}}}},"components/schemas/File":{"id":"components/schemas/File","kind":"json-schema","title":"File","data":{"description":"The metadata and optional content of a file.","required":["name"],"type":"object","properties":{"name":{"description":"The name of the file.","type":"string","example":"data-link.json"},"content":{"description":"Encoded content of the file in the Data URI format. It will be empty if the file size is larger than 15kb.","type":"string","example":"data:application/json;base64,eyJsaW5rcyI6W3sidXJsIjoiaHR0cHM6Ly9zdXBlcnNlY3JldGV4YW1wbGUuY29tL3lvdS1mb3VuZC10aGUtZXhhbXBsZSJ9XX0K"},"signedURL":{"description":"Signed url for the file. It will be empty if the file size is less than 20mb and/or includeSignedURL flag is false.","type":"string","example":"https://example.com/get-signed-url"}},"example":{"name":"data-link.json","content":"data:application/json;base64,eyJsaW5rcyI6W3sidXJsIjoiaHR0cHM6Ly9zdXBlcnNlY3JldGV4YW1wbGUuY29tL3lvdS1mb3VuZC10aGUtZXhhbXBsZSJ9XX0K"}}},"components/schemas/CreateContainerFileResponse":{"id":"components/schemas/CreateContainerFileResponse","kind":"json-schema","title":"CreateContainerFileResponse","data":{"description":"Response for a successful file creation.","type":"object","properties":{"fileURI":{"description":"The relative URI of the file.","type":"string","example":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV/production-forecast.json"}},"example":{"fileURI":"01C7VGQWGZVPSBV9NJMEAJSBGM/containers/production-forecast/01CH0K76B5ANMW149TZZEGPZFV/production-forecast.json"}}},"components/schemas/FileSpec":{"id":"components/schemas/FileSpec","kind":"json-schema","title":"FileSpec","data":{"description":"A specification for the type of file allowed for a data-type.","type":"object","properties":{"extension":{"description":"The file extension e.g. 'xlsx'","type":"string","example":"xlsx"},"schemaRef":{"$ref":"#/components/schemas/SchemaRef"},"defaultFilename":{"description":"The optional default filename for this file specification. This field is useful when the file specification defines a single file which always has the same filename. (e.g. filename.json). Note that the extension of the default filename should match the file specification extension.","type":"string"}},"example":{"extension":"json","schemaRef":{"id":"planning:fdplan:result-set:0.0.1","type":"JSON"},"defaultFilename":"filename.json"}}},"components/schemas/ComputationError":{"id":"components/schemas/ComputationError","kind":"json-schema","title":"ComputationError","data":{"description":"Human readible error messages and references to the workflow elements responsible for a computation error.","type":"object","properties":{"addresses":{"description":"A list of workflow spec addresses to describe the parts of a workflow which have resulted in the error.","type":"array","items":{"$ref":"#/components/schemas/SpecAddress"},"example":[{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}]},"message":{"description":"A message which describes the error(s).","type":"string","example":"Something went wrong."}},"example":{"addresses":[{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}],"message":"Something went wrong."}}},"components/schemas/SpecAddress":{"id":"components/schemas/SpecAddress","kind":"json-schema","title":"SpecAddress","data":{"description":"An address used to describe the location of a Spec within a WorkflowSpec. Used to enrich the spec model with additional attributes such as specifying the location of a data container or providing annotations.","required":["type"],"type":"object","properties":{"type":{"description":"Whether the address refers to 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 Spec.","type":"integer","example":0,"x-omitempty":false},"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","example":1,"x-omitempty":false}},"example":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0}}},"components/schemas/WorkflowComputationSpec":{"id":"components/schemas/WorkflowComputationSpec","kind":"json-schema","title":"WorkflowComputationSpec","data":{"description":"An evaluation computation specification reference which includes inputs and outputs with relevant workflow specification addresses.","allOf":[{"$ref":"#/components/schemas/Spec"},{"required":["inputDataTypeIds","outputDataTypeIds"],"type":"object","properties":{"address":{"$ref":"#/components/schemas/SpecAddress"},"inputDataTypeIds":{"description":"The input data-types for the computation.","type":"array","items":{"$ref":"#/components/schemas/WorkflowDataType"},"example":[{"id":"decline-curves","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0}},{"id":"facility-constraints","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}}]},"outputDataTypeIds":{"description":"The output data-types for the computation.","type":"array","items":{"$ref":"#/components/schemas/WorkflowDataType"},"example":[{"id":"production-forecast","version":1,"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0}}]}},"example":{"id":"01DV2RPKYS5NYBAR6TNMJ8TNT8","name":"spec-type","version":1,"latest":true,"archived":false,"description":"A specification.","createdBy":"user@slb.com","createdAt":"2020-01-01T00:00:00.000Z","address":{"type":"Computation","computationIndex":0,"dataTypeIndex":0},"inputDataTypeIds":[{"id":"decline-curves","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0}},{"id":"facility-constraints","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":1}}],"outputDataTypeIds":[{"id":"production-forecast","version":1,"address":{"type":"DataTypeOutput","computationIndex":0,"dataTypeIndex":0}}]}}]}},"components/schemas/WorkflowDataType":{"id":"components/schemas/WorkflowDataType","kind":"json-schema","title":"WorkflowDataType","data":{"description":"A workflow specific version of an evaluation data-type that includes its address within the workflow.","allOf":[{"$ref":"#/components/schemas/VersionId"},{"type":"object","properties":{"address":{"$ref":"#/components/schemas/SpecAddress"}},"example":{"id":"decline-curves","version":1,"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0}}}]}},"components/schemas/Annotation":{"id":"components/schemas/Annotation","kind":"json-schema","title":"Annotation","data":{"description":"An annotation or tag which describes elements within a workflow spec.","type":"object","properties":{"address":{"$ref":"#/components/schemas/SpecAddress"},"key":{"description":"Free form content with relevant information for the given address.","type":"string","example":"name","x-omitempty":false},"value":{"description":"Free form content with relevant information for the given address.","type":"string","example":"Decline Curves","x-omitempty":false},"createdBy":{"description":"The user who created this annotation.","type":"string","example":"user@slb.com","x-omitempty":false}},"example":{"address":{"type":"DataTypeInput","computationIndex":0,"dataTypeIndex":0},"key":"name","value":"Decline Curves","createdBy":"user@slb.com"}}},"components/schemas/ComputationLogEvent":{"id":"components/schemas/ComputationLogEvent","kind":"json-schema","title":"ComputationLogEvent","data":{"description":"The computationLogEvent. The log event should contain a list of logs associated with the computation.","type":"object","properties":{"logs":{"description":"The computation logs.","type":"array","items":{"$ref":"#/components/schemas/ComputationLog"}}}}},"components/schemas/ComputationLog":{"id":"components/schemas/ComputationLog","kind":"json-schema","title":"ComputationLog","data":{"description":"Computation log describing the log file.","type":"object","properties":{"text":{"description":"Text to describe the computation log file.","maxLength":100,"type":"string"},"filePath":{"description":"File path for the log file.","maxLength":256,"type":"string"}}}},"components/schemas/ComputationProgressEventMessage":{"id":"components/schemas/ComputationProgressEventMessage","kind":"json-schema","title":"ComputationProgressEventMessage","data":{"description":"A message to provide a progress report on the status of an ongoing computation. Messages are logged as events.","required":["timeStamp","progressStatus","source"],"type":"object","properties":{"timeStamp":{"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time that the event occurred given in format "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC3339"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"2020-01-01T00:00:00.000Z"},"progressStatus":{"description":"The progress status of the computation e.g. Queued.","maxLength":50,"type":"string","example":"Queued"},"source":{"description":"The environment/infrastructure the computation is executing.","maxLength":100,"type":"string","example":"External application"},"body":{"description":"Free-form text as per individual requirements.","maxLength":1500,"type":"string","example":"This is a progress event message."}},"example":{"timeStamp":"2020-01-01T00:00:00.000Z","progressStatus":"Queued","source":"External application","body":"This is a progress event message"}}},"components/schemas/ContainerLabels":{"id":"components/schemas/ContainerLabels","kind":"json-schema","title":"ContainerLabels","data":{"description":"The labels of a container.","additionalProperties":{"type":"string"},"type":"object","example":{"name":"p10"}}},"components/schemas/ComputationConfiguration":{"id":"components/schemas/ComputationConfiguration","kind":"json-schema","title":"ComputationConfiguration","data":{"description":"The request body to create or update configuration properties for a computation","additionalProperties":{"type":"string"},"type":"object"}},"components/schemas/SignedURLResponse":{"id":"components/schemas/SignedURLResponse","kind":"json-schema","title":"SignedURLResponse","data":{"description":"A signed URL","required":["signedURL","filePath"],"type":"object","properties":{"signedURL":{"description":"The signed URL","type":"string"},"filePath":{"description":"The file path for which the signed URL was generated.","type":"string","example":"01JKZXK6ZDKC25MN3BN2ZDP1AQ/containers/slb:data-types:drilling-parameters/01JKZXMA7WRM8RCQKANECXZ9K1/slb-data-types-drilling-parameters.json"},"requiredHeaders":{"description":"Headers that need to be set when calling the generated upload signed URL","type":["array","null"],"items":{"type":"string"},"example":["x-goog-content-length-range:0,<max-file-size-in-bytes>"]}}}},"components/schemas/WorkflowSpecMappings":{"id":"components/schemas/WorkflowSpecMappings","kind":"json-schema","title":"WorkflowSpecMappings","data":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowSpecMapping"}}},"components/schemas/WorkflowSpecMapping":{"id":"components/schemas/WorkflowSpecMapping","kind":"json-schema","title":"WorkflowSpecMapping","data":{"required":["fromWorkflowSpec","toWorkflowSpec","inputMappings"],"type":"object","properties":{"fromWorkflowSpec":{"$ref":"#/components/schemas/VersionId"},"toWorkflowSpec":{"$ref":"#/components/schemas/VersionId"},"inputMappings":{"type":"array","items":{"$ref":"#/components/schemas/InputMapping"}}},"example":{"fromWorkflowSpec":{"id":"slb:workflow-specs:test-123","version":1},"toWorkflowSpec":{"id":"slb:workflow-specs:test-123","version":2},"inputMappings":[{"fromAddress":{"computationIndex":0,"type":"DataTypeInput","dataTypeIndex":0},"toAddress":{"computationIndex":0,"type":"DataTypeInput","dataTypeIndex":0}},{"fromAddress":{"computationIndex":0,"type":"DataTypeInput","dataTypeIndex":1},"toAddress":{"computationIndex":0,"type":"DataTypeInput","dataTypeIndex":1}}]}}},"components/schemas/InputMapping":{"id":"components/schemas/InputMapping","kind":"json-schema","title":"InputMapping","data":{"required":["fromAddress","toAddress"],"type":"object","properties":{"fromAddress":{"$ref":"#/components/schemas/SpecAddress"},"toAddress":{"$ref":"#/components/schemas/SpecAddress"}},"example":{"fromAddress":{"computationIndex":0,"type":"DataTypeInput","dataTypeIndex":0},"toAddress":{"computationIndex":0,"type":"DataTypeInput","dataTypeIndex":0}}}},"schema_0":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"number"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","properties":{"uploadFile":{"description":"The file to upload.","type":"string","format":"binary"}},"required":["uploadFile"]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","format":"binary"},"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/fdplan/evaluation/v1"},{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"schemaDefinitionsTagName":"Schema Definitions","downloadUrls":[{"title":"Evaluation Spec","url":"https://developer.slb.com/fdplan/FDPlan-Evaluation.yaml"}],"mockServer":{"url":"/_mock/solutions/fdplan/apis/fdplan-evaluation","position":"last","description":"Mock server"},"disableRouter":true,"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Evaluation","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 Evaluation API is responsible for evaluation workflows in FDPlan. The\nkey features of the API include:\n\n* The ability to create custom evaluation workflows.\n* The ability to drive custom evaluation workflows and computations.\n\nThe key API concepts include:\n\n* **workflow-specs**: A workflow-spec is a workflow specification defining\n  all the computation specifications which form the workflow. A workflow\n  specification also defines the edges which connect computations together\n  in a graph. These edges connect an output from one computation\n  specification to the input of another.\n  A number of default 'system' workflow specifications are provided to the\n  user. Details of these 'system' workflow specifications can be discovered\n  by using the API to get all workflow specifications.\n\n* **computation-specs**: A computation-spec is a computation specification\n  which defines all the input and output data-types for the computation.\n  A number of default 'system' computation specifications are provided to\n  the user.  Details of these 'system' computation specifications can be\n  discovered by using the API to get all computation specifications.\n\n* **data-types**: A data-type is a specification for a data representation\n  which is required as one of a computation-spec's inputs or produced as\n  one of a computation-spec's outputs.\n  A number of default 'system' data-types are provided to the user. Details\n  of these 'system' data-types can be discovered by using the API to get all\n  data-types.\n\n* **computation**: A computation is an instance of a computation-spec for a\n  running workflow. It encapsulates the state of the computation\n  (i.e. running, succeeded), input/output data containers which have been\n  associated with the computation and any errors which have occurred during\n  the running of the computation. The input and output data containers\n  associated with the computation can be accessed through the containers API\n  operations.\n\n* **container**: A container is a resource which holds all the data for a\n  given data-type definition.\n\n* **schema**: A schema is a formal description of a data-type. It defines\n  the structure of the data-type against which data can be validated.\n  A number of default schemas for 'system' data-types are provided for the\n  user.\n  Currently only JSON schemas are supported, for more information see\n  [JSON Schema](https://json-schema.org/).\n  Schemas defined in the OSDU schema service may be used to describe\n  evaluation data-types by using their unique identifiers in schema\n  references, e.g. osdu:wks:wellbore:1.0.0.\n"}},"baseSlug":"/solutions/fdplan/apis/fdplan-evaluation","routesMapping":{}}