> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/deployment/ja/to/vision-events/get-custom-metadata-schema.md).

# カスタムメタデータスキーマを取得する

## 概要

このエンドポイントは、以下全体で使用されているカスタムメタデータフィールドを返します [Vision Events](/deployment/ja/to/vision-events.md) 特定の [ユースケース](/deployment/ja/to/vision-events/use-cases.md)。カスタムメタデータは固定スキーマではなくイベントごとに定義されるため、これを使って、作成する前にどのフィールドが存在し、その型が何であるかを確認してください [イベントクエリ](/deployment/ja/to/vision-events/query-events.md) またはダッシュボードフィルター。

## HTTP API

特定のユースケースにおいてイベントで使用されたカスタムメタデータフィールドのスキーマを取得します。これは、フィルタリングに利用できるメタデータフィールドを見つけるのに役立ちます [クエリリクエスト](/deployment/ja/to/vision-events/query-events.md#http-api).

**必要なスコープ:** `vision-events:read` または `device:read`

{% openapi src="/files/934e54fa9aa57656316a422a76238b867f081de5" path="/vision-events/custom-metadata-schema/{useCaseId}" method="get" %}
[openapi.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-dfdc1702ad3d1a62ad0a661e9609f6bbe2fc8d4c%2Fopenapi.yaml?alt=media)
{% endopenapi %}

### パスパラメータ

* **`:useCaseId`** (文字列、必須): ユースケースID。

### リクエスト例

```bash
curl "https://api.roboflow.com/vision-events/custom-metadata-schema/a1b3c8e1" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### レスポンス例

{% tabs %}
{% tab title="200" %}

```json
{
  "fields": {
    "production_line": {
      "types": ["string"]
    },
    "temperature": {
      "types": ["number"]
    },
    "is_overtime": {
      "types": ["boolean"]
    }
  }
}
```

以下の各フィールド `フィールド` オブジェクトには次が含まれます:

* **`型`** (文字列の配列): このフィールドで観測されたデータ型。各要素は次のいずれかです `文字列`, `数値`、または `boolean`。異なるイベントで同じキーに異なる型が使用されていた場合、1つのフィールドに複数の型が含まれることがあります。
  {% endtab %}

{% tab title="403" %}

```json
{
  "error": "このリソースに対する権限が不十分です。"
}
```

{% endtab %}
{% endtabs %}

## Python SDK

特定のユースケースにおいてイベントで使用されたカスタムメタデータフィールドを見つけます。これは、クエリを作成する際に役立ちます `customMetadataFilters`.

```python
import roboflow

roboflow.login()

rf = roboflow.Roboflow()
ws = rf.workspace()

schema = ws.get_vision_event_metadata_schema("a1b3c8e1")

for field, info in schema["fields"].items():
    print(f"{field}: {info['types']}")
```

レスポンスには〜が含まれます `フィールド` 見つかった各フィールド名をその観測された型に対応付ける辞書（例: `["string"]`, `["number"]`）。この情報を使って、イベントをクエリする際に型付きフィルターを構築できます [イベントをクエリする際](/deployment/ja/to/vision-events/query-events.md#python-sdk):

```python
page = ws.query_vision_events(
    "a1b3c8e1",
    customMetadataFilters=[
        {"field": "temperature", "operator": "gt", "value": 70, "type": "number"}
    ],
)
```

詳細は次を参照してください [REST APIリファレンス](#http-api).