1. API Reference
  2. Changes in Release 24.1 for Oracle APEX API Reference

1 Changes in Release 24.1 for Oracle APEX API Reference

All content in Oracle APEX API Reference has been updated to reflect release 24.1 functionality.

New Features and Updates

The following topics have been added or updated for this release:

  • APEX_AI (New)
    • Constants (New)
    • Data Types (New)
    • CHAT Function (New)
    • GENERATE Function (New)
    • IS_ENABLED Function (New)
    • IS_USER_CONSENT_NEEDED Function (New)
    • REVOKE_USER_CONSENT Procedure (New)
    • REVOKE_USER_CONSENT_FOR_ALL Procedure (New)
    • SET_USER_CONSENT Procedure (New)
  • APEX_APPLICATION_INSTALL (Updates)
    • Public SQL Views (New)
    • GET_REMOTE_SERVER_AI_ATTRS Function (New)
    • GET_REMOTE_SERVER_AI_HEADERS Function (New)
    • GET_REMOTE_SERVER_AI_MODEL Function (New)
    • GET_REMOTE_SERVER_DEFAULT_DB Function (New)
    • GET_REMOTE_SERVER_SQL_MODE Function (New)
    • GET_REST_SOURCE_CATALOG_GROUP Function (New)
    • SET_REMOTE_SERVER Procedure (Updates)
    • SET_REST_SOURCE_CATALOG_GROUP Procedure (New)
  • APEX_APPROVAL (Updates)
    • CREATE_TASK Procedure (Updated) - New parameter p_initiator_can_complete.
    • GET_NEXT_PURGE_TIMESTAMP Function (New) - Retrieves the timestamp of the next purge.
    • GET_TASKS Function (Updated) - Returns initiator_can_complete varchar2(1).
    • SET_INITIATOR_CAN_COMPLETE Procedure (New) - Sets the initiator_can_Complete attribute of a task.
  • APEX_AUTHENTICATION (Updates)
    • SAML_CALLBACK Procedure (New) - Landing resource for SAML authentication.
  • APEX_CREDENTIAL (Updates)
    • CREATE_CREDENTIAL Procedure Signature 2 (New)
    • SET_DATABASE_CREDENTIAL Procedure (New)
  • APEX_EXEC (Updates)
    • ADD_DML_ARRAY_ROW Procedure (New)
    • CLOSE_ARRAY Procedure (New)
    • COLUMN_EXISTS Function (New)
    • DESCRIBE_QUERY Function Signature 1 (New)
    • DESCRIBE_QUERY Function Signature 2 (New)
    • GET_ARRAY_ROW_DML_OPERATION Function (New)
    • GET_ARRAY_ROW_VERSION_CHECKSUM Function (New)
    • GET_COLUMNS Function (New)
    • HAS_MORE_ARRAY_ROWS Function (New)
    • NEXT_ARRAY_ROW Function (New)
    • OPEN_ARRAY Procedure (New)
    • SET_ARRAY_CURRENT_ROW Procedure (New)
    • SET_ARRAY_ROW_VERSION_CHECKSUM Procedure (New)
  • APEX_EXPORT (Updates)
    • GET_APPLICATION Function (Updated) - Enhanced support for checksum and split exports. Parameter p_components contains new % indicator to export all components of a given type.
  • APEX_EXTENSION (New)
    • SET_WORKSPACE Procedure Signature 1 (New)
    • SET_WORKSPACE Procedure Signature 2 (New)
  • APEX_HTTP (New)
    • DOWNLOAD Procedure Signature 1 (New)
    • DOWNLOAD Procedure Signature 2 (New)
  • APEX_INSTANCE_ADMIN (Updates)
    • CREATE_CLOUD_CREDENTIAL Procedure (New)
    • DROP_CLOUD_CREDENTIAL Procedure (New)
  • APEX_PLUGIN_UTIL (Updates)
    • PRINT_READ_ONLY Procedure Signature 1 (New) - Outputs a read-only text field or textarea.
    • PRINT_READ_ONLY Procedure Signature 2 (New) - Outputs a read-only text field or textarea.
    • SPLIT_MUTLIPLE_VALUE_TO_TABLE Function (New) - Converts a separated input string into an array.
  • APEX_PRINT (New)
    • Constants (New)
    • GENERATE_DOCUMENT Function Signature 1 (New)
    • GENERATE_DOCUMENT Function Signature 2 (New)
    • GENERATE_DOCUMENT Function Signature 3 (New)
    • GENERATE_DOCUMENT Function Signature 4 (New)
    • REMOVE_TEMPLATE Procedure (New)
    • UPLOAD_TEMPLATE Function (New)
  • APEX_SEARCH (Updates)
    • QUERY_EXPERT_SEARCH Function (New) - Converts an end-user search query into the corresponding Oracle Text syntax, enabling advanced and precise searching capabilities.
    • QUERY_SEARCH_ENGINE Function (New) - This function converts a simple end-user search query into the corresponding Oracle Text syntax for a smart search that incorporates query relaxation.
  • APEX_STRING (Updates)
    • INDEX_OF Function Signature 1 (New) - Returns the first position in the list where p_value is stored.
    • INDEX_OF Function Signature 2 (New) - Returns the first position in the list where p_value is stored.
    • PLIST_TO_JSON_CLOB Function (New) - Converts a wwv_flow_t_varchar2 record to a sys.json_object_t object type and stringifies it.
    • PUSH Procedure Signature 7 (New) - Appends number collection values to the apex_t_varchar2 table.
    • TABLE_TO_CLOB Function (New) - Returns the values of the apex_application_global.vc_arr2 input table p_table as a concatenated clob, separated by p_sep.
  • APEX_WEB_SERVICE
    • GET_REQUEST_HEADER Function (New)
    • MAKE_REQUEST Function Signature 2 (New)
    • MAKE_REQUEST Procedure Signature 2 (New)
    • REMOVE_REQUEST_HEADER Procedure (New)
    • SET_REQUEST_ECID_CONTEXT Procedure (New)
  • APEX_WORKFLOW (Updates)
    • Data Type parameter value (New)
    • GET_NEXT_PURGE_TIMESTAMP Function (New) - Retrieves the timestamp of the next purge.
    • GET_VARIABLE_CLOB_VALUE Function (New) - Gets the CLOB value of a workflow variable.
  • APEX_ZIP (Updates)
    • GET_DIR_ENTRIES Function (New)
    • GET_FILE_CONTENT Function Signature 2 (New)

Deprecated and Desupported Features

The following APIs are deprecated as of this release:

  • APEX_APPROVAL (Deprecated) - Entire package is deprecated. Use APEX_HUMAN_TASK instead.
    • Constants and Data Types (Deprecated)
    • ADD_TASK_COMMENT Procedure (Deprecated)
    • ADD_TASK_POTENTIAL_OWNER Procedure (Deprecated)
    • ADD_TO_HISTORY Procedure (Deprecated)
    • APPROVE_TASK Procedure (Deprecated)
    • CANCEL_TASK Procedure (Deprecated)
    • CLAIM_TASK Procedure (Deprecated)
    • COMPLETE_TASK Procedure (Deprecated)
    • CREATE_TASK Function (Deprecated)
    • DELEGATE_TASK Procedure (Deprecated)
    • GET_LOV_PRIORITY Function (Deprecated)
    • GET_LOV_STATE Function (Deprecated)
    • GET_NEXT_PURGE_TIMESTAMP Function (Deprecated)
    • GET_TASK_DELEGATES Function (Deprecated)
    • GET_TASK_HISTORY Function (Deprecated)
    • GET_TASK_PARAMETER_OLD_VALUE Function (Deprecated)
    • GET_TASK_PARAMETER_VALUE Function (Deprecated)
    • GET_TASK_PRIORITIES Function (Deprecated)
    • GET_TASKS Function (Deprecated)
    • HANDLE_TASK_DEADLINES Procedure (Deprecated)
    • HAS_TASK_PARAM_CHANGED Function (Deprecated)
    • IS_ALLOWED Function (Deprecated)
    • IS_BUSINESS_ADMIN Function (Deprecated)
    • IS_OF_PARTICIPANT_TYPE Function (Deprecated)
    • REJECT_TASK Procedure (Deprecated)
    • RELEASE_TASK Procedure (Deprecated)
    • REMOVE_POTENTIAL_OWNER Procedure (Deprecated)
    • RENEW_TASK Function (Deprecated)
    • REQUEST_MORE_INFORMATION Procedure (Deprecated)
    • SET_INITIATOR_CAN_COMPLETE Procedure (Deprecated)
    • SET_TASK_DUE Procedure (Deprecated)
    • SET_TASK_PARAMETER_VALUES Procedure (Deprecated)
    • SET_TASK_PRIORITY Procedure (Deprecated)
    • SUBMIT_INFORMATION Procedure (Deprecated)
  • APEX_AUTOMATION
    • ABORT Procedure (Deprecated)
  • APEX_CSS
    • ADD_3RD_PARTY_LIBRARY_FILE Procedure (Deprecated)
  • APEX_JAVASCRIPT
    • ADD_3RD_PARTY_LIBRARY_FILE Procedure (Deprecated)
  • APEX_PLUGIN
    • GET_INPUT_NAME_FOR_PAGE_ITEM Function (Deprecated)
    • t_item_meta_data_result parameter is_multi_value (Deprecated)
  • APEX_PLUGIN_UTIL
    • PRINT_DISPLAY_ONLY Signature 1 (Deprecated)
    • PRINT_DISPLAY_ONLY Signature 2 (Deprecated)
  • APEX_UTIL
    • URL_ENCODE Function (Deprecated)
  • APEX_WORKFLOW
    • Data Type parameter string_value (Deprecated)
  • APEX_ZIP
    • Data type t_files (Deprecated)
    • GET_FILES Function (Deprecated)
    • GET_FILE_CONTENT Function Signature 1 (Deprecated)

See Deprecated Features and Desupported Features in Oracle APEX Release Notes.