REST API for Oracle Analytics Server

Create a folder

post

/api/20210901/catalog/folders

Create a folder.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Match All

Show Source

CatalogItemRef
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CatalogItemRef"
        },
        {
            "type":"object",
            "properties":{
                "createIntermediateFolders":{
                    "type":"boolean",
                    "description":"Create all intermediate folders if any folder in the parent folder hierarchy doesn't currently exist."
                }
            }
        }
    ]
}

Nested Schema : CatalogItemRef

Match One Schema

Show Source

object CatalogItemIdRef
object CatalogItemParentIdNameRef

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/CatalogItemIdRef"
        },
        {
            "$ref":"#/components/schemas/CatalogItemParentIdNameRef"
        }
    ]
}

Nested Schema : type

Type: object

Show Source

createIntermediateFolders: boolean

Create all intermediate folders if any folder in the parent folder hierarchy doesn't currently exist.

{
    "type":"object",
    "properties":{
        "createIntermediateFolders":{
            "type":"boolean",
            "description":"Create all intermediate folders if any folder in the parent folder hierarchy doesn't currently exist."
        }
    }
}

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

Response

Supported Media Types

application/json

200 Response

Successful operation

Root 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 : 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 : 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"
        }
    }
}

Nested Schema : CatalogItems

Type: array

Show Source

Array of: CatalogItem

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

400 Response

Bad Request (invalid query parameters, malformed headers, 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"
    ]
}

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 create a folder with the full path /@Catalog/shared/Sales/2024 in the catalog for your Oracle Analytics instance. In this case, the intermediate folder Sales will be created as it doesn't exist yet.

cURL Example

First, Base64URL-safe encode the full path of the folder you want to create, that is /@Catalog/shared/Sales/2024. In this case, the Base64URL-safe encoded id value is L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy8yMDI0

Run the cURL command with the required id and request that intermediate folders are created if required:

curl -i \
 --header 'Authorization: Bearer <token>' \
 --header 'Content-Type: application/json' \
 --request POST 'https://<hostname>/api/20210901/catalog/folders' \
 --data '{"createIntermediateFolders": true, \
          "id": "L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy8yMDI0"}'

Example of Response Header

Not applicable.

Example of Response Body

Status 200: