ファイルでの作業
ファイルをアプリケーションサーバーと交換するには、POSTリクエストを使用します。
APIを使用するには、最初にウェブサービスに接続する必要があります。
アクションの型。
POSTリクエストを使って、以下のアクションを実行できます:
- サーバーからファイルを読み込む (Action = Load)
- サーバーでファイルを保存する (Action = Save)
- ファイルの終わりにデータを追加する (Action = Append)
- サーバーからファイルのチェックサムを取得する (チェックサムはCRC32方法で計算) (Action = Checksum)
可能な使用
- 画像をインポート。画像ファイルを部分的にも読み込み、チェックサムを取得します。
- 好きな時に元のページ画像を取得。
- バッチ、文書、ページの添付を操作 (アップロード/ダウンロード)。
注:大きな添付物で作業する場合は、POSTリクエストを使用します。大きなファイルは小さな部分に分割され、サーバーにアップロードされます。POSTリクエストを使用してオブジェクトに添付物を追加した場合は、POSTリクエスト後にSaveAttachment方法を呼び出します。SaveAttachment方法のファイルパラメータとして、転送されたファイルの名前のある長さ0のファイルが渡されます。
これ以外の場合では、添付物を扱うために特別に開発された方法を使用することが推奨されます。 - 検証タスクのXML記述を取得、この文書を変更、サーバーで変更を保存。
パラメータを要求
注:要求フィールドが正しく入力されていることを確認します。
名前 | 型 | 記述 |
Action | string |
アクションの型。可能な値:
|
sessionID | int | セッションID (ユーザーの権限確認に使用されます) |
projectId | int | プロジェクトID |
BatchId | int | バッチID |
objectType | int |
サーバーにおけるオブジェクトの型。可能な値
|
objectId | int | オブジェクトID (文書、ページ、タスクのID) |
ParentId | int |
親文書のID 注:パラメータは文書セットに対して指定されます。セットの一部ではない文書の場合、推奨値は0です。 |
version | int | ファイルバージョン |
streamName | string |
ファイルをサーバーに保存する時のBase64エンコードのバイナリストリーム、またはファイルをサーバーから読み込む時のUrlEncodeエンコードのバイナリストリームの名前。可能な値 ページ用:
文書用:
タスク用:
|
blob | バイナリファイルデータ (アクションパラメータが保存または添付に設定されている場合) | |
offset | int | ファイルの先頭からデータを添付する場所までのオフセット (アクションパラメータが添付に設定されている場合) |
ファイルストレージには、プロジェクトのすべてのファイルが含まれています。ファイル名には、以下のフォームで、オブジェクト型、その識別子、ストリームの名前に関する情報が含まれます。<object type>-<object id>-<stream name>バージョン。
ページ (objectType = 1) のファイルには画像のコピーが含まれ、文書ファイル (objectType = 0) にはソース画像が含まれます。従って、POSTリクエストとパラメータobjectType = 1を使用して画像を変更することはできません。
例の要求
サーバーからのファイルの読み込み
サーバーでファイルを保存
POSTリクエストの例についての詳細は、例を参照してください。
4/12/2024 6:16:06 PM