Jump to

• Request
• Response

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(required): string
  Application Primary Key, Unique over all workspaces.

Query Parameters

• export_format(required): string
  Indicates the file format to return the entire application components. Valid values SQL_SCRIPT | SQL_ZIP

  Allowed Values: [ "SQL_SCRIPT", "SQL_ZIP" ]
• export_type(required): string
  Parameter for APEX Export function. Comma-delimited list of export types to perform APPLICATION_SOURCE,EMBEDDED_CODE, CHECKSUM-SH1

  Examples

  Select an example export_type_src

• p_with_pkg_app_mapping(required): boolean
  If true, export installed packaged applications with references to the packaged application definition. If false, export them as normal applications.
• with_acl_assignments(required): 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(required): boolean
  Parameter for APEX Export function. If true, include developer comments. Only valid if export_format query parameter is also specified.
• with_date(required): 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(required): 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(required): 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(required): 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(required): 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(required): 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(required): 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(required): 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/sql
• application/zip

200 Response

The specified Oracle APEX application.

Body ()

Root Schema : APEXApplicationsItem

Type: object

This object represents a single row on APEX_APPLICATIONS.

Show Source

• application_alias: string
  The alternate alphanumeric application identifier.
• application_group: string
  The alternate alphanumeric application identifier.
• application_id: integer
  Application Primary Key, Unique over all workspaces.
• application_name: string
  The name of this application.
• application_owner: string
  The alternate alphanumeric application identifier.
• availability_status: string
  Specifies whether or not the application is available or unavailable for use.
• last_updated_by: string
  Last updated by.
• last_updated_on: string
  The date and time of the last update.
• links: array links
• page_count: integer
  Number of application pages.
• workspace: string
  The internal name of the workspace.

{
    "type":"object",
    "description":"This object represents a single row on APEX_APPLICATIONS.",
    "properties":{
        "application_id":{
            "type":"integer",
            "description":"Application Primary Key, Unique over all workspaces."
        },
        "application_name":{
            "type":"string",
            "description":"The name of this application."
        },
        "application_alias":{
            "type":"string",
            "description":"The alternate alphanumeric application identifier."
        },
        "application_group":{
            "type":"string",
            "description":"The alternate alphanumeric application identifier."
        },
        "application_owner":{
            "type":"string",
            "description":"The alternate alphanumeric application identifier."
        },
        "page_count":{
            "type":"integer",
            "description":"Number of application pages."
        },
        "workspace":{
            "type":"string",
            "description":"The internal name of the workspace."
        },
        "availability_status":{
            "type":"string",
            "description":"Specifies whether or not the application is available or unavailable for use."
        },
        "last_updated_by":{
            "type":"string",
            "description":"Last updated by."
        },
        "last_updated_on":{
            "type":"string",
            "description":"The date and time of the last update."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Examples

Select an example An example of the details returned for the specified application. Returned when export_format query parameter is not specified in the request.

400 Response

Bad Request - The export related query parameters provided without specifying export_format.

Back to Top