qgis_httprequest: QGIS algorithm - HTTP(S) POST/GET request

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - HTTP(S) POST/GET request

Description

QGIS Algorithm provided by QGIS (native c++) HTTP(S) POST/GET request (native:httprequest). Performs a HTTP(S) POST/GET request and returns the result code, error message and the data This algorithm performs a HTTP(S) POST/GET request and returns the HTTP status code and the reply data. If an error occurs then the error code and the message will be returned. Optionally, the result can be written to a file on disk. By default the algorithm will warn on errors. Optionally, the algorithm can be set to treat HTTP errors as failures.

Usage

qgis_httprequest(
  URL = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  DATA = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  AUTH_CONFIG = qgisprocess:::qgis_default_value(),
  FAIL_ON_ERROR = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

URL	string - URL. String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
METHOD	enum of ⁠("GET", "POST")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
DATA	string - POST data. String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
OUTPUT	fileDestination - File destination. Path for new file.
AUTH_CONFIG	authcfg - Authentication. An existing QGIS authentication ID string.
FAIL_ON_ERROR	boolean - Consider HTTP errors as failures. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
...	further parameters passed to qgisprocess::qgis_run_algorithm()
.complete_output	logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.
.quiet	logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.
.messages	logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

• ERROR_CODE - outputNumber - Network error code

• ERROR_MESSAGE - outputString - Network error message

• OUTPUT - outputFile - File destination

• RESULT_DATA - outputString - Reply data

• STATUS_CODE - outputNumber - HTTP status code

JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.