Get or export a specific APEX application
get
/apex/applications/{application_id}
This service returns a representation of the specified APEX Application. The representation data will be a metadata about the APEX Application from APEX_APPLICATIONS view or an export of the entire application using APEX GET_APPLICATION.EXPORT database procedure. See APEX documentation for more information. A client requires SQL Developer or SQL Administrator role.
Request
Path Parameters
-
application_id: string
Application Primary Key, Unique over all workspaces.
Query Parameters
-
export_format: string
Indicates the file format to return the entire application components. Valid values SQL_SCRIPT | SQL_ZIPAllowed Values:
[ "SQL_SCRIPT", "SQL_ZIP" ]
-
export_type: string
Parameter for APEX Export function. Comma-delimited list of export types to perform APPLICATION_SOURCE,EMBEDDED_CODE, CHECKSUM-SH1
-
p_with_pkg_app_mapping: boolean
If true, export installed packaged applications with references to the packaged application definition. If false, export them as normal applications.
-
with_acl_assignments: boolean
Parameter for APEX Export function. If true, export ACL user role assignments. Only valid if export_format query parameter is also specified.
-
with_comments: boolean
Parameter for APEX Export function. If true, include developer comments. Only valid if export_format query parameter is also specified.
-
with_date: boolean
Parameter for APEX Export function. If true include export date and time in the result. Only valid if export_format query parameter is also specified.
-
with_ir_notifications: boolean
Parameter for APEX Export function. If true, include report notifications. Only valid if export_format query parameter is also specified.
-
with_ir_private_reports: boolean
Parameter for APEX Export function. If true, include private reports that a user saved. Only valid if export_format query parameter is also specified.
-
with_ir_public_reports: boolean
Parameter for APEX Export function. If true, include public reports that a user saved. Only valid if export_format query parameter is also specified.
-
with_no_subscriptions: boolean
Parameter for APEX Export function. If true, components contain subscription references. Only valid if export_format query parameter is also specified.
-
with_original_ids: boolean
Parameter for APEX Export function. If true, export with the IDs as they were when the application was imported. Only valid if export_format query parameter is also specified.
-
with_supporting_objects: string
Parameter for APEX Export function. If 'Y', export supporting objects. If 'I',automatically install on import. If 'N', do not export supporting objects. If null, the application's include in export deployment value is used. Only valid if export_format query parameter is also specified.Allowed Values:
[ "Y", "I", "N" ]
-
with_translations: boolean
Parameter for APEX Export function. If true, include application translation mappings and all text from the translation repository. Only valid if export_format query parameter is also specified.
Response
Supported Media Types
- application/json
- application/sql
- application/zip
200 Response
The specified Oracle APEX application.
Root Schema : APEXApplicationsItem
Type:
object
This object represents a single row on APEX_APPLICATIONS.
Show Source
-
application_alias(optional):
string
The alternate alphanumeric application identifier.
-
application_group(optional):
string
The alternate alphanumeric application identifier.
-
application_id(optional):
integer
Application Primary Key, Unique over all workspaces.
-
application_name(optional):
string
The name of this application.
-
application_owner(optional):
string
The alternate alphanumeric application identifier.
-
availability_status(optional):
string
Specifies whether or not the application is available or unavailable for use.
-
last_updated_by(optional):
string
Last updated by.
-
last_updated_on(optional):
string
The date and time of the last update.
-
links(optional):
array links
-
page_count(optional):
integer
Number of application pages.
-
workspace(optional):
string
The internal name of the workspace.
400 Response
Bad Request - The export related query parameters provided without specifying export_format.