Data Sources

Get Data Sources

get

Returns a list of data sources in your organization.

Autorisierungen

AuthorizationstringErforderlich

Abfrageparameter

cursorstringOptional

uuidstring · uuid[] · max: 50 · nullableOptional

machinestring · uuid[] · max: 50 · nullableOptional

sparkstring · uuid[] · max: 50 · nullableOptional

Antworten

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/data-sources

GET /api/v2/data-sources HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "readout_limit": 1,
      "readout_interval": 1,
      "readout_status": {
        "last_readout_at": "2026-07-19T06:49:54.164Z",
        "configured_variables": 1,
        "state": {
          "type": "OK"
        }
      },
      "name": "text",
      "spark": "123e4567-e89b-12d3-a456-426614174000",
      "manufacturer": "Siemens",
      "device_model": "S7-1214C",
      "note": "text",
      "capabilities": {
        "variable_discovery": true
      },
      "machine": "123e4567-e89b-12d3-a456-426614174000",
      "details": {
        "host": "text",
        "port": 44818,
        "type": "text"
      }
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}

Post Data Source

post

Create a new data source

Autorisierungen

AuthorizationstringErforderlich

Body

namestringErforderlich

The human readable name of the data source.

sparkstring · uuidErforderlich

Which SPARK reads from the data source. It must be located at the same site as the current SPARK.

manufacturerstring · nullableOptional

Manufacturer of the data source.

Example: Siemens

device_modelstring · nullableOptional

Specific model or name describing the data source as concretely as possible.

Example: S7-1214C

notestring · nullableOptional

General remarks concerning this data source.

machinestring · uuidErforderlich

On which machine the data source is located.

detailsone ofErforderlich

Data Source specific properties required for the connection to the data source

oder

Antworten

201

Successful Response

application/json

uuidstring · uuidErforderlich

typestringErforderlich

readout_limitinteger · nullableErforderlich

readout_intervalintegerErforderlich

namestringErforderlich

The human readable name of the data source.

sparkstring · uuidErforderlich

Which SPARK reads from the data source. It must be located at the same site as the current SPARK.

manufacturerstring · nullableErforderlich

Manufacturer of the data source.

Example: Siemens

device_modelstring · nullableErforderlich

Specific model or name describing the data source as concretely as possible.

Example: S7-1214C

notestring · nullableErforderlich

General remarks concerning this data source.

machinestring · uuidErforderlich

On which machine the data source is located.

last_readout_atstring · date-time · nullableErforderlichVeraltet

This field is deprecated, use the readout_status.last_readout_at

detailsone of · nullableErforderlich

Data Source specific properties required for the connection to the data source

oder

422

Validation Error

application/json

post/v2/data-sources

POST /api/v2/data-sources HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "name": "text",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "manufacturer": "Siemens",
  "device_model": "S7-1214C",
  "note": "text",
  "machine": "123e4567-e89b-12d3-a456-426614174000",
  "details": {
    "host": "text",
    "port": 44818,
    "type": "text"
  }
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "readout_limit": 1,
  "readout_interval": 1,
  "readout_status": {
    "last_readout_at": "2026-07-19T06:49:54.164Z",
    "configured_variables": 1,
    "state": {
      "type": "OK"
    }
  },
  "name": "text",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "manufacturer": "Siemens",
  "device_model": "S7-1214C",
  "note": "text",
  "capabilities": {
    "variable_discovery": true
  },
  "machine": "123e4567-e89b-12d3-a456-426614174000",
  "details": {
    "host": "text",
    "port": 44818,
    "type": "text"
  }
}

Get Data Source

get

Returns details for a specific data source.

Autorisierungen

AuthorizationstringErforderlich

Pfadparameter

uuidstring · uuidErforderlich

Antworten

200

Successful Response

application/json

uuidstring · uuidErforderlich

typestringErforderlich

readout_limitinteger · nullableErforderlich

readout_intervalintegerErforderlich

namestringErforderlich

The human readable name of the data source.

sparkstring · uuidErforderlich

Which SPARK reads from the data source. It must be located at the same site as the current SPARK.

manufacturerstring · nullableErforderlich

Manufacturer of the data source.

Example: Siemens

device_modelstring · nullableErforderlich

Specific model or name describing the data source as concretely as possible.

Example: S7-1214C

notestring · nullableErforderlich

General remarks concerning this data source.

machinestring · uuidErforderlich

On which machine the data source is located.

last_readout_atstring · date-time · nullableErforderlichVeraltet

This field is deprecated, use the readout_status.last_readout_at

detailsone of · nullableErforderlich

Data Source specific properties required for the connection to the data source

oder

422

Validation Error

application/json

get/v2/data-sources/{uuid}

GET /api/v2/data-sources/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "readout_limit": 1,
  "readout_interval": 1,
  "readout_status": {
    "last_readout_at": "2026-07-19T06:49:54.164Z",
    "configured_variables": 1,
    "state": {
      "type": "OK"
    }
  },
  "name": "text",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "manufacturer": "Siemens",
  "device_model": "S7-1214C",
  "note": "text",
  "capabilities": {
    "variable_discovery": true
  },
  "machine": "123e4567-e89b-12d3-a456-426614174000",
  "details": {
    "host": "text",
    "port": 44818,
    "type": "text"
  }
}

Delete Data Source

delete

Delete a data source

Autorisierungen

AuthorizationstringErforderlich

Pfadparameter

data_source_uuidstring · uuidErforderlich

Antworten

204

Successful Response

Kein Inhalt

422

Validation Error

application/json

delete/v2/data-sources/{data_source_uuid}

DELETE /api/v2/data-sources/{data_source_uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

Kein Inhalt

Update Data Source

patch

Update a data source

Autorisierungen

AuthorizationstringErforderlich

Pfadparameter

data_source_uuidstring · uuidErforderlich

Body

namestringOptional

The human readable name of the data source.

sparkstring · uuidOptional

Which SPARK reads from the data source. It must be located at the same site as the current SPARK.

manufacturerstring · nullableOptional

Manufacturer of the data source.

Example: Siemens

device_modelstring · nullableOptional

Specific model or name describing the data source as concretely as possible.

Example: S7-1214C

notestring · nullableOptional

General remarks concerning this data source.

detailsone ofOptional

Data Source specific properties required for the connection to the data source

oder

Antworten

201

Successful Response

application/json

anyOptional

422

Validation Error

application/json

patch/v2/data-sources/{data_source_uuid}

PATCH /api/v2/data-sources/{data_source_uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "name": "text",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "manufacturer": "Siemens",
  "device_model": "S7-1214C",
  "note": "text",
  "details": {
    "type": "text",
    "host": "text",
    "port": 1
  }
}

Kein Inhalt

VorherigeMachines NächsteSPARKs

Zuletzt aktualisiert vor 2 Tagen