ストレージ内のファイルまたはフォルダーを移動
保持されているアセットまたはバージョンの識別子を変更せずに、パスを指定してファイルまたはフォルダーを移動します。
https://api2.transloadit.com/ dam/ entries/ moveこのエンドポイントはアルファ版です。URL、パラメーター、レスポンス、動作が大幅に変更され、既存の連携が動作しなくなる可能性があります。
Workspace からの相対パスを指定して、既存のファイルやフォルダーを移動または名前変更します。移動先の親フォルダーは、すでに存在している必要があります。移動先がすでに使用されている場合、操作は拒否されます。フォルダーが暗黙的にマージされることはありません。
移動元がフォルダーの場合は、末尾に / を付けてください。レスポンスは、正規化された移動先パスを返します。フォルダーの場合は末尾のスラッシュも含まれます。ネイティブの移動では、移動したフォルダー内のファイルも含め、アセットとバージョンの ID が保持されます。以前に保存したパス参照は、最新の状態を反映しなくなります。
これはカタログ操作であり、S3 でのコピーと削除ではありません。保存されているバイト列を保持し、置き換え用のアセット識別情報の作成を回避します。
リクエスト例
curl が使えるサーバー側のシェルで、適切な Bearer トークン を TRANSLOADIT_TOKEN に設定して、このリクエストを実行してください。トークンが必要な場合は、以下のセットアップを展開してください。
Bearer トークンが必要ですか?
curl と jq が使える信頼できるサーバー側のシェルで、TRANSLOADIT_KEY と TRANSLOADIT_SECRET に、それぞれ Auth Key と Auth Secret を設定してください。両方の認証情報と生成されたトークンを秘密に保ち、このセットアップをブラウザーのコードで実行しないでください。
まず、このエンドポイントで必要なスコープを持つトークンを作成します。Auth Key には、それらのスコープがすでに付与されている必要があります。
if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
--request POST \
--url 'https://api2.transloadit.com/token' \
--user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'aud=api2' \
--data-urlencode 'scope=dam:write')"; then
printf '%s\n' "$TOKEN_RESPONSE" >&2
exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
jq -er '.access_token | strings | select(length > 0)')" || exit 1
このシェルを開いたまま、以下のリクエストを実行してください。トークンが有効な間は再利用してください。
curl --fail-with-body -sS --request POST \
--url "https://api2.transloadit.com/dam/entries/move" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={"source":"photos/old.jpg","destination":"photos/new.jpg"}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: dam:write。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
フォームフィールド
コンテンツタイプ: application/x-www-form-urlencoded
params(JSON 文字列)、必須。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。署名付きリクエストでは必須です。Bearer トークンを使用する場合は、このフィールドを省略してください。
params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | DAM の変更操作に使用する Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params.必須 | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params.必須 | stringリクエストの認証に使用する Transloadit API キー |
params. | "DELETE" | "GET" | "PATCH" | "POST"これらの署名済み params が認可するリクエストの HTTP メソッド。大文字で指定します。すべての署名付きリクエストで、 |
params. | string (最大長: 2048)これらの署名付き params が認可するリクエストの URL パス(例: 検証パターン(正規表現)^\/[^?#]*$ |
params.必須 | string (最小長: 1, 最大長: 513)source と同じ種類の、新しい Workspace 相対パスです。フォルダーパスの末尾にはスラッシュを付けてください。移動先がすでに使用されている場合、上書きやマージは行われず、操作が拒否されます。 |
params. | string | integer各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
params.必須 | string (最小長: 1, 最大長: 513)既存のファイルまたはフォルダーのパス(Workspace からの相対パス)。フォルダーのパスの末尾にはスラッシュを付けてください。ネイティブの移動では、アセット ID とバージョン ID が保持されます。 |
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.auth, params.destination, params.nonce, params.source
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.destination, params.nonce, params.source
| フィールド | 型と説明 |
|---|---|
params. | DAM の変更操作に使用する Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
params. | "DELETE" | "GET" | "PATCH" | "POST"これらの署名済み params が認可するリクエストの HTTP メソッド。大文字で指定します。すべての署名付きリクエストで、 |
params. | string (最大長: 2048)これらの署名付き params が認可するリクエストの URL パス(例: 検証パターン(正規表現)^\/[^?#]*$ |
レスポンス
レスポンスボディの例を以下に示します:
{
"message": "The Storage file or folder was successfully moved.",
"ok": "DAM_ENTRY_MOVED",
"path": "photos/new.jpg"
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには、このオブジェクトについて記載されているフィールドのみが含まれます。
エラーレスポンス
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
assembly_id | string |
error | string (最小長: 1) |
http_code | number | string
|
message | string人が読んで理解できる形式のエラー説明です。文言は変わる場合があるため、特定の失敗を処理する際は |
reason | null | string | number | boolean | Array<任意の値> | object次のいずれかのスキーマが適用される場合があります: nullstringnumberbooleanArray<任意の値>Array<任意の値>配列要素のスキーマ任意の値objectobject追加プロパティのスキーマ任意の値 |