Oracle Analytics ServerのためのREST API

フォルダの作成

post

/api/20210901/catalog/folders

フォルダを作成します。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされているメディア・タイプ

application/json

ルート・スキーマ: schema

すべてに一致

ソースを表示

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

ネストされたスキーマ: CatalogItemRef

1つのスキーマに一致

ソースを表示

object CatalogItemIdRef
object CatalogItemParentIdNameRef

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

ネストされたスキーマ: type

Type: object

ソースを表示

createIntermediateFolders: boolean

親フォルダ階層内にフォルダが現在存在しない場合は、すべての中間フォルダを作成します。

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

ネストされたスキーマ: CatalogItemIdRef

Type: object

ソースを表示

id: string

カタログ品目識別子

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

ネストされたスキーマ: CatalogItemParentIdNameRef

Type: object

ソースを表示

name: string

カタログ品目名
parentId: string

カタログの親品目識別子(カタログ品目に親がある場合)

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

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

成功した操作

ルート・スキーマ: CatalogFolderItem

すべてに一致

ソースを表示

allOf CatalogItem
object CatalogFolderItem-allOf[1]

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

ネストされたスキーマ: CatalogItem

すべてに一致

ソースを表示

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

ネストされたスキーマ: 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"
    }
}

ソースを表示

description: string

カタログ品目摘要(ある場合)
lastModified: string (date-time)

カタログ品目最終変更日時
owner: string

カタログ品目所有者
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"
    }
}

ネストされたスキーマ: CatalogItemIdRef

Type: object

ソースを表示

id: string

カタログ品目識別子

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

ネストされたスキーマ: CatalogItemParentIdNameRef

Type: object

ソースを表示

name: string

カタログ品目名
parentId: string

カタログの親品目識別子(カタログ品目に親がある場合)

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

ネストされたスキーマ: CatalogFolderItem-allOf[1]

Type: object

ソースを表示

childItems: array CatalogItems

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

ネストされたスキーマ: CatalogItems

Type: array

ソースを表示

Array of: CatalogItem

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

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): 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レスポンス

未承認(資格情報の欠落や期限切れなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): 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レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): 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レスポンス

見つかりません。リクエストされたリソースが見つかりませんでした。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): 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レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): 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"
    ]
}

先頭に戻る

例

この例では、Oracle Analyticsインスタンスのカタログにフルパス/@Catalog/shared/Sales/2024のフォルダを作成します。この場合、中間フォルダSalesは、まだ存在しないため作成されます。

cURLの例

まず、Base64URLセーフで、作成するフォルダのフルパス(/@Catalog/shared/Sales/2024)をエンコードします。この場合、Base64URLセーフでエンコードされたid値はL0BDYXRhbG9nL3NoYXJlZC9TYWxlcy8yMDI0です。

必要なidを指定してcURLコマンドを実行し、必要に応じて中間フォルダを作成するようにリクエストします。

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

レスポンス・ヘッダーの例

適用不可。

レスポンス本文の例

Status 200:

先頭に戻る