...
Lesen eines speziellen Generators:
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.generator.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0",
"id": 1
} |
Filtern von Generatoren:
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.generator.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"title": "LWL %LWL%"
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | Optional: ID des Generators | ab Version 1.0 |
| filter | array | Optional: Filter für Generatoren Der Filter unterstützt alle Eigenschaften des Generators (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
...
| Wert | Typ | Beschreibung | Version | ||||
|---|---|---|---|---|---|---|---|
| id | int | ID des Generators | ab Version 1.0 | obj_id | int | ID des referenzierten Generator-Objektesab Version 1.0 | |
| title | string | Titel des Generators | ab Version 1.0 | ||||
| description | string | Beschreibung des Generators | ab Version 1.0 | ||||
| mask | string | Maske der Generator-Vorlage z.B.: #/#/# | ab Version 1.0 | ||||
| counter_min | string | kleinster möglicher WertStartwerte der einzelnen Segmente z.B.: 01/01/1 | ab Version 1.0 | ||||
| counter_max | string | größter möglicher WertEndwerte der einzelnen Segmente z.B.: 01/04/9 | ab Version 1.0 |
...
cable.generator.create
Beschreibung
Legt eine neue Strecke einen neuen Generator an.
Beispielaufruf
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.generator.create",
"params":{
"apikey":"24174j3tqj",
"data": {
"title":"Generatore A",
"mask": "#/#/#",
"objcounter_idmin": 14"01/01/1",
"titlecounter_max":"Generatore A "02/24/4"
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version | ||||
|---|---|---|---|---|---|---|---|
| obj_idtitle | int | ID des referenzierten Strecken-Objektesstring | Titel des Generators | ab Version 1.0 | |||
| description | string | Optional: Beschreibung | der Streckedes Generators | ab Version 1.0 | |||
| mask | string | Maske der Generator-Vorlage z.B.: #/#/# | ab Version 1.0 | ||||
| channelcounter_count | int | Optional: Anzahl logischer Kanälemin | string | Startwerte der einzelnen Segmente z.B.: 01/01/1 | ab Version 1.0 | current_channel_count | int |
| Optional: Aktuelle Anzahl logischer Kanälecounter_max | string | Endwerte der einzelnen Segmente z.B.: 01/04/9 | ab Version 1.0 |
Rückgabewert
...
cable.generator.update
Beschreibung
Aktualisiert eine bestehende Streckeeinen bestehenden Generator.
Beispielaufruf
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.generator.update",
"params":{
"apikey":"24174j3tqj",
"id":4,
"data": {
"description":"Generator A"
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID |
| des Generators | ab Version 1.0 | ||
| title | string | Titel des Generators | ab Version 1.0 |
| description | string | Beschreibung |
| des Generators | ab Version 1.0 | ||
| mask | string | Maske der Generator-Vorlage z.B.: #/#/# | ab Version 1.0 |
| counter_min | string | Startwerte der einzelnen Segmente z.B.: 01/01/1 | ab Version 1.0 |
| counter_max | string | Endwerte der einzelnen Segmente z.B.: 01/04/9 | 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.generate
Beschreibung
Führt den Generator mit den konkreten Start- und Endwerten aus.
Beispielaufruf
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.generator.generate",
"params":{
"apikey":"24174j3tqj",
"data": {
"id":4,
"start_pattern": "01/02/1",
"end_pattern": "02/04/4"
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Generators | ab Version 1.0 |
| start_pattern | string | Startwert z.B.: 01/02/1 | ab Version 1.0 |
| end_pattern | string | Optional: Endwert z.B.: 02/04/4 | ab Version 1.0 |
| max_count | int |
| Optional: Anzahl der Elemente, welche generiert werden sollen | ab Version 1.0 |
Rückgabewert
...
Auflistung der generierten Werte.
...
cable.generator.count
Beschreibung
Gibt die Anzahl der generierten Werte eines Generators aus.
Beispielaufruf
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.generator.count",
"params":{
"apikey":"24174j3tqj",
"data": {
"id":4,
"start_pattern": "01/02/1",
"end_pattern": "02/04/4"
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Generators | ab Version 1.0 |
| start_pattern | string | Startwert z.B.: 01/02/1 | ab Version 1.0 |
| end_pattern | string | Optional: Endwert z.B.: 02/04/4 | ab Version 1.0 |
| max_count | int | Optional: Anzahl der Elemente, welche generiert werden sollen | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Beschreibung | Version |
|---|---|---|---|
| count | int | Anzahl der generierten Elemente | ab Version 1.0 |
| end_element | string | Zuletzt generiertes Element | ab Version 1.0 |
...
cable.generator.delete
Beschreibung
Löscht eine Streckeeinen Generator.
Beispielaufruf
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.generator.delete",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID der des zu löschenden Streckelöschenden Generators | 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 |
...