Jump to

• Request
• Response

Get workspace

get

/apex/workspaces/{workspace_name}/

This service returns a specific Oracle APEX workspace. A client requires SQL Administrator role to invoke this service.

Request

Path Parameters

• workspace_name(required): string
  Display name of the workspace.

Query Parameters

• limit: integer(int32)
  The maximum number of records to return.
• q:
  Filtering is the process of limiting a collection resource by using a per-request dynamic filter definition across multiple page resources, where each page contains a subset of items found in the complete collection. Filtering enables efficient traversal of large collections.

  Examples

  Select an example FilterCriteriaExample OrderByPropertyExample FilterAndOrderExample

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A specific Oracle APEX workspace.

Body ()

Root Schema : APEXWorkspacesItem

Type: object

This object represents a single row on APEX_WORKSPACES.

Show Source

• allow_app_building_yn: string
  Controls availability of application building component.
• allow_issue_files_yn: string
  Controls availability of issue files component.
• allow_packaged_app_ins_yn: string
  Controls availability of packaged application installation component.
• allow_restful_services_yn: string
  Controls availability of RESTful services component.
• allow_sql_workshop_yn: string
  Controls availability of SQL workshop component.
• allow_team_dev_files_yn: string
  Controls availability of team development files component.
• allow_team_development_yn: string
  Controls availability of team development component.
• allow_to_be_purged_yn: string
  Controls availability of purge component.
• allow_websheet_dev_yn: string
  Controls availability of websheet development component.
• apex_users: integer
  Number of APEX users created in this workspace.
• application_pages: integer
  Number of application pages created in this workspace.
• applications: integer
  Number of applications created in this workspace.
• created_on: string
  The date the workspace was created.
• last_login: string
  Creation date of the most recently purged session. Used to track last login for workspaces who no longer have entries in the activity log.
• links: array links
• workspace_description: string
  The description for the workspace.
• workspace_display_name: string
  Display name for the workspace.
• workspace_id: integer
  Primary key that identifies the workspace.
• workspace_name: string
  A work area mapped to one or more database schemas.

{
    "type":"object",
    "description":"This object represents a single row on APEX_WORKSPACES.",
    "properties":{
        "allow_app_building_yn":{
            "type":"string",
            "description":"Controls availability of application building component."
        },
        "allow_issue_files_yn":{
            "type":"string",
            "description":"Controls availability of issue files component."
        },
        "allow_packaged_app_ins_yn":{
            "type":"string",
            "description":"Controls availability of packaged application installation component."
        },
        "allow_restful_services_yn":{
            "type":"string",
            "description":"Controls availability of RESTful services component."
        },
        "allow_sql_workshop_yn":{
            "type":"string",
            "description":"Controls availability of SQL workshop component."
        },
        "allow_team_dev_files_yn":{
            "type":"string",
            "description":"Controls availability of team development files component."
        },
        "allow_team_development_yn":{
            "type":"string",
            "description":"Controls availability of team development component."
        },
        "allow_to_be_purged_yn":{
            "type":"string",
            "description":"Controls availability of purge component."
        },
        "allow_websheet_dev_yn":{
            "type":"string",
            "description":"Controls availability of websheet development component."
        },
        "apex_users":{
            "type":"integer",
            "description":"Number of APEX users created in this workspace."
        },
        "application_pages":{
            "type":"integer",
            "description":"Number of application pages created in this workspace."
        },
        "applications":{
            "type":"integer",
            "description":"Number of applications created in this workspace."
        },
        "created_on":{
            "type":"string",
            "description":"The date the workspace was created."
        },
        "last_login":{
            "type":"string",
            "description":"Creation date of the most recently purged session.  Used to track last login for workspaces who no longer have entries in the activity log."
        },
        "workspace_display_name":{
            "type":"string",
            "description":"Display name for the workspace."
        },
        "workspace_id":{
            "type":"integer",
            "description":"Primary key that identifies the workspace."
        },
        "workspace_name":{
            "type":"string",
            "description":"A work area mapped to one or more database schemas."
        },
        "workspace_description":{
            "type":"string",
            "description":"The description for the workspace."
        },
        "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"
    ]
}

Back to Top