/rpg/externalapi/index.htmlExternal APIs Procedures This chapter describes prcedures to complete an HTTP request to external API.Hugoen-usMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapi/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapi/index.htmlThis procedure completes an HTTP request with the specified HTTP method Parameter Type Description httpMethod 10A Mandatory Specifies the HTTP method to use. Valid values are GET, POST, PUT and DELETE. You can also use already prepared constant values from Aperio copy book: HTTP_METHOD_GET, HTTP_METHOD_POST, HTTP_METHOD_PUT and HTTP_METHOD_DELETE url 2048A VARYING Mandatory URL at which to complete the request. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. requestMsg 65535A VARYING Optional Specifies the data to update at the specified URL. This parameter is crucial for the POST and PUT methods - if it hasn’t been passed then the empty string request is sent. Procedure returns response message data structure (see data structure description bellow)./rpg/externalapi/extapidelete/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapidelete/index.htmlThis procedure deletes a resource from the specified URL through an HTTP DELETE request. Parameter Type Description url 2048A VARYING Mandatory URL at which to complete the request. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. Procedure returns response message data structure (see data structure description here)./rpg/externalapi/extapiget/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapiget/index.htmlThis procedure retrieves a resource from the specified URL through an HTTP GET request. Parameter Type Description url 2048A VARYING Mandatory URL at which to complete the request. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. Procedure returns response message data structure (see data structure description here)./rpg/externalapi/extapipost/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapipost/index.htmlThis procedure creates a resource under the specified URL through an HTTP POST request. Parameter Type Description url 2048A VARYING Mandatory URL at which to complete the request. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. requestMsg 65535A VARYING Optional Specifies the data to update at the specified URL. If it hasn’t been passed then the empty string request is sent. Procedure returns response message data structure (see data structure description here)./rpg/externalapi/extapiproxy/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapiproxy/index.htmlThis procedure completes an HTTP request with the specified HTTP method by forwarding the request to a service from External API services file. Parameter Type Description httpMethod 10A Mandatory Specifies the HTTP method to use. Valid values are GET, POST, PUT and DELETE. You can also use already prepared constant values from Aperio copy book: HTTP_METHOD_GET, HTTP_METHOD_POST, HTTP_METHOD_PUT and HTTP_METHOD_DELETE servicdId 30A Mandatory Specifies the service from External API services file to complete the request. destinationUrl 2048A VARYING Optional Represents the value which is concatenated with the url which stands behind given service id to create final url where request is sent. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. requestMsg 65535A VARYING Optional Specifies the data to update at the specified URL. This parameter is crucial for the POST and PUT methods - if it hasn’t been passed then the empty string request is sent. Procedure returns response message data structure (see data structure description here)./rpg/externalapi/extapiproxydelete/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapiproxydelete/index.htmlThis procedure deletes a resource from the specified URL through an HTTP DELETE request by forwarding the request to a service from External API services file. Parameter Type Description servicdId 30A Mandatory Specifies the service from External API services file to complete the request. destinationUrl 2048A VARYING Optional Represents the value which is concatenated with the url which stands behind given service id to create final url where request is sent. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. Procedure returns response message data structure (see data structure description here)./rpg/externalapi/extapiproxyget/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapiproxyget/index.htmlThis procedure retrieves a resource from the specified URL through an HTTP GET request by forwarding the request to a service from External API services file. Parameter Type Description servicdId 30A Mandatory Specifies the service from External API services file to complete the request. destinationUrl 2048A VARYING Optional Represents the value which is concatenated with the url which stands behind given service id to create final url where request is sent. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. Procedure returns response message data structure (see data structure description here)./rpg/externalapi/extapiproxypost/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapiproxypost/index.htmlThis procedure creates a resource under the specified URL through an HTTP POST request by forwarding the request to a service from External API services file. Parameter Type Description servicdId 30A Mandatory Specifies the service from External API services file to complete the request. destinationUrl 2048A VARYING Optional Represents the value which is concatenated with the url which stands behind given service id to create final url where request is sent. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. requestMsg 65535A VARYING Optional Specifies the data to update at the specified URL. This parameter is crucial for the POST and PUT methods - if it hasn’t been passed then the empty string request is sent. Procedure returns response message data structure (see data structure description here)./rpg/externalapi/extapiproxyput/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapiproxyput/index.htmlThis procedure updates a resource under the specified URL through an HTTP PUT request by forwarding the request to a service from External API services file. Parameter Type Description servicdId 30A Mandatory Specifies the service from External API services file to complete the request. destinationUrl 2048A VARYING Optional Represents the value which is concatenated with the url which stands behind given service id to create final url where request is sent. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. requestMsg 65535A VARYING Optional Specifies the data to update at the specified URL. This parameter is crucial for the POST and PUT methods - if it hasn’t been passed then the empty string request is sent. Procedure returns response message data structure (see data structure description here)./rpg/externalapi/extapiput/index.htmlMon, 01 Jan 0001 00:00:00 +0000/rpg/externalapi/extapiput/index.htmlThis procedure updates a resource under the specified URL through an HTTP PUT request. Parameter Type Description url 2048A VARYING Mandatory URL at which to complete the request. httpHeader 10240A VARYING Optional An optional header XML document. To use the default HTTP header, do not pass the parameter or specify the empty string. See Foundational HTTP functions at IBM Knowledge Center for a description of the header content. requestMsg 65535A VARYING Optional Specifies the data to update at the specified URL. If it hasn’t been passed then the empty string request is sent. Procedure returns response message data structure (see data structure description here).