機械翻訳について

ジャンプ先

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

ワークブック・キャンバスのエクスポート

post

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

PDFまたはPNGへのワークブック・キャンバスのエクスポートを開始します。 作業リクエストIDを返します。

リクエスト

パス・パラメータ

• urlBase64WorkbookId(required): string

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• object ExportBasePayload
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ExportBasePayload"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The name of the output file."
                },
                "type":{
                    "type":"string",
                    "enum":[
                        "file"
                    ],
                    "description":"The type of the entity."
                },
                "format":{
                    "type":"string",
                    "enum":[
                        "pdf",
                        "png"
                    ],
                    "description":"The output format."
                },
                "canvasIds":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "description":"A list of canvas IDs."
                },
                "screenwidth":{
                    "type":"integer",
                    "description":"Browser screen width. Maximum width is 3600."
                },
                "screenheight":{
                    "type":"integer",
                    "description":"Browser screen height. Maximum height is 3600."
                }
            },
            "required":[
                "name",
                "type",
                "format",
                "canvasIds",
                "screenwidth",
                "screenheight"
            ]
        }
    ]
}

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

Type: object

ソースを表示

• format(required): string
  許容値: [ "pdf", "png" ]

  出力フォーマット
• name(required): string
  出力ファイルの名前。
• type(required): string
  許容値: [ "file" ]

  エンティティのタイプ。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the output file."
        },
        "type":{
            "type":"string",
            "enum":[
                "file"
            ],
            "description":"The type of the entity."
        },
        "format":{
            "type":"string",
            "enum":[
                "pdf",
                "png"
            ],
            "description":"The output format."
        }
    },
    "required":[
        "name",
        "type",
        "format"
    ]
}

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

Type: object

ソースを表示

• canvasIds(required): array canvasIds
  キャンバスIDのリスト。
• format(required): string
  許容値: [ "pdf", "png" ]

  出力フォーマット
• name(required): string
  出力ファイルの名前。
• screenheight(required): integer
  ブラウザ画面の高さ。 最大高さは3600です。
• screenwidth(required): integer
  ブラウザ画面の幅。 最大幅は3600です。
• type(required): string
  許容値: [ "file" ]

  エンティティのタイプ。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the output file."
        },
        "type":{
            "type":"string",
            "enum":[
                "file"
            ],
            "description":"The type of the entity."
        },
        "format":{
            "type":"string",
            "enum":[
                "pdf",
                "png"
            ],
            "description":"The output format."
        },
        "canvasIds":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A list of canvas IDs."
        },
        "screenwidth":{
            "type":"integer",
            "description":"Browser screen width. Maximum width is 3600."
        },
        "screenheight":{
            "type":"integer",
            "description":"Browser screen height. Maximum height is 3600."
        }
    },
    "required":[
        "name",
        "type",
        "format",
        "canvasIds",
        "screenwidth",
        "screenheight"
    ]
}

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

Type: array

キャンバスIDのリスト。

ソースを表示

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"A list of canvas IDs."
}

先頭に戻る

レスポンス

202レスポンス

非同期操作が開始されました。

ヘッダー

• oa-work-request-id:

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

412レスポンス

前提条件が失敗しました。 操作を続行するための1つ以上の前提条件が満たされていません。

本文()

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

422レスポンス

処理できないエンティティ リクエスト・エンティティが正しいため、操作を続行できません。

本文()

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

先頭に戻る

例

ワークブックまたはPDFまたはPNGからキャンバスをエクスポートするには、次の情報を含むペイロードを作成する必要があります:

• name: 出力ファイル名。
• type: 出力タイプ。 型はfileである必要があります。
• canvasIds: ワークブックのキャンバスのID。 最大5個のキャンバス。 canvasIdの最大長は2000文字です。
• format: 出力形式。 書式は、PDFまたはPNGである必要があります。
• screenwidth: ブラウザ画面の幅。 最大幅は3600です。
• screenheight: ブラウザ画面の高さ。 最大高さは3600です。

payload.jsonという名前のJSONファイルの例を次に示します:

{
    "name": "Monthly report",
    "type": "file",
    "canvasIds": ["snapshot!canvas!1", "snapshot!canvas!2"],
    "format": "pdf",
    "screenwidth": 1440,
    "screenheight": 900
}

例 - JSONペイロードを使用したワークブックからのPDF出力のリクエスト

この例では、JSONファイルpayload.jsonを使用して、指定されたIDを持つ既存のワークブックから2つのキャンバスを持つPDFをリクエストします。 ワークブックのオブジェクトIDは、Base64URLでエンコードされたID値を持つ/shared/Sales/MySalesWorkbook'です: L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s。 ワークブックのIDを取得するには、「タイプ別のカタログ項目の取得」を使用します。

操作に成功すると、作業リクエストIDが返されます。このIDは、レスポンス例ではbiwj-J2MwOjQwOCcuJ2N3Ojc4NScです。 作業リクエストIDを「作業リクエスト項目の取得」に渡すことで、エクスポート・リクエストのステータスを確認できます。 作業リクエストIDは、エクスポートIDとも呼ばれます。

cURLの例:

curl    --header 'Authorization: Bearer <token>'    
            --header 'Content-Type: application/json'   
         --request POST 'http://<hostname>:<port>/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s/exports/
         --data @payload.json'

リクエスト本文の例

Not applicable.

レスポンス本文の例

{
    "resourceUri": "/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s/exports/biwj-J2MwOjQwOCcuJ2N3Ojc4NSc"
}

先頭に戻る