機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

キャンバスの取得

post

/api/20210901/catalog/workbooks/{id}/actions/getCanvases

指定されたIDのワークブックのキャンバス・リストを取得します。

リクエスト

パス・パラメータ

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

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

• */*

リクエスト本文 - */* ()

ルート・スキーマ: schema

Type: string

指定できる値: [ "" ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功した操作

本文()

ルート・スキーマ: WorkbookCanvases

Type: object

ソースを表示

• presentCanvases: array presentCanvases
• visualizeCanvases: array visualizeCanvases

{
    "type":"object",
    "properties":{
        "visualizeCanvases":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkbookVisualizeCanvas"
            }
        },
        "presentCanvases":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkbookPresentCanvas"
            }
        }
    }
}

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

Type: array

ソースを表示

• Array of: WorkbookPresentCanvas

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

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

Type: array

ソースを表示

• Array of: object WorkbookCanvas

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

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

すべてに一致

ソースを表示

• object WorkbookCanvas
• object WorkbookPresentCanvas-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkbookCanvas"
        },
        {
            "type":"object",
            "properties":{
                "visualizeCanvasId":{
                    "type":"string",
                    "description":"Visualize canvas ID."
                },
                "isEnabled":{
                    "type":"string",
                    "description":"Indicates whether this canvas is enabled."
                }
            }
        }
    ]
}

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

Type: object

ソースを表示

• canvasId: string
  キャンバスID。
• canvasName: string
  キャンバス名。

{
    "type":"object",
    "properties":{
        "canvasId":{
            "type":"string",
            "description":"Canvas ID."
        },
        "canvasName":{
            "type":"string",
            "description":"Canvas name."
        }
    }
}

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

Type: object

ソースを表示

• isEnabled: string
  このキャンバスが使用可能かどうかを示します。
• visualizeCanvasId: string
  キャンバスIDをビジュアル化します。

{
    "type":"object",
    "properties":{
        "visualizeCanvasId":{
            "type":"string",
            "description":"Visualize canvas ID."
        },
        "isEnabled":{
            "type":"string",
            "description":"Indicates whether this canvas is enabled."
        }
    }
}

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

先頭に戻る

例

この例では、指定したワークブックIDに属するすべてのキャンバスの詳細を返します。 ワークブックのオブジェクトIDは、Base64URLでエンコードされたID値を持つ'/shared/Sales/Sales Analysis'です: L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw。 ワークブックのIDを取得するには、「タイプ別のカタログ項目の取得」を使用します。

cURLの例:

curl    --header 'Authorization: Bearer <token>'    \
         --request POST 'https://<hostname>/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw/actions/getCanvases'

リクエスト本文の例

Not applicable.

レスポンス本文の例

{
    "visualizeCanvases": [
        {
            "canvasId": 1,
            "canvasName": "Sales by Product Category"
        }
    ],
    "presentCanvases": [
        {
            "canvasId": "snapshot!canvas!1",
            "visualizeCanvasId": 1,
            "isEnabled": true,
            "canvasName": "Sales by Product Category"
        }
    ]
}

先頭に戻る