Japanese (日本語) - Change language

ファイルでの作業

ファイルをアプリケーションサーバーと交換するには、POSTリクエストを使用します。

APIを使用するには、最初にウェブサービスに接続する必要があります。

アクションの型。

POSTリクエストを使って、以下のアクションを実行できます:

  • サーバーからファイルを読み込む (Action = Load)
  • サーバーでファイルを保存する (Action = Save)
  • ファイルの終わりにデータを追加する (Action = Append)
  • サーバーからファイルのチェックサムを取得する (チェックサムはCRC32方法で計算) (Action = Checksum)

可能な使用

  1. 画像をインポート。画像ファイルを部分的にも読み込み、チェックサムを取得します。
  2. 好きな時に元のページ画像を取得。
  3. バッチ、文書、ページの添付を操作 (アップロード/ダウンロード)。
    注:大きな添付物で作業する場合は、POSTリクエストを使用します。大きなファイルは小さな部分に分割され、サーバーにアップロードされます。POSTリクエストを使用してオブジェクトに添付物を追加した場合は、POSTリクエスト後にSaveAttachment方法を呼び出します。SaveAttachment方法のファイルパラメータとして、転送されたファイルの名前のある長さ0のファイルが渡されます。
    これ以外の場合では、添付物を扱うために特別に開発された方法を使用することが推奨されます。
  4. 検証タスクのXML記述を取得、この文書を変更、サーバーで変更を保存。

パラメータを要求

注:要求フィールドが正しく入力されていることを確認します。

名前 記述
Action string

アクションの型。可能な値:

  • Loadは、サーバーからファイルを読み込みます
  • Saveは、サーバーでファイルを保存します
  • Appendは、サーバーでデータを既存のファイルに追加します
  • Checksumは、サーバーからファイルのチェックサムを要求します、チェックサムはCRC32方法で計算されます
sessionID int セッションID (ユーザーの権限確認に使用されます)
projectId int プロジェクトID
BatchId int バッチID
objectType int

サーバーにおけるオブジェクトの型。可能な値

  • 0 文書
  • 1 ページ
  • 5 サムネイルとして表示されるページの小さなコピー、PNGファイル
  • 8 タスク添付 (XML文書)
    注:大きな添付を操作する時に効率的です。または、添付を扱うために特別に開発された方法を使用することが推奨されます。
  • 13 すべてのユーザーがアクセス可能なファイル (エンドユーザー使用許諾契約など)
    注: この型のファイルでは、ProjectId=0およびBatchId=0、すなわち特定のプロジェクト、バッチ、またはテナントに属していません。この型のファイルを書き込むには、管理者はセッションを開く必要があります。この型のファイルを読み込むには、sessionid=0を渡します (セッションを開く必要はありません)。
objectId int オブジェクトID (文書、ページ、タスクのID)
ParentId int

親文書のID

注:パラメータは文書セットに対して指定されます。セットの一部ではない文書の場合、推奨値は0です。

version int ファイルバージョン
streamName string

ファイルをサーバーに保存する時のBase64エンコードのバイナリストリーム、またはファイルをサーバーから読み込む時のUrlEncodeエンコードのバイナリストリームの名前。可能な値

ページ用:

  • BlackWhiteImage ページの白黒画像、PNGファイル
  • ColorImage ページのカラー画像、JPGファイル
  • Preview ページプレビュー画像、PNGファイル

文書用:

  • DocumentBody 文書フィールドを記述するXML文書。ウェブステーションのタスクを準備する時に作成されます。文書の変更が検証後に処理されます。バージョンはサポートされておらず、バージョンパラメータは0に設定します。文書処理結果をこのファイルに保存します。
  • PagepageID、ここではpageIDはAddNewPage方法に返されるページID。このストリーム名は、前処理の前にソースページの画像をアップロードするために使用できます。
  • FileName、ここではFileNameはAddNewDocument方法で文書を作成する時に指定するファイル名。このストリーム名は、文書ページの画像のある多ページファイルをアップロードするために使用できます。
  • RecognizedWords 認識された単語とページでのその座標を含むXML文書。

タスク用:

  • Verification 検証タスクを記述するXML文書。ウェブステーションのタスクを準備する時に作成されます。文書の変更が検証後に処理されます。バージョンはサポートされておらず、バージョンパラメータは1に設定します。タスク処理結果をこのファイルに保存します。
  • VerificationRequest 以下のリクエストに対応します:
    • 文書区切りやページの再配置など、バッチ内での操作の実行要求が含まれているXML文書。特に、この要求の型はウェブステーションによって規則確認に使用されます。
    • 転送リクエストが含まれているXML文書
    • LineItems外挿リクエストが含まれているXML文書
    • データ検証要求が含まれているXML文書
blob バイナリファイルデータ (アクションパラメータが保存または添付に設定されている場合)
offset int ファイルの先頭からデータを添付する場所までのオフセット (アクションパラメータが添付に設定されている場合)

ファイルストレージには、プロジェクトのすべてのファイルが含まれています。ファイル名には、以下のフォームで、オブジェクト型、その識別子、ストリームの名前に関する情報が含まれます。<object type>-<object id>-<stream name>バージョン。

ページ (objectType = 1) のファイルには画像のコピーが含まれ、文書ファイル (objectType = 0) にはソース画像が含まれます。従って、POSTリクエストとパラメータobjectType = 1を使用して画像を変更することはできません。

例の要求

サーバーからのファイルの読み込み

サーバーでファイルを保存

POSTリクエストの例についての詳細は、を参照してください。

11/10/2020 12:08:06 PM


Please leave your feedback about this article