メディアとアセット
未登録アセットの一覧を取得
どのアセットレコードからも参照されていないワークスペース内の保存オブジェクトを、継続トークンでページ単位で取得します(ストレージ整理用)。オーナーのみ実行できます。
POST /assets-api/orphans/list契約確認日: · sha256:563d2d581da0ad29
概要
どのアセットレコードからも参照されていないワークスペース内の保存オブジェクトを、継続トークンでページ単位で取得します(ストレージ整理用)。オーナーのみ実行できます。
HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。
認証と権限
トークンは所有者の権利内でのみ使えます。各要求で所属、リソース所有権、選択ワークスペース、付与機能を確認します。coreとfullは表示だけを変え、アクセスは付与しません。
リクエストのフィールド
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド/分岐 | 型/必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 | — |
workspace_id | string親要素内で必須 |
|
object_continuation_token | string任意/項目 |
|
continuation_token | string任意/項目 |
|
limit | integer任意/項目 |
|
完全なJSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"object_continuation_token": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"continuation_token": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"limit": {
"default": 100,
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"required": [
"workspace_id"
]
}レスポンスと完了条件
成功時のHTTPステータス: 200. 操作完了時: synchronous_http_response.
HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド/分岐 | 型/必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 | — |
orphans | array親要素内で必須 | — |
orphans[] | object任意/項目 | — |
orphans[].key | string親要素内で必須 |
|
orphans[].kind | string | null親要素内で必須 | — |
orphans[].kindanyOf 1 | string親要素内で必須 |
|
orphans[].kindanyOf 2 | null親要素内で必須 | — |
orphans[].size | integer親要素内で必須 |
|
orphans[].lastModified | string親要素内で必須 | — |
orphans[].eligible_for_cleanup | boolean親要素内で必須 | — |
total | integer親要素内で必須 |
|
next_object_continuation_token | string | null親要素内で必須 | — |
next_object_continuation_tokenanyOf 1 | string親要素内で必須 | — |
next_object_continuation_tokenanyOf 2 | null親要素内で必須 | — |
continuation_token | string | null親要素内で必須 | — |
continuation_tokenanyOf 1 | string親要素内で必須 | — |
continuation_tokenanyOf 2 | null親要素内で必須 | — |
完全なJSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"orphans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 1
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"video",
"image",
"audio",
"cover",
"thumbnail",
"frame",
"video-source",
"branding"
]
},
{
"type": "null"
}
]
},
"size": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lastModified": {
"type": "string"
},
"eligible_for_cleanup": {
"type": "boolean"
}
},
"required": [
"key",
"kind",
"size",
"lastModified",
"eligible_for_cleanup"
]
}
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"next_object_continuation_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"continuation_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"orphans",
"total",
"next_object_continuation_token",
"continuation_token"
]
}エラーと安全な再試行
HTTPステータスとレスポンス本文を確認します。400の検証エラーにはZodErrorが含まれる場合があります。ハンドラーエラーはerror、message、codeを使用します。診断用にrequest_idまたはx-request-idを保持し、認証情報は含めないでください。401/403はアクセス問題を解消してから再試行し、429はRetry-Afterに従います。書き込み結果が不確か、または5xxの場合は、まず既存の結果を取得してください。冪等性キーは対応する操作でのみ再利用します。再試行の挙動は操作ごとに異なり、厳密に一回の配信は保証しません。
トラブルシューティングガイド例
スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。
サーバーのSOSOAPI_ACCESS_TOKENに操作が受け付ける認証情報を設定し、ブラウザーコードに含めないでください。エージェントはsosoapi auth loginでブラウザーログインし、CLIに更新を任せます。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/orphans/list" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/orphans/list", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /assets-api/orphans/list < request.json合成レスポンス例
{
"orphans": [],
"total": 0,
"next_object_continuation_token": null,
"continuation_token": null
}