REST API for Oracle Analytics Server

Delete a folder

delete

/api/20210901/catalog/folders/{id}

Remove a folder from the catalog.

Request

Path Parameters

id(required): string

Catalog item ID in base64url format.

Query Parameters

recursive: boolean

If specified and true, delete all child items recursively. Otherwise only empty folder can be deleted

There's no request body for this operation.

Response

200 Response

Successful operation.

401 Response

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

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).

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.

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.

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

Examples

In this example, you delete a folder that you no longer want called Sales. The object ID of the folder is /@Catalog/shared/Sales, which has the Base64URL-safe encoded id value L0BDYXRhbG9nL3NoYXJlZC9TYWxlcw

cURL Example

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

Run the cURL command with the required id:

curl -i \
 --header 'Authorization: Bearer <token>' \
 --request DELETE 'https://<hostname>/api/20210901/catalog/folders/L0BDYXRhbG9nL3NoYXJlZC9TYWxlcw'

Example of Response Header

Not applicable.

Example of Response Body

Not applicable.