Jump to

• Request
• Response
• Examples

Get catalog item details

get

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

Returns information about a catalog item with a given type and ID. For example, details such as owner, name, description, ID, last modified 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. Returned lists have a maximum of 10000 items. For information about the search syntax, see Search Options.

Request

Path Parameters

• id(required): string
  Catalog item ID in base64url format.
• type(required):
  Type of catalog item. These content types are supported

  • folders - Folders containing catalog objects.
  • workbooks - Workbooks.
  • subjectAreas - Subject areas.
  • datasets - Datasets.
  • connections - Objects containing connection details.
  • dataflows - Data flows.
  • models - Predictive and machine learning models.
  • sequences - Sequences.
  • analysis - Analyses.
  • reports - Pixel-perfect reports (BIP reports).
  • dashboards - Dashboards.
  • dashboardpages - Dashboard pages.
  • dashboardgroupfolders - Workbooks and dashboards available from the Navigation menu on the Home page.
  • scripts - Custom scripts for machine learning and data curation.

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.
• manageContent: boolean
  If true, search is performed in content management mode. You need Manage Content permission to enable content management mode.
• 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. These content filter types are supported

  • folders - Folders containing catalog objects.
  • workbooks - Workbooks.
  • subjectAreas - Subject areas.
  • datasets - Datasets.
  • connections - Objects containing connection details.
  • dataflows - Data flows.
  • models - Predictive and machine learning models.
  • sequences - Sequences.
  • analysis - Analyses.
  • reports - Pixel-perfect reports (BIP reports).
  • dashboards - Dashboards.
  • dashboardpages - Dashboard pages.
  • dashboardgroupfolders - Workbooks and dashboards available from the Navigation menu on the Home page.
  • scripts - Custom scripts for machine learning and data curation.

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":{
                    "allOf":[
                        {
                            "$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":{
            "allOf":[
                {
                    "$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: type

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Catalog item description, if any"
        },
        "type":{
            "allOf":[
                {
                    "$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

cURL Example - No Search Criteria

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.

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'

cURL Example - With Search Criteria

If the item is a container object (such as a folder or dashboard), you can use the search query parameter to further refine the results of your search. This example returns all the subitems in the shared/Sales folder.

curl -i --header 'Authorization: Bearer <token>' \
--request GET 'https://<hostname>/api/20210901/catalog/folders/c2hhcmVkL1NhbGVz?search=*'

You can also narrow the search to only return items that contain a specific string. This example returns all subitems in the shared/Sales folder that contains KPI.

curl -i --header 'Authorization: Bearer <token>' \
--request GET 'https://<hostname>/api/20210901/catalog/folders/c2hhcmVkL1NhbGVz?search="KPI"'

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

cURL Example - With manageContent Enabled

If you have the appropriate privileges, you can run search queries in content management mode by setting the manageContent parameter set to true. When you search in content management mode, the API can return items not owned by or shared with you. You must have the Manage Content permission or BI Service Administrator role to run the query in content management mode.

This example returns details for a workbook not owned by or shared with you. The workbook has the object ID /@Catalog/shared/Sales/MySalesWorkbook and the Base64URL-safe encoded id value L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s.

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

Back to Top