Assemblies の一覧を取得する
認証済みの Workspace の Assemblies を一覧表示します。
https://api2.transloadit.com/ assembliesアカウントの Assemblies の一覧を取得します。作成日の降順で並べられます。
リクエスト例
curl が使えるサーバー側のシェルで、TRANSLOADIT_TOKEN に適切な Bearer トークンを設定して、このリクエストを実行してください。トークンが必要な場合は、以下の設定手順を展開してください。
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=assemblies:read')"; 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/assemblies" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: assemblies:read。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
クエリパラメーター
params(JSON 文字列)。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。署名付きリクエストでは必須です。Bearer トークンを使用する場合は、このフィールドを省略してください。
署名対象の params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params. | string結果を単一の Assembly ID に限定します。 検証パターン(正規表現)^[a-z0-9]{32}$ |
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | Assembly の一覧取得リクエスト用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params.必須 | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params.必須 | stringリクエストの認証に使用する Transloadit API キー |
params. | stringAssembly の作成日時(UTC)の下限を指定します。この日時より後の Assemblies のみが返されます。形式は |
params. | string | Array<string>検索式を 1 つ直接指定するか、各要素がカンマで結合される文字列配列として指定します。レンダリングされた検索式が空白のみではない場合、前後の空白を除去した後で 3 文字以上である必要があります。検索式は、Assembly ID または ID の先頭 6 文字、認識されるエラーコードのいずれかに一致するか、(Workspace で Assembly フィールド検索が有効な場合は)カスタムフィールドの名前または値に完全一致します。認識されるエラーコードがカスタムフィールドの名前または値にも一致する場合は、両方に一致する Assemblies のみが返されます。デフォルトではキーワードによるフィルタリングは行われません。 次のいずれかのスキーマが適用される場合があります: stringstring検証パターン(正規表現)^(?:[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*|[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[^\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff](?:[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]|[^\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff])+[^\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff][\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*)$Array<string>Array<string>配列要素のスキーマstring |
params. | string | integer各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
params. | "asc" | "desc"並べ替えの方向を指定します。デフォルトは |
params. | integer (デフォルト: 1, 最小値: 1, 最大値: 9007199254740991)現在のページネーションにおける現在のページを指定します。デフォルトは |
params. | integer (デフォルト: 50, 最小値: 1, 最大値: 5000)API リクエストごとに返す Assemblies の数を指定します。デフォルトは |
params. | string結果を特定のリージョンに限定します。省略した場合、空白文字のみの値を指定した場合、または 次のいずれかのスキーマが適用される場合があります: バリアント 1: stringstring検証パターン(正規表現)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*$バリアント 2: stringstring検証パターン(正規表現)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[A-Za-z0-9._-]{1,30}[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*$ |
params. | "created" | "created_ts" | "updated"結果の並べ替えに使用するフィールドを指定します。デフォルトは |
params. | stringTemplate ID または名前で結果を絞り込みます。Template のない Assemblies には |
params. | stringAssembly の作成日時(UTC)の上限を指定します。この日時より前に作成された Assemblies のみが返されます。 |
params. | string取得する Assemblies の種類を指定します。デフォルトは 指定可能な値 (10)
|
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.assembly_id, params.auth, params.fromdate, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.region, params.sort, params.template_id, params.todate, params.type
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.assembly_id, params.fromdate, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.region, params.sort, params.template_id, params.todate, params.type
| フィールド | 型と説明 |
|---|---|
params. | Assembly の一覧取得リクエスト用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
レスポンス
レスポンスボディの例を以下に示します:
{
"count": 50,
"items": [
{
"account_id": "7c91e50845204dea9ed4791f7d8440f1",
"created": "2023-02-11T16:04:22.000Z",
"created_ts": 1676131462,
"error": null,
"execution_duration": 2.337,
"execution_start": "2023-02-11T16:04:24.000Z",
"files": "[\"Saturn as seen from the Cas....jpg\"]",
"id": "195c60855fda4fb9a3b2f848374ca4e1",
"instance": "tam.transloadit.com",
"notify_url": null,
"ok": "ASSEMBLY_COMPLETED",
"parent_id": null,
"redirect_url": null,
"region": "eu-west-1",
"template_id": "40b0efc6b37f432dbe9485017b52a7b7",
"template_name": "my-template-1676131432311",
"warning_count": 0
},
{
"account_id": "7c91e50845204dea9ed4791f7d8440f1",
"created": "2023-02-11T16:04:04.000Z",
"created_ts": 1676131444,
"error": null,
"execution_duration": 6.275,
"execution_start": "2023-02-11T16:04:06.000Z",
"files": "[\"green grass fiels.jpg\",\"Morning Dew.jpg\",\"green leaf plant.jpg\"]",
"id": "72fc13f46db84fa1969d913ca8763de1",
"instance": "tam.transloadit.com",
"notify_url": null,
"ok": "ASSEMBLY_COMPLETED",
"parent_id": null,
"redirect_url": null,
"region": "eu-west-1",
"template_id": "40b0efc6b37f432dbe9485017b52a7b7",
"template_name": "my-template-1676131432311",
"warning_count": 0
}
]
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
count必須 | integer (最小値: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
items必須 | Array<object>配列要素のスキーマ
|
エラーレスポンス
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追加プロパティのスキーマ任意の値 |
HTTP 400
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
名前付きエラーと一般的なエラー形式
error: "ASSEMBLY_LIST_ERROR"
不正なパラメータです。
レスポンスには追加のフィールドが含まれる場合があります。