Jump to

• Request
• Response

Create or Update an APEX application, with a specific application id, in the specified workspace

put

/apex/workspaces/{workspace_name}/applications/{application_id}

This services creates a new application in the specified workspace, using the given application/sql or application/zip input content using APEX install application procedure. The Application ID in the input file is ignored. If an application already exists with the application_id in the URL then it is overwritten. Otherwise, a new application is created in the workspace with the specified application_id from the URL. A client requires SQL Developer or SQL Administrator role to access this endpoint.

Request

Path Parameters

• application_id(required): string
  Application Primary Key, Unique over all workspaces.
• workspace_name(required): string
  Display name of the workspace.

Supported Media Types

• application/sql
• application/zip

Request Body - application/zip ()

Root Schema : schema

Type: string

Request Body - application/sql ()

Root Schema : schema

Type: string

Back to Top

Response

Supported Media Types

• application/json

201 Response

Details of the created/updated application

Headers

• Location:
  Location header will provide URI of created 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"
    ]
}

400 Response

Bad Request - The input file could not be processed.

Back to Top