トランザクション
トランザクション命令を発行します。
ファイルのアップロード、ダウンロード実行前および実行後にトランザクションAPIを利用することで、オブジェクト（ファイル）の排他制御を行い、安全なファイル転送を実現することができます。
(1) 必要な権限
Transact APIを使用するには以下の権限が必要です。
1. アップロード時
-
ファイルのアップロード権限
2. ダウンロード時
-
ファイルのダウンロード権限
上記の権限に加えて、リクエストで指定したオブジェクトに対するアクセス権が必要です。
(2) リクエストURL
http(s)://Domain:xxxx/コンテキスト名/Transact
(3) リクエストインタフェース
|
項目名 |
説明 |
文字 |
省略 |
省略値 |
||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
object_id |
オブジェクトID 排他対象となるファイルのオブジェクトIDを16バイトで指定します。 |
半角 |
○ |
ブランク parent_object_idおよびnameを省略した場合は省略不可 |
||||||
|
command |
トランザクション命令
|
半角 |
× |
|
||||||
|
transact_type |
トランザクション種別
|
半角 |
× |
|
||||||
|
parent_object_id |
親オブジェクトID 対象ファイルの親オブジェクトID（ファイルが格納されるフォルダ）を16バイトで指定します。 |
半角 |
○ |
ブランク object_idを省略した場合は省略不可 |
||||||
|
name |
オブジェクト名 対象ファイルの名前を255バイトで指定します。 |
混在 |
○ |
ブランク object_idを省略した場合は省略不可 |
||||||
|
operation_id |
処理識別子 当該トランザクションの識別子を34バイトで指定します。 |
半角 |
○ |
commandがbeginの場合のみ省略可 |
||||||
|
option1 |
オプション1（*1） 255バイト以内で指定します。 |
混在 |
○ |
ブランク |
||||||
|
option2 |
オプション2（*1） 255バイト以内で指定します。 |
混在 |
○ |
ブランク |
||||||
|
option3 |
オプション3（*1） 255バイト以内で指定します。 |
混在 |
○ |
ブランク |
|
*1 |
: |
command（トランザクション命令）が“begin”の場合のみ指定できます。 |
オブジェクトIDを指定した場合、親オブジェクトIDとファイル名の指定は無視されます。
(4) レスポンスインタフェース
|
項目名 |
説明 |
備考 |
||||
|---|---|---|---|---|---|---|
|
object_id |
オブジェクトID 排他対象となるファイルのオブジェクトIDを返却します。 |
|
||||
|
operation_id |
処理識別子 当該トランザクションの識別子を返却します。 |
|
||||
|
hash_value |
データ検証値（*1）
|
|
||||
|
size |
ファイルサイズ（*1）
|
|
|
*1 |
: |
command（トランザクション命令）が“begin”の場合のみ返却します。 |
|
*2 |
: |
DBに登録されたデータではなく、テンポラリフォルダに出力されたデータのハッシュ値およびファイルサイズです。転送前フォルダイベントが実行された場合は、イベント完了後の値となります。 |
|
*3 |
: |
アップロード時にデータ検証を行った場合のみ、hash_valueに値が返却されます。 |