Profil-Regel

Verwaltung von Regel zu einem Profil.

Seitenverzeichnis:

1 bsm.profile_rule.read
2 bsm.profile_rule.create
3 bsm.profile_rule.update
4 bsm.profile_rule.delete

bsm.profile_rule.read

Beschreibung

Gibt alle Regeln eines Profils zurück.

Beispielaufruf

{
    "method": "bsm.profile_rule.read",
    "params": {
        "apikey": "24174j3tqj",
        "profile_id": 19
    },
    "id": 1,
    "version": "2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
profile_id	int	ID des jeweiligen Profils	ab Version 1.0

Rückgabewert

Array der Regeln eines Profils.

Wert	Typ	Version
id	int	ab Version 1.0
profile_id	int	ab Version 1.0
name	string	ab Version 1.0
result_status	int	ab Version 1.0
operation	string	ab Version 1.0
output	string	ab Version 1.0

bsm.profile_rule.create

Beschreibung

Legt eine neue Regel zu einem Profil an.

Beispielaufruf

{
    "method": "bsm.profile_rule.create",
    "params": {
        "apikey": "24174j3tqj",
        "profile_id": 19,
        "name": "myProfileRule",
        "result_status": 1,
        "operation": "all_available",
        "output": "myOutput",
        "services": []
    },
    "id": 1,
    "version": "2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
profile_id	int	ID des jeweiligen Profils	ab Version 1.0
name	string	Name der Regel	ab Version 1.0
result_status	int	Sich ergebender Status	ab Version 1.0
operation	string	Name der Operation	ab Version 1.0
output	string	Ausgabetext	ab Version 1.0
services	array	Liste der abhängigen Services	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

bsm.profile_rule.update

Beschreibung

Aktualisiert eine bestehende Regel.

Beispielaufruf

{
    "method": "bsm.profile_rule.update",
    "params": {
        "apikey": "24174j3tqj",
        "rule_id": 24,
        "name": "myProfileRule",
        "result_status": 1,
        "operation": "all_available",
        "output": "myOutput",
        "services": []
    },
    "id": 1,
    "version": "2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
rule_id	int	ID der jeweiligen Regel	ab Version 1.0
name	string	Name der Regel	ab Version 1.0
result_status	int	Sich ergebender Status	ab Version 1.0
operation	string	Name der Operation	ab Version 1.0
output	string	Ausgabetext	ab Version 1.0
services	array	Liste der abhängigen Services	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

bsm.profile_rule.delete

Beschreibung

Löscht eine bestehende Regel.

Beispielaufruf

{
    "method": "bsm.profile_rule.delete",
    "params": {
        "apikey": "24174j3tqj",
        "rule_id": 24
    },
    "id": 1,
    "version": "2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
rule_id	int	ID der jeweiligen Regel	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