Skip to main content

2-2　印刷

印刷の実行

印刷を実行します。

例 1. エンドポイントのURI
https://api.svfcloud.com/v1/artifacts


例 2. HTTPメソッド

POST



例 3. HTTPリクエストのContent-Typeヘッダー

multipart/form-data



例 4. パラメーター

  • リクエストボディ

    リクエストボディのデータ

    値

    必須

    説明

    name

    成果物名

    作成する成果物名を指定します。成果物名はSVF Cloud Managerの処理履歴に表示されます。

    成果物名に以下の文字は使用できません。　

    • /（スラッシュ）（0x2F）

    • \0（0x00）

    本パラメーターを省略した場合、「data/{name}」の「name」が成果物名として使用されます。「data/{name}」も省略した場合、成果物名は空白になります。

    printer

    プリンターID

    maru.png

    出力先のプリンターを指定します。

    以下の値を指定できます。

    • 登録したプリンターID

      指定したプリンターに、ダイレクトプリントで出力します。

      帳票レイアウトがXMLファイルの場合にのみ、指定できます。

    • ファイルのフォーマット

      指定したフォーマットのファイルをダウンロードします。指定できるフォーマットは、帳票レイアウトの形式によって異なります。

      • XMLファイル

        • PDF

        • EMF

        • EMFPLUS

        • EXCEL *1

      • Excelファイル

        • EXCEL *1

      • Wordファイル

        • WORD

    • null

      帳票イメージを取得します。

    source

    データタイプ

    maru.png

    入力データのタイプを指定します。現在指定できる値はCSVのみです。

    defaultForm

    様式ファイルパス

    帳票レイアウトのパスとファイル名を指定します。帳票レイアウトがExcelファイルの場合は、シート名も指定します（[<ファイル名>]<シート名>）。

    パスとファイル名は、SVF Cloud Managerの［リソース］画面で確認できます。

    • XMLファイルの例

      form/書類/見積書/見積書.xml

    • Excelファイルの例

      form/書類/見積書/[見積書.xlsx]Sheet1

    • Wordファイルの例

      form/書類/見積書/見積書.docx

    CSVファイル内でVrSetFormを指定する場合は、本パラメーターの指定は不要です。CSVファイルでの指定が優先されます。2-2-1　CSVデータの形式

    data/{name}

    CSVデータ

    maru.png

    {name}に指定された値は、PDFプロパティの「タイトル」になります。指定するCSVデータについては、「2-2-1　CSVデータの形式」を参照してください。

    出力したPDFファイルを、クラウド版のinvoiceAgent 文書管理（以下、iA文書管理）にアーカイブする場合、{name}の値に拡張子を付与したものがファイル名として使用されます。

    mode

    処理モード

    出力したPDFファイルを、クラウド版のinvoiceAgent 文書管理にアーカイブする場合、指定は必須です。

    「archive」を指定します。

    preference

    印刷設定

    印刷設定名を省略したり、存在しない名前を指定すると、デフォルトの印刷設定が使用されます。印刷設定は、SVF Cloud Managerで作成します。

    詳細は、SVF Cloud Managerの『SVF Cloud 管理ガイド』を参照してください。

    timeout

    タイムアウト時間（秒）

    指定しない場合（または0以下の場合）は、処理の受付のみ行います。

    最大900秒（15分）まで指定できます。

    resource/{path}

    リソースデータ

    「{path}」部分に、印刷時に使用する画像データのパスを指定します。

    画像を出力するには、以下の作業が必要です。

    target

    出力ターゲット

    出力したPDFファイルをiA文書管理にアーカイブする場合、指定は必須です。

    「SPA_ARCHIVE」を指定します。

    参考

    「SPA」は、invoiceAgent 文書管理の旧名称です。

    target/spaFolder

    格納先フォルダー

    出力したPDFファイルをiA文書管理にアーカイブする場合、指定は必須です。

    格納先のiA文書管理上のフォルダーを指定します（例：/Users/local/User01/SC連携_受け取り）。

    target/overwrite

    同一ファイル名の上書きオプション

    出力したPDFファイルをiA文書管理にアーカイブする場合に、任意で指定します。

    アーカイブ先のフォルダーに同名の文書が存在する場合の動作を指定します。

    • true（デフォルト）

      ファイルを上書きしてアーカイブする

    • false

      異なるファイル名に変更（通し番号を符番）し、アーカイブする

    password

    パスワード

    PDFファイルを開くときにパスワード入力を求めるダイアログが表示されます。この指定により、PDFファイルの閲覧を許可する/しないなどの制限（セキュリティ）をかけることができます。パスワードには、32バイトまでの半角文字列を使用してください。2バイト文字などはAdobe Acrobat/Adobe Readerの仕様上、使用できません。

    注意

    PDFファイルをiA文書管理にアーカイブする場合は、パスワードが指定されていても自動で解除されます。

    参考

    権限パスワードと併用する場合は、必ず異なる文字列を指定してください。同じ文字列を指定すると、権限パスワードは設定されません。

    pdfPermPass

    権限パスワード

    Adobe Acrobat/Adobe Reader使用時に設定できる、各種セキュリティを変更するためのパスワードを指定します。

    この指定により、PDFのセキュリティ設定を変更して保護できます。パスワードには、32バイトまでの半角文字列を使用してください。2バイト文字などはAdobe Acrobat/Adobe Readerの仕様上、使用できません。

    参考

    PDFファイルを開くときのパスワードと併用する場合は、必ず異なるパスワードを指定してください。同じ文字列を指定すると、権限パスワードは設定されません。

    pdfPermPrint

    PDF印刷許可

    PDFの印刷許可を制御します。権限パスワードが指定されている必要があります。

    以下の値を指定できます。

    • none（デフォルト）

      印刷が許可されません。

    • low

      低解像度の印刷が許可されます。

    • high

      高解像度の印刷が許可されます。

    pdfPermModify

    PDF変更許可

    PDFの変更許可を制御します。権限パスワードが指定されている必要があります。

    以下の値を指定できます。

    • none（デフォルト）

      変更が許可されません。

    • assembly

      ページの挿入、削除、回転が許可されます。

    • fill

      フォームフィールドの入力と既存の署名フィールドに署名が許可されます。

    • annotation

      注釈の作成、フォームフィールドの入力と既存の署名フィールドに署名が許可されます。

    • all

      ページの抽出を除くすべての操作が許可されます。

    pdfPermCopy

    PDFコピー許可

    PDFのコピー許可を制御します。権限パスワードが指定されている必要があります。

    以下の値を指定できます。

    • false（デフォルト）

      コピーは許可されません。

    • true

      テキスト、画像、およびその他の内容のコピーを有効にします。

    参考

    この指定にかかわらず、スクリーンリーダーデバイスのテキストアクセスは常に有効になります。

    redirect

    リダイレクト動作

    PDFなど、ダウンロード可能なプリンターを指定した場合に、リダイレクトするかどうかを指定します。

    以下の値を指定できます。

    • false

      リダイレクトしません。

    • true

      リダイレクトします。

    参考

    • デフォルトの動作は、リダイレクトします。

    • ブラウザーからクロスオリジンでリクエストを行った場合（CORS）、自動的にリダイレクトすると、リダイレクト先でpreflightがされていないという理由で処理がブロックされます。その際はredirect=falseを指定し、明示的にリダイレクトを抑止した上で、レスポンスのLocationヘッダーでダウンロードを実行してください。

    inputTray

    給紙トレイ

    EMFで印刷時の給紙トレイを指定します。指定する値はプリンター情報の"inputTrays"のインデックス番号です。

    以下の"inputTrays"の例で、トレイ5(手差し)で印刷する場合は「6」を指定します。

    例 5. "inputTrays"の例
    "inputTrays":["プリンタの設定に従う","自動","トレイ1","トレイ2","トレイ3","トレイ4","トレイ5(手差し)"]


    useEudc

    外字ファイル利用

    外字ファイルを利用するかどうかを指定します。以下の値を指定できます。

    • false

      利用しない。

    • true

      利用する。

    外字は、Unicodeの私用領域のみマッピングされます。

    なお、外字を出力するためには弊社での設定が必要なため、サポートに問い合わせてください。

    adjust

    印字位置調整

    印字位置調整をミリ単位で指定します。

    X方向とY方向の値を、カンマ区切りで指定します。

    • 例

      • X方向とY方向を指定

        adjust=0.1,-0.2

      • X方向のみ指定

        adjust=-0.1,

      • Y方向のみ指定

        adjust=,0.2

    copies

    印刷部数

    部数を指定します。1～999の範囲で指定可能です。

    ファイルダウンロードの場合は無視されます。

    defaultSvfEncode

    デフォルトのSVFエンコード

    デフォルトのSVFエンコードを指定します。

    帳票レイアウトの拡張子が「xml」で、かつロケールが「英語」に指定されている場合に有効になります。また、CSVデータでSVFエンコードを指定している場合、ここでの指定内容は無視されます。

    指定する値は、出力する帳票の言語によって異なります。値の詳細は『SVF Cloud 管理ガイド』の「日本語以外の言語で帳票を出力したい」を参照してください。

    *1 帳票レイアウトを作成したツールによって、フィールドがないページの出力のされ方が異なります。詳細は『SVF Cloud 管理ガイド』の「帳票レイアウトを作成したい」の「Excelファイル出力の違い（SVF Cloud Designer、Microsoft Excel）」を参照してください。

  • リクエストヘッダー

    ヘッダーフィールド

    値

    説明

    Authorization

    Bearer {your access token}

    認証で取得したアクセストークンを指定します。



レスポンス

コード

説明

HTTP/1.1 202 Accepted

次のどちらかの処理が、正常に実行されたことを意味します。

  • ダイレクトプリント

    レスポンスヘッダーの「Location」に、印刷状況を問い合わせるURIが返されます。

  • 「printer」パラメーターにPDF、EXCEL、WORDのどれかを指定し、かつ「redirect」パラメーターにfalseを指定

    レスポンスヘッダーの「Location」に、ダウンロードを問い合わせるURIが返されます。

HTTP/1.1 303 See Other

処理が正常に実行されたことを意味します。「printer」パラメーターにPDF、EXCEL、WORDのどれかを指定し、かつ「redirect」パラメーターにtrueを指定した処理で発生します（「redirect」パラメーターの指定を省略した場合は、trueで動作します）。

レスポンスヘッダーの「Location」に、ダウンロードを問い合わせるURIが返されます。

HTTP/1.1 400 Bad Request

リクエスト内容が不正な場合に発生します。

HTTP/1.1 401 Unauthorized

認証情報が不正な場合に発生します。

HTTP/1.1 403 Forbidden

以下の場合に発生します。

  • 実行権限がない

  • 必要なポイントが足りない

HTTP/1.1 429 Too many Requests

APIコール数が閾値を超えた場合に発生します。レスポンスヘッダーの「Retry-After」に返された値の秒数経過後に、再度実行してください。

HTTP/1.1 503 Service Unavailable

同時に処理できる数の制限を超過した場合に発生します。しばらく時間を置いてから、再度実行してください。

成果物情報の取得

指定した成果物の情報を取得します。

例 6. エンドポイントのURI
https://api.svfcloud.com/v1/artifacts/{artifactId}


例 7. HTTPメソッド

GET



例 8. HTTPリクエストのAcceptヘッダー

application/json



例 9. パラメーター

  • パスのパラメーター

    パスパラメーター

    値

    必須

    説明

    artifactId

    成果物ID

    maru.png

    情報を取得する成果物のIDを指定します。

  • リクエストヘッダー

    ヘッダーフィールド

    値

    説明

    Authorization

    Bearer {your access token}

    認証で取得したアクセストークンを指定します。



レスポンス

コード

説明

HTTP/1.1 200 OK

正常に処理が実行されたことを意味します。

HTTP/1.1 401 Unauthorized

認証情報が不正な場合に発生します。

HTTP/1.1 404 Not Found

指定した成果物が存在しない場合に発生します。

HTTP/1.1 429 Too many Requests

APIコール数が閾値を超えた場合に発生します。レスポンスヘッダーの「Retry-After」に返された値の秒数経過後に、再度実行してください。

例 10. 出力例（JSON形式）
{
  "expiration": "2018-03-08T02:01:49.000Z",
  "id": "8149fed9-dadd-4678-af2d-da2ead6d656d",
  "name": "WingArc",
  "segment": "",
  "sourceType": "CSV",
  "user": {
    "id": "xxxx@api.svfcloud.com",
    "name": "帳票太郎"
  }
}

キー

内容

説明

id

成果物ID

成果物を識別するためのIDです。

name

成果物名

印刷時に指定した成果物名です。

expiration

期限日時

成果物の保存期限です。デフォルトで1日が指定されています。

user

ユーザー情報

成果物を作成したユーザー情報です。印刷時のJWTベアラートークンで指定したユーザーIDが適用されています。

sourceType

入力ソースタイプ

帳票生成の元となるデータのタイプです。

表に記載されていないキー項目は、現在未使用です。将来使用する目的で定義しています。



成果物のダウンロード

指定した成果物をダウンロードします。

例 11. エンドポイントのURI
https://api.svfcloud.com/v1/artifacts/{artifactId}


例 12. HTTPメソッド

GET



例 13. HTTPリクエストのAcceptヘッダー

application/octet-stream



例 14. パラメーター

  • パスのパラメーター

    パスパラメーター

    値

    必須

    説明

    artifactId

    成果物ID

    maru.png

    ダウンロードする成果物のIDを指定します。

  • クエリーパラメーター

    クエリーパラメーター

    値

    必須

    説明

    action

    アクションID

    maru.png

    アクションのIDを指定します。

    ticket

    ワンタイムチケット

    maru.png

    アクションに関連付けられたワンタイムチケット情報を指定します。

    timeout

    タイムアウト時間（秒）

    指定がない場合は、デフォルトで60秒です。最大900秒（15分）まで指定できます。

  • リクエストヘッダー

    ヘッダーフィールド

    値

    説明

    Authorization

    Bearer {your access token}

    認証で取得したアクセストークンを指定します。



レスポンス

コード

説明

HTTP/1.1 200 OK

正常に処理が実行されたことを意味します。レスポンスボディに成果物が返されます。

HTTP/1.1 303 See Other

正常に処理が実行されたことを意味します。レスポンスヘッダーの「Location」にダウンロードを問い合わせるURIが返されます。

HTTP/1.1 400 Bad Request

リクエスト内容が不正な場合に発生します。

HTTP/1.1 401 Unauthorized

認証情報が不正な場合に発生します。

HTTP/1.1 403 Forbidden

以下の場合に発生します。

  • 実行権限がない

  • 必要なポイントが足りない

HTTP/1.1 404 Not Found

指定した成果物が存在しない場合に発生します。

HTTP/1.1 408 Request Timeout

タイムアウト時間内に処理が完了しなかった場合に発生します。

HTTP/1.1 429 Too many Requests

APIコール数が閾値を超えた場合に発生します。レスポンスヘッダーの「Retry-After」に返された値の秒数経過後に、再度実行してください。

HTTP/1.1 503 Service Unavailable

有効なサービスプランまたはポイントが存在しない場合に発生します。

帳票イメージの取得

指定したページの帳票イメージを取得します。

なお、帳票レイアウトがXMLファイルの場合にのみ、指定できます。

例 15. エンドポイントのURI
https://api.svfcloud.com/v1/artifacts/{artifactId}/{page}


例 16. HTTPメソッド

GET



例 17. HTTPリクエストのAcceptヘッダー

image/png



例 18. パラメーター

  • パスのパラメーター

    パスパラメーター

    値

    必須

    説明

    artifactId

    成果物ID

    maru.png

    「印刷の実行」の際に、「printer」パラメーターにnullを指定した成果物のIDを指定します。

    page

    ページ番号

    maru.png

    イメージを取得するページ番号を指定します。

  • クエリーパラメーター

    クエリーパラメーター

    値

    必須

    説明

    timeout

    タイムアウト時間（秒）

    指定がない場合は、デフォルトで60秒です。最大900秒（15分）まで指定できます。

  • リクエストヘッダー

    ヘッダーフィールド

    値

    説明

    Authorization

    Bearer {your access token}

    認証で取得したアクセストークンを指定します。



レスポンス

コード

説明

HTTP/1.1 200 OK

正常に処理が実行されたことを意味します。

HTTP/1.1 400 Bad Request

リクエスト内容が不正な場合に発生します。

HTTP/1.1 401 Unauthorized

認証情報が不正な場合に発生します。

HTTP/1.1 403 Forbidden

以下の場合に発生します。

  • 実行権限がない

  • 必要なポイントが足りない

HTTP/1.1 404 Not Found

指定した成果物が存在しない場合に発生します。

HTTP/1.1 408 Request Timeout

タイムアウト時間内に処理が完了しなかった場合に発生します。

HTTP/1.1 429 Too many Requests

APIコール数が閾値を超えた場合に発生します。レスポンスヘッダーの「Retry-After」に返された値の秒数経過後に、再度実行してください。

HTTP/1.1 503 Service Unavailable

有効なサービスプランまたはポイントが存在しない場合に発生します。

: