Skip to content

Commit e8c415a

Browse files
author
Daniel Hochleitner
committed
plsql api readme changes
1 parent 3808901 commit e8c415a

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ openssl pkcs12 -export -in cert.pem -out ewallet.p12 -nokeys
209209
#### Compile PL/SQL package
210210

211211
- Change the global variables in the [package specification](https://github.com/Dani3lSun/apex-websocket-notify-bundle/blob/master/plsql/ws_notify_api.pks) under "Websocket REST Call defaults" to reflect your environment
212-
- **g_ws_rest_host:** Host/IP of Node Server
212+
- **g_ws_rest_host:** Hostname or IP of Node Server
213213
- **g_ws_rest_port:** Port of Node Server
214214
- **g_ws_rest_proto:** Protocol of Node Server (http or https) - if https, then "g_ssl_wallet_path" and "g_ssl_wallet_pwd" are required
215215
- **g_ws_basic_auth_user:** HTTP Basic Auth username of Node Server (REST-Interface)
@@ -286,9 +286,22 @@ curl -H "notify-title: Test Title Text" -H "notify-message: Test Message Text" "
286286

287287
### PL/SQL API
288288

289-
The PL/SQL API includes many procedures to send any kind of possible notifications over the REST-Interface.
289+
The PL/SQL API includes many procedures to send any kind of possible notifications over the REST-Interface. It can be used to send notifications to users via PL/SQL or inside of APEX. All web service requests are based on APEX package APEX_WEB_SERVICE.
290290

291-
Here is a list of all procedures with all parameters.
291+
**List of global package variables:**
292+
293+
- **g_ws_rest_host** - Node Notification Server Hostname or IP
294+
- **g_ws_rest_port** - Node Notification Server Port
295+
- **g_ws_rest_path** - Node Notification Server REST-Service Base Path
296+
- **g_ws_rest_proto** - Node Notification Server Protocol (http or https)
297+
- **g_ws_rest_base_url** - Combines Protocol, Host, Port and Path
298+
- **g_ws_basic_auth_user** - HTTP Basic Auth username of Node Server (REST-Interface)
299+
- **g_ws_basic_auth_pwd** - HTTP Basic Auth password of Node Server (REST-Interface)
300+
- **g_ssl_wallet_path** - If https, path to oracle wallet
301+
- **g_ssl_wallet_pwd** - If https, password of oracle wallet
302+
303+
304+
**List of all procedures with all parameters:**
292305

293306
**Procedure:** do_rest_notify_user
294307

@@ -301,6 +314,7 @@ Here is a list of all procedures with all parameters.
301314
- **i_title** (required)
302315
- **i_message** (required)
303316
- **i_optparam** (optional) - (Optional Parameter String)
317+
304318
----
305319

306320
**Procedure:** do_notify_user_private_info
@@ -312,6 +326,7 @@ Here is a list of all procedures with all parameters.
312326
- **i_title** (required)
313327
- **i_message** (required)
314328
- **i_optparam** (optional) - (Optional Parameter String)
329+
315330
----
316331

317332
**Procedure:** do_notify_user_private_success
@@ -323,6 +338,7 @@ Here is a list of all procedures with all parameters.
323338
- **i_title** (required)
324339
- **i_message** (required)
325340
- **i_optparam** (optional) - (Optional Parameter String)
341+
326342
----
327343

328344
**Procedure:** do_notify_user_private_warn
@@ -334,6 +350,7 @@ Here is a list of all procedures with all parameters.
334350
- **i_title** (required)
335351
- **i_message** (required)
336352
- **i_optparam** (optional) - (Optional Parameter String)
353+
337354
----
338355

339356
**Procedure:** do_notify_user_private_error
@@ -345,6 +362,7 @@ Here is a list of all procedures with all parameters.
345362
- **i_title** (required)
346363
- **i_message** (required)
347364
- **i_optparam** (optional) - (Optional Parameter String)
365+
348366
----
349367

350368
**Procedure:** do_notify_user_public_info
@@ -356,6 +374,7 @@ Here is a list of all procedures with all parameters.
356374
- **i_title** (required)
357375
- **i_message** (required)
358376
- **i_optparam** (optional) - (Optional Parameter String)
377+
359378
----
360379

361380
**Procedure:** do_notify_user_public_success
@@ -436,6 +455,8 @@ Here is a list of all procedures with all parameters.
436455
- **i_message** (required)
437456
- **i_optparam** (optional) - (Optional Parameter String)
438457

458+
----
459+
439460
### APEX
440461

441462

0 commit comments

Comments
 (0)