Skip to main content

Query Parameters (REST)

The plug-in RESTful service handlers upload, browse and delete uses query parameters accessible in PL/SQL code using bind variables. The plug-in default query parameters can be extended with a developer-specified:

Oracle REST documentation

Read about Oracle REST support for query parameters in the official documentation.

Options​

imageUploadParams​

The option imageUploadParams defines upload query parameters computed (only once) on a page load when the plug-in is initialized.

Initialiazation JavaScript Code
function( pOptions ) {
  //add a new parameter by extending the plug-in default parameters
  pOptions.imageUploadParams = $.extend( pOptions.imageUploadParams, {
    "parameterName": "parameterValue"
  });
    
  return pOptions;
}

As the result, when an image upload request is processed, the REST uplaod handler PL/SQL code can reference value parameterValue using PL/SQL bind variable :parameterName.

Dynamic upload parameters

The plug-in dynamic action Upload parameters allow computing upload query parameters before each image is uploaded.

imageManagerLoadParams​

The option imageManagerLoadParams defines browse query parameters computed (only once) on a page load when the plug-in is initialized. The query parameters are used to display uploaded images browser.

Initialiazation JavaScript Code
function( pOptions ) {
  // add custom query parameter "parameterName"
  pOptions.imageManagerLoadParams = $.extend( pOptions.imageManagerLoadParams, {
    "parameterName": "parameterValue"
  });
  
  return pOptions;
}

As the result, when an browse images request is processed, the REST browse handler PL/SQL code can reference value parameterValue using PL/SQL bind variable :parameterName.

Dynamic browse parameters

The plug-in dynamic action Image Browser Parameters allow computing upload query parameters before each image is uploaded.

imageManagerDeleteParams​

The option imageManagerDeleteParams defines delete request query parameters computed (only once) on a page load when the plug-in is initialized.

Initialiazation JavaScript Code
function( pOptions ) {
  // add custom query parameter "parameterName"
  pOptions.imageManagerDeleteParams = $.extend( pOptions.imageManagerDeleteParams, {
    "parameterName": "parameterValue"
  });
  
  return pOptions;
}

As the result, when an delete image request is processed, the REST delete handler PL/SQL code can reference value parameterValue using PL/SQL bind variable :parameterName.