Get Deriver

GET 
/api/v1/derivers/:deriver

Get Deriver

Request

Path Parameters

deriver stringrequired

Name of the Deriver

Responses

200

Success

application/json

Schema

Schema

id integerrequired
ID of the Deriver
Possible values: > 0
Example: 1000
name stringrequired
Name of the Deriver class definition
Example: TestDeriver
createdAt date-timerequired
Creation Date of the Deriver
Example: 2025-08-25T19:29:40.668Z
updatedAt date-timerequired
Update Date of the Deriver
Example: 2025-08-25T19:29:40.668Z
definition stringrequired
description stringnullable
startAt date-timenullable
Example: 2025-01-01T00:00:00Z

inputs

object[]

required

Array [

id integerrequired

ID of the Signal

Possible values: > 0

Example: 1000

name stringrequired

Name of the Signal

Example: Signal 1

createdAt date-timerequired

Creation Date of the Signal

Example: 2025-08-25T19:29:40.667Z

updatedAt date-timerequired

Update Date of the Signal

Example: 2025-08-25T19:29:40.667Z

physicalUnit stringrequired

Physical unit of the Signal

Example: m/s

dataType stringrequired

Data type of the Signal

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

Example: float

description stringnullablerequired

Description of the Signal

Example: Description

longDescription stringnullablerequired

Long description of the Signal

workspace

object

required

id integerrequired

ID of the Workspace

Possible values: > 0

Example: 1000

name stringrequired

Name of the Workspace

Example: Workspace 1

asset

object

required

id integerrequired

ID of the Asset

Possible values: > 0

Example: 1000

name stringrequired

Name of the Asset

Example: Asset 1

division

object

required

id integerrequired

ID of the Division

Possible values: > 0

Example: 1000

name stringrequired

Name of the Division

Example: Division 1

unit

object

required

id integerrequired

ID of the Unit

Possible values: > 0

Example: 1000

name stringrequired

Name of the Unit

Example: Unit 1

]

outputs

object[]

required

Array [

id integerrequired

ID of the Signal

Possible values: > 0

Example: 1000

name stringrequired

Name of the Signal

Example: Signal 1

createdAt date-timerequired

Creation Date of the Signal

Example: 2025-08-25T19:29:40.667Z

updatedAt date-timerequired

Update Date of the Signal

Example: 2025-08-25T19:29:40.667Z

physicalUnit stringrequired

Physical unit of the Signal

Example: m/s

dataType stringrequired

Data type of the Signal

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

Example: float

description stringnullablerequired

Description of the Signal

Example: Description

longDescription stringnullablerequired

Long description of the Signal

workspace

object

required

id integerrequired

ID of the Workspace

Possible values: > 0

Example: 1000

name stringrequired

Name of the Workspace

Example: Workspace 1

asset

object

required

id integerrequired

ID of the Asset

Possible values: > 0

Example: 1000

name stringrequired

Name of the Asset

Example: Asset 1

division

object

required

id integerrequired

ID of the Division

Possible values: > 0

Example: 1000

name stringrequired

Name of the Division

Example: Division 1

unit

object

required

id integerrequired

ID of the Unit

Possible values: > 0

Example: 1000

name stringrequired

Name of the Unit

Example: Unit 1

]

status stringrequired

Possible values: [STARTING, RUNNING, STOPPED, ERROR]

Example (from schema)

{
  "id": 1000,
  "name": "TestDeriver",
  "createdAt": "2025-08-25T19:29:40.668Z",
  "updatedAt": "2025-08-25T19:29:40.668Z",
  "definition": "string",
  "description": "string",
  "startAt": "2025-01-01T00:00:00Z",
  "inputs": [
    {
      "id": 1000,
      "name": "Signal 1",
      "createdAt": "2025-08-25T19:29:40.667Z",
      "updatedAt": "2025-08-25T19:29:40.667Z",
      "physicalUnit": "m/s",
      "dataType": "float",
      "description": "Description",
      "longDescription": "string",
      "workspace": {
        "id": 1000,
        "name": "Workspace 1"
      },
      "asset": {
        "id": 1000,
        "name": "Asset 1"
      },
      "division": {
        "id": 1000,
        "name": "Division 1"
      },
      "unit": {
        "id": 1000,
        "name": "Unit 1"
      }
    }
  ],
  "outputs": [
    {
      "id": 1000,
      "name": "Signal 1",
      "createdAt": "2025-08-25T19:29:40.667Z",
      "updatedAt": "2025-08-25T19:29:40.667Z",
      "physicalUnit": "m/s",
      "dataType": "float",
      "description": "Description",
      "longDescription": "string",
      "workspace": {
        "id": 1000,
        "name": "Workspace 1"
      },
      "asset": {
        "id": 1000,
        "name": "Asset 1"
      },
      "division": {
        "id": 1000,
        "name": "Division 1"
      },
      "unit": {
        "id": 1000,
        "name": "Unit 1"
      }
    }
  ],
  "status": "STARTING"
}

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"
}

404

Deriver not found

application/json

Schema

Schema

status stringrequired

Possible values: [Deriver not found]

Example (from schema)

{
  "status": "Deriver not found"
}

Loading...