Skip to content

Data Sources (1.0.0)

Client ID
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.com

The data sources API is responsible for managing data sources in FDPlan.

A data source is a versioned input bundle consumed by scenario evaluations. It pairs a user-facing source (a registered data type and its store) with one target data type understood by computations, and is discovered and reused across scenarios through tags (usually StudyId:id).

Data sources are never created directly. Every data source is produced by an asynchronous data source job: the caller posts the inputs (source, target, dataProviders, tags) and the platform runs the transformation declared on the matching data source type in the background. A data source type is the reusable conversion contract between a domain-native input format and one or more evaluation-ready data types, and also declares the editors, viewers, and transformation/copy providers used to author and process the data.

Key resources:

  • data-source-types - register and manage the conversion contracts (source/target, editors, viewers, providers).
  • data-source-jobs - create, reprocess, poll, and complete the asynchronous work that builds a data source. External transformers report completion via .../{id}/state.
  • workflow-input-data-source-jobs - build all workflow input data sources of a study at once to create virtual scenarios.
  • data-sources - read a given version, list by tags, and delete.
Download OpenAPI description
Languages
Servers
https://api.delfi.slb.com/fdplan/data-sources
Mock server
https://developer.slb.com/_mock/solutions/fdplan/apis/fdplan-data-sources