# 封存報表定義

Canonical URL: https://sosoapi.ai/zh-hant/docs/mcp/archive-report-definition

`sosoapi_archive_report_definition`

以 editor 或以上角色，按 workspace_id、id 同最新讀取嘅 expected_version 封存報表定義；版本衝突要先重讀，唔好覆寫其他成員更改。封存唔等於刪除平台數據，亦唔會更新來源或產生報表檔案。

## Profiles 及連接方式

Profiles: full

Transports: stdio, http

Profile 只影響工具可見性，不會授予權限。HTTP 不提供本機檔案上傳。SOSOAPI_OUTPUT_SCHEMAS=1 會宣告輸出 schema；兩種模式均會回傳 structured results。

## 權限及改動

MCP annotations 只提供工具發現提示，並非存取控制保證；實際呼叫仍須通過登入、角色、資源及能力檢查。

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

`/analytics-api/reporting/definitions/archive` — agent:operate; synchronous_http_response

## 輸入欄位

```json
{
  "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
}
```

## 結構化輸出

此 schema 描述成功工具結果的 structuredContent。MCP envelope 亦包括 content，失敗時可能設定 isError；請勿將文字收據或已接受的請求視為平台終態。權限及重試規則請參閱對應的 API 操作。

```json
{
  "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
}
```

## 工具呼叫範例

以下虛構值已按 contract 驗證，並非真實帳戶 ID、憑證或發佈紀錄。請以已授權範圍回傳的 ID、已準備完成的素材及已審核排程取代，並在寫入前核對平台資格。此頁不會呼叫 API。

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

structuredContent

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

## 對應 API 操作

- [/analytics-api/reporting/definitions/archive](https://sosoapi.ai/zh-hant/docs/api/analytics-api-reporting-definitions-archive)