---
title: "Collection Framework Metadata"
method: POST
path: "/v2/framework/metadata"
tags: ["Framework"]
---

# Collection Framework Metadata

`POST /v2/framework/metadata`

## Request body

- BodyCollectionFrameworkMetadataV2FrameworkMetadataPost
  - `frameworks` FrameworkRequest[], required
    - `entities` union, required
      - FrameworkEntityRequest[]
        - `carc_id` integer, required
        - `representation` string, required
        - `entity_name` string, nullable
      - WildCardEntityRequest
        - `carc_name` string
        - `representation` string, required
    - `insight` FrameworkInsightRequest, required
      - `insight_id` integer, required
      - `insight_name` string, nullable
    - `filters` object, required
    - `aggregate` 'sum' | 'mean' | 'count_distinct', nullable
    - `events` FrameworkEventRequest[], nullable
      - `event_id` string, nullable
      - `representation` string, required
      - `event_name` string, nullable
      - `event_category_id` union
        - integer
        - string
  - `config` object, nullable

## Response `200`

Successful Response

- FrameworkCollectionResponse
  - `total_price` number, required
  - `number_of_frameworks` integer, required
  - `frameworks` FrameworkMetadataResponse[], required
    - `id` string, uuid, nullable
    - `name` string, nullable
    - `payload` FrameworkRequest, required
      - `entities` union, required
        - FrameworkEntityRequest[]
          - `carc_id` integer, required
          - `representation` string, required
          - `entity_name` string, nullable
        - WildCardEntityRequest
          - `carc_name` string
          - `representation` string, required
      - `insight` FrameworkInsightRequest, required
        - `insight_id` integer, required
        - `insight_name` string, nullable
      - `filters` object, required
      - `aggregate` 'sum' | 'mean' | 'count_distinct', nullable
      - `events` FrameworkEventRequest[], nullable
        - `event_id` string, nullable
        - `representation` string, required
        - `event_name` string, nullable
        - `event_category_id` union
          - integer
          - string
    - `refreshed_date` string, nullable, required
    - `reinstated_date` string, nullable, required
    - `reinstatement_reason` 'Ontology Change' | 'Full Refresh' | 'Vendor Reinstatement' | 'Vendor Backfill' | 'Logic Enhancement', required
    - `ontology_version` string, required
    - `price` number, required
    - `table_max_date` string, nullable, required
    - `columns` SchemaColumn[], nullable
      - `col_name` string, required
      - `data_type` string, required
    - `data_type` string[], nullable
    - `message` string, nullable
    - `latest_framework_id` string, uuid, nullable
    - `is_superseded` boolean

## Other responses

- `404` — Not Found
- `422` — Validation Error

---

[API](https://skmtc.net/carbonarc/apis/carbon-arc-api-documentation.md) · [All operations](https://skmtc.net/carbonarc/apis/carbon-arc-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/carbonarc/carbon-arc-api-documentation/revisions/bd33ea42994c/schema)