Session system object - Revision history

Alexei.baranov at 11:31, 17 June 2020

2020-06-17T11:31:43Z

Pavel.lobko at 10:53, 5 June 2020

2020-06-05T10:53:20Z

Pavel.lobko at 10:52, 5 June 2020

2020-06-05T10:52:55Z

Alexei.baranov at 14:48, 25 May 2020

2020-05-25T14:48:32Z

Alexei.baranov at 13:32, 25 May 2020

2020-05-25T13:32:58Z

Pavel.lobko at 09:23, 18 May 2020

2020-05-18T09:23:24Z

Pavel.lobko at 09:22, 18 May 2020

2020-05-18T09:22:07Z

Alexei.baranov: Created page with "= Session System Object = Object representing session system settings Do not forget to define system_* scope for Ses..."

2020-04-02T15:59:17Z

Created page with "= Session System Object = Object representing session system settings Do not forget to define system_* scope for Ses..."

New page

= Session System Object =

Object representing [[i2Rest Gates#session_system|session system]] settings

Do not forget to define system_* [[OAuth2 object#scopes|scope]] for Session Systems with names other than *ANONYMOUS and *LOCAL

{| style="width: 100%; vertical-align:top; border-collapse:collapse" border="1"
| style="width: 10%; padding: 5px"|'''Field'''
| style="width: 10%; padding: 5px"|'''Type'''
| style="width: 40%; padding: 5px"|'''Description'''
| style="width: 40%; padding: 5px"|'''Default value'''
|-style="vertical-align:top;"
|style="padding: 5px"|name
|style="padding: 5px"|string
|style="padding: 5px"|'''REQUIRED, Name of the system'''
Name to be used as an identity for this session system. To call APIs with this system settings, clients will have to obtain authority with special [[i2Rest scopes|scope]] <tt>system_<nowiki><system_name></nowiki></tt>. This scope is not required when calling for APIs on systems with special names:<br/>
{|
|-style="vertical-align:top;"
|style="padding: 5px"|<tt>*LOCAL</tt>
|corresponds to this IBM i server
|-style="vertical-align:top;"
|style="padding: 5px"|<tt>*ANONYMOUS</tt>
|for that API which is allowed to call without user/client authorization
|}
|-style="vertical-align:top;"
|style="padding: 5px"|submit
|style="padding: 5px"|string
|style="padding: 5px"|<div id="submit_string"></div>'''REQUIRED, Command to submit session'''
Specifies command to be used on submitting job which will process client's requests. Typically, it would be one of: SBMJOB or SBMRMTCMD. But i2Rest does not limit to use external non-IBMi systems which will act as session processor.<br/>
To be more flexible in terms of defining submitted job characteristics, i2Rest will substitute following substrings with appropriate values:<br/>
{|
|-style="vertical-align:top;"
|style="padding: 5px"|<tt>${uid}</tt>
|style="padding: 5px"|session ID (value of OAuth2 access token or automatically generated ID of anonymous session)
|-style="vertical-align:top;"
|style="padding: 5px"|<tt>${surl}</tt>
|session gate URL
|-style="vertical-align:top;"
|style="padding: 5px"|<tt>${user}</tt>
|style="padding: 5px"|user ID
|-style="vertical-align:top;"
|style="padding: 5px"|<tt>${token}</tt>
|style="padding: 5px"|OAuth2 token value
|-style="vertical-align:top;"
|style="padding: 5px"|<tt>${anonymous}</tt>
|style="padding: 5px"|Y for anonymous sessions, N for others
|}
Examples:
<pre>
SBMJOB JOB(I2RESTS) USER(${user})
CMD(CALL I2REST PARM(
'-session'
'-url' '${surl}'
'-uid' '${uid}'
'-user' '${user}'
'-init' 'ADDLIBLE MYLIB'))
INLLIBL(LIBX LIBY)

SBMRMTCMD DDMFILE(QGPL/RMTSYS)
CMD('SBMJOB CMD(CALL I2REST PARM(''-session''
''-url'' ''${surl}''
''-uid'' ''${uid}''))')
</pre>
See also [[i2Rest -session]]
|
|-style="vertical-align:top;"
|style="padding: 5px"|non_ibmi
|style="padding: 5px"|boolean
|style="padding: 5px"|'''Non-IBMi system?'''
For IBMi systems, you have to prepare special "submit" command and session processor program. Submit command should be able to start session processor task on remote non-IBMi system.<br/><br/>
Please [[contact i2Rest support]] for additional information
|style="padding: 5px"|<tt>false</tt>
|}

← Older revision		Revision as of 13:32, 25 May 2020
Line 1:		Line 1:
−	= Session System Object =	+	{{DISPLAYTITLE:Session System Object}}
−
	Object representing [[i2Rest Gates#session_system\|session system]] settings		Object representing [[i2Rest Gates#session_system\|session system]] settings

@@ Line 45: / Line 45: @@
 |style="padding: 5px"|<tt>${anonymous}</tt>
 |style="padding: 5px"|Y for anonymous sessions, N for others
 |}
 Examples:
@@ Line 54: / Line 57: @@
               '-uid' '${uid}'
               '-user' '${user}'
               '-init' 'ADDLIBLE MYLIB'))
         INLLIBL(LIBX LIBY)

@@ Line 14: / Line 14: @@
 |style="padding: 5px"|'''REQUIRED, Name of the system'''
 Name to be used as an identity for this session system. To call APIs with this system settings, clients will have to obtain authority with special [[i2Rest scopes|scope]] <tt>system_<nowiki><system_name></nowiki></tt>. This scope is not required when calling for APIs on systems with special names:<br/>
-|}
 {|
 |-style="vertical-align:top;"

@@ Line 67: / Line 67: @@
 |style="padding: 5px"|boolean
 |style="padding: 5px"|'''Non-IBMi system?'''
-For IBMi systems, you have to prepare special "submit" command and session processor program. Submit command should be able to start session processor task on remote non-IBMi system.<br/><br/>
+For IBMi systems, you have to prepare special "submit" command and session processing program. Submit command should be able to start session processor task on remote non-IBMi system.<br/><br/>
-Please [[contact i2Rest support]] for additional information
+Please [mailto:contacts@i2rest.com contact us] for additional information
 |style="padding: 5px"|<tt>false</tt>
 |}