Import Signal Data

POST 
/api/v1/signal/data/import

This endpoint allows you to import signal data into the system. Requires editor role.

Request

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

signals

object[]

required

Possible values: >= 1

Array [

name stringrequired

Name of the Signal

Example: Signal 1

points

object[]

required

Possible values: >= 1

Array [

value

object

required

oneOf

MOD1

oneOf

MOD1

oneOf

MOD1

number

MOD2

string

MOD2

object

MOD2

boolean

timestamp

object

required

ISO date string or Unix timestamp

oneOf

MOD1

Unix timestamp in milliseconds

number

MOD2

ISO date string

string

]

]

Responses

200

200

application/json

Schema

Schema

status stringrequired

Possible values: [success]

Example (from schema)

{
  "status": "success"
}

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

404

application/json

Schema

Schema

oneOf

MOD1

Workspace not found

status stringrequired

Possible values: [Workspace not found]

MOD2

Asset not found

status stringrequired

Possible values: [Asset not found]

MOD3

Division not found

status stringrequired

Possible values: [Division not found]

MOD4

Unit not found

status stringrequired

Possible values: [Unit not found]

MOD5

Signals not found

status stringrequired

Possible values: [Signals not found]

signals string[]required

Missing Signals

Example (from schema)

{}

Loading...