Das Put Sessions Status (putSessionsStatus) API verändert den Status einer Sitzung und fügt optional zusätzliche Informationen zu einer Sitzung hinzu.
Erforderliche Parameter
|
Pos |
Name |
I/O |
Typ |
|---|---|---|---|
|
1 |
API token |
Input |
char(256) |
|
2 |
Session ID |
Input |
decimal(7 0) |
|
3 |
Status |
Input |
char(10) |
|
4 |
Message |
Input |
char(1024) |
|
5 |
Comment |
Input |
char(256) |
|
6 |
Error code |
I/O |
Char(*) |
Serviceprogramm
Um das API verwenden zu können, muss das folgenden Serviceprogramm eingebunden werden
|
Serviceprogramm |
Bibliothek |
Thread sicher |
|---|---|---|
|
SERVICEAPI |
IEFFECT |
yes |
Der Job, welcher dieses API verwendet, muss mit einer gültigen JOB CCSID ausgestattet sein. Die Job CCSID 65535 wird nicht unterstützt.
Berechtigungen und Sperren
Public API Berechtigung *USE
Parameter details
Parameterdetails
API token
INPUT; CHAR(256)
API-Token zur Authentifizierung auf dem Server. Der autorisierte Benutzer kann dieses Token mit i-effect WebControl generieren.. Siehe Generate API token
Session ID
INPUT; DECIMAL(7 0)
Die i-effect Logbuch Sitzungsnummer, zu der eine Statusänderung erfolgen soll.
Status
INPUT; CHAR(10)
Der neue Sitzungsstatus. Mögliche Werte sind:
|
Value |
Description |
|---|---|
|
OK |
i-effect processing was successfull |
|
ERROR |
i-effect processing finished abnormally |
|
DIAG |
i-effect processing ended with diagnostic messages |
|
WAIT |
i-effect is waiting for the update of the session status |
|
ACTIVE |
i-effect processing is active |
Message
INPUT; CHAR(1024)
Benutzerdefinierte Nachriczt, die Der Sitzung hinzugefügt werden soll. Die Nachricht erscheint im Nachrichtentext der zweiten Ebene zusammen mit folgender Nachrichten ID
|
Nachricht ID |
Beschreibung |
|---|---|
|
GZI9026 |
Session status was changed from user &1 from &2 to &3. |
Comment
INPUT; CHAR(256)
Benutzerdefinierter Kommentar
Kommentare zu einer i-effect Logbuchsitzung können nur in i-effect WebControl angezeigt und bearbeitet werden.
Error code
I/O; CHAR(*)
The structure in which to return error information:
|
Offset |
I/O |
Type |
Description |
|---|---|---|---|
|
0 |
Output |
CHAR(1024) |
Message ID |
|
1025 |
Output |
CHAR(1024) |
Message description |
|
2049 |
Output |
CHAR(1024) |
Stack trace |
Nachrichten
Jeder Aufruf dieser API gibt die folgenden Status- und Fehlermeldungen zurück
|
Message ID |
Description |
Sample Message description |
Sample Callstack |
|---|---|---|---|
|
200 |
The API call was successful |
|
|
|
400 |
The API Call returned an error |
Could not find the specified session '99999' in the database! |
com.menten.ieffect.rest.exceptions.SessionNotFoundException: Could not find the specified session '99999' in the database! at com.menten.ieffect.rest.controller.LogbookController.getSession(LogbookController.java:110) |
|
401 |
The API Authentification was unsuccessful |
Authentication failed. |
|
Beispiel
In diesem Beispiel eines API-Aufrufs in RPG-FREE wird der Status der Sitzung 28130 auf OK gesetzt und der Nachrichtentext der zweiten Ebene enthält eine benutzerdefinierte Nachricht.
returnCode = putSessionsStatus(token:
28130:
'OK':
'Short user defined message':
'Long explanatory text to be added to the comment':
errorDS);
See Sample programs