1/721

Contents

Expand All · Collapse All

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Changes in This Release

• Changes in Oracle Application Express Release 18.2
  • New Features
  • Deprecated and Desupported Features
• Changes in Oracle Application Express Release 18.1
  • New Features
  • Deprecated and Desupported Features

1 APEX_APPLICATION

• 1.1 Global Variables
• 1.2 Referencing Arrays
• 1.3 Referencing Values Within an On Submit Process
• 1.4 Converting an Array to a Single Value
• 1.5 HELP Procedure
• 1.6 STOP_APEX_ENGINE Procedure

2 APEX_ACL

• 2.1 ADD_USER_ROLE Procedure Signature 1
• 2.2 ADD_USER_ROLE Procedure Signature 2
• 2.3 HAS_USER_ANY_ROLES Function
• 2.4 HAS_USER_ROLE Function
• 2.5 REMOVE_USER_ROLE Procedure Signature 1
• 2.6 REMOVE_USER_ROLE Procedure Signature 2
• 2.7 REPLACE_USER_ROLES Procedure Signature 1
• 2.8 REPLACE_USER_ROLES Procedure Signature 2
• 2.9 REMOVE_ALL_USER_ROLES Procedure

3 APEX_APPLICATION_INSTALL

• 3.1 Package Overview
• 3.2 Attributes Manipulated by APEX_APPLICATION_INSTALL
• 3.3 Import Script Examples
• 3.4 CLEAR_ALL Procedure
• 3.5 GENERATE_APPLICATION_ID Procedure
• 3.6 GENERATE_OFFSET Procedure
• 3.7 GET_APPLICATION_ALIAS Function
• 3.8 GET_APPLICATION_ID Function
• 3.9 GET_APPLICATION_NAME Function
• 3.10 GET_AUTO_INSTALL_SUP_OBJ Function
• 3.11 GET_IMAGE_PREFIX Function
• 3.12 GET_KEEP_SESSIONS Function
• 3.13 GET_NO_PROXY_DOMAINS Function
• 3.14 GET_OFFSET Function
• 3.15 GET_PROXY Function
• 3.16 GET_REMOTE_SERVER_BASE_URL Function
• 3.17 GET_REMOTE_SERVER_HTTPS_HOST Function
• 3.18 GET_SCHEMA Function
• 3.19 GET_WORKSPACE_ID Function
• 3.20 SET_APPLICATION_ALIAS Procedure
• 3.21 SET_APPLICATION_ID Procedure
• 3.22 SET_APPLICATION_NAME Procedure
• 3.23 SET_AUTO_INSTALL_SUP_OBJ Procedure
• 3.24 SET_IMAGE_PREFIX Procedure
• 3.25 SET_KEEP_SESSIONS Procedure
• 3.26 SET_OFFSET Procedure
• 3.27 SET_PROXY Procedure
• 3.28 SET_REMOTE_SERVER Procedure
• 3.29 SET_SCHEMA Procedure
• 3.30 SET_WORKSPACE_ID Procedure
• 3.31 SET_WORKSPACE_Procedure

4 APEX_AUTHENTICATION

• 4.1 Constants
• 4.2 CALLBACK Procedure
• 4.3 GET_CALLBACK_URL Function
• 4.4 GET_LOGIN_USERNAME_COOKIE Function
• 4.5 IS_AUTHENTICATED Function
• 4.6 IS_PUBLIC_USER Function
• 4.7 LOGIN Procedure
• 4.8 LOGOUT Procedure
• 4.9 POST_LOGIN Procedure
• 4.10 SEND_LOGIN_USERNAME_COOKIE Procedure

5 APEX_AUTHORIZATION

• 5.1 ENABLE_DYNAMIC_GROUPS Procedure
• 5.2 IS_AUTHORIZED Function
• 5.3 RESET_CACHE Procedure

6 APEX_APP_SETTING

• 6.1 SET_VALUE Procedure
• 6.2 GET_VALUE Function

7 APEX_COLLECTION

• 7.1 About the APEX_COLLECTION API
• 7.2 Naming Collections
• 7.3 Creating a Collection
• 7.4 About the Parameter p_generate_md5
• 7.5 Accessing a Collection
• 7.6 Merging Collections
• 7.7 Truncating a Collection
• 7.8 Deleting a Collection
• 7.9 Deleting All Collections for the Current Application
• 7.10 Deleting All Collections in the Current Session
• 7.11 Adding Members to a Collection
• 7.12 About the Parameters p_generate_md5, p_clob001, p_blob001, and p_xmltype001
• 7.13 Updating Collection Members
• 7.14 Deleting Collection Members
• 7.15 Obtaining a Member Count
• 7.16 Resequencing a Collection
• 7.17 Verifying Whether a Collection Exists
• 7.18 Adjusting a Member Sequence ID
• 7.19 Sorting Collection Members
• 7.20 Clearing Collection Session State
• 7.21 Determining Collection Status
• 7.22 ADD_MEMBER Procedure
• 7.23 ADD_MEMBER Function
• 7.24 ADD_MEMBERS Procedure
• 7.25 COLLECTION_EXISTS Function
• 7.26 COLLECTION_HAS_CHANGED Function
• 7.27 COLLECTION_MEMBER_COUNT Function
• 7.28 CREATE_COLLECTION Procedure
• 7.29 CREATE_OR_TRUNCATE_COLLECTION Procedure
• 7.30 CREATE_COLLECTION_FROM_QUERY Procedure
• 7.31 CREATE_COLLECTION_FROM_QUERY2 Procedure
• 7.32 CREATE_COLLECTION_FROM_QUERY_B Procedure
• 7.33 CREATE_COLLECTION_FROM_QUERY_B Procedure (No bind version)
• 7.34 CREATE_COLLECTION_FROM_QUERYB2 Procedure
• 7.35 CREATE_COLLECTION_FROM_QUERYB2 Procedure (No bind version)
• 7.36 DELETE_ALL_COLLECTIONS Procedure
• 7.37 DELETE_ALL_COLLECTIONS_SESSION Procedure
• 7.38 DELETE_COLLECTION Procedure
• 7.39 DELETE_MEMBER Procedure
• 7.40 DELETE_MEMBERS Procedure
• 7.41 GET_MEMBER_MD5 Function
• 7.42 MERGE_MEMBERS Procedure
• 7.43 MOVE_MEMBER_DOWN Procedure
• 7.44 MOVE_MEMBER_UP Procedure
• 7.45 RESEQUENCE_COLLECTION Procedure
• 7.46 RESET_COLLECTION_CHANGED Procedure
• 7.47 RESET_COLLECTION_CHANGED_ALL Procedure
• 7.48 SORT_MEMBERS Procedure
• 7.49 TRUNCATE_COLLECTION Procedure
• 7.50 UPDATE_MEMBER Procedure
• 7.51 UPDATE_MEMBERS Procedure
• 7.52 UPDATE_MEMBER_ATTRIBUTE Procedure Signature 1
• 7.53 UPDATE_MEMBER_ATTRIBUTE Procedure Signature 2
• 7.54 UPDATE_MEMBER_ATTRIBUTE Procedure Signature 3
• 7.55 UPDATE_MEMBER_ATTRIBUTE Procedure Signature 4
• 7.56 UPDATE_MEMBER_ATTRIBUTE Procedure Signature 5
• 7.57 UPDATE_MEMBER_ATTRIBUTE Procedure Signature 6

8 APEX_CREDENTIAL

• 8.1 CLEAR_TOKENS Procedure
• 8.2 SET_PERSISTENT_CREDETIALS Procedure Signature 1
• 8.3 SET_PERSISTENT_CREDETIALS Procedure Signature 2
• 8.4 SET_PERSISTENT_TOKEN Procedure
• 8.5 SET_SESSION_CREDENTIALS Procedure Signature1
• 8.6 SET_SESSION_CREDENTIALS Procedure Signature2
• 8.7 SET_SESSION_TOKEN Procedure

9 APEX_CSS

• 9.1 ADD Procedure
• 9.2 ADD_3RD_PARTY_LIBRARY_FILE Procedure
• 9.3 ADD_FILE Procedure

10 APEX_CUSTOM_AUTH

• 10.1 APPLICATION_PAGE_ITEM_EXISTS Function
• 10.2 CURRENT_PAGE_IS_PUBLIC Function
• 10.3 DEFINE_USER_SESSION Procedure
• 10.4 GET_COOKIE_PROPS Procedure
• 10.5 GET_LDAP_PROPS Procedure
• 10.6 GET_NEXT_SESSION_ID Function
• 10.7 GET_SECURITY_GROUP_ID Function
• 10.8 GET_SESSION_ID Function
• 10.9 GET_SESSION_ID_FROM_COOKIE Function
• 10.10 GET_USER Function
• 10.11 GET_USERNAME Function
• 10.12 IS_SESSION_VALID Function
• 10.13 LOGIN Procedure
• 10.14 LOGOUT Procedure [DEPRECATED]
• 10.15 POST_LOGIN Procedure
• 10.16 SESSION_ID_EXISTS Function
• 10.17 SET_SESSION_ID Procedure
• 10.18 SET_SESSION_ID_TO_NEXT_VALUE Procedure
• 10.19 SET_USER Procedure

11 APEX_DEBUG

• 11.1 Constants
• 11.2 DISABLE Procedure
• 11.3 DISABLE_DBMS_OUTPUT Procedure
• 11.4 ENABLE Procedure
• 11.5 ENTER Procedure
• 11.6 ENABLE_DBMS_OUTPUT Procedure
• 11.7 ERROR Procedure
• 11.8 INFO Procedure
• 11.9 LOG_DBMS_OUTPUT Procedure
• 11.10 LOG_LONG_MESSAGE Procedure
• 11.11 LOG_MESSAGE Procedure [Deprecated]
• 11.12 LOG_PAGE_SESSION_STATE Procedure
• 11.13 MESSAGE Procedure
• 11.14 REMOVE_DEBUG_BY_AGE Procedure
• 11.15 REMOVE_DEBUG_BY_APP Procedure
• 11.16 REMOVE_DEBUG_BY_VIEW Procedure
• 11.17 REMOVE_SESSION_MESSAGES Procedure
• 11.18 TOCHAR Function
• 11.19 TRACE Procedure
• 11.20 WARN Procedure

12 APEX_ESCAPE

• 12.1 Constants
• 12.2 HTML Function
• 12.3 HTML_ATTRIBUTE Function
• 12.4 HTML_TRUNC Function
• 12.5 HTML_WHITELIST Function
• 12.6 JS_LITERAL Function
• 12.7 JSON Function
• 12.8 LDAP_DN Function
• 12.9 LDAP_SEARCH_FILTER Function
• 12.10 NOOP Function
• 12.11 REGEXP Function
• 12.12 SET_HTML_ESCAPING_MODE Procedure

13 APEX_ERROR

• 13.1 Constants and Attributes used for Result Types
• 13.2 Example of an Error Handling Function
• 13.3 ADD_ERROR Procedure Signature 1
• 13.4 ADD_ERROR Procedure Signature 2
• 13.5 ADD_ERROR Procedure Signature 3
• 13.6 ADD_ERROR Procedure Signature 4
• 13.7 ADD_ERROR Procedure Signature 5
• 13.8 APEX_ERROR.HAVE_ERRORS_OCCURRED Function
• 13.9 AUTO_SET_ASSOCIATED_ITEM Procedure
• 13.10 EXTRACT_CONSTRAINT_NAME Function
• 13.11 GET_FIRST_ORA_ERROR_TEXT Function
• 13.12 INIT_ERROR_RESULT Function

14 APEX_EXEC

• 14.1 Global Constants
• 14.2 Data Types
• 14.3 ADD_COLUMN Procedure
• 14.4 ADD_FILTER Procedure
• 14.5 ADD_ORDER_BY Procedure
• 14.6 ADD_PARAMETER Procedure
• 14.7 CLOSE Procedure
• 14.8 EXECUTE_PLSQL Procedure
• 14.9 EXECUTE_REMOTE_PLSQL Procedure
• 14.10 EXECUTE_WEB_SOURCE Procedure
• 14.11 GET Functions
• 14.12 GET_COLUMN Function
• 14.13 GET_COLUMN_COUNT Function
• 14.14 GET_COLUMN_POSITION Function
• 14.15 GET_PARAMETER Functions
• 14.16 GET_TOTAL_ROW_COUNT Function
• 14.17 IS_REMOTE_SQL_AUTH_VALID Function
• 14.18 NEXT_ROW Function
• 14.19 OPEN_REMOTE_SQL_QUERY Function
• 14.20 OPEN_QUERY_CONTEXT Function
• 14.21 OPEN_WEB_SOURCE_QUERY Function
• 14.22 PURGE_WEB_SOURCE _CACHE Procedure

15 APEX_EXPORT

• 15.1 GET_APPLICATION Function
• 15.2 GET_WORKSPACE _FILES Function
• 15.3 GET_FEEDBACK Function
• 15.4 GET_WORKSPACE Function

16 APEX_INSTANCE_ADMIN

• 16.1 Available Parameter Values
• 16.2 ADD_SCHEMA Procedure
• 16.3 ADD_WORKSPACE Procedure
• 16.4 CREATE_SCHEMA_EXCEPTION Procedure
• 16.5 FREE_WORKSPACE_APP_IDS Procedure
• 16.6 GET_PARAMETER Function
• 16.7 GET_SCHEMAS Function
• 16.8 GET_WORKSPACE_PARAMETER
• 16.9 REMOVE_APPLICATION Procedure
• 16.10 REMOVE_SAVED_REPORT Procedure
• 16.11 REMOVE_SAVED_REPORTS Procedure
• 16.12 REMOVE_SCHEMA Procedure
• 16.13 REMOVE_SCHEMA_EXCEPTION Procedure
• 16.14 REMOVE_SCHEMA_EXCEPTIONS Procedure
• 16.15 REMOVE_SUBSCRIPTION Procedure
• 16.16 REMOVE_WORKSPACE Procedure
• 16.17 REMOVE_WORKSPACE_EXCEPTIONS Procedure
• 16.18 RESERVE_WORKSPACE_APP_IDS Procedure
• 16.19 RESTRICT_SCHEMA Procedure
• 16.20 SET_LOG_SWITCH_INTERVAL Procedure
• 16.21 SET_WORKSPACE_PARAMETER
• 16.22 SET_PARAMETER Procedure
• 16.23 SET_WORKSPACE_CONSUMER_GROUP Procedure
• 16.24 TRUNCATE_LOG Procedure
• 16.25 UNRESTRICT_SCHEMA Procedure

17 APEX_IR

• 17.1 ADD_FILTER Procedure Signature 1
• 17.2 ADD_FILTER Procedure Signature 2
• 17.3 CHANGE_SUBSCRIPTION_EMAIL Procedure
• 17.4 CHANGE_REPORT_OWNER Procedure
• 17.5 CHANGE_SUBSCRIPTION_EMAIL Procedure
• 17.6 CHANGE_SUBSCRIPTION_LANG Procedure
• 17.7 CLEAR_REPORT Procedure Signature 1
• 17.8 CLEAR_REPORT Procedure Signature 2
• 17.9 DELETE_REPORT Procedure
• 17.10 DELETE_SUBSCRIPTION Procedure
• 17.11 GET_LAST_VIEWED_REPORT_ID Function
• 17.12 GET_REPORT Function
• 17.13 RESET_REPORT Procedure Signature 1
• 17.14 RESET_REPORT Procedure Signature 2

18 APEX_ITEM

• 18.1 CHECKBOX2 Function
• 18.2 DATE_POPUP Function
• 18.3 DATE_POPUP2 Function
• 18.4 DISPLAY_AND_SAVE Function
• 18.5 HIDDEN Function
• 18.6 MD5_CHECKSUM Function
• 18.7 MD5_HIDDEN Function
• 18.8 POPUP_FROM_LOV Function
• 18.9 POPUP_FROM_QUERY Function
• 18.10 POPUPKEY_FROM_LOV Function
• 18.11 POPUPKEY_FROM_QUERY Function
• 18.12 RADIOGROUP Function
• 18.13 SELECT_LIST Function
• 18.14 SELECT_LIST_FROM_LOV Function
• 18.15 SELECT_LIST_FROM_LOV_XL Function
• 18.16 SELECT_LIST_FROM_QUERY Function
• 18.17 SELECT_LIST_FROM_QUERY_XL Function
• 18.18 SWITCH Function
• 18.19 TEXT Function
• 18.20 TEXTAREA Function
• 18.21 TEXT_FROM_LOV Function
• 18.22 TEXT_FROM_LOV_QUERY Function

19 APEX_JAVASCRIPT

• 19.1 ADD_3RD_PARTY_LIBRARY_FILE Procedure
• 19.2 ADD_ATTRIBUTE Function Signature 1
• 19.3 ADD_ATTRIBUTE Function Signature 2
• 19.4 ADD_ATTRIBUTE Function Signature 3
• 19.5 ADD_ATTRIBUTE Function Signature 4
• 19.6 ADD_INLINE_CODE Procedure
• 19.7 ADD_LIBRARY Procedure
• 19.8 ADD_REQUIREJS Procedure
• 19.9 ADD_REQUIREJS_DEFINE Procedure
• 19.10 ADD_ONLOAD_CODE Procedure
• 19.11 ADD_VALUE Function Signature 1
• 19.12 ADD_VALUE Function Signature 2
• 19.13 ADD_VALUE Function Signature 3
• 19.14 ADD_VALUE Function Signature 4
• 19.15 Escape Function

20 APEX_JSON

• 20.1 Package Overview and Examples
• 20.2 Constants and Data Types
• 20.3 CLOSE_ALL Procedure
• 20.4 CLOSE_ARRAY Procedure
• 20.5 CLOSE_OBJECT Procedure
• 20.6 DOES_EXIST Function
• 20.7 FIND_PATHS_LIKE Function
• 20.8 FREE_OUTPUT Procedure
• 20.9 FLUSH Procedure
• 20.10 GET_BOOLEAN Function
• 20.11 GET_CLOB_OUTPUT Function
• 20.12 GET_COUNT Function
• 20.13 GET_DATE Function
• 20.14 GET_MEMBERS Function
• 20.15 GET_NUMBER Function
• 20.16 GET_VALUE Function
• 20.17 GET_T_NUMBER Function
• 20.18 GET_T_VARCHAR2 Function
• 20.19 GET_VARCHAR2 Function
• 20.20 GET_CLOB Function
• 20.21 INITIALIZE_CLOB_OUTPUT Procedure
• 20.22 INITIALIZE_OUTPUT Procedure
• 20.23 OPEN_ARRAY Procedure
• 20.24 OPEN_OBJECT Procedure
• 20.25 PARSE Procedure Signature 1
• 20.26 PARSE Procedure Signature 2
• 20.27 STRINGIFY Function Signature 1
• 20.28 STRINGIFY Function Signature 2
• 20.29 STRINGIFY Function Signature 3
• 20.30 STRINGIFY Function Signature 4
• 20.31 TO_MEMBER_NAME Function
• 20.32 TO_XMLTYPE Function
• 20.33 TO_XMLTYPE_SQL Function
• 20.34 WRITE Procedure Signature 1
• 20.35 WRITE Procedure Signature 2
• 20.36 WRITE Procedure Signature 3
• 20.37 WRITE Procedure Signature 4
• 20.38 WRITE Procedure Signature 5
• 20.39 WRITE Procedure Signature 6
• 20.40 WRITE Procedure Signature 7
• 20.41 WRITE Procedure Signature 8
• 20.42 WRITE Procedure Signature 9
• 20.43 WRITE Procedure Signature 10
• 20.44 WRITE Procedure Signature 11
• 20.45 WRITE Procedure Signature 12
• 20.46 WRITE Procedure Signature 13
• 20.47 WRITE Procedure Signature 14
• 20.48 WRITE Procedure Signature 15
• 20.49 WRITE Procedure Signature 16
• 20.50 WRITE Procedure Signature 17
• 20.51 WRITE Procedure Signature 18

21 APEX_JWT

• 21.1 T_TOKEN
• 21.2 ENCODE Function
• 21.3 DECODE Function
• 21.4 VALIDATE Procedure

22 APEX_LANG

• 22.1 CREATE_LANGUAGE_MAPPING Procedure
• 22.2 DELETE_LANGUAGE_MAPPING Procedure
• 22.3 EMIT_LANGUAGE_SELECTOR_LIST Procedure
• 22.4 LANG Function
• 22.5 MESSAGE Function
• 22.6 PUBLISH_APPLICATION Procedure
• 22.7 SEED_TRANSLATIONS Procedure
• 22.8 UPDATE_LANGUAGE_MAPPING Procedure
• 22.9 UPDATE_MESSAGE Procedure
• 22.10 UPDATE_TRANSLATED_STRING Procedure

23 APEX_LDAP

• 23.1 AUTHENTICATE Function
• 23.2 GET_ALL_USER_ATTRIBUTES Procedure
• 23.3 GET_USER_ATTRIBUTES Procedure
• 23.4 IS_MEMBER Function
• 23.5 MEMBER_OF Function
• 23.6 MEMBER_OF2 Function
• 23.7 SEARCH Function

24 APEX_MAIL

• 24.1 Configuring Oracle Application Express to Send Email
• 24.2 ADD_ATTACHMENT Procedure
• 24.3 GET_IMAGES_URL Function
• 24.4 GET_INSTANCE_URL Function
• 24.5 PREPARE_TEMPLATE Procedure
• 24.6 PUSH_QUEUE Procedure
• 24.7 SEND Procedure
• 24.8 SEND Function
• 24.9 SEND Procedure
• 24.10 SEND Function

25 APEX_PKG_APP_INSTALL

• 25.1 DEINSTALL Procedure Signature 1
• 25.2 DEINSTALL Procedure Signature 2
• 25.3 INSTALL Function Signature 1
• 25.4 INSTALL Function Signature 2
• 25.5 UPGRADE Procedure Signature 1
• 25.6 UPGRADE Procedure Signature 2

26 APEX_PAGE

• 26.1 Global Constants
• 26.2 IS_DESKTOP_UI Function
• 26.3 IS_JQM_SMARTPHONE_UI Function
• 26.4 IS_JQM_TABLET_UI Function
• 26.5 GET_UI_TYPE Function
• 26.6 IS_READ_ONLY Function
• 26.7 GET_PAGE_MODE Function
• 26.8 PURGE_CACHE Procedure
• 26.9 GET_URL Function

27 APEX_PLUGIN

• 27.1 Data Types
• 27.2 GET_AJAX_IDENTIFIER Function
• 27.3 GET_INPUT_NAME_FOR_PAGE_ITEM Function

28 APEX_PLUGIN_UTIL

• 28.1 CLEAR_COMPONENT_VALUES Procedure
• 28.2 DEBUG_DYNAMIC _ACTION Procedure
• 28.3 DEBUG_PAGE_ITEM Procedure Signature 1
• 28.4 DEBUG_PAGE_ITEM Procedure Signature 2
• 28.5 DEBUG_PROCESS Procedure
• 28.6 DEBUG_REGION Procedure Signature 1
• 28.7 DEBUG_REGION Procedure Signature 2
• 28.8 ESCAPE Function
• 28.9 EXECUTE_PLSQL_CODE Procedure
• 28.10 GET_ATTRIBUTE_AS_NUMBER Function
• 28.11 GET_DATA Function Signature 1
• 28.12 GET_DATA Function Signature 2
• 28.13 GET_DATA2 Function Signature 1
• 28.14 GET_DATA2 Function Signature 2
• 28.15 GET_DISPLAY_DATA Function Signature 1
• 28.16 GET_DISPLAY_DATA Function Signature 2
• 28.17 GET_ELEMENT_ATTRIBUTES Function
• 28.18 GET_PLSQL_EXPRESSION_RESULT Function
• 28.19 GET_PLSQL_FUNCTION_RESULT Function
• 28.20 GET_POSITION_IN_LIST Function
• 28.21 GET_SEARCH_STRING Function
• 28.22 GET_VALUE_AS_VARCHAR2 Function
• 28.23 IS_EQUAL Function
• 28.24 PAGE_ITEM_NAMES_TO_JQUERY Function
• 28.25 PRINT_DISPLAY_ONLY Procedure
• 28.26 PRINT_ESCAPED_VALUE Procedure
• 28.27 PRINT_HIDDEN_IF_READONLY Procedure
• 28.28 PRINT_JSON_HTTP_HEADER Procedure
• 28.29 PRINT_LOV_AS_JSON Procedure
• 28.30 PRINT_OPTION Procedure
• 28.31 REPLACE_SUBSTITUTIONS Function
• 28.32 SET_COMPONENT_VALUES Procedure

29 APEX_REGION

• 29.1 IS_READ_ONLY Function
• 29.2 PURGE_CACHE Procedure

30 APEX_SESSION

• 30.1 SET_DEBUG Procedure
• 30.2 SET_TRACE Procedure
• 30.3 CREATE_SESSION Procedure
• 30.4 DELETE_SESSION Procedure
• 30.5 ATTACH Procedure
• 30.6 DETACH Procedure

31 APEX_SPATIAL

• 31.1 Data Types
• 31.2 CHANGE_GEOM_METADATA Procedure
• 31.3 CIRCLE_POLYGON Function
• 31.4 DELETE_GEOM_METADATA Procedure
• 31.5 INSERT_GEOM_METADATA Procedure
• 31.6 INSERT_GEOM_METADATA_LONLAT Procedure
• 31.7 POINT Function
• 31.8 RECTANGLE Function

32 APEX_STRING

• 32.1 FORMAT Function
• 32.2 GET_INITIALS Function
• 32.3 GREP Function Signature 1
• 32.4 GREP Function Signature 2
• 32.5 GREP Function Signature 3
• 32.6 JOIN_CLOB Function
• 32.7 JOIN Function Signature 1
• 32.8 JOIN Function Signature 2
• 32.9 NEXT_CHUNK Function
• 32.10 PLIST_DELETE Procedure
• 32.11 PLIST_GET Function
• 32.12 PLIST_PUT Function
• 32.13 PUSH Procedure Signature 1
• 32.14 PUSH Procedure Signature 2
• 32.15 PUSH Procedure Signature 3
• 32.16 SHUFFLE Function
• 32.17 SHUFFLE Procedure
• 32.18 SPLIT Function Signature 1
• 32.19 SPLIT Function Signature 2
• 32.20 SPLIT_NUMBERS Function

33 APEX_THEME

• 33.1 CLEAR_ALL_USERS_STYLE Procedure
• 33.2 CLEAR_USER_STYLE Procedure
• 33.3 DISABLE_USER_STYLE Procedure
• 33.4 ENABLE_USER_STYLE Procedure
• 33.5 GET_USER_STYLE Function
• 33.6 SET_CURRENT_STYLE Procedure
• 33.7 SET_SESSION_STYLE Procedure
• 33.8 SET_SESSION_STYLE_CSS Procedure
• 33.9 SET_USER_STYLE Procedure

34 APEX_UI_DEFAULT_UPDATE

• 34.1 ADD_AD_COLUMN Procedure
• 34.2 ADD_AD_SYNONYM Procedure
• 34.3 DEL_AD_COLUMN Procedure
• 34.4 DEL_AD_SYNONYM Procedure
• 34.5 DEL_COLUMN Procedure
• 34.6 DEL_GROUP Procedure
• 34.7 DEL_TABLE Procedure
• 34.8 SYNCH_TABLE Procedure
• 34.9 UPD_AD_COLUMN Procedure
• 34.10 UPD_AD_SYNONYM Procedure
• 34.11 UPD_COLUMN Procedure
• 34.12 UPD_DISPLAY_IN_FORM Procedure
• 34.13 UPD_DISPLAY_IN_REPORT Procedure
• 34.14 UPD_FORM_REGION_TITLE Procedure
• 34.15 UPD_GROUP Procedure
• 34.16 UPD_ITEM_DISPLAY_HEIGHT Procedure
• 34.17 UPD_ITEM_DISPLAY_WIDTH Procedure
• 34.18 UPD_ITEM_FORMAT_MASK Procedure
• 34.19 UPD_ITEM_HELP Procedure
• 34.20 UPD_LABEL Procedure
• 34.21 UPD_REPORT_ALIGNMENT Procedure
• 34.22 UPD_REPORT_FORMAT_MASK Procedure
• 34.23 UPD_REPORT_REGION_TITLE Procedure
• 34.24 UPD_TABLE Procedure

35 APEX_UTIL

• 35.1 CACHE_GET_DATE_OF_PAGE_CACHE Function
• 35.2 CACHE_GET_DATE_OF_REGION_CACHE Function
• 35.3 CACHE_PURGE_BY_APPLICATION Procedure
• 35.4 CACHE_PURGE_BY_PAGE Procedure
• 35.5 CACHE_PURGE_STALE Procedure
• 35.6 CHANGE_CURRENT_USER_PW Procedure
• 35.7 CHANGE_PASSWORD_ON_FIRST_USE Function
• 35.8 CLOSE_OPEN_DB_LINKS Procedure
• 35.9 CLEAR_APP_CACHE Procedure
• 35.10 CLEAR_PAGE_CACHE Procedure
• 35.11 CLEAR_USER_CACHE Procedure
• 35.12 COUNT_CLICK Procedure
• 35.13 CREATE_USER Procedure
• 35.14 CREATE_USER_GROUP Procedure
• 35.15 CURRENT_USER_IN_GROUP Function
• 35.16 CUSTOM_CALENDAR Procedure
• 35.17 DELETE_USER_GROUP Procedure Signature 1
• 35.18 DELETE_USER_GROUP Procedure Signature 2
• 35.19 DOWNLOAD_PRINT_DOCUMENT Procedure Signature 1
• 35.20 DOWNLOAD_PRINT_DOCUMENT Procedure Signature 2
• 35.21 DOWNLOAD_PRINT_DOCUMENT Procedure Signature 3
• 35.22 DOWNLOAD_PRINT_DOCUMENT Procedure Signature 4
• 35.23 EDIT_USER Procedure
• 35.24 END_USER_ACCOUNT_DAYS_LEFT Function
• 35.25 EXPIRE_END_USER_ACCOUNT Procedure
• 35.26 EXPIRE_WORKSPACE_ACCOUNT Procedure
• 35.27 EXPORT_USERS Procedure
• 35.28 FETCH_APP_ITEM Function
• 35.29 FETCH_USER Procedure Signature 1
• 35.30 FETCH_USER Procedure Signature 2
• 35.31 FETCH_USER Procedure Signature 3
• 35.32 FIND_SECURITY_GROUP_ID Function
• 35.33 FIND_WORKSPACE Function
• 35.34 GET_ACCOUNT_LOCKED_STATUS Function
• 35.35 GET_APPLICATION_STATUS Function
• 35.36 GET_ATTRIBUTE Function
• 35.37 GET_AUTHENTICATION_RESULT Function
• 35.38 GET_BLOB_FILE_SRC Function
• 35.39 GET_BUILD_OPTION_STATUS Function Signature 1
• 35.40 GET_BUILD_OPTION_STATUS Function Signature 2
• 35.41 GET_CURRENT_USER_ID Function
• 35.42 GET_DEFAULT_SCHEMA Function
• 35.43 GET_EDITION Function
• 35.44 GET_EMAIL Function
• 35.45 GET_FEEDBACK_FOLLOW_UP Function
• 35.46 GET_FILE Procedure
• 35.47 GET_FILE_ID Function
• 35.48 GET_FIRST_NAME Function
• 35.49 GET_GLOBAL_NOTIFICATION Function
• 35.50 GET_GROUPS_USER_BELONGS_TO Function
• 35.51 GET_GROUP_ID Function
• 35.52 GET_GROUP_NAME Function
• 35.53 GET_HASH Function
• 35.54 GET_HIGH_CONTRAST_MODE_TOGGLE Function
• 35.55 GET_LAST_NAME Function
• 35.56 GET_NUMERIC_SESSION_STATE Function
• 35.57 GET_PREFERENCE Function
• 35.58 GET_PRINT_DOCUMENT Function Signature 1
• 35.59 GET_PRINT_DOCUMENT Function Signature 2
• 35.60 GET_PRINT_DOCUMENT Function Signature 3
• 35.61 GET_PRINT_DOCUMENT Function Signature 4
• 35.62 GET_SCREEN_READER_MODE_TOGGLE Function
• 35.63 GET_SESSION_LANG Function
• 35.64 GET_SESSION_STATE Function
• 35.65 GET_SESSION_TERRITORY Function
• 35.66 GET_SESSION_TIME_ZONE Function
• 35.67 GET_SINCE Function
• 35.68 GET_SUPPORTING_OBJECT_SCRIPT Function
• 35.69 GET_SUPPORTING_OBJECT_SCRIPT Procedure
• 35.70 GET_USER_ID Function
• 35.71 GET_USER_ROLES Function
• 35.72 GET_USERNAME Function
• 35.73 HOST_URL Function
• 35.74 HTML_PCT_GRAPH_MASK Function
• 35.75 INCREMENT_CALENDAR Procedure
• 35.76 IR_CLEAR Procedure [DEPRECATED]
• 35.77 IR_DELETE_REPORT Procedure [DEPRECATED]
• 35.78 IR_DELETE_SUBSCRIPTION Procedure [DEPRECATED]
• 35.79 IR_FILTER Procedure [DEPRECATED]
• 35.80 IR_RESET Procedure [DEPRECATED]
• 35.81 IS_HIGH_CONTRAST_SESSION Function
• 35.82 IS_HIGH_CONTRAST_SESSION_YN Function
• 35.83 IS_LOGIN_PASSWORD_VALID Function
• 35.84 IS_SCREEN_READER_SESSION Function
• 35.85 IS_SCREEN_READER_SESSION_YN Function
• 35.86 IS_USERNAME_UNIQUE Function
• 35.87 KEYVAL_NUM Function
• 35.88 KEYVAL_VC2 Function
• 35.89 LOCK_ACCOUNT Procedure
• 35.90 PASSWORD_FIRST_USE_OCCURRED Function
• 35.91 PREPARE_URL Function
• 35.92 PUBLIC_CHECK_AUTHORIZATION Function [DEPRECATED]
• 35.93 PURGE_REGIONS_BY_APP Procedure
• 35.94 PURGE_REGIONS_BY_NAME Procedure
• 35.95 PURGE_REGIONS_BY_PAGE Procedure
• 35.96 REDIRECT_URL Procedure
• 35.97 REMOVE_PREFERENCE Procedure
• 35.98 REMOVE_SORT_PREFERENCES Procedure
• 35.99 REMOVE_USER Procedure
• 35.100 RESET_AUTHORIZATIONS Procedure [DEPRECATED]
• 35.101 RESET_PASSWORD Procedure
• 35.102 RESET_PW Procedure
• 35.103 SAVEKEY_NUM Function
• 35.104 SAVEKEY_VC2 Function
• 35.105 SET_APP_BUILD_STATUS Procedure
• 35.106 SET_APPLICATION_STATUS Procedure
• 35.107 SET_ATTRIBUTE Procedure
• 35.108 SET_AUTHENTICATION_RESULT Procedure
• 35.109 SET_BUILD_OPTION_STATUS Procedure
• 35.110 SET_CURRENT_THEME_STYLE Procedure [DEPRECATED]
• 35.111 SET_CUSTOM_AUTH_STATUS Procedure
• 35.112 SET_EDITION Procedure
• 35.113 SET_EMAIL Procedure
• 35.114 SET_FIRST_NAME Procedure
• 35.115 SET_GLOBAL_NOTIFICATION Procedure
• 35.116 SET_GROUP_GROUP_GRANTS Procedure
• 35.117 SET_GROUP_USER_GRANTS Procedure
• 35.118 SET_LAST_NAME Procedure
• 35.119 SET_PARSING_SCHEMA_FOR _REQUEST Procedure
• 35.120 SET_PREFERENCE Procedure
• 35.121 SET_SECURITY_GROUP_ID Procedure
• 35.122 SET_SESSION_HIGH_CONTRAST_OFF Procedure
• 35.123 SET_SESSION_HIGH_CONTRAST_ON Procedure
• 35.124 SET_SESSION_LANG Procedure
• 35.125 SET_SESSION_LIFETIME_SECONDS Procedure
• 35.126 SET_SESSION_MAX_IDLE_SECONDS Procedure
• 35.127 SET_SESSION_SCREEN_READER_OFF Procedure
• 35.128 SET_SESSION_SCREEN_READER_ON Procedure
• 35.129 SET_SESSION_STATE Procedure
• 35.130 SET_SESSION_TERRITORY Procedure
• 35.131 SET_SESSION_TIME_ZONE Procedure
• 35.132 SET_USERNAME Procedure
• 35.133 SET_WORKSPACE_Procedure
• 35.134 SHOW_HIGH_CONTRAST_MODE_TOGGLE Procedure
• 35.135 SHOW_SCREEN_READER_MODE_TOGGLE Procedure
• 35.136 STRING_TO_TABLE Function [DEPRECATED]
• 35.137 STRONG_PASSWORD_CHECK Procedure
• 35.138 STRONG_PASSWORD_VALIDATION Function
• 35.139 SUBMIT_FEEDBACK Procedure
• 35.140 SUBMIT_FEEDBACK_FOLLOWUP Procedure
• 35.141 TABLE_TO_STRING Function [DEPRECATED]
• 35.142 UNEXPIRE_END_USER_ACCOUNT Procedure
• 35.143 UNEXPIRE_WORKSPACE_ACCOUNT Procedure
• 35.144 UNLOCK_ACCOUNT Procedure
• 35.145 URL_ENCODE Function
• 35.146 WORKSPACE_ACCOUNT_DAYS_LEFT Function

36 APEX_WEB_SERVICE

• 36.1 About the APEX_WEB_SERVICE API
• 36.2 Invoking a SOAP Style Web Service
• 36.3 Invoking a RESTful Style Web Service
• 36.4 Retrieving Cookies and HTTP Headers
• 36.5 Setting Cookies and HTTP Headers
• 36.6 BLOB2CLOBBASE64 Function
• 36.7 CLOBBASE642BLOB Function
• 36.8 MAKE_REQUEST Procedure
• 36.9 MAKE_REQUEST Function
• 36.10 MAKE_REST_REQUEST Function
• 36.11 MAKE_REST_REQUEST_B Function
• 36.12 OAUTH_AUTHENTICATE Function
• 36.13 OAUTH_GET_LAST_TOKEN Function
• 36.14 OAUTH_SET_TOKEN Function
• 36.15 PARSE_RESPONSE Function
• 36.16 PARSE_RESPONSE_CLOB Function
• 36.17 PARSE_XML Function
• 36.18 PARSE_XML_CLOB Function

37 APEX_ZIP

• 37.1 Data Types
• 37.2 ADD_FILE Procedure
• 37.3 FINISH Procedure
• 37.4 GET_FILE_CONTENT Function
• 37.5 GET_FILES Function

38 JavaScript APIs

• 38.1 apex namespace
  • 38.1.1 About apex.confirm Function
  • 38.1.2 apex.confirm Signature 1
  • 38.1.3 apex.confirm Signature 2
  • 38.1.4 apex.gPageContext$ Property
  • 38.1.5 apex.jQuery Property
  • 38.1.6 About apex.submit Function
  • 38.1.7 apex.submit Signature 1
  • 38.1.8 apex.submit Signature 2
• 38.2 apex.da namespace
  • 38.2.1 apex.da.resume
• 38.3 apex.debug namespace
  • 38.3.1 Log Level Constants
  • 38.3.2 apex.debug.error
  • 38.3.3 apex.debug.getLevel
  • 38.3.4 apex.debug.info
  • 38.3.5 apex.debug.log
  • 38.3.6 apex.debug.message
  • 38.3.7 apex.debug.setLevel
  • 38.3.8 apex.debug.trace
  • 38.3.9 apex.debug.warn
• 38.4 apex.event namespace
  • 38.4.1 apex.event.trigger
• 38.5 apex.item
  • 38.5.1 apex.item
  • 38.5.2 addValue
  • 38.5.3 disable
  • 38.5.4 displayValueFor
  • 38.5.5 enable
  • 38.5.6 getValidity
  • 38.5.7 getValidationMessage
  • 38.5.8 getValue
  • 38.5.9 hide
  • 38.5.10 isChanged
  • 38.5.11 isDisabled
  • 38.5.12 isEmpty
  • 38.5.13 Item Object Properties
  • 38.5.14 setFocus
  • 38.5.15 setStyle
  • 38.5.16 setValue
  • 38.5.17 show
  • 38.5.18 apex.item.create
• 38.6 apex.lang namespace
  • 38.6.1 apex.lang.addMessages
  • 38.6.2 apex.lang.clearMessages
  • 38.6.3 apex.lang.format
  • 38.6.4 apex.lang.formatMessage
  • 38.6.5 apex.lang.formatMessageNoEscape
  • 38.6.6 apex.lang.formatNoEscape
  • 38.6.7 apex.lang.getMessage
• 38.7 apex.message namespace
  • 38.7.1 apex.message.addVisibilityCheck
  • 38.7.2 apex.message.alert
  • 38.7.3 apex.message.clearErrors
  • 38.7.4 apex.message.confirm
  • 38.7.5 apex.message.hidePageSuccess
  • 38.7.6 apex.message.setThemeHooks
  • 38.7.7 apex.message.showErrors
  • 38.7.8 apex.message.showPageSuccess
  • 38.7.9 apex.message.TYPE
• 38.8 apex.navigation namespace
  • 38.8.1 apex.navigation.dialog
  • 38.8.2 apex.navigation.dialog.cancel
  • 38.8.3 apex.navigation.dialog.close
  • 38.8.4 apex.navigation.dialog.fireCloseHandler
  • 38.8.5 apex.navigation.dialog.registerCloseHandler
  • 38.8.6 apex.navigation.openInNewWindow
  • 38.8.7 apex.navigation.popup
  • 38.8.8 apex.navigation.popup.close
  • 38.8.9 apex.navigation.redirect
• 38.9 apex.page namespace
  • 38.9.1 apex.page.cancelWarnOnUnsavedChanges
  • 38.9.2 apex.page.confirm Signature 1
  • 38.9.3 apex.page.confirm Signature 2
  • 38.9.4 apex.page.submit Signature 1
  • 38.9.5 apex.page.submit Signature 2
  • 38.9.6 apex.page.validate
  • 38.9.7 apex.page.isChanged
  • 38.9.8 apex.page.warnOnUnsavedChanges
• 38.10 apex.region
  • 38.10.1 apex.region
    • 38.10.1.1 focus
    • 38.10.1.2 refresh
    • 38.10.1.3 widget
  • 38.10.2 apex.region.create
  • 38.10.3 apex.region.destroy
  • 38.10.4 apex.region.isRegion
  • 38.10.5 apex.region.findClosest
• 38.11 apex.server namespace
  • 38.11.1 apex.server.loadScript
  • 38.11.2 apex.server.plugin
  • 38.11.3 apex.server.pluginUrl
  • 38.11.4 apex.server.process
  • 38.11.5 apex.server.url
• 38.12 apex.storage namespace
  • 38.12.1 About local and session storage
  • 38.12.2 apex.storage.getCookie
  • 38.12.3 apex.storage.hasLocalStorageSupport
  • 38.12.4 apex.storage.getScopedLocalStorage
  • 38.12.5 apex.storage.getScopedSessionStorage
  • 38.12.6 apex.storage.hasSessionStorageSupport
  • 38.12.7 apex.storage.setCookie
• 38.13 apex.util namespace
  • 38.13.1 apex.util.escapeCSS
  • 38.13.2 apex.util.escapeHTML
  • 38.13.3 apex.util.showSpinner
  • 38.13.4 apex.util.stripHTML
  • 38.13.5 apex.util.applyTemplate
  • 38.13.6 About apex.util.delayLinger
  • 38.13.7 apex.util.delayLinger.start
  • 38.13.8 apex.util.delayLinger.finish
• 38.14 apex.widget namespace
  • 38.14.1 apex.widget.initPageItem
• 38.15 Events
  • 38.15.1 apexafterclosedialog
  • 38.15.2 apexafterrefresh
  • 38.15.3 apexbeforerefresh
  • 38.15.4 apexbeforepagesubmit
  • 38.15.5 apexbeginrecordedit
  • 38.15.6 apexendrecordedit
  • 38.15.7 apexpagesubmit
  • 38.15.8 apexwindowresized
• 38.16 Non-namespace JavaScript APIs
  • 38.16.1 $x
  • 38.16.2 $v
  • 38.16.3 $v2
  • 38.16.4 $s
  • 38.16.5 $u_Narray
  • 38.16.6 $u_Carray
  • 38.16.7 $nvl
  • 38.16.8 $x_Style
  • 38.16.9 $x_Hide
  • 38.16.10 $x_Show
  • 38.16.11 $x_Toggle
  • 38.16.12 $x_Remove
  • 38.16.13 $x_Value
  • 38.16.14 $x_UpTill
  • 38.16.15 $x_ItemRow
  • 38.16.16 $x_HideItemRow
  • 38.16.17 $x_ShowItemRow
  • 38.16.18 $x_ToggleItemRow
  • 38.16.19 $x_HideAllExcept
  • 38.16.20 $x_HideSiblings
  • 38.16.21 $x_ShowSiblings
  • 38.16.22 $x_Class
  • 38.16.23 $x_SetSiblingsClass
  • 38.16.24 $x_ByClass
  • 38.16.25 $x_ShowAllByClass
  • 38.16.26 $x_ShowChildren
  • 38.16.27 $x_HideChildren
  • 38.16.28 $x_disableItem
  • 38.16.29 $f_get_emptys
  • 38.16.30 $v_Array
  • 38.16.31 $f_ReturnChecked
  • 38.16.32 $d_ClearAndHide
  • 38.16.33 $f_SelectedOptions
  • 38.16.34 $f_SelectValue
  • 38.16.35 $u_ArrayToString
  • 38.16.36 $x_CheckImageSrc
  • 38.16.37 $v_CheckValueAgainst
  • 38.16.38 $f_Hide_On_Value_Item
  • 38.16.39 $f_Show_On_Value_Item
  • 38.16.40 $f_Hide_On_Value_Item_Row
  • 38.16.41 $f_Show_On_Value_Item_Row
  • 38.16.42 $f_DisableOnValue
  • 38.16.43 $x_ClassByClass
  • 38.16.44 $f_ValuesToArray
  • 38.16.45 $x_FormItems
  • 38.16.46 $f_CheckAll
  • 38.16.47 $f_CheckFirstColumn
  • 38.16.48 $x_ToggleWithImage
  • 38.16.49 $x_SwitchImageSrc
  • 38.16.50 $x_CheckImageSrc
  • 38.16.51 $u_SubString
  • 38.16.52 html_RemoveAllChildren
  • 38.16.53 html_SetSelectValue
  • 38.16.54 addLoadEvent
  • 38.16.55 $f_Swap
  • 38.16.56 $f_SetValueSequence
  • 38.16.57 $dom_AddTag
  • 38.16.58 $tr_AddTD
  • 38.16.59 $tr_AddTH
  • 38.16.60 $dom_AddInput
  • 38.16.61 $dom_MakeParent
  • 38.16.62 $x_RowHighlight
  • 38.16.63 $x_RowHighlightOff
  • 38.16.64 $v_Upper
  • 38.16.65 $d_Find
  • 38.16.66 $f_First_field

39 Using REST Administration Interface API

• 39.1 Authentication
• 39.2 Individual REST Services
  • 39.2.1 Fetch Instance-Level Statistics
  • 39.2.2 Fetch Workspace-Level Statistics
  • 39.2.3 Application-Level Statistics
  • 39.2.4 Instance Overview
  • 39.2.5 REST Service Version Information

Index