Jump to

• Request
• Response

Get all workspaces

get

/apex/workspaces/

Returns information about the Oracle APEX workspaces available. A client requires SQL Administrator role to invoke this service.

Request

Query Parameters

• limit(optional): integer(int32)
  The maximum number of records to return.
• q(optional): string
  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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

All Oracle APEX workspaces in the instance.

Body ()

Root Schema : APEXWorkspaces

Type: object

Show Source

• count(optional): integer
  Total number of records in the current response.
• hasMore(optional): boolean
  Indicates if there are more records to be retrieved.
• items(optional): array items
• limit(optional): integer
  The actual page size limit on number of records applied by the server.
• links(optional): array links
• offset(optional): integer
  The actual index from which the item resources are returned.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/APEXWorkspacesItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object APEXWorkspacesItem
  This object represents a single row on APEX_WORKSPACES.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/APEXWorkspacesItem"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : APEXWorkspacesItem

Type: object

This object represents a single row on APEX_WORKSPACES.

Show Source

• allow_app_building_yn(optional): string
  Controls availability of application building component.
• allow_issue_files_yn(optional): string
  Controls availability of issue files component.
• allow_packaged_app_ins_yn(optional): string
  Controls availability of packaged application installation component.
• allow_restful_services_yn(optional): string
  Controls availability of RESTful services component.
• allow_sql_workshop_yn(optional): string
  Controls availability of SQL workshop component.
• allow_team_dev_files_yn(optional): string
  Controls availability of team development files component.
• allow_team_development_yn(optional): string
  Controls availability of team development component.
• allow_to_be_purged_yn(optional): string
  Controls availability of purge component.
• allow_websheet_dev_yn(optional): string
  Controls availability of websheet development component.
• apex_users(optional): integer
  Number of APEX users created in this workspace.
• application_pages(optional): integer
  Number of application pages created in this workspace.
• applications(optional): integer
  Number of applications created in this workspace.
• created_on(optional): string
  The date the workspace was created.
• last_login(optional): 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(optional): array links
• workspace_display_name(optional): string
  Display name for the workspace.
• workspace_id(optional): integer
  Primary key that identifies the workspace.
• workspace_name(optional): 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."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

• href: string
• rel: string

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

Back to Top