Oracle Analytics ServerのためのREST API

カタログ品目の移動

post

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

特定のタイプとIDを持つカタログ品目を特定のフォルダに移動します。このAPIを使用して、フォルダ、ワークブック、サブジェクト領域、分析、ダッシュボード、ダッシュボード・ページおよびレポートを移動します。APIを使用して接続、データセット、データ・フロー、シーケンス、スクリプトまたはセマンティック・モデルを移動することはできません。

リクエスト

パス・パラメータ

id(必須): string

base64url形式のカタログ品目ID。
type(必須):

カタログ品目のタイプこのAPIがサポートするコンテンツ・タイプには、フォルダ、ワークブック、サブジェクト領域、分析、ダッシュボード、ダッシュボード・ページ、レポート、接続、データセット、データ・フロー、シーケンス、スクリプトおよびセマンティック・モデルが含まれます。

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

application/json

ルート・スキーマ: schema

Type: object

ソースを表示

createIntermediateFolders: boolean

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

宛先品目のカタログ品目識別子。
destParentId: string

親フォルダID
newItemName: string

コピーする新しいカタログ品目の名前。
overwrite: boolean

指定してtrueにした場合、宛先カタログ品目が存在する場合は上書きします。

{
    "type":"object",
    "properties":{
        "destId":{
            "type":"string",
            "description":"Catalog item identifier for destination item."
        },
        "destParentId":{
            "type":"string",
            "description":"Parent folder id."
        },
        "newItemName":{
            "type":"string",
            "description":"Name for the new catalog item that you copy."
        },
        "overwrite":{
            "type":"boolean",
            "description":"If specified and true, overwrite the destination catalog item if it exists."
        },
        "createIntermediateFolders":{
            "type":"boolean",
            "description":"Create all intermediate folders if any folder in the parent folder hierarchy doesn't currently exist."
        }
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功した操作

ルート・スキーマ: 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"
        }
    }
}

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

先頭に戻る

例

この例では、特定のtype (ワークブック)と特定のidを持つカタログ・オブジェクトを特定のフォルダに移動します。ワークブックはMySalesWorkbookと呼ばれます。ワークブックのオブジェクトIDは/@Catalog/shared/Sales/MySalesWorkbookで、Base64URLセーフでエンコードされたid値はL0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2sです。

宛先フォルダのオブジェクトIDは/@Catalog/shared/NewSales/MySalesWorkbookで、Base64URLセーフでエンコードされたdestId値はL0BDYXRhbG9nL3NoYXJlZC9OZXdTYWxlcy9NeVNhbGVzV29ya2Jvb2sです

cURLの例:

まず、移動するワークブックのオブジェクトIDと、移動先フォルダの場合はオブジェクトIDを取得します。Base64URLセーフで値をエンコードしてidおよびdestIdを決定します。「オブジェクトID」の値は、Oracle Analytics Serverのワークブック(またはフォルダ)の「検査」ダイアログから取得できます。

必要なtype、idおよびdestIdを指定してcURLコマンドを実行します。

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request POST 'https://<hostname>/api/20210901/catalog/workbooks/L0BDYXRhbG9nL3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s/actions/move' \
     --data '{"destId": "L0BDYXRhbG9nL3NoYXJlZC9OZXdTYWxlcy9NeVNhbGVzV29ya2Jvb2s"}'

リクエスト本文の例

{"destId": "string", 
  "destParentId": "string", 
  "newItemName": "string", 
  "overwrite": true, 
  "createIntermediateFolders": true}

たとえば:

{"destId": "L0BDYXRhbG9nL3NoYXJlZC9OZXdTYWxlcy9NeVNhbGVzV29ya2Jvb2s"}

レスポンス本文の例

Status 200:
{    
    "owner": "<User-Name>",
    "name": "MySalesWorkbook",
    "description": "",
    "id": "L3NoYXJlZC9OZXdTYWxlcy9NeVNhbGVzV29ya2Jvb2s",
    "lastModified": "2024-02-27T18:11:33Z",
    "type": "workbooks",
    "parentId": "L3NoYXJlZC9OZXdTYWxlcw"

先頭に戻る