Ataccama

Ataccama Catalog API

The Catalog API from Ataccama — 13 operation(s) for catalog.

GitHub OpenAPI

Operations 16

POST /api/catalog/v1/attributes/term-assignments/batch/{batchid} POST /api/catalog/v1/attributes/term-assignments/batch/assign #
POST /api/catalog/v1/attributes/term-assignments/denylist/batch/{batchid} POST /api/catalog/v1/attributes/term-assignments/denylist/batch/add #
POST /api/catalog/v1/catalog-items/filter POST /api/catalog/v1/catalog-items/filter #
GET /api/catalog/v1/documentation-flow/configurations GET /api/catalog/v1/documentation-flow/configurations #
POST /api/catalog/v1/documentation-flow/start POST /api/catalog/v1/documentation-flow/start #
POST /api/catalog/v1/entities/batch/{batchid} POST /api/catalog/v1/entities/batch/create #
GET /api/catalog/v1/metadata-model/entities GET /api/catalog/v1/metadata-model/entities #
GET /api/catalog/v1/metadata-model/entities/businessTerm GET /api/catalog/v1/metadata-model/entities/businessTerm #
POST /api/catalog/v1/stewardship/batch/manage POST /api/catalog/v1/stewardship/batch/manage #
POST /api/catalog/v1/stewardship/manage POST /api/catalog/v1/stewardship/manage #
GET /api/catalog/v1/{v1id} GET /api/catalog/v1/attributes #
POST /api/catalog/v1/{v1id} POST /api/catalog/v1/catalog-items #
DELETE /api/catalog/v1/{v1id}/{urn} DELETE /api/catalog/v1/catalog-items/{urn} #
GET /api/catalog/v1/{v1id}/{urn} GET /api/catalog/v1/attributes/{urn} #
PATCH /api/catalog/v1/{v1id}/{urn} PATCH /api/catalog/v1/attributes/{urn} #
POST /catalog/v1/attributes/term-assignments/batch/assign The REST API is currently in Early Access Preview #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ataccama/refs/heads/main/openapi/ataccama-catalog-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ataccama/refs/heads/main/json-schema/ataccama-patch-api-data-quality-v1-catalog-items-catalogitemurn-dq-monitors-dqm-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ataccama/refs/heads/main/json-schema/ataccama-get-api-catalog-v1-metadata-model-entities-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ataccama/refs/heads/main/json-schema/ataccama-get-api-catalog-v1-v1-id-urn-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ataccama/refs/heads/main/json-schema/ataccama-get-api-catalog-v1-metadata-model-entities-businessterm-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ataccama/refs/heads/main/json-schema/ataccama-patch-api-data-quality-v1-rules-ruleurn-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ataccama/refs/heads/main/json-schema/ataccama-post-api-catalog-v1-v1-id-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ataccama-catalog-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ataccama-catalog-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ataccama Catalog API
  version: '2026-09-26'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-09-26: 32 operation(s) read from 18 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Ataccama has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 73
    documentation: -41
    pages-with-code: 16
    pages-read: 18
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-09-26'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/rest-api-overview.html
  - https://community.ataccama.com/master-data-management-reference-data-management-92
  - https://docs.ataccama.com/one/latest/one-apis/api-requests-authentication.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/api-authentication.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/urn-reference.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/catalog-items-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/folders-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/term-assignments-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/sources-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/stewardship-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/documentation-flow-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/generic-metadata-entities-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/metadata-model-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/set-up-dq-rules-and-monitors-via-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/run-dq-evaluation-from-pipelines.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/retrieve-dq-results-api.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/move-dq-rules-and-monitors-between-environments.html
  - https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/manage-dq-rules-via-api.html
servers:
- url: https://<keycloak
security:
- bearer: []
tags:
- name: Catalog
paths:
  /api/catalog/v1/attributes/term-assignments/batch/{batchid}:
    post:
      operationId: post_api_catalog_v1_attributes_term_assignments_batch_batchid
      tags:
      - Catalog
      summary: POST /api/catalog/v1/attributes/term-assignments/batch/assign
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/term-assignments-api.html
      parameters:
      - name: batchid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCatalogV1AttributesTermAssignmentsBatchBatchidRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCatalogV1AttributesTermAssignmentsBatchBatchidRespons'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://{your-environment}.ataccama.one/api/catalog/v1/attributes/term-assignments/batch/assign\"  -H \"Authorization: Bearer {access_token}\"  -H \"Content-Type: application/json\"  -d '{\n \"data\": [\n {\n \"id\": \"item-1\",\n \"attributeUrn\": \"urn:ata:{your-tenant}:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000\",\n \"termUrns\": [\n \"urn:ata:{your-tenant}:catalog:term:3fa85f64-5717-"
        collapsed_from: 2 example path(s) differing only at batchId
  /api/catalog/v1/attributes/term-assignments/denylist/batch/{batchid}:
    post:
      operationId: post_api_catalog_v1_attributes_term_assignments_denylist_batch_batchid
      tags:
      - Catalog
      summary: POST /api/catalog/v1/attributes/term-assignments/denylist/batch/add
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/term-assignments-api.html
      parameters:
      - name: batchid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCatalogV1AttributesTermAssignmentsDenylistBatchBatchi'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCatalogV1AttributesTermAssignmentsDenylistBatchBatchi2'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://{your-environment}.ataccama.one/api/catalog/v1/attributes/term-assignments/denylist/batch/add\"  -H \"Authorization: Bearer {access_token}\"  -H \"Content-Type: application/json\"  -d '{\n \"data\": [\n {\n \"id\": \"item-1\",\n \"attributeUrn\": \"urn:ata:{your-tenant}:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000\",\n \"termUrns\": [\n \"urn:ata:{your-tenant}:catalog:term:7c9e6679"
        collapsed_from: 2 example path(s) differing only at batchId
  /api/catalog/v1/catalog-items/filter:
    post:
      operationId: post_api_catalog_v1_catalog_items_filter
      tags:
      - Catalog
      summary: POST /api/catalog/v1/catalog-items/filter
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/catalog-items-api.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCatalogV1CatalogItemsFilterRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://{your-environment}.ataccama.one/api/catalog/v1/catalog-items/filter\"  -H \"Authorization: Bearer {access_token}\"  -H \"Content-Type: application/json\"  -d '{\n \"filter\": {\n \"name\": {\n \"contains\": \"customer\"\n }\n }\n }' \n Query parameters \n Parameter \n Type \n Required \n Description \n after \n string \n No \n Cursor for forward pagination. \n size \n integer \n No \n Number of catalog item"
  /api/catalog/v1/documentation-flow/configurations:
    get:
      operationId: get_api_catalog_v1_documentation_flow_configurations
      tags:
      - Catalog
      summary: GET /api/catalog/v1/documentation-flow/configurations
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/documentation-flow-api.html
      parameters:
      - name: size
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogV1DocumentationFlowConfigurationsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://{your-environment}.ataccama.one/api/catalog/v1/documentation-flow/configurations?size=20\"  -H \"Authorization: Bearer {access_token}\" \n Query parameters \n Parameter \n Type \n Required \n Description \n after \n string \n No \n Cursor for forward pagination. \n size \n integer \n No \n Number of configurations to return. \n Default: 20 . \n Max: 100 . \n Response example \n {\n \"meta\": {\n \"nex"
  /api/catalog/v1/documentation-flow/start:
    post:
      operationId: post_api_catalog_v1_documentation_flow_start
      tags:
      - Catalog
      summary: POST /api/catalog/v1/documentation-flow/start
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/documentation-flow-api.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCatalogV1DocumentationFlowStartRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCatalogV1DocumentationFlowStartResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://{your-environment}.ataccama.one/api/catalog/v1/documentation-flow/start\"  -H \"Authorization: Bearer {access_token}\"  -H \"Content-Type: application/json\"  -d '{\n \"configurationUrn\": \"urn:ata:{your-tenant}:catalog:documentation-flow-configuration:123e4567-e89b-12d3-a456-426614174000\",\n \"connectionUrn\": \"urn:ata:{your-tenant}:processing:connection:b812d964-f94e-4be7-85c3-0073742"
  /api/catalog/v1/entities/batch/{batchid}:
    post:
      operationId: post_api_catalog_v1_entities_batch_batchid
      tags:
      - Catalog
      summary: POST /api/catalog/v1/entities/batch/create
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/generic-metadata-entities-api.html
      parameters:
      - name: batchid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCatalogV1EntitiesBatchBatchidRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCatalogV1EntitiesBatchBatchidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://{your-environment}.ataccama.one/api/catalog/v1/entities/batch/create\"  -H \"Authorization: Bearer {access_token}\"  -H \"Content-Type: application/json\"  -d '{\n \"data\": [\n {\n \"id\": \"item-1\",\n \"concreteType\": \"businessTerm\",\n \"parentProperty\": \"terms\",\n \"properties\": {\n \"name\": \"PII\",\n \"abbreviation\": \"PII\"\n }\n },\n {\n \"id\": \"item-2\",\n \"concreteType\": \"businessTerm\",\n \"parentPrope"
        collapsed_from: 3 example path(s) differing only at batchId
  /api/catalog/v1/metadata-model/entities:
    get:
      operationId: get_api_catalog_v1_metadata_model_entities
      tags:
      - Catalog
      summary: GET /api/catalog/v1/metadata-model/entities
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/metadata-model-api.html
      parameters:
      - name: searchQuery
        in: query
        required: false
        schema:
          type: string
      - name: size
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogV1MetadataModelEntitiesResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://{your-environment}.ataccama.one/api/catalog/v1/metadata-model/entities?searchQuery=term&size=20\"  -H \"Authorization: Bearer {access_token}\" \n Query parameters \n Parameter \n Type \n Required \n Description \n after \n string \n No \n Cursor for forward pagination.\nWhen omitted, the list starts at the beginning. \n size \n integer \n No \n Number of entity definitions to return. \n Default"
  /api/catalog/v1/metadata-model/entities/businessTerm:
    get:
      operationId: get_api_catalog_v1_metadata_model_entities_businessTerm
      tags:
      - Catalog
      summary: GET /api/catalog/v1/metadata-model/entities/businessTerm
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/metadata-model-api.html
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogV1MetadataModelEntitiesBusinesstermResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://{your-environment}.ataccama.one/api/catalog/v1/metadata-model/entities/businessTerm\"  -H \"Authorization: Bearer {access_token}\" \n Path parameters \n Parameter \n Type \n Required \n Description \n name \n string \n Yes \n The entity-type identifier, matching the name field of the entity definition.\nFor example: term , businessTerm , catalogItem . \n Response example \n {\n \"name\": \"busin"
  /api/catalog/v1/stewardship/batch/manage:
    post:
      operationId: post_api_catalog_v1_stewardship_batch_manage
      tags:
      - Catalog
      summary: POST /api/catalog/v1/stewardship/batch/manage
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/stewardship-api.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCatalogV1StewardshipBatchManageRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCatalogV1StewardshipBatchManageResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://{your-environment}.ataccama.one/api/catalog/v1/stewardship/batch/manage\"  -H \"Authorization: Bearer {access_token}\"  -H \"Content-Type: application/json\"  -d '{\n \"data\": [\n {\n \"id\": \"item-1\",\n \"entityUrn\": \"urn:ata:{your-tenant}:catalog:catalog-item:fde84300-7a83-4d24-8c88-30ada80b0b54\",\n \"groupUrn\": \"urn:ata:{your-tenant}:iam:group:7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"pre"
  /api/catalog/v1/stewardship/manage:
    post:
      operationId: post_api_catalog_v1_stewardship_manage
      tags:
      - Catalog
      summary: POST /api/catalog/v1/stewardship/manage
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/stewardship-api.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCatalogV1StewardshipManageRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCatalogV1StewardshipManageResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://{your-environment}.ataccama.one/api/catalog/v1/stewardship/manage\"  -H \"Authorization: Bearer {access_token}\"  -H \"Content-Type: application/json\"  -d '{\n \"entityUrn\": \"urn:ata:{your-tenant}:catalog:catalog-item:fde84300-7a83-4d24-8c88-30ada80b0b54\",\n \"groupUrn\": \"urn:ata:{your-tenant}:iam:group:7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"previousStewardAccessLevel\": \"viewMetada"
  /api/catalog/v1/{v1id}:
    get:
      operationId: get_api_catalog_v1_v1id
      tags:
      - Catalog
      summary: GET /api/catalog/v1/attributes
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/catalog-items-api.html
      parameters:
      - name: v1id
        in: path
        required: true
        schema:
          type: string
      - name: size
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogV1V1IdResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://{your-environment}.ataccama.one/api/catalog/v1/attributes?size=20\"  -H \"Authorization: Bearer {access_token}\" \n Query parameters \n Parameter \n Type \n Required \n Description \n after \n string \n No \n Cursor for forward pagination. \n size \n integer \n No \n Number of catalog item attributes to return. \n Default: 20 . \n Max: 100 . \n catalogItemUrn \n string \n No \n Filter attributes by"
        collapsed_from: 5 example path(s) differing only at v1Id
    post:
      operationId: post_api_catalog_v1_v1id
      tags:
      - Catalog
      summary: POST /api/catalog/v1/catalog-items
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/catalog-items-api.html
      parameters:
      - name: v1id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCatalogV1V1IdRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCatalogV1V1IdResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://{your-environment}.ataccama.one/api/catalog/v1/catalog-items\"  -H \"Authorization: Bearer {access_token}\"  -H \"Content-Type: application/json\"  -d '{\n \"type\": \"dslQueryCatalogItem\",\n \"name\": \"high_value_customers\",\n \"description\": \"Customers with a lifetime value over 10k\",\n \"connectionUrn\": \"urn:ata:{your-tenant}:processing:connection:b812d964-f94e-4be7-85c3-0073742ade09\",\n \""
        collapsed_from: 4 example path(s) differing only at v1Id
  /api/catalog/v1/{v1id}/{urn}:
    delete:
      operationId: delete_api_catalog_v1_v1id_urn
      tags:
      - Catalog
      summary: DELETE /api/catalog/v1/catalog-items/{urn}
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/catalog-items-api.html
      parameters:
      - name: v1id
        in: path
        required: true
        schema:
          type: string
      - name: urn
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiCatalogV1V1IdUrnResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X DELETE \"https://{your-environment}.ataccama.one/api/catalog/v1/catalog-items/{urn}\"  -H \"Authorization: Bearer {access_token}\" \n The response returns the HTTP status code 204 No Content on success. \n Complete example \n Here’s a complete example using cURL to work with catalog items: "
        collapsed_from: 4 example path(s) differing only at v1Id
    get:
      operationId: get_api_catalog_v1_v1id_urn
      tags:
      - Catalog
      summary: GET /api/catalog/v1/attributes/{urn}
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/catalog-items-api.html
      parameters:
      - name: v1id
        in: path
        required: true
        schema:
          type: string
      - name: urn
        in: path
        required: true
        schema:
          type: string
      - name: properties
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogV1V1IdUrnResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://{your-environment}.ataccama.one/api/catalog/v1/attributes/{urn}\"  -H \"Authorization: Bearer {access_token}\" \n Path parameters \n Parameter \n Type \n Required \n Description \n urn \n string \n Yes \n URN identifier of the catalog item attribute.\nFor example: urn:ata:{your-tenant}:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000 . \n Query parameters \n Parameter \n Type \n "
        collapsed_from: 5 example path(s) differing only at v1Id
    patch:
      operationId: patch_api_catalog_v1_v1id_urn
      tags:
      - Catalog
      summary: PATCH /api/catalog/v1/attributes/{urn}
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/catalog-items-api.html
      parameters:
      - name: v1id
        in: path
        required: true
        schema:
          type: string
      - name: urn
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiCatalogV1V1IdUrnRequest'
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchApiCatalogV1V1IdUrnResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X PATCH \"https://{your-environment}.ataccama.one/api/catalog/v1/attributes/{urn}\"  -H \"Authorization: Bearer {access_token}\"  -H \"Content-Type: application/json\"  -d '{\n \"description\": \"Primary email address of the customer\",\n \"extraProperties\": {\n \"isPii\": true,\n \"sensitivity\": \"HIGH\"\n }\n }' \n Request body fields \n Field \n Type \n Required \n Description \n description \n string or null \n No \n "
        collapsed_from: 5 example path(s) differing only at v1Id
  /catalog/v1/attributes/term-assignments/batch/assign:
    post:
      operationId: post_catalog_v1_attributes_term_assignments_batch_assign
      tags:
      - Catalog
      summary: The REST API is currently in Early Access Preview
      x-source: https://docs.ataccama.com/ataccama-one-agentic/latest/rest-api/move-dq-rules-and-monitors-between-environments.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiCatalogV1V1IdResponse:
      type: object
      properties:
        next:
          type: string
        total:
          type: integer
    GetApiCatalogV1V1IdUrnResponse:
      type: object
      properties:
        urn:
          type: string
        name:
          type: string
        dataType:
          type: string
        columnType:
          type: string
        description:
          type: string
        catalogItemUrn:
          type: string
        termAssignments:
          type: array
          items:
            type: object
            properties:
              termUrn:
                type: string
              source:
                type: string
        termDetectionDenylist:
          type: array
          items:
            type: object
            properties:
              termUrn:
                type: string
        effectiveCriticality:
          type: object
          properties:
            isCritical:
              type: boolean
        extraProperties:
          type: object
          properties:
            isPii:
              type: boolean
            sensitivity:
              type: string
    GetApiCatalogV1MetadataModelEntitiesBusinesstermResponse:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        nodePaths:
          type: array
          items:
            type: string
        superEntities:
          type: array
          items:
            type: string
        subEntities:
          type: array
          items: {}
        properties:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              description:
                type: string
              type:
                type: string
              scalarType:
                type: string
              editable:
                type: boolean
        editable:
          type: boolean
    GetApiCatalogV1DocumentationFlowConfigurationsResponse:
      type: object
      properties:
        meta:
          type: object
          properties:
            next:
              type: string
            total:
              type: integer
        data:
          type: array
          items:
            type: object
            properties:
              urn:
                type: string
              name:
                type: string
              description:
                type: string
              configuration:
                type: string
    PatchApiCatalogV1V1IdUrnResponse:
      type: object
      properties:
        next:
          type: string
        total:
          type: integer
    PostApiCatalogV1CatalogItemsFilterRequest:
      type: object
      properties:
        filter:
          type: object
          properties:
            name:
              type: object
              properties:
                contains:
                  type: string
    PostApiCatalogV1StewardshipManageRequest:
      type: object
      properties:
        entityUrn:
          type: string
        groupUrn:
          type: string
        previousStewardAccessLevel:
          type: string
    PostApiCatalogV1StewardshipManageResponse:
      type: object
      properties:
        entityUrn:
          type: string
        effectiveStewardship:
          type: object
          properties:
            groupUrn:
              type: string
            originUrn:
              type: string
    DeleteApiCatalogV1V1IdUrnResponse:
      type: object
      properties:
        total:
          type: integer
        success:
          type: integer
        fail:
          type: integer
    PostApiCatalogV1StewardshipBatchManageResponse:
      type: object
      properties:
        total:
          type: integer
        success:
          type: integer
        fail:
          type: integer
    PostApiCatalogV1AttributesTermAssignmentsBatchBatchidRequest:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              attributeUrn:
                type: string
              termUrns:
                type: array
                items:
                  type: string
    PostApiCatalogV1StewardshipBatchManageRequest:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              entityUrn:
                type: string
              groupUrn:
                type: string
              previousStewardAccessLevel:
                type: string
    PostApiCatalogV1EntitiesBatchBatchidResponse:
      type: object
      properties:
        total:
          type: integer
        success:
          type: integer
        fail:
          type: integer
    PostApiCatalogV1DocumentationFlowStartResponse:
      type: object
      properties:
        workflowUrn:
          type: string
    PatchApiCatalogV1V1IdUrnRequest:
      type: object
      properties:
        description:
          type: string
        extraProperties:
          type: object
          properties:
            isPii:
              type: boolean
            sensitivity:
              type: string
    PostApiCatalogV1AttributesTermAssignmentsBatchBatchidRespons:
      type: object
      properties:
        total:
          type: integer
        success:
          type: integer
        fail:
          type: integer
    PostApiCatalogV1AttributesTermAssignmentsDenylistBatchBatchi:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              attributeUrn:
                type: string
              termUrns:
                type: array
                items:
                  type: string
    PostApiCatalogV1V1IdRequest:
      type: object
      properties:
        type:
          type: string
        name:
          type: string
        description:
          type: string
        connectionUrn:
          type: string
        query:
          type: string
        folderUrn:
          type: string
    PostApiCatalogV1AttributesTermAssignmentsDenylistBatchBatchi2:
      type: object
      properties:
        total:
          type: integer
        success:
          type: integer
        fail:
          type: integer
    PostApiCatalogV1V1IdResponse:
      type: object
      properties:
        urn:
          type: string
        name:
          type: string
        description:
          type: string
        connection:
          type: object
          properties:
            urn:
              type: string
        folders:
          type: array
          items:
            type: object
            properties:
              urn:
                type: string
              name:
                type: string
        source:
          type: object
          properties:
            urn:
              type: string
    PostApiCatalogV1EntitiesBatchBatchidRequest:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              concreteType:
                type: string
              parentProperty:
                type: string
              properties:
                type: object
                properties:
                  name:
                    type: string
                  abbreviation:
                    type: string
    PostApiCatalogV1DocumentationFlowStartRequest:
      type: object
      properties:
        configurationUrn:
          type: string
        connectionUrn:
          type: string
    GetApiCatalogV1MetadataModelEntitiesResponse:
      type: object
      properties:
        meta:
          type: object
          properties:
            next:
              type: string
            total:
              type: integer
        data:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              description:
                type: string
              nodePaths:
                type: array
                items:
                  type: string
              superEntities:
                type: array
                items:
                  type: string
              subEntities:
                type: array
                items: {}
              properties:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    description:
                      type: string
                    type:
                      type: string
                    scalarType:
                      type: string
                    editable:
                      type: boolean
              editable:
                type: boolean
  securitySchemes:
    bearer:
      type: http
      scheme: bearer