Verwaltung von Operationen für eingerichtete BSM-Konfigurationen.
Seitenverzeichnis:
| Inhalt |
|---|
| maxLevel | 2 |
|---|
| indent | 10px |
|---|
| style | square |
|---|
|
...
bsm.operation.read
Beschreibung
Gibt alle konfigurierten Operationen zu einem Service zurück.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.operation.read",
"params": {
"apikey": "24174j3tqj",
"service_id": 19
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version |
|---|
| service_id | int | ab Version 1.0 |
Rückgabewert
Liste aller Operation zum angegebenen Service.
| Wert | Typ | Version |
|---|
| id | int | ab Version 1.0 |
| description | string | ab Version 1.0 |
| layer_id | int | ab Version 1.0 |
| operation | string | ab Version 1.0 |
| operation_value | int | ab Version 1.0 |
| config_items | array | ab Version 1.0 |
...
bsm.operation.status
Beschreibung
Gibt den Status aller Operationen eines Services zurück.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.operation.status",
"params": {
"apikey": "24174j3tqj",
"service_id": 19
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version |
|---|
| service_id | int | ab Version 1.0 |
Rückgabewert
Liste der Status aller Operationen des angegebenen Services.
Ein Eintrag in der Liste enthält folgende Werte:
| Wert | Typ | Beschreibung | Version |
|---|
| id | int | ID der Operation | ab Version 1.0 |
| description | int | Status-Code | ab Version 1.0 |
| layer_id | int | ID der OBASHI-Schicht, dieser Operation | ab Version 1.0 |
| operation | string | Typ der Operation | ab Version 1.0 |
| operation_value | int | Optionaler Wert zur Operation | ab Version 1.0 |
| config_items | array | Liste mit IDs der Konfigurationselemente | ab Version 1.0 |
| status | int | Berechneter Status der Operation | ab Version 1.0 |
...
bsm.operation.create
Beschreibung
Legt eine neue Operation an.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.operation.create",
"params": {
"apikey": "24174j3tqj",
"service_id": 19,
"description": "Operation Name",
"operation": "min_available",
"operation_value": "2",
"config_items": [
2,
67
],
"dependent_items": [
4,
8
]
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| service_id | int | ID des Service | ab Version 1.0 |
| description | string | Name der Operation | ab Version 1.0 |
| operation | string | Typ der Operation Mögliche Werte sind: - all_available
- min_available
- max_available
- one_available
- max_unavailable
| ab Version 1.0 |
| operation_value | int | Optionaler Wert zur Operation Der Wert muss für folgende Operationstypen gesetzt sein: - min_available
- max_available
- max_unavailable
| ab Version 1.0 |
| config_items | array | Liste mit IDs der Konfigurationselemente |
.dependent_items | array | Liste mit IDs der abhängigen Services. | Rückgabewert
| Wert | Typ | Version |
|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
...
...
bsm.operation.update
Beschreibung
Aktualisiert die angegebene Operation.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.operation.update",
"params": {
"apikey": "24174j3tqj",
"operation_id": 4,
"description": "Operation Name",
"operation": "min_available",
"operation_value": "2",
"config_items": [
2,
67
],
"dependent_items": [
4,
8
]
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| operation_id | int | ID der Operation | ab Version 1.0 |
| description | string | Name der Operation | ab Version 1.0 |
| operation | string | Typ der Operation Mögliche Werte sind: - all_available
- min_available
- max_available
- one_available
- max_unavailable
| ab Version 1.0 |
| operation_value | int | Optionaler Wert zur Operation Der Wert muss für folgende Operationstypen gesetzt sein: - min_available
- max_available
- max_unavailable
| ab Version 1.0 |
| config_items | array | Liste mit IDs der Konfigurationselemente |
.dependent_items | array | Liste mit IDs der abhängigen Services.Rückgabewert
| Wert | Typ | Version |
|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
...
...
bsm.operation.delete
Beschreibung
Löscht die angegebene Operation.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.operation.delete",
"params": {
"apikey": "24174j3tqj",
"operation_id": 4
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version |
|---|
| operation_id | int | 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 |