Das Post Sessions Activities Message (postSessionsActivitiesMessage) API fügt einer Sitzung eine neue Nachricht hinzu.
Erforderliche Parameter
|
Pos |
Name |
I/O |
Typ |
|---|---|---|---|
|
1 |
API token |
Input |
char(256) |
|
2 |
Session ID |
Input |
decimal(7 0) |
|
3 |
Severity |
Input |
decimal(4) |
|
4 |
Message |
Input |
char(136) |
|
5 |
Long message |
Input |
char(1026) |
|
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
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 Nachricht hinzugefügt werden soll.
Severity
INPUT; DECIMAL(4)
Die Nachrichtenbewertung der neuen Nachricht.
Message
INPUT; CHAR(136)
Benutzerdefinierter Nachrichtentext der ersten Ebene, der hinzugefügt werden soll. Die Nachricht erscheint mit folgender Nachrichten ID
|
Nachricht ID |
Beschreibung |
|---|---|
|
IEF9600 |
<user defined message text> |
Long message
INPUT; CHAR(256)
Benutzerdefinierter Nachrichtentext der zweiten Ebene, der hinzugefügt werden soll. Die Nachricht erscheint mit folgender Nachrichten ID
|
Nachricht ID |
Beschreibung |
|---|---|
|
IEF9600 |
<user defined message text> |
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 eine Nachrichten für die Sitzung 28130 hinzugefügt.
returnCode = postSessionactivitiesMessage(token:
28130:
30:
'User defined short message text':
'Long eplanatory message text to be added to the seesion logbook':
errorDS);
See Sample programs