• Preface
    • Topic Overview
    • Audience
    • Documentation Accessibility
    • Related Documents
    • Conventions
  • What's New in this Document
    • Oracle Application Express API Reference Updates for Release 4.0
  • APEX_APPLICATION
    • Referencing Arrays
    • Referencing Values Within an On Submit Process
    • Converting an Array to a Single Value
    • HELP Procedure
  • APEX_APPLICATION_INSTALL
    • Package Overview
    • Import Script Examples
    • CLEAR_ALL Procedure
    • GENERATE_APPLICATION_ID Procedure
    • GENERATE_OFFSET Procedure
    • GET_APPLICATION_ALIAS Function
    • GET_APPLICATION_ID Function
    • GET_APPLICATION_NAME Function
    • GET_IMAGE_PREFIX Function
    • GET_OFFSET Function
    • GET_PROXY Function
    • GET_SCHEMA Function
    • GET_WORKSPACE_ID Function
    • SET_APPLICATION_ALIAS Procedure
    • SET_APPLICATION_ID Procedure
    • SET_APPLICATION_NAME Procedure
    • SET_IMAGE_PREFIX Procedure
    • SET_OFFSET Procedure
    • SET_PROXY Procedure
    • SET_SCHEMA Procedure
    • SET_WORKSPACE_ID Procedure
  • APEX_COLLECTION
    • About the APEX_COLLECTION API
      • Naming, Creating and Accessing Collections
      • Merging, Truncating and Deleting Collections
      • Adding, Updating and Deleting Collection Members
      • Managing Collections
    • ADD_MEMBER Procedure
    • ADD_MEMBER Function
    • ADD_MEMBERS Procedure
    • COLLECTION_EXISTS Function
    • COLLECTION_HAS_CHANGED Function
    • COLLECTION_MEMBER_COUNT Function
    • CREATE_COLLECTION Procedure
    • CREATE_OR_TRUNCATE_COLLECTION Procedure
    • CREATE_COLLECTION_FROM_QUERY Procedure
    • CREATE_COLLECTION_FROM_QUERY2 Procedure
    • CREATE_COLLECTION_FROM_QUERY_B Procedure
    • CREATE_COLLECTION_FROM_QUERYB2 Procedure
    • DELETE_ALL_COLLECTIONS Procedure
    • DELETE_ALL_COLLECTIONS_SESSION Procedure
    • DELETE_COLLECTION Procedure
    • DELETE_MEMBER Procedure
    • DELETE_MEMBERS Procedure
    • GET_MEMBER_MD5 Function
    • MERGE_MEMBERS Procedure
    • MOVE_MEMBER_DOWN Procedure
    • MOVE_MEMBER_UP Procedure
    • RESEQUENCE_COLLECTION Procedure
    • RESET_COLLECTION_CHANGED Procedure
    • RESET_COLLECTION_CHANGED_ALL Procedure
    • SORT_MEMBERS Procedure
    • TRUNCATE_COLLECTION Procedure
    • UPDATE_MEMBER Procedure
    • UPDATE_MEMBERS Procedure
    • UPDATE_MEMBER_ATTRIBUTE Procedure Signature 1
    • UPDATE_MEMBER_ATTRIBUTE Procedure Signature 2
    • UPDATE_MEMBER_ATTRIBUTE Procedure Signature 3
    • UPDATE_MEMBER_ATTRIBUTE Procedure Signature 4
    • UPDATE_MEMBER_ATTRIBUTE Procedure Signature 5
    • UPDATE_MEMBER_ATTRIBUTE Procedure Signature 6
  • APEX_CSS
    • ADD Procedure
    • ADD_FILE Procedure
  • APEX_CUSTOM_AUTH
    • APPLICATION_PAGE_ITEM_EXISTS Function
    • CURRENT_PAGE_IS_PUBLIC Function
    • DEFINE_USER_SESSION Procedure
    • GET_COOKIE_PROPS Procedure
    • GET_LDAP_PROPS Procedure
    • GET_NEXT_SESSION_ID Function
    • GET_SECURITY_GROUP_ID Function
    • GET_SESSION_ID Function
    • GET_SESSION_ID_FROM_COOKIE Function
    • GET_USER Function
    • GET_USERNAME Function
    • IS_SESSION_VALID Function
    • LOGIN Procedure
    • LOGOUT Procedure
    • POST_LOGIN Procedure
    • SESSION_ID_EXISTS Function
    • SET_SESSION_ID Procedure
    • SET_SESSION_ID_TO_NEXT_VALUE Procedure
    • SET_USER Procedure
  • APEX_DEBUG_MESSAGE
    • DISABLE_DEBUG_MESSAGES Procedure
    • ENABLE_DEBUG_MESSAGES Procedure
    • LOG_MESSAGE Procedure
    • LOG_LONG_MESSAGE Procedure
    • LOG_PAGE_SESSION_STATE Procedure
    • REMOVE_DEBUG_BY_AGE Procedure
    • REMOVE_DEBUG_BY_APP Procedure
    • REMOVE_DEBUG_BY_VIEW Procedure
    • REMOVE_SESSION_MESSAGES Procedure
  • APEX_INSTANCE_ADMIN
    • ADD_SCHEMA Procedure
    • ADD_WORKSPACE Procedure
    • GET_PARAMETER Function
    • GET_SCHEMAS Function
    • REMOVE_SAVED_REPORT Procedure
    • REMOVE_SAVED_REPORTS Procedure
    • REMOVE_SCHEMA Procedure
    • REMOVE_WORKSPACE Procedure
    • SET_PARAMETER Procedure
    • Available Parameter Values
  • APEX_ITEM
    • CHECKBOX Function
    • DATE_POPUP Function
    • DATE_POPUP2 Function
    • DISPLAY_AND_SAVE Function
    • HIDDEN Function
    • MD5_CHECKSUM Function
    • MD5_HIDDEN Function
    • POPUP_FROM_LOV Function
    • POPUP_FROM_QUERY Function
    • POPUPKEY_FROM_LOV Function
    • POPUPKEY_FROM_QUERY Function
    • RADIOGROUP Function
    • SELECT_LIST Function
    • SELECT_LIST_FROM_LOV Function
    • SELECT_LIST_FROM_LOV_XL Function
    • SELECT_LIST_FROM_QUERY Function
    • SELECT_LIST_FROM_QUERY_XL Function
    • TEXT Function
    • TEXTAREA Function
    • TEXT_FROM_LOV Function
    • TEXT_FROM_LOV_QUERY Function
  • APEX_JAVASCRIPT
    • ADD_ATTRIBUTE Function Signature 1
    • ADD_ATTRIBUTE Function Signature 2
    • ADD_ATTRIBUTE Function Signature 3
    • ADD_ATTRIBUTE Function Signature 4
    • ADD_INLINE_CODE Procedure
    • ADD_LIBRARY Procedure
    • ADD_ONLOAD_CODE Procedure
    • ADD_VALUE Function Signature 1
    • ADD_VALUE Function Signature 2
    • ADD_VALUE Function Signature 3
    • ADD_VALUE Function Signature 4
    • Escape Function
  • APEX_LANG
    • LANG Function
    • MESSAGE Function
  • APEX_LDAP
    • AUTHENTICATE Function
    • GET_ALL_USER_ATTRIBUTES Procedure
    • GET_USER_ATTRIBUTES Procedure
    • IS_MEMBER Function
    • MEMBER_OF Function
    • MEMBER_OF2 Function
  • APEX_MAIL
    • About Configuring Oracle Application Express to Send Email
    • ADD_ATTACHMENT Procedure
    • PUSH_QUEUE Procedure
    • SEND Procedure
  • APEX_PLSQL_JOB
    • About the APEX_PLSQL_JOB Package
    • JOBS_ARE_ENABLED Function
    • PURGE_PROCESS Procedure
    • SUBMIT_PROCESS Function
    • TIME_ELAPSED Function
    • UPDATE_JOB_STATUS Procedure
  • APEX_PLUGIN
    • Data Types used by APEX_PLUGIN Package
    • GET_AJAX_IDENTIFIER Function
    • GET_INPUT_NAME_FOR_PAGE_ITEM Function
  • APEX_PLUGIN_UTIL
    • DEBUG_DYNAMIC _ACTION Procedure
    • DEBUG_PAGE_ITEM Procedure Signature 1
    • DEBUG_PAGE_ITEM Procedure Signature 2
    • DEBUG_PROCESS Procedure
    • DEBUG_REGION Procedure Signature 1
    • DEBUG_REGION Procedure Signature 2
    • ESCAPE Function
    • EXECUTE_PLSQL_CODE Procedure
    • GET_DISPLAY_DATA Function Signature 1
    • GET_DISPLAY_DATA Function Signature 2
    • GET_PLSQL_EXPRESSION_RESULT Function
    • GET_PLSQL_FUNCTION_RESULT Function
    • GET_POSITION_IN_LIST Function
    • GET_SEARCH_STRING Function
    • IS_EQUAL Function
    • PAGE_ITEM_NAMES_TO_JQUERY Function
    • PRINT_DISPLAY_ONLY Procedure
    • PRINT_ESCAPED_VALUE Procedure
    • PRINT_HIDDEN_IF_READONLY Procedure
    • PRINT_JSON_HTTP_HEADER Procedure
    • PRINT_LOV_AS_JSON Procedure
    • PRINT_OPTION Procedure
  • APEX_UI_DEFAULT_UPDATE
    • ADD_AD_COLUMN Procedure
    • ADD_AD_SYNONYM Procedure
    • DEL_AD_COLUMN Procedure
    • DEL_AD_SYNONYM Procedure
    • DEL_COLUMN Procedure
    • DEL_GROUP Procedure
    • DEL_TABLE Procedure
    • SYNCH_TABLE Procedure
    • UPD_AD_COLUMN Procedure
    • UPD_AD_SYNONYM Procedure
    • UPD_COLUMN Procedure
    • UPD_DISPLAY_IN_FORM Procedure
    • UPD_DISPLAY_IN_REPORT Procedure
    • UPD_FORM_REGION_TITLE Procedure
    • UPD_GROUP Procedure
    • UPD_ITEM_DISPLAY_HEIGHT Procedure
    • UPD_ITEM_DISPLAY_WIDTH Procedure
    • UPD_ITEM_FORMAT_MASK Procedure
    • UPD_ITEM_HELP Procedure
    • UPD_LABEL Procedure
    • UPD_REPORT_ALIGNMENT Procedure
    • UPD_REPORT_FORMAT_MASK Procedure
    • UPD_REPORT_REGION_TITLE Procedure
    • UPD_TABLE Procedure
  • APEX_UTIL
    • CACHE_GET_DATE_OF_PAGE_CACHE Function
    • CACHE_GET_DATE_OF_REGION_CACHE Function
    • CACHE_PURGE_BY_APPLICATION Procedure
    • CACHE_PURGE_BY_PAGE Procedure
    • CACHE_PURGE_STALE Procedure
    • CHANGE_CURRENT_USER_PW Procedure
    • CHANGE_PASSWORD_ON_FIRST_USE Function
    • CLEAR_APP_CACHE Procedure
    • CLEAR_PAGE_CACHE Procedure
    • CLEAR_USER_CACHE Procedure
    • COUNT_CLICK Procedure
    • CREATE_USER Procedure
    • CREATE_USER_GROUP Procedure
    • CURRENT_USER_IN_GROUP Function
    • CUSTOM_CALENDAR Procedure
    • DOWNLOAD_PRINT_DOCUMENT Procedure Signature 1
    • DOWNLOAD_PRINT_DOCUMENT Procedure Signature 2
    • DOWNLOAD_PRINT_DOCUMENT Procedure Signature 3
    • DOWNLOAD_PRINT_DOCUMENT Procedure Signature 4
    • EDIT_USER Procedure
    • END_USER_ACCOUNT_DAYS_LEFT Function
    • EXPIRE_END_USER_ACCOUNT Procedure
    • EXPIRE_WORKSPACE_ACCOUNT Procedure
    • EXPORT_USERS Procedure
    • FETCH_APP_ITEM Function
    • FETCH_USER Procedure Signature 1
    • FETCH_USER Procedure Signature 2
    • FETCH_USER Procedure Signature 3
    • FIND_SECURITY_GROUP_ID Function
    • FIND_WORKSPACE Function
    • GET_ACCOUNT_LOCKED_STATUS Function
    • GET_ATTRIBUTE Function
    • GET_AUTHENTICATION_RESULT Function
    • GET_BLOB_FILE_SRC Function
    • GET_CURRENT_USER_ID Function
    • GET_DEFAULT_SCHEMA Function
    • GET_EDITION Function
    • GET_EMAIL Function
    • GET_FEEDBACK_FOLLOW_UP Function
    • GET_FILE Procedure
    • GET_FILE_ID Function
    • GET_FIRST_NAME Function
    • GET_GROUPS_USER_BELONGS_TO Function
    • GET_GROUP_ID Function
    • GET_GROUP_NAME Function
    • GET_LAST_NAME Function
    • GET_NUMERIC_SESSION_STATE Function
    • GET_PREFERENCE Function
    • GET_PRINT_DOCUMENT Function Signature 1
    • GET_PRINT_DOCUMENT Function Signature 2
    • GET_PRINT_DOCUMENT Function Signature 3
    • GET_PRINT_DOCUMENT Function Signature 4
    • GET_SCREEN_READER_MODE_TOGGLE Function
    • GET_SESSION_LANG Function
    • GET_SESSION_STATE Function
    • GET_SESSION_TERRITORY Function
    • GET_SESSION_TIME_ZONE Function
    • GET_USER_ID Function
    • GET_USER_ROLES Function
    • GET_USERNAME Function
    • HTML_PCT_GRAPH_MASK Function
    • INCREMENT_CALENDAR Procedure
    • IR_CLEAR Procedure
    • IR_FILTER Procedure
    • IR_RESET Procedure
    • IS_LOGIN_PASSWORD_VALID Function
    • IS_SCREEN_READER_SESSION Function
    • IS_SCREEN_READER_SESSION_YN Function
    • IS_USERNAME_UNIQUE Function
    • KEYVAL_NUM Function
    • KEYVAL_VC2 Function
    • LOCK_ACCOUNT Procedure
    • PASSWORD_FIRST_USE_OCCURRED Function
    • PREPARE_URL Function
    • PUBLIC_CHECK_AUTHORIZATION Function
    • PURGE_REGIONS_BY_APP Procedure
    • PURGE_REGIONS_BY_NAME Procedure
    • PURGE_REGIONS_BY_PAGE Procedure
    • REMOVE_PREFERENCE Procedure
    • REMOVE_SORT_PREFERENCES Procedure
    • REMOVE_USER Procedure
    • RESET_AUTHORIZATIONS Procedure
    • RESET_PW Procedure
    • SAVEKEY_NUM Function
    • SAVEKEY_VC2 Function
    • SET_ATTRIBUTE Procedure
    • SET_AUTHENTICATION_RESULT Procedure
    • SET_CUSTOM_AUTH_STATUS Procedure
    • SET_EDITION Procedure
    • SET_EMAIL Procedure
    • SET_FIRST_NAME Procedure
    • SET_LAST_NAME Procedure
    • SET_PREFERENCE Procedure
    • SET_SECURITY_GROUP_ID Procedure
    • SET_SESSION_LANG Procedure
    • SET_SESSION_LIFETIME_SECONDS Procedure
    • SET_SESSION_MAX_IDLE_SECONDS Procedure
    • SET_SESSION_SCREEN_READER_OFF Procedure
    • SET_SESSION_SCREEN_READER_ON Procedure
    • SET_SESSION_STATE Procedure
    • SET_SESSION_TERRITORY Procedure
    • SET_SESSION_TIME_ZONE Procedure
    • SET_USERNAME Procedure
    • SHOW_SCREEN_READER_MODE_TOGGLE Procedure
    • STRING_TO_TABLE Function
    • STRONG_PASSWORD_CHECK Procedure
    • STRONG_PASSWORD_VALIDATION Function
    • SUBMIT_FEEDBACK Procedure
    • SUBMIT_FEEDBACK_FOLLOWUP Procedure
    • TABLE_TO_STRING Function
    • UNEXPIRE_END_USER_ACCOUNT Procedure
    • UNEXPIRE_WORKSPACE_ACCOUNT Procedure
    • UNLOCK_ACCOUNT Procedure
    • URL_ENCODE Function
    • WORKSPACE_ACCOUNT_DAYS_LEFT Function
  • APEX_WEB_SERVICE
    • About the APEX_WEB_SERVICE API
      • Invoking a SOAP Style Web Service
      • Invoking a RESTful Style Web Service
      • Retrieving Cookies and HTTP Headers
      • Setting Cookies and HTTP Headers
    • BLOB2CLOBBASE64 Function
    • CLOBBASE642BLOB Function
    • MAKE_REQUEST Procedure
    • MAKE_REQUEST Function
    • MAKE_REST_REQUEST Function
    • PARSE_RESPONSE Function
    • PARSE_RESPONSE_CLOB Function
    • PARSE_XML Function
    • PARSE_XML_CLOB Function
  • JavaScript APIs
    • apex.event.trigger(pSelector,pEvent,pData)
    • apex.widget.initPageItem(pName,pOptions)
    • $x(pNd)
    • $v(pNd)
    • $v2(pNd)
    • $s(pNd, pValue, pDisplayValue)
    • $u_Carray(pNd)
    • $u_Narray(pNd)
    • $nvl(pTest, pDefault)
    • apex.submit(pOptions)
    • apex.submit(pRequest)
    • apex.confirm(pMessage, pRequest)
    • apex.confirm(pMessage, pOptions)
    • $x_Style(pNd, pStyle, pString)
    • $x_Hide(pNd)
    • $x_Show(pNd)
    • $x_Toggle(pNd)
    • $x_Remove(pNd)
    • $x_Value(pNd,pValue)
    • $x_UpTill(pNd, pToTag)
    • $x_ItemRow(pNd,pFunc)
    • $x_HideItemRow(pNd)
    • $x_ShowItemRow(pNd)
    • $x_ToggleItemRow(pNd)
    • $x_HideAllExcept(pNd,pNdArray)
    • $x_HideSiblings(pNd)
    • $x_ShowSiblings(pNd)
    • $x_Class(pNd,pClass)
    • $x_SetSiblingsClass(pNd, pClass, pNdClass)
    • $x_ByClass(pClass, pNd, pTag)
    • $x_ShowAllByClass(pNd, pClass, pTag)
    • $x_ShowChildren(pNd)
    • $x_HideChildren(pNd)
    • $x_disableItem(pNd, pTest)
    • $f_get_emptys(pNd, pClassFail, pClass)
    • $v_Array(pNd)
    • $f_ReturnChecked(pNd)
    • $d_ClearAndHide(pNd)
    • $f_SelectedOptions(pNd)
    • $f_SelectValue(pNd)
    • $u_ArrayToString(pArray, pDelim)
    • $x_CheckImageSrc(pId,pSearch)
    • $v_CheckValueAgainst(pThis, pValue)
    • $f_Hide_On_Value_Item(pThis, pThat, pValue)
    • $f_Show_On_Value_Item(pThis, pThat, pValue)
    • $f_Hide_On_Value_Item_Row(pThis, pThat, pValue)
    • $f_Show_On_Value_Item_Row(pThis, pThat, pValue)
    • $f_DisableOnValue(pThis, pValue, pThat)
    • $x_ClassByClass(pNd, pClass, pTag, pClass2)
    • $f_ValuesToArray(pThis, pClass, pTag)
    • $x_FormItems(pNd, pType)
    • $f_CheckAll(pThis, pCheck, pArray)
    • $f_CheckFirstColumn(pNd)
    • $v_PopupReturn(pValue, pThat)
    • $x_ToggleWithImage(pThis,pNd)
    • $x_SwitchImageSrc(pNd, pSearch, pReplace)
    • $x_CheckImageSrc(pNd, pSearch)
    • $u_SubString(pText,pMatch)
    • html_RemoveAllChildren(pNd)
    • $v_IsEmpty(pThis)
    • html_SetSelectValue(pId,pValue)
    • addLoadEvent(pFunction)
    • $f_Swap(pThis,pThat)
    • submitEnter(pNd,e)
    • $f_SetValueSequence(pArray,pMultiple)
    • $dom_AddTag(pThis, pTag, pText)
    • $tr_AddTD(pThis,pText)
    • $tr_AddTH(pThis,pText)
    • $dom_AddInput(pThis,pType,pId,pName,pValue)
    • $dom_MakeParent(p_Node,p_Parent)
    • $x_RowHighlight(pThis, pColor)
    • $x_RowHighlightOff(pThis)
    • $v_Upper(pNd)
    • $d_Find(pThis,pString,pTags,pClass)
    • returnInput(p_R, p_D)
    • setReturn(p_R,p_D)
    • $f_First_field(pNd)
    • GetCookie (pName)
    • SetCookie (pName,pValue)
  • Index