Jump to

• Request
• Response
• Examples

Get catalog item details

get

/api/20210901/catalog/{type}/{id}

Return information about a catalog item with a given type and id. For example, details such as owner, name, description, id, last modfied date, object type, and parent id. If the item is a container item such as folder or dashboard, sub items can be searched using the search query parameter.

Request

Path Parameters

• id(required): string
  Catalog item ID in base64url format.
• type(required):
  Type of catalog item. The content types that this API supports include folders, workbooks, subject areas, analyses, dashboards, dashboard pages, reports, connections, datasets, data flows, sequences, scripts, and semantic models.

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Headers

• oa-current-page:
• oa-next-page:
• oa-page-count:
• oa-prev-page:
• oa-total-items:

Body ()

Root Schema : schema

Match One Schema

Show Source

• CatalogItem
• CatalogFolderItem
• array CatalogItems

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/CatalogItem"
        },
        {
            "$ref":"#/components/schemas/CatalogFolderItem"
        },
        {
            "$ref":"#/components/schemas/CatalogItems"
        }
    ]
}

Nested Schema : CatalogItem

Match All

Show Source

• object CatalogItemIdRef
• object CatalogItemParentIdNameRef
• object Discriminator: type
  Discriminator: { "propertyName":"type" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CatalogItemIdRef"
        },
        {
            "$ref":"#/components/schemas/CatalogItemParentIdNameRef"
        },
        {
            "type":"object",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"Catalog item description, if any"
                },
                "type":{
                    "$ref":"#/components/schemas/Types",
                    "description":"Catalog item type"
                },
                "owner":{
                    "type":"string",
                    "description":"Catalog item owner"
                },
                "lastModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Catalog item last modified date and time"
                }
            },
            "discriminator":{
                "propertyName":"type"
            }
        }
    ]
}

Nested Schema : CatalogFolderItem

Match All

Show Source

• allOf CatalogItem
• object CatalogFolderItem-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CatalogItem"
        },
        {
            "type":"object",
            "properties":{
                "childItems":{
                    "$ref":"#/components/schemas/CatalogItems"
                }
            }
        }
    ]
}

Nested Schema : CatalogItems

Type: array

Show Source

• Array of: CatalogItem

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

Nested Schema : Discriminator: type

Type: object

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Catalog item description, if any"
        },
        "type":{
            "$ref":"#/components/schemas/Types",
            "description":"Catalog item type"
        },
        "owner":{
            "type":"string",
            "description":"Catalog item owner"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time",
            "description":"Catalog item last modified date and time"
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

Show Source

• 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" ]

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Catalog item description, if any"
        },
        "type":{
            "$ref":"#/components/schemas/Types",
            "description":"Catalog item type"
        },
        "owner":{
            "type":"string",
            "description":"Catalog item owner"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time",
            "description":"Catalog item last modified date and time"
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

Nested Schema : CatalogItemIdRef

Type: object

Show Source

• id: string
  Catalog item identifier

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Catalog item identifier"
        }
    }
}

Nested Schema : CatalogItemParentIdNameRef

Type: object

Show Source

• name: string
  Catalog item name
• parentId: string
  Catalog parent item identifier (if catalog item has a parent)

{
    "type":"object",
    "properties":{
        "parentId":{
            "type":"string",
            "description":"Catalog parent item identifier (if catalog item has a parent)"
        },
        "name":{
            "type":"string",
            "description":"Catalog item name"
        }
    }
}

Nested Schema : CatalogFolderItem-allOf[1]

Type: object

Show Source

• childItems: array CatalogItems

{
    "type":"object",
    "properties":{
        "childItems":{
            "$ref":"#/components/schemas/CatalogItems"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404 Response

Not Found. The requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

Examples

This example shows you how to obtain details about a specific catalog object, MySalesWorkbook. The object type value is workbooks. The object ID of the workbook is /@Catalog/shared/Sales/MySalesWorkbook which has the Base64URL-safe encoded id value L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s

cURL Example:

First, obtain the object ID of the workbook you want details for. Base64URL-safe encode the value to determine the id. You can obtain the Object ID value from the Inspect dialog for the object in Oracle Analytics Cloud.

Run the cURL command with the required type and id:

curl -i --header 'Authorization: Bearer <token>' \
--request GET 'https://<hostname>/api/20210901/catalog/workbooks/L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s'

Example of Request Body

Not applicable.

Example of Response Body

Status 200:

[
 {
    "owner": "smith",
    "name": "MySalesWorkbook",
    "description": "My cool sales analytics",
    "id": "L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s",
    "lastModified": "2024-01-01T18:59:16Z",
    "type": "workbooks",
    "parentId": "L0BDYXRhbG9nL3NoYXJlZC9TYWxlcw" 
 }
]

Back to Top