Get catalog items
get
/api/20210901/catalog
Without search criteria, returns a list of supported catalog item types. With search criteria, returns catalog items that match the criteria specified.
Request
Query Parameters
-
excludedFields: string
Comma separated list of fields to exclude from response.
-
fields: string
Comma separated list of fields to include in response.
-
limit: integer
Number of catalog items per page.
-
page: integer
Page number.
-
search: string
search string
-
sortBy: string
Sort by criteria.
-
sortOrder: string
Sort order.Allowed Values:
[ "ASC", "DESC" ]
-
type:
catalog item type filter
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Headers
Nested Schema : CatalogItem
Match All
Show Source
-
object
CatalogItemIdRef
-
object
CatalogItemParentIdNameRef
-
object
Discriminator: type
Discriminator:
{ "propertyName":"type" }
Nested Schema : Discriminator: type
Type:
Show Source
object
-
description: string
Catalog item description, if any
-
lastModified: string
(date-time)
Catalog item last modified date and time
-
owner: string
Catalog item owner
-
type: string
Allowed Values:
[ "workbooks", "folders", "datasets", "connections", "dataflows", "models", "sequences", "subjectAreas", "analysis", "reports", "dashboards", "dashboardpages", "scripts" ]
Nested Schema : CatalogItemParentIdNameRef
Type:
Show Source
object
-
name: string
Catalog item name
-
parentId: string
Catalog parent item identifier (if catalog item has a parent)
Nested Schema : TypeInfo
Type:
Show Source
object
-
type: string
Allowed Values:
[ "workbooks", "folders", "datasets", "connections", "dataflows", "models", "sequences", "subjectAreas", "analysis", "reports", "dashboards", "dashboardpages", "scripts" ]
400 Response
Bad Request (invalid query parameters, malformed headers, and so on).
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
401 Response
Unauthorized (missing or expired credentials, and so on).
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
500 Response
Internal Server Error. The server encountered an unexpected condition
preventing fulfilment of the request.
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
Examples
This example shows you how to obtain a list of the types of catalog object that the catalog REST API supports.
cURL Example:
curl -i --header 'Authorization: Bearer <token>' \ --request GET 'https://<hostname>/api/20210901/catalog'
Example of Request Body
Not applicable.
Example of Response Body
Status 200:
[ {"type": "workbooks"}, {"type": "folders"}, {"type": "datasets"}, {"type": "connections"}, {"type": "dataflows"}, {"type": "models"}, {"type": "sequences"}, {"type": "subjectAreas"}, {"type": "analysis"}, {"type": "reports"}, {"type": "dashboardgroupfolders"}, {"type": "dashboardfolders"}, {"type": "dashboardpages"}, {"type": "dashboards"}, {"type": "scripts"}]