StartStopp API
Die StartStopp-API
StartStopp ¶
Gruppe aller StartStopp-bezogenenen Ressourcen.
Status von StartStopp ¶
Liefert den Status der StartStopp-Applikation.
GET/ststapi/v1/system
Example URI
200
Headers
Content-Type: application/json
Body
{
"status": "initialized",
"betriebsmeldungen": true,
"davconnection": false
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"initialized",
"running",
"running_canceled",
"stopping",
"stopping_canceled",
"stopped",
"shutdown",
"configerror"
],
"default": "initialized",
"description": "der Status der StartStoppApplikation"
},
"betriebsmeldungen": {
"type": "boolean",
"default": true
},
"davconnection": {
"type": "boolean",
"default": false
}
},
"required": [
"status",
"betriebsmeldungen",
"davconnection"
]
}
StartStopp Applikation beenden ¶
Beendet die StartStopp-Applikation.
StartStopp-Konfiguration beenden ¶
Startet die StartStopp-Konfiguration neu.
StartStopp-Konfiguration neu starten ¶
Startet die StartStopp-Konfiguration neu.
StartStopp-Konfiguration starten ¶
Startet die nicht laufenden Prozesse der StartStopp-Konfiguration neu.
StartStopp - Betriebsmeldungen ¶
Schaltet den Zustand der Betriebsmeldungen um
POST/ststapi/v1/system/betriebsmeldungen
Example URI
202
Alle Applikationen der bekannten Rechner abrufen ¶
Liefert die Applikationen aller definierten Rechner, soweit diese verfügbar sind.
GET/ststapi/v1/system/applikationen
Example URI
200
Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnation": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"enum": []
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
],
"description": "die verwendete Inkarnation"
},
"rechner": {
"type": "string"
},
"letzteStartzeit": {
"type": "string",
"description": "die letzte Startzeit der Inkarnation"
},
"letzteInitialisierung": {
"type": "string",
"description": "die letzte Initialisierungszeit der Inkarnation"
},
"letzteStoppzeit": {
"type": "string",
"description": "die letzte Stoppzeit der Inkarnation"
},
"status": {
"enum": [
"installiert",
"startenwarten",
"gestartet",
"initialisiert",
"stoppenwarten",
"gestoppt"
],
"description": "der Status der Inkarnation in StartStopp"
},
"startMeldung": {
"type": "string"
}
},
"required": [
"inkarnation",
"status",
"startMeldung"
]
},
"$schema": "http://json-schema.org/draft-04/schema#"
}
Skripte ¶
Gruppe aller skriptbezogenenen Ressourcen.
Aktuelles Skript ¶
Liefert oder schreibt das aktuell von StartStopp geladene Skript.
GET/ststapi/v1/skripte/current
Example URI
200
Headers
Content-Type: application/json
Body
{
"global": {
"kernsysteme": [
{
"inkarnationsName": "Parametrierung"
}
],
"makrodefinitionen": [
{
"name": "kbliste",
"wert": "kb.tlsObjekte,kb.verkehrsObjekte"
}
],
"zugangDav": {
"adresse": "localhost",
"passWord": "passwort",
"port": "3000",
"userName": "Tester"
},
"usv": {
"pid": ""
},
"rechner": [
{
"name": "Hauptserver",
"tcpAdresse": "127.0.0.1",
"port": "3000"
}
]
},
"inkarnationen": [
{
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
}
],
"metaDaten": {
"aenderungsGrund": "",
"erstelltAm": "",
"erstelltDurch": "",
"versionsNummer": "",
"name": ""
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"global": {
"type": "object",
"properties": {
"kernsysteme": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
}
},
"required": [
"inkarnationsName"
]
}
},
"makrodefinitionen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"wert": {
"type": "string"
}
},
"required": [
"name",
"wert"
]
}
},
"zugangDav": {
"type": "object",
"properties": {
"adresse": {
"type": "string",
"default": "localhost"
},
"passWord": {
"type": "string",
"default": "passwort"
},
"port": {
"type": "string",
"default": "3000"
},
"userName": {
"type": "string",
"default": "Tester"
}
},
"required": [
"adresse",
"passWord",
"port",
"userName"
]
},
"usv": {
"type": "object",
"properties": {
"pid": {
"type": "string"
}
},
"required": [
"pid"
]
},
"rechner": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tcpAdresse": {
"type": "string"
},
"port": {
"type": "string",
"default": "3000"
}
},
"required": [
"name",
"tcpAdresse",
"port"
]
}
}
},
"required": [
"zugangDav"
]
},
"inkarnationen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
]
}
},
"metaDaten": {
"type": "object",
"properties": {
"aenderungsGrund": {
"type": "string"
},
"erstelltAm": {
"type": "string"
},
"erstelltDurch": {
"type": "string"
},
"versionsNummer": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"global",
"inkarnationen"
]
}
503
Headers
Content-Type: application/json
Body
{
"code": -1,
"messages": [
"Hello, world!"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number"
},
"messages": {
"type": "array"
}
},
"required": [
"code"
]
}
PUT/ststapi/v1/skripte/current
Das gesendete Skript wird geprüft, versioniert und aktiviert.
Example URI
Headers
Content-Type: application/json
Body
{
"name": "",
"aenderungsgrund": "",
"skript": {
"global": {
"kernsysteme": [
{
"inkarnationsName": "Parametrierung"
}
],
"makrodefinitionen": [
{
"name": "kbliste",
"wert": "kb.tlsObjekte,kb.verkehrsObjekte"
}
],
"zugangDav": {
"adresse": "localhost",
"passWord": "passwort",
"port": "3000",
"userName": "Tester"
},
"usv": {
"pid": ""
},
"rechner": [
{
"name": "Hauptserver",
"tcpAdresse": "127.0.0.1",
"port": "3000"
}
]
},
"inkarnationen": [
{
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
}
],
"metaDaten": {
"aenderungsGrund": "",
"erstelltAm": "",
"erstelltDurch": "",
"versionsNummer": "",
"name": ""
}
},
"veranlasser": "",
"passwort": ""
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"aenderungsgrund": {
"type": "string"
},
"skript": {
"type": "object",
"properties": {
"global": {
"type": "object",
"properties": {
"kernsysteme": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
}
},
"required": [
"inkarnationsName"
]
}
},
"makrodefinitionen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"wert": {
"type": "string"
}
},
"required": [
"name",
"wert"
]
}
},
"zugangDav": {
"type": "object",
"properties": {
"adresse": {
"type": "string",
"default": "localhost"
},
"passWord": {
"type": "string",
"default": "passwort"
},
"port": {
"type": "string",
"default": "3000"
},
"userName": {
"type": "string",
"default": "Tester"
}
},
"required": [
"adresse",
"passWord",
"port",
"userName"
]
},
"usv": {
"type": "object",
"properties": {
"pid": {
"type": "string"
}
},
"required": [
"pid"
]
},
"rechner": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tcpAdresse": {
"type": "string"
},
"port": {
"type": "string",
"default": "3000"
}
},
"required": [
"name",
"tcpAdresse",
"port"
]
}
}
},
"required": [
"zugangDav"
]
},
"inkarnationen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
]
}
},
"metaDaten": {
"type": "object",
"properties": {
"aenderungsGrund": {
"type": "string"
},
"erstelltAm": {
"type": "string"
},
"erstelltDurch": {
"type": "string"
},
"versionsNummer": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"global",
"inkarnationen"
]
},
"veranlasser": {
"type": "string"
},
"passwort": {
"type": "string"
}
},
"required": [
"aenderungsgrund",
"skript",
"veranlasser",
"passwort"
]
}
200
Headers
Content-Type: application/json
Body
{
"global": {
"kernsysteme": [
{
"inkarnationsName": "Parametrierung"
}
],
"makrodefinitionen": [
{
"name": "kbliste",
"wert": "kb.tlsObjekte,kb.verkehrsObjekte"
}
],
"zugangDav": {
"adresse": "localhost",
"passWord": "passwort",
"port": "3000",
"userName": "Tester"
},
"usv": {
"pid": ""
},
"rechner": [
{
"name": "Hauptserver",
"tcpAdresse": "127.0.0.1",
"port": "3000"
}
]
},
"inkarnationen": [
{
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
}
],
"metaDaten": {
"aenderungsGrund": "",
"erstelltAm": "",
"erstelltDurch": "",
"versionsNummer": "",
"name": ""
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"global": {
"type": "object",
"properties": {
"kernsysteme": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
}
},
"required": [
"inkarnationsName"
]
}
},
"makrodefinitionen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"wert": {
"type": "string"
}
},
"required": [
"name",
"wert"
]
}
},
"zugangDav": {
"type": "object",
"properties": {
"adresse": {
"type": "string",
"default": "localhost"
},
"passWord": {
"type": "string",
"default": "passwort"
},
"port": {
"type": "string",
"default": "3000"
},
"userName": {
"type": "string",
"default": "Tester"
}
},
"required": [
"adresse",
"passWord",
"port",
"userName"
]
},
"usv": {
"type": "object",
"properties": {
"pid": {
"type": "string"
}
},
"required": [
"pid"
]
},
"rechner": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tcpAdresse": {
"type": "string"
},
"port": {
"type": "string",
"default": "3000"
}
},
"required": [
"name",
"tcpAdresse",
"port"
]
}
}
},
"required": [
"zugangDav"
]
},
"inkarnationen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
]
}
},
"metaDaten": {
"type": "object",
"properties": {
"aenderungsGrund": {
"type": "string"
},
"erstelltAm": {
"type": "string"
},
"erstelltDurch": {
"type": "string"
},
"versionsNummer": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"global",
"inkarnationen"
]
}
400
Headers
Content-Type: application/json
Body
{
"code": -1,
"messages": [
"Hello, world!"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number"
},
"messages": {
"type": "array"
}
},
"required": [
"code"
]
}
Aktueller Skript-Status ¶
Liefert den Status des aktuell von StartStopp geladenen Skripts.
GET/ststapi/v1/skripte/current/status
Example URI
200
Headers
Content-Type: application/json
Body
{
"status": "initialized",
"messages": []
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"initialized",
"failure"
],
"default": "initialized",
"description": "der Status der StartStoppApplikation"
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"status"
]
}
Versionierte Skripte ¶
Liefert eine Liste der Informationen versionierten Skripten
GET/ststapi/v1/skripte/versionen
Example URI
200
Headers
Content-Type: application/json
Body
[
{
"name": "Hello, world!",
"version": "Hello, world!",
"erstelltDurch": "Hello, world!",
"aenderungsGrund": "Hello, world!",
"pruefsumme": "Hello, world!"
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"erstelltDurch": {
"type": "string"
},
"aenderungsGrund": {
"type": "string"
},
"pruefsumme": {
"type": "string"
}
},
"required": [
"version",
"erstelltDurch",
"aenderungsGrund",
"pruefsumme"
]
}
}
Applikation ¶
Alle Applikationen ¶
Alle von StartStopp verwalteten Applikationen
GET/ststapi/v1/applikationen
Example URI
200
Headers
Content-Type: application/json
Body
[
{
"inkarnation": {
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
},
"rechner": "localhost",
"letzteStartzeit": "24.12.2016 12:01",
"letzteInitialisierung": "24.12.2016 12:04",
"letzteStoppzeit": "06.12.2016 11:11",
"status": "installiert",
"startMeldung": "undefiniert"
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnation": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
],
"description": "die verwendete Inkarnation"
},
"rechner": {
"type": "string"
},
"letzteStartzeit": {
"type": "string",
"description": "die letzte Startzeit der Inkarnation"
},
"letzteInitialisierung": {
"type": "string",
"description": "die letzte Initialisierungszeit der Inkarnation"
},
"letzteStoppzeit": {
"type": "string",
"description": "die letzte Stoppzeit der Inkarnation"
},
"status": {
"type": "string",
"enum": [
"installiert",
"startenwarten",
"gestartet",
"initialisiert",
"stoppenwarten",
"gestoppt"
],
"description": "der Status der Inkarnation in StartStopp"
},
"startMeldung": {
"type": "string"
}
},
"required": [
"inkarnation",
"status",
"startMeldung"
]
}
}
Status einer Applikation ¶
Liefert den Status der referenzierten Applikation.
GET/ststapi/v1/applikationen/{inkarnationsname}
Example URI
- inkarnationsname
string
(required) Example: Datenverteilerder Inkarnationsname der Applikation.
200
Headers
Content-Type: application/json
Body
{
"inkarnation": {
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
},
"rechner": "localhost",
"letzteStartzeit": "24.12.2016 12:01",
"letzteInitialisierung": "24.12.2016 12:04",
"letzteStoppzeit": "06.12.2016 11:11",
"status": "installiert",
"startMeldung": "undefiniert"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"inkarnation": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
],
"description": "die verwendete Inkarnation"
},
"rechner": {
"type": "string"
},
"letzteStartzeit": {
"type": "string",
"description": "die letzte Startzeit der Inkarnation"
},
"letzteInitialisierung": {
"type": "string",
"description": "die letzte Initialisierungszeit der Inkarnation"
},
"letzteStoppzeit": {
"type": "string",
"description": "die letzte Stoppzeit der Inkarnation"
},
"status": {
"type": "string",
"enum": [
"installiert",
"startenwarten",
"gestartet",
"initialisiert",
"stoppenwarten",
"gestoppt"
],
"description": "der Status der Inkarnation in StartStopp"
},
"startMeldung": {
"type": "string"
}
},
"required": [
"inkarnation",
"status",
"startMeldung"
]
}
Startmeldungen einer Applikation ¶
Liefert die Startmeldungen der referenzierten Applikation.
GET/ststapi/v1/applikationen/{inkarnationsname}/log
Example URI
- inkarnationsname
string
(required) Example: Datenverteilerder Inkarnationsname der Applikation.
200
Headers
Content-Type: application/json
Body
{
"inkarnation": "Hello, world!",
"messages": [
"Hello, world!"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"inkarnation": {
"type": "string",
"description": "der Name der Inkarnation"
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"inkarnation"
]
}
Applikation starten ¶
Startet die referenzierte Applikation.
POST/ststapi/v1/applikationen/{inkarnationsname}/start
Example URI
- inkarnationsname
string
(required) Example: Datenverteilerder Inkarnationsname der Applikation.
200
Headers
Content-Type: application/json
Body
{
"inkarnation": {
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
},
"rechner": "localhost",
"letzteStartzeit": "24.12.2016 12:01",
"letzteInitialisierung": "24.12.2016 12:04",
"letzteStoppzeit": "06.12.2016 11:11",
"status": "installiert",
"startMeldung": "undefiniert"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"inkarnation": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
],
"description": "die verwendete Inkarnation"
},
"rechner": {
"type": "string"
},
"letzteStartzeit": {
"type": "string",
"description": "die letzte Startzeit der Inkarnation"
},
"letzteInitialisierung": {
"type": "string",
"description": "die letzte Initialisierungszeit der Inkarnation"
},
"letzteStoppzeit": {
"type": "string",
"description": "die letzte Stoppzeit der Inkarnation"
},
"status": {
"type": "string",
"enum": [
"installiert",
"startenwarten",
"gestartet",
"initialisiert",
"stoppenwarten",
"gestoppt"
],
"description": "der Status der Inkarnation in StartStopp"
},
"startMeldung": {
"type": "string"
}
},
"required": [
"inkarnation",
"status",
"startMeldung"
]
}
409
Headers
Content-Type: application/json
Body
{
"code": -1,
"messages": [
"Hello, world!"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number"
},
"messages": {
"type": "array"
}
},
"required": [
"code"
]
}
Applikation neu starten ¶
Startet die referenzierte Applikation neu.
POST/ststapi/v1/applikationen/{inkarnationsname}/restart
Example URI
- inkarnationsname
string
(required) Example: Datenverteilerder Inkarnationsname der Applikation.
200
Headers
Content-Type: application/json
Body
{
"inkarnation": {
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
},
"rechner": "localhost",
"letzteStartzeit": "24.12.2016 12:01",
"letzteInitialisierung": "24.12.2016 12:04",
"letzteStoppzeit": "06.12.2016 11:11",
"status": "installiert",
"startMeldung": "undefiniert"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"inkarnation": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
],
"description": "die verwendete Inkarnation"
},
"rechner": {
"type": "string"
},
"letzteStartzeit": {
"type": "string",
"description": "die letzte Startzeit der Inkarnation"
},
"letzteInitialisierung": {
"type": "string",
"description": "die letzte Initialisierungszeit der Inkarnation"
},
"letzteStoppzeit": {
"type": "string",
"description": "die letzte Stoppzeit der Inkarnation"
},
"status": {
"type": "string",
"enum": [
"installiert",
"startenwarten",
"gestartet",
"initialisiert",
"stoppenwarten",
"gestoppt"
],
"description": "der Status der Inkarnation in StartStopp"
},
"startMeldung": {
"type": "string"
}
},
"required": [
"inkarnation",
"status",
"startMeldung"
]
}
409
Headers
Content-Type: application/json
Body
{
"code": -1,
"messages": [
"Hello, world!"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number"
},
"messages": {
"type": "array"
}
},
"required": [
"code"
]
}
Applikation beenden ¶
Beendet die referenzierte Applikation.
POST/ststapi/v1/applikationen/{inkarnationsname}/stopp
Example URI
- inkarnationsname
string
(required) Example: Datenverteilerder Inkarnationsname der Applikation.
200
Headers
Content-Type: application/json
Body
{
"inkarnation": {
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
},
"rechner": "localhost",
"letzteStartzeit": "24.12.2016 12:01",
"letzteInitialisierung": "24.12.2016 12:04",
"letzteStoppzeit": "06.12.2016 11:11",
"status": "installiert",
"startMeldung": "undefiniert"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"inkarnation": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
],
"description": "die verwendete Inkarnation"
},
"rechner": {
"type": "string"
},
"letzteStartzeit": {
"type": "string",
"description": "die letzte Startzeit der Inkarnation"
},
"letzteInitialisierung": {
"type": "string",
"description": "die letzte Initialisierungszeit der Inkarnation"
},
"letzteStoppzeit": {
"type": "string",
"description": "die letzte Stoppzeit der Inkarnation"
},
"status": {
"type": "string",
"enum": [
"installiert",
"startenwarten",
"gestartet",
"initialisiert",
"stoppenwarten",
"gestoppt"
],
"description": "der Status der Inkarnation in StartStopp"
},
"startMeldung": {
"type": "string"
}
},
"required": [
"inkarnation",
"status",
"startMeldung"
]
}
409
Headers
Content-Type: application/json
Body
{
"code": -1,
"messages": [
"Hello, world!"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number"
},
"messages": {
"type": "array"
}
},
"required": [
"code"
]
}
Rechner ¶
Rechner abrufen ¶
Alle bei StartStopp definierten Rechner
GET/ststapi/v1/rechner
Example URI
200
Headers
Content-Type: application/json
Body
[
{
"name": "Hauptserver",
"tcpAdresse": "127.0.0.1",
"port": "Hello, world!"
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tcpAdresse": {
"type": "string"
},
"port": {
"type": "string",
"default": "3000"
}
},
"required": [
"name",
"tcpAdresse",
"port"
]
}
}
Skript des Rechners abrufen ¶
GET/ststapi/v1/rechner/{rechnername}/skript
Example URI
- rechnername
string
(required) Example: rechner2der Name des Rechners.
200
Headers
Content-Type: application/json
Body
{
"global": {
"kernsysteme": [
{
"inkarnationsName": "Parametrierung"
}
],
"makrodefinitionen": [
{
"name": "kbliste",
"wert": "kb.tlsObjekte,kb.verkehrsObjekte"
}
],
"zugangDav": {
"adresse": "localhost",
"passWord": "passwort",
"port": "3000",
"userName": "Tester"
},
"usv": {
"pid": ""
},
"rechner": [
{
"name": "Hauptserver",
"tcpAdresse": "127.0.0.1",
"port": "3000"
}
]
},
"inkarnationen": [
{
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
}
],
"metaDaten": {
"aenderungsGrund": "",
"erstelltAm": "",
"erstelltDurch": "",
"versionsNummer": "",
"name": ""
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"global": {
"type": "object",
"properties": {
"kernsysteme": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
}
},
"required": [
"inkarnationsName"
]
}
},
"makrodefinitionen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"wert": {
"type": "string"
}
},
"required": [
"name",
"wert"
]
}
},
"zugangDav": {
"type": "object",
"properties": {
"adresse": {
"type": "string",
"default": "localhost"
},
"passWord": {
"type": "string",
"default": "passwort"
},
"port": {
"type": "string",
"default": "3000"
},
"userName": {
"type": "string",
"default": "Tester"
}
},
"required": [
"adresse",
"passWord",
"port",
"userName"
]
},
"usv": {
"type": "object",
"properties": {
"pid": {
"type": "string"
}
},
"required": [
"pid"
]
},
"rechner": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tcpAdresse": {
"type": "string"
},
"port": {
"type": "string",
"default": "3000"
}
},
"required": [
"name",
"tcpAdresse",
"port"
]
}
}
},
"required": [
"zugangDav"
]
},
"inkarnationen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
]
}
},
"metaDaten": {
"type": "object",
"properties": {
"aenderungsGrund": {
"type": "string"
},
"erstelltAm": {
"type": "string"
},
"erstelltDurch": {
"type": "string"
},
"versionsNummer": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"global",
"inkarnationen"
]
}
Applikationen des Rechners abrufen ¶
GET/ststapi/v1/rechner/{rechnername}/applikationen
Example URI
- rechnername
string
(required) Example: rechner2der Name des Rechners.
200
Headers
Content-Type: application/json
Body
[
{
"inkarnation": {
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
},
"rechner": "localhost",
"letzteStartzeit": "24.12.2016 12:01",
"letzteInitialisierung": "24.12.2016 12:04",
"letzteStoppzeit": "06.12.2016 11:11",
"status": "installiert",
"startMeldung": "undefiniert"
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnation": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
],
"description": "die verwendete Inkarnation"
},
"rechner": {
"type": "string"
},
"letzteStartzeit": {
"type": "string",
"description": "die letzte Startzeit der Inkarnation"
},
"letzteInitialisierung": {
"type": "string",
"description": "die letzte Initialisierungszeit der Inkarnation"
},
"letzteStoppzeit": {
"type": "string",
"description": "die letzte Stoppzeit der Inkarnation"
},
"status": {
"type": "string",
"enum": [
"installiert",
"startenwarten",
"gestartet",
"initialisiert",
"stoppenwarten",
"gestoppt"
],
"description": "der Status der Inkarnation in StartStopp"
},
"startMeldung": {
"type": "string"
}
},
"required": [
"inkarnation",
"status",
"startMeldung"
]
}
}
Applikation eines Rechners abrufen ¶
GET/ststapi/v1/rechner/{rechnername}/applikationen/{inkarnationsname}
Example URI
- rechnername
string
(required) Example: rechner2der Name des Rechners.
- inkarnationsname
string
(required) Example: Parametrierungder Name der Inkarnation.
200
Headers
Content-Type: application/json
Body
[
{
"inkarnation": {
"inkarnationsName": "",
"inkarnationsTyp": "dav",
"initialize": false,
"mitInkarnationsName": true,
"applikation": "",
"aufrufParameter": [],
"startArt": {
"option": "automatisch",
"neuStart": true,
"intervall": ""
},
"startBedingung": {
"vorgaenger": [],
"warteart": "beginn",
"rechner": "",
"wartezeit": ""
},
"startFehlerVerhalten": {
"option": "beenden",
"wiederholungen": "0"
},
"stoppBedingung": {
"nachfolger": [],
"rechner": "",
"wartezeit": ""
},
"stoppFehlerVerhalten": {
"option": "stopp",
"wiederholungen": "0"
}
},
"rechner": "localhost",
"letzteStartzeit": "24.12.2016 12:01",
"letzteInitialisierung": "24.12.2016 12:04",
"letzteStoppzeit": "06.12.2016 11:11",
"status": "installiert",
"startMeldung": "undefiniert"
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"inkarnation": {
"type": "object",
"properties": {
"inkarnationsName": {
"type": "string"
},
"inkarnationsTyp": {
"type": "string",
"enum": [
"dav",
"wrapped",
"extern"
],
"default": "dav"
},
"initialize": {
"type": "boolean",
"default": false
},
"mitInkarnationsName": {
"type": "boolean",
"default": true
},
"applikation": {
"type": "string"
},
"aufrufParameter": {
"type": "array",
"items": {
"type": "string"
}
},
"startArt": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"automatisch",
"manuell",
"intervallrelativ",
"intervallabsolut"
]
},
"neuStart": {
"type": "boolean"
},
"intervall": {
"type": "string"
}
},
"required": [
"option"
]
},
"startBedingung": {
"type": "object",
"properties": {
"vorgaenger": {
"type": "array",
"items": {
"type": "string"
}
},
"warteart": {
"type": "string",
"enum": [
"beginn",
"ende"
]
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"vorgaenger"
]
},
"startFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"beenden",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
}
},
"stoppBedingung": {
"type": "object",
"properties": {
"nachfolger": {
"type": "array",
"items": {
"type": "string"
}
},
"rechner": {
"type": "string"
},
"wartezeit": {
"type": "string"
}
},
"required": [
"nachfolger"
]
},
"stoppFehlerVerhalten": {
"type": "object",
"properties": {
"option": {
"type": "string",
"enum": [
"stopp",
"abbruch",
"ignorieren"
]
},
"wiederholungen": {
"type": "string"
}
},
"required": [
"option"
]
}
},
"required": [
"inkarnationsName",
"inkarnationsTyp",
"applikation",
"startArt"
],
"description": "die verwendete Inkarnation"
},
"rechner": {
"type": "string"
},
"letzteStartzeit": {
"type": "string",
"description": "die letzte Startzeit der Inkarnation"
},
"letzteInitialisierung": {
"type": "string",
"description": "die letzte Initialisierungszeit der Inkarnation"
},
"letzteStoppzeit": {
"type": "string",
"description": "die letzte Stoppzeit der Inkarnation"
},
"status": {
"type": "string",
"enum": [
"installiert",
"startenwarten",
"gestartet",
"initialisiert",
"stoppenwarten",
"gestoppt"
],
"description": "der Status der Inkarnation in StartStopp"
},
"startMeldung": {
"type": "string"
}
},
"required": [
"inkarnation",
"status",
"startMeldung"
]
}
}