Jelentésdefiníció archiválása

Profilok és átviteli módok

Profilok: full · Átviteli módok: stdio, http

A core vagy full profillal szabályozhatod a kliens által látható eszközöket; ez nem változtat engedélyt. Helyi fájlfeltöltéshez stdio kell, HTTP-n nem elérhető. A SOSOAPI_OUTPUT_SCHEMAS=1 kimeneti sémákat ad a felderítéshez. Az eszközök e beállítással és nélküle is strukturált eredményt adnak.

Engedélyek és mellékhatások

A jelölések segítenek a kliensnek leírni az eszközt. Minden hívás továbbra is ellenőrzi a felhasználó hitelesítését, szerepkörét, erőforrás-hozzáférését és képességengedélyeit.

{
  "readOnlyHint": false,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

• /analytics-api/reporting/definitions/archive: agent:operate · synchronous_http_response

Bemeneti mező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.

{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "expected_version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    }
  },
  "required": [
    "workspace_id",
    "id",
    "expected_version"
  ],
  "additionalProperties": false
}

Strukturált kimenet

Ez a séma egy sikeres eszközeredmény structuredContent mezőjét írja le. Az MCP-válasz content mezőt is tartalmaz, és sikertelen hívásnál isError értéket állíthat be. Közzétételnél a bejegyzés végső eredményét olvasd el; ne tekintsd az elfogadott kérést vagy szöveges választ megerősítésnek. A kapcsolódó API-művelet ismerteti az engedélyeket és újrapróbálási szabályokat.

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.

{
  "type": "object",
  "properties": {
    "archived": {
      "type": "boolean",
      "const": true
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    }
  },
  "required": [
    "archived",
    "id",
    "version"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Példa eszközhívás

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.

{
  "name": "sosoapi_archive_report_definition",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "id": "11111111-1111-4111-8111-111111111111",
    "expected_version": 1
  }
}

structuredContent

{
  "archived": true,
  "id": "11111111-1111-4111-8111-111111111111",
  "version": 1
}

Mögöttes API-műveletek

• /analytics-api/reporting/definitions/archive