アクションの種類
一般的なユースケース
- 画像をインポートします。画像ファイルを分割された状態でもロードし、そのチェックサムを取得します。
- 処理中の任意の時点で元のページ画像を取得します。
- バッチ、ドキュメント、ページの添付ファイルを操作します (アップロードとダウンロード) 。
- 検証タスクの XML 記述を取得し、ドキュメントを変更して、変更内容をサーバーに保存します。
大きな添付ファイルには、POST リクエストを使用します。大きなファイルは小さな部分に分割され、サーバーにアップロードされます。POST リクエストを使用して object に添付ファイルを追加する場合は、POST リクエストの後に SaveAttachment メソッドを呼び出し、転送したファイル名を
file パラメーターに指定した長さ 0 のファイルを渡してください。それ以外の場合は、添付ファイル専用に用意された Attachments メソッドを使用してください。リクエスト パラメーター
リクエストの各フィールドが正しく設定されていることを確認してください。
型
objectType パラメーターでは、次の値を指定できます。
型
8 (タスク添付ファイル) は、大容量の添付ファイルに最適です。それ以外の場合は、添付ファイル専用の Attachments メソッドを使用してください。型
13 のファイルでは、projectId と batchId をどちらも 0 に設定します。これらのファイルは、どのプロジェクト、バッチ、テナントにも属しません。この型のファイルを書き込むには、管理者がセッションを開始する必要があります。この型のファイルを読み取る場合は、sessionId=0 を渡してください。セッションを開始する必要はありません。ストリーム名
streamName Parameter は、バイナリストリームの名前です。ファイルをサーバーに保存する場合は Base64 エンコードを使用し、サーバーからファイルをロードする場合は UrlEncode エンコードを使用します。使用できる値は、オブジェクトの型によって異なります。
ページストリーム名
Document ストリーム名
タスクストリーム名
Verification— 検証タスクを記述する XML ドキュメントです。タスクを Web Station 用に準備する際に作成されます。検証後、ドキュメント内の変更が処理されます。バージョンはサポートされていないため、versionパラメーターを1に設定してください。タスクの処理結果はこのファイルに保存します。VerificationRequest— 次のいずれかのリクエストに対応します。- 文書分割やページの並べ替えを含む、バッチ内で操作を実行するためのリクエストを含む XML ドキュメントです。この種のリクエストは、ルールチェックのために Web Station で使用されます。
- ルーティングリクエストを含む XML ドキュメントです。
LineItemsの外挿リクエストを含む XML ドキュメントです。- データ検証リクエストを含む XML ドキュメントです。
ファイルストレージ
<object type>-<object id>-<stream name>version の形式で、型、オブジェクト識別子、およびストリーム名が埋め込まれています。
ページファイル (objectType = 1) には画像のコピーが含まれ、ドキュメントファイル (objectType = 0) には元の画像が含まれます。そのため、objectType = 1 を指定した POST リクエスト では画像を変更できません。
リクエスト例
サーバーからファイルをロードする
id=4、streamName=C:\Temp\image.pdf、version=184201843 のページファイル (objectType = 1) をサーバーからロードするには、次の POST リクエストを使用します。
サーバーにファイルを保存する
id=4、projectId=3、batchId=6、version=522、streamName=C:\Temp\image.pdf のドキュメント (objectType = 0) をサーバーに保存するには、次の POST リクエストを使用します。