I2Rest API - Revision history

Alexei.baranov: /* run_program API parameters */

2021-04-12T15:24:11Z

‎run_program API parameters

2021-04-12T15:16:58Z

‎run_program API parameters

2020-07-09T11:34:32Z

2020-05-25T13:25:23Z

‎run_program API URL

2020-05-25T13:23:50Z

‎run_program API

2020-05-22T11:24:33Z

‎Management APIs

2020-05-22T11:22:02Z

‎OAuth2 APIs

2020-05-22T11:21:37Z

‎swagger

2020-05-22T08:25:47Z

‎run_program API

2020-05-22T08:23:31Z

@@ Line 63: / Line 63: @@
 |style="padding: 5px"|'''Serialize output parameters on the fly'''<br/>
 This parameter can improve i2Rest Server performance. By default, Server processes output PLIST and creates temporary JSON object in memory. After that, it serializes this JSON object and sends response to client. This PLIST pre-processing allows to analyze [[I2Rest_PCML_syntax#assert|assert]] conditions before sending response to client<br/>
-With <tt>"streamed_response":true,</tt> server starts sending service response immediately when it starts processing of output PLIST. This reduces the cost of preparing a response message and improves system performance. From other side, if assert condition will be met somewhere in between of output processing, the response will contain two parts - incomplete "output" object and "errors" object.
+With <tt>"streamed_response":true,</tt> server starts sending service response immediately when it starts processing of output PLIST. This reduces the cost of preparing a response message and improves system performance. From other side, if assert condition will be met somewhere in between of output processing, the response will contain two parts - incomplete "output" object and "errors" object.<br/>
 |style="padding: 5px"|<tt>false</tt>
 |-style="vertical-align:top;"

@@ Line 57: / Line 57: @@
 |style="padding: 5px"|'''Return job log in case of errors'''<br/>
 The same as previous, but job log messages will be returned only in case of errors. Still impact on performance, even when no error will occur
 |style="padding: 5px"|<tt>false</tt>
 |}

@@ Line 167: / Line 167: @@
+}
 </pre>
 == Management APIs ==
 [[Management_APIs|Management APIs]] includes functions that can be used to do some management stuff - change runtime parameters, query current status of server instance, etc. Here is a full list of all API provided:

@@ Line 16: / Line 16: @@
 * <tt>your_i2Rest_server</tt> - host name and optional port of i2Rest Server instance (defined in [[Gate_object|Main Gate Config]])
 * <tt>pcml_mount_point&nbsp;&nbsp;</tt> - [[I2Rest_API_Implementation#mount_point|mount name]] where PCML file is deployed
-* <tt>pcml_program_name&nbsp;</tt> - program name as defined in [[PCML file]]
+* <tt>pcml_program_name&nbsp;</tt> - program name as defined in [[I2Rest_PCML_syntax|PCML file]]
 example:

@@ Line 15: / Line 15: @@
 where:
 * <tt>your_i2Rest_server</tt> - host name and optional port of i2Rest Server instance (defined in [[Gate_object|Main Gate Config]])
-* <tt>pcml_mount_point&nbsp;&nbsp;</tt> - [[Deploy PCML|mount name]] where PCML file is deployed
+* <tt>pcml_mount_point&nbsp;&nbsp;</tt> - [[I2Rest_API_Implementation#mount_point|mount name]] where PCML file is deployed
 * <tt>pcml_program_name&nbsp;</tt> - program name as defined in [[PCML file]]

@@ Line 177: / Line 177: @@
 [[Management_APIs|Management APIs]] includes functions that can be used to do some management stuff - change runtime parameters, query current status of server instance, etc. Here is a full list of all API provided:
 * <tt>[[Management_APIs#STATUS API|STATUS API]]</tt>
-* <tt>[[Management_APIs#GET_SWAGGER API|GET_SWAGGER API]]</tt>
+* <tt>[[Management_APIs#GET_OPENAPI30 API|GET_OPENAPI30 API]]</tt>
 * <tt>[[Management_APIs#DEBUG API|DEBUG API]]</tt>
 * <tt>[[Management_APIs#PCMLS API|PCMLS API]]</tt>

@@ Line 168: / Line 168: @@
 </pre>
-== OAuth2 APIs ==
+== OAuth2 and OpenAPI APIs ==
 TODO
 === openapi30 ===

@@ Line 170: / Line 170: @@
 == OAuth2 APIs ==
 TODO
-=== swagger ===
+=== openapi30 ===
 === scope ===

@@ Line 5: / Line 5: @@
 == run_program API ==
-This API allows you to call IBM i programs as Json REST web service. To call IBM i program, you must prepare file describing program parameters in [[i2Rest Server PCML|PCML format]], and publish this description to i2Rest Server.
+This API allows you to call IBM i programs as Json REST web service. To call IBM i program, you must prepare file describing program parameters in [[I2Rest_PCML_syntax|PCML format]], and publish this description to i2Rest Server.
 It is required to obtain OAuth2 token with run_program scope to call IBM i programs. Token is not required on calls to programs which has "valid_in_anonymous":true flag in PCML.

← Older revision		Revision as of 08:23, 22 May 2020
Line 1:		Line 1:
	{{DISPLAYTITLE:i2Rest API}}		{{DISPLAYTITLE:i2Rest API}}
−	~~= i2Rest API =~~
−
	i2Rest Server provides a set of web services to call IBM i programs and commands, as well as APIs to manage i2Rest Server instance.		i2Rest Server provides a set of web services to call IBM i programs and commands, as well as APIs to manage i2Rest Server instance.