Projektek és tartalom
Projektek listázása
A munkaterület projektjeinek (opcionális réteg a származás és fiókalapértékek kezelésére) és az aktív projektnek a listázása.
POST /studio-api/projects/listSzerződés ellenőrizve: · sha256:563d2d581da0ad29
Áttekintés
A munkaterület projektjeinek (opcionális réteg a származás és fiókalapértékek kezelésére) és az aktív projektnek a listázása.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
Hitelesítés és engedélyek
A token csak a tulajdonosa jogait használhatja. Minden kérés ellenőrzi a munkaterületi tagságot, erőforrás-tulajdonjogot, kiválasztott munkaterületeket és megadott képességeket. A core és full profil a megjelenített eszközöket változtatja; hozzáférést nem ad.
Kérésmezők
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező |
|
workspace_id | stringA szülőn belül kötelező |
|
limit | integerOpcionális / elem | Oldalméret: 1–100. A limit vagy cursor megadása kurzoros lapozásra váltja az útvonalat, és next_cursor értéket ad a válaszhoz.
|
cursor | stringOpcionális / elem | Átlátszatlan kurzor: az előző oldal next_cursor értéke, változtatás nélkül. Az első oldalnál hagyd ki. Minden oldallal ugyanazokat a szűrőket kell elküldeni.
|
include_version | booleanOpcionális / elem | Opcionális. A true az erőforrás verzióját is hozzáadja a válaszhoz. — |
Teljes 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)$"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Page size, 1 to 100. Sending limit or cursor switches this route to cursor paging and adds next_cursor to the answer."
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "Opaque cursor: the next_cursor of the previous page, unchanged. Omit it for the first page. The same filters must be sent with every page."
},
"include_version": {
"description": "Optional. true adds the resource version to the answer.",
"type": "boolean"
}
},
"required": [
"workspace_id"
],
"additionalProperties": false
}Válasz és befejezés
Sikeres HTTP-állapotok: 200. A művelet befejezésekor: synchronous_http_response.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező | — |
projects | arrayA szülőn belül kötelező | — |
projects[] | objectOpcionális / elem | — |
projects[].id | stringA szülőn belül kötelező |
|
projects[].workspace_id | stringA szülőn belül kötelező |
|
projects[].name | stringA szülőn belül kötelező |
|
projects[].operational_state | stringA szülőn belül kötelező |
|
projects[].lifecycle_version | integerA szülőn belül kötelező |
|
projects[].defaults_version | integerA szülőn belül kötelező |
|
projects[].archived_at | string | nullA szülőn belül kötelező | — |
projects[].archived_atanyOf 1 | stringA szülőn belül kötelező | — |
projects[].archived_atanyOf 2 | nullA szülőn belül kötelező | — |
projects[].archived_by | string | nullA szülőn belül kötelező | — |
projects[].archived_byanyOf 1 | stringA szülőn belül kötelező |
|
projects[].archived_byanyOf 2 | nullA szülőn belül kötelező | — |
projects[].archived_by_api_key_id | string | nullA szülőn belül kötelező | — |
projects[].archived_by_api_key_idanyOf 1 | stringA szülőn belül kötelező |
|
projects[].archived_by_api_key_idanyOf 2 | nullA szülőn belül kötelező | — |
projects[].created_at | stringA szülőn belül kötelező | — |
projects[].updated_at | stringA szülőn belül kötelező | — |
projects[].version | integerOpcionális / elem |
|
active_project_id | string | nullA szülőn belül kötelező | — |
active_project_idanyOf 1 | stringA szülőn belül kötelező |
|
active_project_idanyOf 2 | nullA szülőn belül kötelező | — |
next_cursor | string | nullOpcionális / elem | Csak akkor szerepel, ha a kérés limit vagy cursor értéket küldött. Az utolsó oldalon null. — |
next_cursoranyOf 1 | stringOpcionális / elem | — |
next_cursoranyOf 2 | nullOpcionális / elem | — |
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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)$"
},
"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)$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"operational_state": {
"type": "string",
"enum": [
"active",
"archived"
]
},
"lifecycle_version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"defaults_version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"archived_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"archived_by": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
},
"archived_by_api_key_id": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"workspace_id",
"name",
"operational_state",
"lifecycle_version",
"defaults_version",
"archived_at",
"archived_by",
"archived_by_api_key_id",
"created_at",
"updated_at"
]
}
},
"active_project_id": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
},
"next_cursor": {
"description": "Present only when the request sent limit or cursor. Null on the last page.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"projects",
"active_project_id"
]
}Hibák és biztonságos újrapróbálás
Ellenőrizd a HTTP-állapotot és a válasz törzsét. A 400 ellenőrzési hiba ZodError értéket tartalmazhat; a kezelőhibák az error, message és code mezőket használják. Őrizd meg a request_id vagy x-request-id értéket a diagnózishoz, hitelesítő adatok nélkül. Újrapróbálás előtt javítsd a 401/403 hozzáférési hibákat; 429 esetén kövesd a Retry-After értékét. Bizonytalan írás vagy 5xx válasz esetén előbb olvasd el a meglévő eredményt. Csak támogatott műveletnél használj újra idempotenciakulcsot; az újrapróbálás műveletenként eltér, és nem garantál pontosan egyszeri kézbesítést.
Hibaelhárítási útmutatóPéldák
A példák sémákkal ellenőrzött képzeletbeli értékeket használnak. Az azonosítókat engedélyezettekre, a médiát kész tartalomelemekre, a dátumokat megerősített közzétételi időpontra cseréld. Írás beküldése előtt ellenőrizd a fiók jogosultságát. Ez az oldal nem küld API-kérést.
A szervereden állítsd a SOSOAPI_ACCESS_TOKEN értékét a művelet által elfogadott hitelesítő adatra, és tartsd távol a böngészőkódtól. Ügynökhöz a sosoapi auth login paranccsal jelentkezz be böngészőben, és hagyd, hogy a CLI frissítse a hitelesítő adatokat.
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/projects/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/studio-api/projects/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 /studio-api/projects/list < request.jsonSzintetikus válaszpélda
{
"projects": [],
"active_project_id": null
}