Generator

Verwaltung von Generatoren.

Seitenverzeichnis:

cable.generator.read

Beschreibung

Gibt alle Generatoren zurück.

Beispielaufruf

Lesen eines speziellen Generators:

{
	"method":"cable.generator.read",
	"params":{
		"apikey":"24174j3tqj",
		"id": 4
	},
	"version":"2.0"
}

Filtern von Generatoren:

{
	"method":"cable.generator.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"title": "LWL %"
		}
	},
	"version":"2.0"
}

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

Rückgabewert

Liste aller Generatoren.

Wert	Typ	Beschreibung	Version
id	int	ID des Generators	ab Version 1.0
obj_id	int	ID des referenzierten Generator-Objektes	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	kleinster möglicher Wert z.B.: 01/01/1	ab Version 1.0
counter_max	string	größter möglicher Wert z.B.: 01/04/9	ab Version 1.0

cable.generator.create

Beschreibung

Legt einen neuen Generator an.

Beispielaufruf

{
	"method":"cable.generator.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id": 14,
			"title":"Generatore A",
			"mask": "#/#/#"
		}
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Generator-Objektes	ab Version 1.0
title	string	Titel des Generators	ab Version 1.0
description	string	Optional: Beschreibung des Generators	ab Version 1.0
mask	string	Maske der Generator-Vorlage z.B.: #/#/#	ab Version 1.0
counter_min	string	Optional: kleinster möglicher Wert z.B.: 01/01/1	ab Version 1.0
counter_max	string	Optional: größter möglicher Wert 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.update

Beschreibung

Aktualisiert einen bestehenden Generator.

Beispielaufruf

{
	"method":"cable.generator.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"Generator A"
		}
	},
	"version":"2.0"
}

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	kleinster möglicher Wert z.B.: 01/01/1	ab Version 1.0
counter_max	string	größter möglicher Wert 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

Löscht einen Generator.

Beispielaufruf

{
	"method":"cable.generator.generate",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"start_pattern": "1/2/3",
		"end_pattern": "1/4/8"
	},
	"version":"2.0"
}

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

Endwert

z.B.: 02/04/4

ab Version 1.0

Rückgabewert

Auflistung der generierten Werte.

cable.generator.delete

Beschreibung

Löscht einen Generator.

Beispielaufruf

{
	"method":"cable.generator.delete",
	"params":{
		"apikey":"24174j3tqj",
		"id":4
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des zu lö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