Get Deriver

GET 
/api/v1/derivers/:deriverId

Get Deriver

Request

Path Parameters

deriverId integerrequired

Possible values: > 0

ID of the Deriver

Responses

200

Success

application/json

Schema

Schema

id numberrequired
name stringrequired
script stringrequired
description stringrequired

inputs

object[]

required

Array [

signal

object

required

id numberrequired

name stringrequired

unit

object

nullable

required

id numberrequired

name stringrequired

division

object

required

id numberrequired

name stringrequired

asset

object

required

id numberrequired

name stringrequired

workspace

object

required

id numberrequired

name stringrequired

customer

object

required

id numberrequired

name stringrequired

physicalUnit

object

required

symbol stringrequired

schemaInput

object

required

name stringrequired

physicalQuantity

object

nullable

required

SIUnitSymbol stringrequired

]

outputs

object[]

required

Array [

signal

object

required

id numberrequired

name stringrequired

unit

object

nullable

required

id numberrequired

name stringrequired

division

object

required

id numberrequired

name stringrequired

asset

object

required

id numberrequired

name stringrequired

workspace

object

required

id numberrequired

name stringrequired

customer

object

required

id numberrequired

name stringrequired

physicalUnit

object

required

symbol stringrequired

schemaOutput

object

required

name stringrequired

physicalQuantity

object

nullable

required

SIUnitSymbol stringrequired

]

configurations

object[]

required

Array [

value nullable

schemaConfiguration

object

required

name stringrequired

type stringrequired

description stringrequired

]

startAt date-timerequired
hash stringrequired

scope

object

required

id numberrequired

workspace

object

required

name stringrequired

id numberrequired

Example (from schema)

{
  "id": 0,
  "name": "string",
  "script": "string",
  "description": "string",
  "inputs": [
    {
      "signal": {
        "id": 0,
        "name": "string",
        "unit": {
          "id": 0,
          "name": "string",
          "division": {
            "id": 0,
            "name": "string",
            "asset": {
              "id": 0,
              "name": "string",
              "workspace": {
                "id": 0,
                "name": "string",
                "customer": {
                  "id": 0,
                  "name": "string"
                }
              }
            }
          }
        }
      },
      "physicalUnit": {
        "symbol": "string"
      },
      "schemaInput": {
        "name": "string",
        "physicalQuantity": {
          "SIUnitSymbol": "string"
        }
      }
    }
  ],
  "outputs": [
    {
      "signal": {
        "id": 0,
        "name": "string",
        "unit": {
          "id": 0,
          "name": "string",
          "division": {
            "id": 0,
            "name": "string",
            "asset": {
              "id": 0,
              "name": "string",
              "workspace": {
                "id": 0,
                "name": "string",
                "customer": {
                  "id": 0,
                  "name": "string"
                }
              }
            }
          }
        }
      },
      "physicalUnit": {
        "symbol": "string"
      },
      "schemaOutput": {
        "name": "string",
        "physicalQuantity": {
          "SIUnitSymbol": "string"
        }
      }
    }
  ],
  "configurations": [
    {
      "schemaConfiguration": {
        "name": "string",
        "type": "string",
        "description": "string"
      }
    }
  ],
  "startAt": "2024-07-29T15:51:28.071Z",
  "hash": "string",
  "scope": {
    "id": 0,
    "workspace": {
      "name": "string",
      "id": 0
    }
  }
}

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...