Evaluation (1.0.0)
prod-nam-services-fdplan.slbservice.com
prod-eu-services-fdplan.slbservice.com
prod-au-services-fdplan.slbservice.com
prod-id-services-fdplan.slbservice.com
production-services-fdplan.slbservice.comThe Evaluation API is responsible for evaluation workflows in FDPlan. The key features of the API include:
- The ability to create custom evaluation workflows.
- The ability to drive custom evaluation workflows and computations.
The key API concepts include:
workflow-specs: A workflow-spec is a workflow specification defining all the computation specifications which form the workflow. A workflow specification also defines the edges which connect computations together in a graph. These edges connect an output from one computation specification to the input of another. A number of default 'system' workflow specifications are provided to the user. Details of these 'system' workflow specifications can be discovered by using the API to get all workflow specifications.
computation-specs: A computation-spec is a computation specification which defines all the input and output data-types for the computation. A number of default 'system' computation specifications are provided to the user. Details of these 'system' computation specifications can be discovered by using the API to get all computation specifications.
data-types: A data-type is a specification for a data representation which is required as one of a computation-spec's inputs or produced as one of a computation-spec's outputs. A number of default 'system' data-types are provided to the user. Details of these 'system' data-types can be discovered by using the API to get all data-types.
computation: A computation is an instance of a computation-spec for a running workflow. It encapsulates the state of the computation (i.e. running, succeeded), input/output data containers which have 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.
container: A container is a resource which holds all the data for a given data-type definition.
schema: A schema is a formal description of a data-type. It defines the structure of the data-type against which data can be validated. A number of default schemas for 'system' data-types are provided for the user. Currently only JSON schemas are supported, for more information see JSON Schema. Schemas defined in the OSDU schema service may be used to describe evaluation data-types by using their unique identifiers in schema references, e.g. osdu:wks:wellbore:1.0.0.