Generator-Algorithmus
Verwaltung von Generator-Algorithmen.
Seitenverzeichnis:
cable.generator_algorithm.read
Beschreibung
Gibt alle Generator-Algorithmen zurück.
Beispielaufruf
Lesen eines speziellen Generator-Algorithmus:
{
"method":"cable.generator_algorithm.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0",
"id": 1
}Filtern von Generator-Algorithmen:
{
"method":"cable.generator_algorithm.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"description": "Generator %"
}
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | Optional: ID des Generator-Algorithmus | ab Version 1.0 |
filter | array | Optional: Filter für Generator-Algorithmen Der Filter unterstützt alle Eigenschaften des Generator-Algorithmus (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Liste aller Generator-Algorithmen.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Generator-Algorithmus | ab Version 1.0 |
generator_id | int | ID des zugehörigen Generators | ab Version 1.0 |
description | string | Beschreibung des Generator-Algorithmus | ab Version 1.0 |
index | int | Index, in der der Generator-Algorithmus ausgeführt wird z.B.: 1 wenn der Generator-Algorithmus zuerst ausgeführt wird | ab Version 1.0 |
mask_position | int | Position des Wertes in der Generator-Maske | ab Version 1.0 |
length | int | maximale Zeichenlänge | ab Version 1.0 |
increment | int | Wert, um welchen inkrementiert wird | ab Version 1.0 |
type | string | Typ des Algorithmus Folgende Werte sind möglich:
| ab Version 1.0 |
elements | string | Werte, welche für eine Enumeration verwendet werden, durch Semikolon getrennt | ab Version 1.0 |
cable.generator_algorithm.create
Beschreibung
Legt einen neuen Generator-Algorithmus an.
Beispielaufruf
{
"method":"cable.generator_algorithm.create",
"params":{
"apikey":"24174j3tqj",
"data": {
"generator_id": 14,
"index": 1,
"mask_position": 3
}
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
generator_id | int | ID des zugehörigen Generators | ab Version 1.0 |
description | string | Optional: Beschreibung des Generator-Algorithmus | ab Version 1.0 |
index | int | Index, in der der Generator-Algorithmus ausgeführt wird z.B.: 1 wenn der Generator-Algorithmus zuerst ausgeführt wird | ab Version 1.0 |
mask_position | int | Position des Wertes in der Generator-Maske | ab Version 1.0 |
length | int | Optional: maximale Zeichenlänge | ab Version 1.0 |
increment | int | Optional: Wert, um welchen inkrementiert wird | ab Version 1.0 |
type | string | Optional: Typ des Algorithmus Folgende Werte sind möglich:
| ab Version 1.0 |
elements | string | Optional: Werte, welche für eine Enumeration verwendet werden, durch Semikolon getrennt | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
|---|---|---|
current_date | string | ab Version 1.0 |
id | int | ab Version 1.0 |
message | string | ab Version 1.0 |
cable.generator_algorithm.update
Beschreibung
Aktualisiert einen bestehenden Generator-Algorithmus.
Beispielaufruf
{
"method":"cable.generator_algorithm.update",
"params":{
"apikey":"24174j3tqj",
"id":4,
"data": {
"description":"Generator A"
}
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Generator-Algorithmus | ab Version 1.0 |
description | string | Beschreibung des Generator-Algorithmus | ab Version 1.0 |
index | int | Index, in der der Generator-Algorithmus ausgeführt wird z.B.: 1 wenn der Generator-Algorithmus zuerst ausgeführt wird | ab Version 1.0 |
mask_position | int | Position des Wertes in der Generator-Maske | ab Version 1.0 |
length | int | maximale Zeichenlänge | ab Version 1.0 |
increment | int | Wert, um welchen inkrementiert wird | ab Version 1.0 |
type | string | Typ des Algorithmus Folgende Werte sind möglich:
| ab Version 1.0 |
elements | string | Werte, welche für eine Enumeration verwendet werden, durch Semikolon getrennt | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
|---|---|---|
current_date | string | ab Version 1.0 |
id | int | ab Version 1.0 |
message | string | ab Version 1.0 |
cable.generator_algorithm.delete
Beschreibung
Löscht einen Generator-Algorithmus.
Beispielaufruf
{
"method":"cable.generator_algorithm.delete",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des zu löschenden Generator-Algorithmus | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
|---|---|---|
current_date | string | ab Version 1.0 |
id | int | ab Version 1.0 |
message | string | ab Version 1.0 |
© 2025 SHD System-Haus-Dresden GmbH | Impressum https://www.shd-online.de/impressum/