Create Signal

POST 
/api/v1/signals/new

Create a Signal. Requires editor role.

Request

Query Parameters

createParents string
Possible values: [true, false]
Force creation of parent resources if they don't exist
Default value: false

application/json

Body

Body

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 string
Physical unit of the Signal
Example: m/s
description stringnullable
Description of the Signal
Example: Description
longDescription stringnullable
Description of the Signal
Example: Description
dataType stringrequired
Data type of the Signal
Possible values: [float, boolean, string, json]
Example: float
groupKey string

Signals with the same groupKey are stored together

Possible values: non-empty and <= 64 characters

Responses

201

Success

application/json

Schema

Schema

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

Example (from schema)

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

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]

Example (from schema)

{
  "status": "Forbidden"
}

404

Not found

application/json

Schema

Schema

oneOf

MOD1

Workspace not found

status stringrequired

Possible values: [Workspace not found]

workspace stringrequired

MOD2

Asset not found

status stringrequired

Possible values: [Asset not found]

asset stringrequired

MOD3

Division not found

status stringrequired

Possible values: [Division not found]

division stringrequired

MOD4

Unit not found

status stringrequired

Possible values: [Unit not found]

unit stringrequired

Example (from schema)

{}

409

Signal already exists

application/json

Schema

Schema

status stringrequired

Possible values: [Signal already exists]

Example (from schema)

{
  "status": "Signal already exists"
}

422

Signal limit reached

application/json

Schema

Schema

status stringrequired

Possible values: [Signal limit reached]

message stringrequired

Possible values: [Maximum of 900 signals per unit reached]

Example (from schema)

{
  "status": "Signal limit reached",
  "message": "Maximum of 900 signals per unit reached"
}

Loading...