Create Deriver

POST 
/api/v1/derivers

Create Deriver

Request

application/json

Body

Body

deriver

object

required

name stringrequired

description stringrequired

inputs

object

required

property name*

object

workspace stringrequired

Name of the Workspace

Example: Workspace 1

asset stringrequired

Name of the Asset

Example: Asset 1

division stringrequired

Name of the Division

Example: Division 1

unit stringrequired

Name of the Unit

Example: Unit 1

signal stringrequired

Name of the Signal

Example: Signal 1

physicalUnit

object

required

name stringrequired

description stringrequired

symbol stringrequired

physicalQuantity

object

required

name stringrequired

description stringrequired

SIUnit stringrequired

SIUnitSymbol stringrequired

outputs

object

required

property name*

object

workspace stringrequired

Name of the Workspace

Example: Workspace 1

asset stringrequired

Name of the Asset

Example: Asset 1

division stringrequired

Name of the Division

Example: Division 1

unit stringrequired

Name of the Unit

Example: Unit 1

signal stringrequired

Name of the Signal

Example: Signal 1

physicalUnit

object

required

name stringrequired

description stringrequired

symbol stringrequired

physicalQuantity

object

required

name stringrequired

description stringrequired

SIUnit stringrequired

SIUnitSymbol stringrequired

configurations

object

required

startAt date-timerequired

deriverSchemaDAG

object

required

name stringrequired

description stringrequired

inputs

object[]

required

Array [

name stringrequired

description stringrequired

dataType stringrequired

Possible values: [float, boolean, string, json]

physicalQuantity

object

nullable

name stringrequired

description stringrequired

SIUnit stringrequired

SIUnitSymbol stringrequired

suggestedInputsFromOtherDerivers

object[]

required

Array [

name stringrequired

description stringrequired

dataType stringrequired

Possible values: [float, boolean, string, json]

physicalQuantity

object

nullable

name stringrequired

description stringrequired

SIUnit stringrequired

SIUnitSymbol stringrequired

deriverSchemaDAG required

]

]

outputs

object[]

required

Array [

name stringrequired

description stringrequired

dataType stringrequired

Possible values: [float, boolean, string, json]

physicalQuantity

object

nullable

name stringrequired

description stringrequired

SIUnit stringrequired

SIUnitSymbol stringrequired

]

configurations

object[]

required

Array [

name stringrequired

description stringrequired

dataType stringrequired

Possible values: [float, boolean, string, json]

]

script stringrequired
dryRun booleanrequired
workspace stringnullable
Name of the Workspace
Example: Workspace 1

Responses

200

200

application/json

Schema

Schema

DeriverSchemas

object

required

property name*

object

previousSchema

object

id numberrequired

hash stringrequired

historyId numberrequired

createdAt date-timerequired

updatedAt date-timerequired

newSchema

object

required

id numberrequired

hash stringrequired

historyId numberrequired

createdAt date-timerequired

updatedAt date-timerequired

Derivers

object

required

property name*

object

previousSchema

object

id numberrequired

hash stringrequired

historyId numberrequired

createdAt date-timerequired

updatedAt date-timerequired

newSchema

object

required

id numberrequired

hash stringrequired

historyId numberrequired

createdAt date-timerequired

updatedAt date-timerequired

Example (from schema)

{
  "DeriverSchemas": {},
  "Derivers": {}
}

400

Validation Error

application/json

Schema

Schema

status stringrequired

Possible values: [Validation Error]

errors

object[]

required

Array [

error stringrequired

location stringrequired

Possible values: [body, query, path, headers]

]

Example (from schema)

{
  "status": "Validation Error",
  "errors": [
    {
      "error": "string",
      "location": "body"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

status stringrequired

Possible values: [Unauthorized]

Example (from schema)

{
  "status": "Unauthorized"
}

403

Forbidden

application/json

Schema

Schema

status stringrequired

Possible values: [Forbidden]

reason stringrequired

Example (from schema)

{
  "status": "Forbidden",
  "reason": "string"
}

404

Signal not found

application/json

Schema

Schema

status stringrequired

Possible values: [Signal not found]

Example (from schema)

{
  "status": "Signal not found"
}

Loading...