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.

Management APIs includes functions that can be used to do some management stuff - change runtime parameters, query current status of server instance, etc. Management APIs are available at Management Gate endpoint, for clients who have OAuth2 tokens with management_functions scope.

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 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.

run_program API URL

API run_program is available on Main Gate endpoint. The URL for run_program API of specific program is as follows:

http[s]://<your_i2Rest_server>/run_program/<pcml_mount_point>/<pcml_program_name>

where:

• your_i2Rest_server - host name and optional port of i2Rest Server instance (defined in Main Gate Config)
• pcml_mount_point   - mount name where PCML file is deployed
• pcml_program_name  - program name as defined in PCML file

example:

https://i2rest.com/run_program/echo/echo

run_program API parameters

To call run_program API, you must send POST request with following JSON object as request body (media type 'application/json'):

Field	Type	Description	Default value
input	object	Input parameters object The structure of input parameters depends on the program call definition described in appropriate PCML document
tracein	boolean	Trace input parameters Boolean flag to specify the requirement to print input parameters in job log. If true, all input parameters will be printed in session job log before performing call to program	false
traceout	boolean	Trace output parameters Boolean flag to specify the requirement to print output parameters in job log. If true, all output parameters will be printed in session job log after call to program	false
joblog	boolean	Return job log Specifies whether to return session job log together with output parameters. If true, array with job log messages will be added to return parameters. Job log will contain messages arrived only during this program call. Use this flag only for debugging purposes. Producing of responses with job log can impact on performance	false
joblog_on_error	boolean	Return job log in case of errors 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	false

run_program example

Request:

POST https://i2rest.com:22088/run_program/echo/echo/

{
      "input": {"echo": "0"},
      "tracein": true,
      "joblog": true,
      "traceout": true
}

response:

{
  "output": {
    "echo": "0"
  },
  "joblog": [
    "Input:",
    "echo (10):",
    "000000 :0               :F0 00 00 00 00 00 00 00   00 00",
    "Output:",
    "echo (10):",
    "000000 :0               :F0 00 00 00 00 00 00 00   00 00"
  ],
  "job": "030075/USRX/I2RESTA"
}

run_command API

This API allows you to call IBM i commands.

It is required to obtain OAuth2 token with run_command scope to call IBM i programs.

run_command API URL

API run_command is available on Main Gate endpoint. The URL for run_command API is as follows:

http[s]://<your_i2Rest_server>/run_command

where:

• your_i2Rest_server - host name and optional port of i2Rest Server instance (defined in Main Gate Config)

example:

https://i2rest.com/run_command

run_program API parameters

To call run_program API, you must send POST request with following JSON object as request body (media type 'application/json'):

Field	Type	Description	Default value
input	object	Input parameters object The structure of input parameters depends on the program call definition described in appropriate PCML document
tracein	boolean	Trace input parameters Boolean flag to specify the requirement to print input parameters in job log. If true, all input parameters will be printed in session job log before performing call to program	false
traceout	boolean	Trace output parameters Boolean flag to specify the requirement to print output parameters in job log. If true, all output parameters will be printed in session job log after call to program	false
joblog	boolean	Return job log Specifies whether to return session job log together with output parameters. If true, array with job log messages will be added to return parameters. Job log will contain messages arrived only during this program call. Use this flag only for debugging purposes. Producing of responses with job log can impact on performance	false
joblog_on_error	boolean	Return job log in case of errors 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	false

run_program example

Request:

POST https://i2rest.com/run_program/echo/echo/

{
      "input": {"echo": "0"},
      "tracein": true,
      "joblog": true,
      "traceout": true
}

response:

{
  "output": {
    "echo": "0"
  },
  "joblog": [
    "Input:",
    "echo (10):",
    "000000 :0               :F0 00 00 00 00 00 00 00   00 00",
    "Output:",
    "echo (10):",
    "000000 :0               :F0 00 00 00 00 00 00 00   00 00"
  ],
  "job": "030075/USRX/I2RESTA"
}