# レポート定義をアーカイブ

正規URL： https://sosoapi.ai/ja/docs/mcp/archive-report-definition

`sosoapi_archive_report_definition`

レポート定義をアーカイブ。指定された確認済みデータセットとバージョンを使用し、ソースは自動更新しません。 レンダリング入力は sosoapi report render --output FILE にパイプで渡せます。

## プロファイルと通信方式

プロファイル： full

通信方式： stdio, http

coreまたはfullで表示ツールを選べますが権限は変わりません。ローカルアップロードはstdioのみでHTTPは非対応です。SOSOAPI_OUTPUT_SCHEMAS=1で検出時に出力スキーマを含めます。設定に関係なく構造化結果を返します。

## 権限と副作用

注釈はクライアントがツールを説明するためのものです。各呼び出しでは引き続き認証、ロール、リソースアクセス、機能権限を確認します。

```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
}
```

## 構造化された出力

このスキーマは、成功時のツール結果に含まれるstructuredContentを説明します。MCPレスポンスは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
}
```

## ツール呼び出しの例

スキーマ確認済みの架空値の例です。認可された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/ja/docs/api/analytics-api-reporting-definitions-archive)