ストレージ内のアセットを一覧表示
Workspace のアセットを、安定した識別子と現在のバージョンのメタデータを含めて、件数に上限のあるページ単位で一覧表示します。
https://api2.transloadit.com/ dam/ assets認証済みの Workspace 内にある現在のライブアセットのメタデータを、アセットのバイト列をダウンロードせずに返します。
同じ prefix を指定し、next_cursor を cursor として渡して、次のページを読み取ります。next_cursor が null になったら終了してください。各ページのサイズには上限があり、一連のページはスナップショットを構成しません。同時に行われる移動、書き込み、削除によって、後続のページが変わることがあります。
返されたアセット ID とバージョン ID は、保存して /transloadit/import で使用できます。ディレクトリの境界を指定するには、prefix の末尾にスラッシュを付けてください。たとえば、photos ではなく photos/ を使用します。
リクエスト例
サーバー側のシェルで 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:read 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 GET --get \
--url "https://api2.transloadit.com/dam/assets" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={"prefix":"photos/","limit":100}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: dam:read, dam:write。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
クエリパラメーター
params(JSON 文字列)。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。署名付きリクエストでは必須です。Bearer トークンを使用する場合は、このフィールドを省略してください。
署名対象の params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | ストレージのメタデータリクエスト用の 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, 最大長: 512)前のレスポンスの next_cursor から取得した不透明な継続値です。ページング中は同じ prefix を維持してください。最初のページでは省略してください。 |
params. | integer (デフォルト: 100, 最小値: 1, 最大値: 500)1 ページあたりのアセットの最大数。デフォルトは 100 で、最大 500 まで指定できます。next_cursor が null になるまで、next_cursor をたどってください。 |
params. | string | integer各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
params. | string (デフォルト: "", 最大長: 512)大文字と小文字を区別して、このプレフィックスで始まる現在のアセットパスのみを一覧表示します。デフォルト値は空で、Workspace 全体が対象になります。ディレクトリ境界を指定するには、末尾にスラッシュを付けてください。 |
params. | string (最小長: 1, 最大長: 255)大文字と小文字およびアクセントの違いを区別せず、ファイル名にこのテキストを含むアセットのみを一覧表示します。1 つのディレクトリとその配下全体を検索するには、prefix と組み合わせてください。ページを切り替える際も、同じ検索条件を維持してください。 |
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.auth, params.cursor, params.limit, params.nonce, params.prefix, params.search
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.cursor, params.limit, params.nonce, params.prefix, params.search
| フィールド | 型と説明 |
|---|---|
params. | ストレージのメタデータリクエスト用の 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 パス(例: 検証パターン(正規表現)^\/[^?#]*$ |
レスポンス
レスポンスボディの例を以下に示します:
{
"assets": [
{
"asset_id": "AAAAAAAAAAAAAAAAAAAAAA",
"height": 600,
"mime": "image/jpeg",
"path": "renamed.jpg",
"size": 12345,
"version_id": "AAAAAAAAAAAAAAAAAAAAAQ",
"width": 800,
"workspace": "example-workspace"
}
],
"message": "The Storage assets were successfully listed.",
"next_cursor": null,
"ok": "DAM_ASSETS_LISTED",
"workspace": "example-workspace"
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには、このオブジェクトについて記載されているフィールドのみが含まれます。
| フィールド | 型と説明 | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
assets必須 | Array<object>配列要素のスキーマ
| ||||||||||||||||||||||||||
message必須 | string (最小長: 1) | ||||||||||||||||||||||||||
next_cursor必須 | null | string | ||||||||||||||||||||||||||
ok必須 | string (常に: "DAM_ASSETS_LISTED") | ||||||||||||||||||||||||||
workspace必須 | string (最小長: 1)このアセットを所有する Workspace のスラッグ。このアセットを読み取る、または管理する際は、同じ Workspace に対して認証してください。 |
エラーレスポンス
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追加プロパティのスキーマ任意の値 |