Jump to

• Request
• Response

Get a specific Oracle APEX Dataset

get

/apex/workspaces/{workspace_name}/datasets/{dataset_name}

This service returns a representation of the specified Oracle APEX Dataset. The representation data will be a metadata about the Oracle APEX Dataset from APEX_DR_DATASETS view. See APEX documentation for more information. A client requires SQL Developer or SQL Administrator role.

Request

Path Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The specified Oracle APEX Dataset.

Body ()

Root Schema : DatasetItem

Type: object

This object represents a single row on APEX_DR_DATASETS

Show Source

• dataset_description: string
  A description about this Dataset.
• dataset_id: integer
  Dataset Primary Key.
• dataset_name: string
  The name of this Dataset.
• last_updated_by: string
  Last updated by.
• last_updated_on: string
  The date and time of the last update.
• links: array links
• static_id: string
  The static ID of the dataset
• workspace: string
  The internal name of the workspace.
• workspace_display_name: string
  The displayed name of the workspace.
• workspace_id: string
  The unique ID of the workspace.

{
    "type":"object",
    "description":"This object represents a single row on APEX_DR_DATASETS",
    "properties":{
        "dataset_id":{
            "type":"integer",
            "description":"Dataset Primary Key."
        },
        "dataset_name":{
            "type":"string",
            "description":"The name of this Dataset."
        },
        "dataset_description":{
            "type":"string",
            "description":"A description about this Dataset."
        },
        "static_id":{
            "type":"string",
            "description":"The static ID of the dataset"
        },
        "workspace_display_name":{
            "type":"string",
            "description":"The displayed name of the workspace."
        },
        "workspace":{
            "type":"string",
            "description":"The internal name of the workspace."
        },
        "workspace_id":{
            "type":"string",
            "description":"The unique ID of the workspace."
        },
        "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 Oracle APEX Dataset.

400 Response

Bad Request - The dataset does not exist.

Back to Top