Pcml object - Revision history

Alexei.baranov: /* PCML Object */

2020-04-12T10:31:21Z

‎PCML Object

Alexei.baranov: /* i2Rest PCML Object */

2020-04-12T10:31:10Z

‎i2Rest PCML Object

Alexei.baranov: /* i2Rest PCML Object */

2020-04-12T08:35:48Z

‎i2Rest PCML Object

Alexei.baranov: /* i2Rest PCML Object */

2020-04-12T08:34:34Z

‎i2Rest PCML Object

Alexei.baranov: /* i2Rest PCML Object */

2020-04-12T08:33:13Z

‎i2Rest PCML Object

Alexei.baranov: /* i2Rest PCML Object */

2020-04-12T08:30:29Z

‎i2Rest PCML Object

Alexei.baranov at 08:30, 12 April 2020

2020-04-12T08:30:02Z

Alexei.baranov: Created page with "= i2Rest PCML Object = Use this object to define API for calling existing programs on your IBM i server. It is required to prepare formal description of program call paramet..."

2020-04-12T08:08:48Z

Created page with "= i2Rest PCML Object = Use this object to define API for calling existing programs on your IBM i server. It is required to prepare formal description of program call paramet..."

New page

= i2Rest PCML Object =

Use this object to define API for calling existing programs on your IBM i server.

It is required to prepare formal description of program call parameters to be able to use existing *PGM or *SRVPGM as a API servce. i2Rest Server uses slightly extended version of [https://www.ibm.com/support/knowledgecenter/en/ssw_ibm_i_74/rzahh/pcml.htm Program Call Markup Language (PCML)] as a basis of parameters documenting and processing.

PCML file can be created manually using any existing text editor, or generated automatically as part of CRTRPGMOD/CRTCBLMOD command (parameter PGMINFO). In any case, you have to put PCML file somewhere in IFS folder and include appropriate PCML object to the list of APIs that will be automatically loaded during i2Rest Server startup. As an option, you can publish PCML file to the running i2Rest Server instance using [[I2Rest_API#ADD_PCML|Add PCML API]].

← Older revision		Revision as of 10:31, 12 April 2020
Line 1:		Line 1:
−	~~= PCML Object =~~
−
	Use this object to define API for calling existing programs on your IBM i server.		Use this object to define API for calling existing programs on your IBM i server.

← Older revision		Revision as of 10:31, 12 April 2020
Line 1:		Line 1:
−	= ~~i2Rest~~ PCML Object =	+	= PCML Object =

	Use this object to define API for calling existing programs on your IBM i server.		Use this object to define API for calling existing programs on your IBM i server.

@@ Line 34: / Line 34: @@
 |style="padding: 5px"|boolean
 |style="padding: 5px"|'''Valid in anonymous calls?'''<br/>
-Specifies whether this PCML API is available to calls without OAuth2 authorization token
+Specifies whether this PCML API is available to calls without OAuth2 authorization token<br/><br/>
 |style="padding: 5px"|<tt>false</tt>
 |}

@@ Line 29: / Line 29: @@
 Example:
 <tt>"pcml_file":"/i2rest/Server1/echo.pcml"</tt><br/><br/>
+|
 |}

@@ Line 28: / Line 28: @@
 Path to file with PCML API definition. Path can be specified as absolute path or as path relative to [[I2Rest_Config#curdir|current directory]] of i2Rest Server instance. <br/><br/>
 Example:
-<tt>"pcml_file":"/i2rest/Server1/echo.pcml"</tt>
+<tt>"pcml_file":"/i2rest/Server1/echo.pcml"</tt><br/><br/>
+|
 |}

@@ Line 3: / Line 3: @@
 Use this object to define API for calling existing programs on your IBM i server.
-It is required to prepare formal description of program call parameters to be able to use existing *PGM or *SRVPGM as a API servce. i2Rest Server uses slightly extended version of [https://www.ibm.com/support/knowledgecenter/en/ssw_ibm_i_74/rzahh/pcml.htm Program Call Markup Language (PCML)] as a basis of parameters documenting and processing.
+It is required to prepare formal description of program call parameters to be able to use existing *PGM or *SRVPGM as a API servce. i2Rest Server uses slightly [[i2Rest PCML syntax|extended]] version of [https://www.ibm.com/support/knowledgecenter/en/ssw_ibm_i_74/rzahh/pcml.htm Program Call Markup Language (PCML)] as a basis of parameters documenting and processing.
 PCML file can be created manually using any existing text editor, or generated automatically as part of CRTRPGMOD/CRTCBLMOD command (parameter PGMINFO). In any case, you have to put PCML file somewhere in IFS folder and include appropriate PCML object to the list of APIs that will be automatically loaded during i2Rest Server startup. As an option, you can publish PCML file to the running i2Rest Server instance using [[I2Rest_API#ADD_PCML|Add PCML API]].

← Older revision		Revision as of 08:30, 12 April 2020
Line 6:		Line 6:

	PCML file can be created manually using any existing text editor, or generated automatically as part of CRTRPGMOD/CRTCBLMOD command (parameter PGMINFO). In any case, you have to put PCML file somewhere in IFS folder and include appropriate PCML object to the list of APIs that will be automatically loaded during i2Rest Server startup. As an option, you can publish PCML file to the running i2Rest Server instance using [[I2Rest_API#ADD_PCML\|Add PCML API]].		PCML file can be created manually using any existing text editor, or generated automatically as part of CRTRPGMOD/CRTCBLMOD command (parameter PGMINFO). In any case, you have to put PCML file somewhere in IFS folder and include appropriate PCML object to the list of APIs that will be automatically loaded during i2Rest Server startup. As an option, you can publish PCML file to the running i2Rest Server instance using [[I2Rest_API#ADD_PCML\|Add PCML API]].
		+
		+	PCML Object structure:
		+	{\| 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"\|pcml_mount
		+	\|style="padding: 5px"\|string
		+	\|style="padding: 5px"\|'''REUQIRED, PCML API mount point'''<br/>
		+	Defines PCML API mounting point. This parameter will be used as a part of URL where this PCML API will be accessible:<br/><br/>
		+	<tt>http[s]://<Main Gate>/<<b>Mount Point</b>>/<Program Name></tt><br/><br/>
		+	Example:<br/>
		+	<tt>"pcml_mount":"<b>echo</b>" -> <nowiki>https://i2rest.com/</nowiki><b>echo</b>/echo</tt><br/>
		+	\|
		+	\|-style="vertical-align:top;"
		+	\|style="padding: 5px"\|pcml_file
		+	\|style="padding: 5px"\|string
		+	\|style="padding: 5px"\|'''REUQIRED, path to PCML API definition file'''<br/>
		+	Path to file with PCML API definition. Path can be specified as absolute path or as path relative to [[I2Rest_Config#curdir\|current directory]] of i2Rest Server instance. <br/><br/>
		+	Example:
		+	<tt>"pcml_file":"/i2rest/Server1/echo.pcml"</tt>
		+
		+	\|
		+	\|}