Jump to

• Request
• Response

Export APEX application components and/or runtime instance data

post

/apex/applications/{application_id}

Exports selected components of a specified APEX application and/or runtime instance data.

Request

Path Parameters

• application_id(required): 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_ZIP

  Allowed 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

  Examples

  Select an example Export application source

• 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_audit_info: string
  Parameter for APEX Export function. If 'NULL', export excludes all audit information. if 'NAMES_AND_DATES', export includes Created On, Created By, Updated On, Updated By values if they exist. If 'DATES_ONLY', export includes Created On and Updated On values if they exist. User names are excluded. Only valid if export_format query parameter is also specified.

  Allowed Values: [ "NAMES_AND-DATES", "DATES_ONLY" ]
• 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_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_supporting_objects: string
  Parameter for the APEX Export function. If "NULL", export excludes all audit information. If "NAMES_AND_DATES", export includes Created On, Created By, Updated On, and Updated By values if they exist. If "DATES_ONLY", export includes Created On and Updated On values only; user names are excluded. Only valid if the export_format query parameter is also specified. Enum: "NAMES_AND_DATES", "DATES_ONLY".

  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

This object represents an export request for APEX application components and/or runtime instance data.

Show Source

• components: array components
  Parameter for APEX Export function. The list of components in the specified APEX Application to export.
• withRuntimeInstances: array withRuntimeInstances
  Parameter for APEX Export function. An array with components for which to export runtime instance data

{
    "type":"object",
    "description":"This object represents an export request for APEX application components and/or runtime instance data.",
    "required":[
        "export_format"
    ],
    "properties":{
        "components":{
            "description":"Parameter for APEX Export function. The list of components in the specified APEX Application to export.",
            "type":"array",
            "items":{
                "description":"Alias of the component. Format is TYPE:IDENTIFIER.",
                "type":"string"
            }
        },
        "withRuntimeInstances":{
            "description":"Parameter for APEX Export function. An array with components for which to export runtime instance data",
            "type":"array",
            "items":{
                "description":"If \"WORKFLOW\", exports workflow instances and their associated task instances. If \"TASK\", exports task instances that are not associated with any workflow. If \"WORKFLOW, TASK\", exports both workflow instances with their associated tasks and task instances not associated with any workflow.",
                "type":"string",
                "enum":[
                    "WORKFLOW",
                    "TASK"
                ]
            }
        }
    }
}

Nested Schema : components

Type: array

Parameter for APEX Export function. The list of components in the specified APEX Application to export.

Show Source

• Array of: string
  Alias of the component. Format is TYPE:IDENTIFIER.

{
    "description":"Parameter for APEX Export function. The list of components in the specified APEX Application to export.",
    "type":"array",
    "items":{
        "description":"Alias of the component. Format is TYPE:IDENTIFIER.",
        "type":"string"
    }
}

Nested Schema : withRuntimeInstances

Type: array

Parameter for APEX Export function. An array with components for which to export runtime instance data

Show Source

• Array of: string
  Allowed Values: [ "WORKFLOW", "TASK" ]

  If "WORKFLOW", exports workflow instances and their associated task instances. If "TASK", exports task instances that are not associated with any workflow. If "WORKFLOW, TASK", exports both workflow instances with their associated tasks and task instances not associated with any workflow.

{
    "description":"Parameter for APEX Export function. An array with components for which to export runtime instance data",
    "type":"array",
    "items":{
        "description":"If \"WORKFLOW\", exports workflow instances and their associated task instances. If \"TASK\", exports task instances that are not associated with any workflow. If \"WORKFLOW, TASK\", exports both workflow instances with their associated tasks and task instances not associated with any workflow.",
        "type":"string",
        "enum":[
            "WORKFLOW",
            "TASK"
        ]
    }
}

Examples

Select an example Listing two specific APEX Applications components to export. The query parameter export_format MUST be specified. Setting the runtime instance to WORKFLOW, in order to export workflow instances and their associated task instances. The query parameter export_format MUST be specified.

Back to Top

Response

Supported Media Types

• application/sql
• application/zip

200 Response

The current state of the specified Oracle APEX application components.

Body ()

Root Schema : schema

Type: string(binary)

400 Response

Bad Request - The service requested requires a body in the request.

Back to Top