Update a data source type.

Request

Security

bearer and appkey

Path

dataSourceTypeIdstringrequired

The data source type id to update.

slb-partition-idstringrequired

Data partition id.

Bodyapplication/jsonrequired

The update to apply to the given data source type id.

editorsArray of objects or null(Editor)

List of editors defining how data source type is provided.

viewersArray of objects or null(Viewer)

List of viewers defining how data source type is viewed.

targetsArray of strings or null

List of Data Types.

Example:

[
  "production-forecast"
]

archivedboolean or null

Defines if data source type is archived.

transformationProviderobject(TransformationProvider)

Transformation provider defines which provider is used to process the data.

copyProviderobject(CopyProvider)

Copy provider defines which provider copies the data sources of this data source type. Defaults to system (FDPlan copies internally); set a custom name to delegate copying to an external worker, which then handles copy_transformation_required events. Data source types in the fdplan store can only be processed by the system worker and are not allowed to have a custom copy provider.

curl -i -X PATCH \
  'https://api.delfi.slb.com/fdplan/data-sources/v2/data-source-types/{dataSourceTypeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string' \
  -d '{
    "targets": [
      "production-forecast"
    ]
  }'

Responses

The data source type was updated.

Bodyapplication/json

idstring

Deterministic identifier of the data source type, derived as source.type:source.store.

Example:"demo:data-types:planning-assumption-reference:comm-store"

sourceobject(Source)required

The user-facing input format - a registered data type and the store it lives in. Together with target, it selects the matching data source type.

Example:

{
  "store": "fdplan",
  "type": "production-forecast-fdplan-workbook"
}

targetsArray of stringsrequired

List of evaluation data types that this source can be converted into.

Example:

[
  "production-forecast"
]

editorsArray of objects or null(Editor)

List of editors defining how data source type is provided.

Example:

[
  {
    "editorURL": "",
    "name": "fdplan-file-selector",
    "type": "Both"
  }
]

viewersArray of objects or null(Viewer)

List of viewers defining how data source type is viewed.

Example:

[]

transformationProviderobject(TransformationProvider)

Transformation provider defines which provider is used to process the data.

Example:

{
  "name": "system"
}

copyProviderobject(CopyProvider)

Copy provider defines which provider copies the data sources of this data source type. Defaults to system (FDPlan copies internally); set a custom name to delegate copying to an external worker, which then handles copy_transformation_required events. Data source types in the fdplan store can only be processed by the system worker and are not allowed to have a custom copy provider.

Example:

{
  "name": "system"
}

isSystemboolean

true for built-in types shipped with the platform.

Example:true

archivedboolean

true once the type is retired and should no longer be used to create new data sources.

Response

{
  "id": "production-forecast-fdplan-workbook:fdplan",
  "editors": [
    { … }
  ],
  "isSystem": true,
  "source": {
    "store": "fdplan",
    "type": "production-forecast-fdplan-workbook"
  },
  "targets": [
    "production-forecast"
  ],
  "copyProvider": {
    "name": "system"
  },
  "transformationProvider": {
    "name": "system"
  },
  "viewers": []
}