機械翻訳について

ジャンプ先

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

ワークブック・エクスポートのダウンロード

get

/api/20210901/catalog/workbooks/{urlBase64WorkbookId}/exports/{exportId}

ワークブック・エクスポートによって作成されたエクスポート済PDFまたはPNG出力をダウンロードします。

リクエスト

パス・パラメータ

• exportId(required): string
  エクスポートID。 作業リクエストIDとも呼ばれます。 ワークブック・キャンバスのエクスポートAPIからのレスポンス。
• urlBase64WorkbookId(required): string
  Base64URLエンコーディングのワークブックID。 たとえば、IDが'/myuser/samplefolder/samplesales'のワークブックがある場合、Base64URLでエンコードされた値'L215dXNlci9zYW1wbGVmb2xkZXIvc2FtcGxlc2FsZXM='を入力します。

この操作のリクエスト本文がありません。

先頭に戻る

レスポンス

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

• image/png
• application/pdf

200レスポンス

成功した操作。

本文()

ルート・スキーマ: schema

型: string(binary)

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は、ワークブック・キャンバスのエクスポート時にレスポンスとして取得された作業リクエストIDと同じ値です。

例 - 指定されたエクスポートIDのPDF出力の取得

この例では、指定したオブジェクトとエクスポートIDを持つワークブックからPDFの出力を取得します。 ワークブックのオブジェクトIDは、Base64URLでエンコードされたID値を持つ/shared/Sales/MySalesWorkbook'です: L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s。 ワークブックのIDを取得するには、「タイプ別のカタログ項目の取得」を使用します。

この例のエクスポートIDは、biwj-J2NwOjY1OCcuJ2NlOjM4ODEnです。 エクスポートIDは、「ワークブック・キャンバスのエクスポート」からのレスポンスで作業リクエストIDとして取得します。

cURLの例:

curl    --header 'Authorization: Bearer <token>'    
         --request GET 'http://<hostname>:<port>/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s/exports/{export-id}'

リクエスト本文の例

Not applicable.

レスポンス本文の例

Response of binary data. Response would contain metadata headers for the type of file (PDF/PNG).

先頭に戻る