Variables

Get Variables

get

Returns a paginated list of variables. A variable represents a process measure of one machine of which timeseries data is captured and stored in the ENLYZE platform. One machine may have many variables, whereas one variable is only associated with one machine.

Autorisierungen

AuthorizationstringErforderlich

Abfrageparameter

machinestring · uuid[] · max: 50 · nullableOptional

data_sourcestring · uuid[] · max: 50 · nullableOptional

uuidstring · uuid[] · max: 50 · nullableOptional

depends_onstring · uuid[] · max: 50 · nullableOptional

limitinteger · min: 1 · max: 1000Optional

Caps the page size. Defaults to 1000, which is also the maximum; a value below 1 or above 1000 is rejected.

Default: 1000

cursorstringOptional

Antworten

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/variables

GET /api/v2/variables HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "machine": "123e4567-e89b-12d3-a456-426614174000",
      "display_name": "Barrel Temperature",
      "unit": "°C",
      "scaling_factor": 0.1,
      "comment": "text",
      "data_type": "FLOAT",
      "details": {
        "type": "spark",
        "data_source": "123e4567-e89b-12d3-a456-426614174000",
        "origin_identifier": {
          "code": "MW2",
          "data_type": "REAL"
        },
        "origin_name": "Temperature_Actual",
        "origin_comment": "text",
        "state": "inactive"
      }
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}

Create Variable

post

Create one SPARK variable. Create-only: if a variable already exists for the (data_source, origin_identifier) it is never modified — the request returns 409 carrying the existing variable. Creating a variable active requires a non-empty display_name.

Autorisierungen

AuthorizationstringErforderlich

Body

display_namestring · nullableOptional

Human-readable name shown to users in the platform.

Example: Barrel Temperature

unitstring · nullableOptional

Unit of measure of the values.

Example: °C

scaling_factornumber · nullableOptional

Multiplier applied to raw readouts. A numeric variable needs one to be usable in analyses; string and boolean variables do not.

Example: 0.1

commentstring · nullableOptional

Free-form comment stored with the variable.

data_typestring · enumErforderlich

Data type of the captured values.

Example: FLOATMögliche Werte:

detailsone ofErforderlich

Antworten

201

Successful Response

application/json

uuidstring · uuidErforderlich

Unique identifier of the variable.

machinestring · uuidErforderlich

The machine the variable is associated with.

display_namestring · nullableOptional

Human-readable name shown to users in the platform.

Example: Barrel Temperature

unitstring · nullableOptional

Unit of measure of the values.

Example: °C

scaling_factornumber · nullableOptional

Multiplier applied to raw readouts. A numeric variable needs one to be usable in analyses; string and boolean variables do not.

Example: 0.1

commentstring · nullableOptional

Free-form comment stored with the variable.

data_typestring · enumErforderlich

Data type of the captured values.

Example: FLOATMögliche Werte:

typestring · enumOptionalVeraltet

Deprecated; use details.type, which this mirrors.

Default: sparkMögliche Werte:

detailsone ofErforderlich

oder

400

The request was rejected on a business rule and nothing was created. Unlike on the bulk endpoints, the error carries no index — there is no data array to correlate into. (422 is used for request-shape validation.)

application/json

404

The data_source is unknown or not the caller's customer.

application/json

409

A variable already exists for the (data_source, origin_identifier); it was not modified. The body carries its uuid.

application/json

422

Validation Error

application/json

post/v2/variables

POST /api/v2/variables HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 362

{
  "display_name": "Barrel Temperature",
  "unit": "°C",
  "scaling_factor": 0.1,
  "comment": "text",
  "data_type": "FLOAT",
  "details": {
    "type": "text",
    "data_source": "123e4567-e89b-12d3-a456-426614174000",
    "origin_identifier": {
      "type": "s7",
      "code": "DB400:12",
      "data_type": "DINT",
      "hints": [
        "ignore_length"
      ]
    },
    "origin_name": "Temperature_Actual",
    "origin_comment": "text",
    "state": "inactive"
  }
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "machine": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "Barrel Temperature",
  "unit": "°C",
  "scaling_factor": 0.1,
  "comment": "text",
  "data_type": "FLOAT",
  "details": {
    "type": "spark",
    "data_source": "123e4567-e89b-12d3-a456-426614174000",
    "origin_identifier": {
      "code": "MW2",
      "data_type": "REAL"
    },
    "origin_name": "Temperature_Actual",
    "origin_comment": "text",
    "state": "inactive"
  }
}

Bulk Register Variables

post

Bulk-create SPARK variables (may span data sources). Create-only: existing variables are reported but never modified. Returns one outcome per input item, in input order.

Autorisierungen

AuthorizationstringErforderlich

Body

Antworten

200

Successful Response

application/json

400

The request was rejected on a business rule and nothing was created. The error carries the offending item's index where applicable. (422 is used for request-shape validation.)

application/json

404

A data_source is unknown or not the caller's customer.

application/json

422

Validation Error

application/json

post/v2/variables/bulk

POST /api/v2/variables/bulk HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "data": [
    {
      "display_name": "Barrel Temperature",
      "unit": "°C",
      "scaling_factor": 0.1,
      "comment": "text",
      "data_type": "FLOAT",
      "details": {
        "type": "text",
        "data_source": "123e4567-e89b-12d3-a456-426614174000",
        "origin_identifier": {
          "type": "s7",
          "code": "DB400:12",
          "data_type": "DINT",
          "hints": [
            "ignore_length"
          ]
        },
        "origin_name": "Temperature_Actual",
        "origin_comment": "text",
        "state": "inactive"
      }
    }
  ]
}

{
  "data": [
    {
      "outcome": "created",
      "data": {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "machine": "123e4567-e89b-12d3-a456-426614174000",
        "display_name": "Barrel Temperature",
        "unit": "°C",
        "scaling_factor": 0.1,
        "comment": "text",
        "data_type": "FLOAT",
        "details": {
          "type": "spark",
          "data_source": "123e4567-e89b-12d3-a456-426614174000",
          "origin_identifier": {
            "code": "MW2",
            "data_type": "REAL"
          },
          "origin_name": "Temperature_Actual",
          "origin_comment": "text",
          "state": "inactive"
        }
      }
    }
  ]
}

Bulk Update Variables

patch

Batch-update variables addressed by uuid, transactionally: context (display_name, unit, scaling_factor, comment) on any variable, plus data_type and details (state, origin) on SPARK variables. A field that is omitted is left unchanged; nullable fields clear on an explicit null. All-or-nothing — a single invalid item rejects the whole request and changes nothing. Returns the updated variables in input order.

A batch-update request may contain at most 100 state changes.

Autorisierungen

AuthorizationstringErforderlich

Body

Antworten

200

Successful Response

application/json

400

The request was rejected on a business rule and nothing was changed. The error carries the offending item's index where applicable. (422 is used for request-shape validation.)

application/json

404

An addressed variable uuid is unknown or not the caller's customer.

application/json

409

A requested state change conflicts with something that still depends on the variable; nothing was changed.

application/json

422

Validation Error

application/json

patch/v2/variables/bulk

PATCH /api/v2/variables/bulk HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "display_name": "Barrel Temperature",
      "unit": "°C",
      "scaling_factor": 0.1,
      "comment": "text",
      "data_type": "FLOAT",
      "details": {
        "type": "text",
        "state": "inactive",
        "origin_identifier": {
          "type": "s7",
          "code": "DB400:12",
          "data_type": "DINT",
          "hints": [
            "ignore_length"
          ]
        },
        "origin_name": "Temperature_Actual",
        "origin_comment": "text"
      }
    }
  ]
}

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "machine": "123e4567-e89b-12d3-a456-426614174000",
      "display_name": "Barrel Temperature",
      "unit": "°C",
      "scaling_factor": 0.1,
      "comment": "text",
      "data_type": "FLOAT",
      "details": {
        "type": "spark",
        "data_source": "123e4567-e89b-12d3-a456-426614174000",
        "origin_identifier": {
          "code": "MW2",
          "data_type": "REAL"
        },
        "origin_name": "Temperature_Actual",
        "origin_comment": "text",
        "state": "inactive"
      }
    }
  ]
}