i-effect Manual
i-effect Manual
Breadcrumbs

getSessions (Sitzungsinformationen abrufen)

Das Get Sessions (getSessions) API liefert Informationen über eine spezielle Sitzung oder eine Gruppe von Sitzungen.

Erforderliche Parameter:

Pos

Name

I/O

Typ

1

API token

Input

char(256)

2

Session ID

Input

decimal(7 0)

3

Filter

Input

Char(*)

4

Sessions

Output

Char(*)

5

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 Informationen abgerufen werden sollen.

Filter

INPUT; ARRAY OF DATA STRUCTURE;

Eine Liste von Suchanfragen. Es werden bis zu 999 Elemente unterstützt. Die Struktur eines einzelnen Elements lautet wie folgt:

Offset

I/O

Typ

Beschreibung

Gültige Werte

Beispiel

0

Input

CHAR(52)

Filter field

sessionstart

sessionend

module

status

action

"sessionstart"

53

Input

CHAR(257)

Filter value


"03.12.2018 09:52:54"

311

Input

CHAR(2)

Filter comparison

eq - equal

ne - not equal

gt - greater

lt - less

ge - greater equal

le - less equal

ct - contains

"ge"

314

Input

CHAR(3)

Filter and/or

and

or

"and"


Wenn der Filter "ct" definiert ist, verwenden Sie folgende Sonderzeichen in Ihrem Filterwertfeld, um den Suchbegriff anzugeben


LIKE Operator

Beschreibung

 a%

Finds any values that start with "a"

%a

Finds any values that end with "a"

%or%

Finds any values that have "or" in any position

_r%

Finds any values that have "r" in the second position

a_%_%

Finds any values that start with "a" and are at least 3 characters in length

a%o

Finds any values that start with "a" and ends with "o"

Sessions

OUTPUT;  DATA STRUCTURE;

List der zurück gelieferten Sitzungsinformationen

Offset

I/O

Typ

Beschreibung

0

Output

DECIMAL(10)

Count of elemens

4

Output

ARRAY

Offset to list of session

Jede einzelne Sitzung enthält folgende Informationen

Offset

I/O

Typ

Beschreibung

0

Output

DECIMAL(7)

Session ID

4

Output

CHAR(14)

Status

19

Output

CHAR(14)

Module

33

Output

CHAR(14)

Action

47

Output

CHAR(28)

Session start

75

Output

CHAR(28)

Session end

103

Output

CHAR(12)

Duration

115

Output

CHAR(1026)

Command

1141

Output

CHAT(1026)

Server entry

2167

Output

CHAR(14)

Job description

2181

Output

CHAR(14)

Library

2195

Output

CHAR(4)

Task

2199

Output

CHAR(52)

Comment

Error code

I/O; CHAR(*)

Die Struktur in der Fehlerinformationen zurück geliefert werden.

Offset

I/O

Typ

Beschreibung

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

Code

Nachricht

Nachrihtenbeschreibung

Beispiel

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 '9999' 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 werden Informationen für die Sitzung 28130 angefordert. 

Java
returnCode = getSessions(token: 
                         28130:
                         arrayOfFilterDS:
                         arrayOfSessionDS:
                         errorDS);

Siehe Sample programs