Jump to

• Request
• Response

Get all datasets in the specified workspace

get

/apex/workspaces/{workspace_name}/datasets/

Returns information about the datasets available in the specified 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

All datasets in the workspace.

Body ()

Root Schema : APEXDatasets

Type: object

This object represents data from APEX_DR_DATASETS view.

Show Source

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

{
    "type":"object",
    "description":"This object represents data from APEX_DR_DATASETS view.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatasetItem"
            }
        },
        "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":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object DatasetItem
  This object represents a single row on APEX_DR_DATASETS

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DatasetItem"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested 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 a list of all the datasets in the workspace that the user has access to.

Back to Top