Acceldata Asset Tags & Labels API

openapi: 3.2.0
info:
  title: Catalog Asset Tags & Labels API
  version: '1.0'
  description: API for managing the ADOC data catalog, including assets, asset metadata, tags, labels, sampling, lineage, and watched assets, as well as data reliability policies (data quality, reconciliation, data drift, schema drift, and related rule types) and their executions. Covers discovering and searching assets, retrieving asset configuration and activity, and creating, scheduling, and running policies against catalog assets.
tags:
- name: Asset Tags & Labels
paths:
  /catalog-server/api/assets/{id}/tags:
    get:
      operationId: getAssetTagsById
      tags:
      - Asset Tags & Labels
      summary: Get tags for an asset
      description: 'This endpoint retrieves the tags associated with an asset.


        **Authorization**: requires `ASSET_VIEW` and `TAGS_VIEW` (feature permission).


        ### Response


        Returns `AssetTagResponse` containing the list of tags linked to the asset.'
      parameters:
      - name: id
        in: path
        description: Asset ID
        required: true
        schema:
          type: integer
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of asset tags
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetTagResponse'
  /catalog-server/api/assets/{id}/tag:
    post:
      operationId: addAssetTag
      tags:
      - Asset Tags & Labels
      summary: Add a tag to an asset
      description: 'This endpoint is used to add a tag to a specific asset by making an HTTP POST request to the provided URL.


        **Authorization**: requires `ASSET_VIEW` and `TAGS_CREATE` (feature permission).


        #### Request Body


        The request body should be in raw JSON format (`AssetTagRequest`) and include one of:


        - `name` (string): The name of the tag to be added to the asset.

        - `id` (number): The ID of an existing tag to associate with the asset.


        #### Response


        Upon a successful request, the response will include the following parameters:


        - `assetId` (number): The ID of the asset.

        - `autoTagged` (boolean): Indicates if the asset was auto-tagged.

        - `domains` (array): An array of domains.

        - `id` (number): The ID of the tag.

        - `name` (string): The name of the tag.

        - `protectedData` (boolean): Indicates if the data is protected.

        - `state` (string): The state of the tag.

        - `tagId` (number): The ID of the tag.

        - `tenantId` (null): The ID of the tenant.

        - `uid` (null): The unique identifier.


        > If autotagging is not enabled and an asset lacks a tag, the POST Add Tags method can be used to create tags for the asset.'
      parameters:
      - name: id
        in: path
        description: Asset ID
        required: true
        schema:
          type: integer
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      requestBody:
        description: 'Tag to associate with the asset (`name` or `id` required). Schema: `AssetTagRequest`.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetTagRequest'
      responses:
        '200':
          description: Tag association result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetTag'
  /catalog-server/api/assets/{id}/tag/{tagId}:
    delete:
      operationId: deleteAssetTag
      tags:
      - Asset Tags & Labels
      summary: Remove a tag from an asset
      description: 'This endpoint removes the specified tag associated with an asset using the provided `tagId`.


        **Authorization**: requires `ASSET_VIEW` and `TAGS_MODIFY` (feature permission).


        ### Response


        Returns `true` when the tag was removed successfully.'
      parameters:
      - name: id
        in: path
        description: Asset ID
        required: true
        schema:
          type: integer
      - name: tagId
        in: path
        description: Tag ID to remove
        required: true
        schema:
          type: integer
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Tag removal result
          content:
            application/json:
              schema:
                type: boolean
  /catalog-server/api/assets/{id}/labels:
    put:
      operationId: updateAssetLabels
      tags:
      - Asset Tags & Labels
      summary: Update asset labels
      description: 'This endpoint is used to add, delete, or update labels for a specific asset identified by its `ID`.


        **Authorization**: requires `ASSET_VIEW` and `TAGS_MODIFY` (feature permission).


        ### Request Body


        The request body should contain a JSON object with a "labels" key, which is an array of label objects. Each label object should have a "key" and "value" field. These fields are used to specify the key-value pairs for the labels to be added, deleted, or updated.


        - `labels`: An array of label objects, where each object contains the following fields:

        - `key`: Specifies the type or category of information (e.g., "Confidentiality").

        - `value`: Provides specific details or levels within that category (e.g., "High", "Medium", "Low").


        ### Response


        Returns the updated list of `Label` objects for the asset.'
      parameters:
      - name: id
        in: path
        description: Asset ID
        required: true
        schema:
          type: integer
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      requestBody:
        description: 'Label update request. Schema: `AssetLabelRequest`.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetLabelRequest'
      responses:
        '200':
          description: Updated labels
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Label'
    get:
      operationId: getAssetLabels
      tags:
      - Asset Tags & Labels
      summary: Get asset labels
      description: 'This endpoint returns all the labels associated with an asset based on the asset''s `ID`.


        **Authorization**: requires `ASSET_VIEW` and `TAGS_VIEW` (feature permission).


        ### Response


        Returns a list of `Label` key/value pairs for the asset.'
      parameters:
      - name: id
        in: path
        description: Asset ID
        required: true
        schema:
          type: integer
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Asset labels
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Label'
components:
  schemas:
    AssetLabelRequest:
      type: object
      title: io.ad.catalog.api.model.AssetLabelRequest
      required:
      - labels
      properties:
        labels:
          type: array
          items:
            $ref: '#/components/schemas/Label'
    TagDomain:
      type: object
      title: io.ad.catalog.api.model.tags.TagDomain
      required:
      - createdAt
      - name
      properties:
        createdAt:
          $ref: '#/components/schemas/DateTime'
        createdBy:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        id:
          type: integer
        lastUpdatedBy:
          type:
          - string
          - 'null'
        name:
          type: string
        updatedAt:
          oneOf:
          - $ref: '#/components/schemas/DateTime'
          - type: 'null'
    Label:
      type: object
      title: io.ad.catalog.api.model.Label
      required:
      - key
      - value
      properties:
        key:
          type: string
        labelType:
          type:
          - string
          - 'null'
          enum:
          - ASSET
          - RULE
          - DQ_RULE_ITEM
          - RECONCILIATION_COLUMN_MAPPING
          - POLICY_TEMPLATE_MEASURE
          - USER_DEFINED_FUNCTION
        value:
          type: string
    DateTime:
      type: object
      title: org.joda.time.DateTime
    AssetTag:
      type: object
      title: io.ad.catalog.api.model.AssetTag
      required:
      - assetId
      - autoTagged
      - domains
      - name
      - state
      properties:
        assetId:
          type: integer
        autoTagged:
          type: boolean
        domains:
          type: array
          items:
            $ref: '#/components/schemas/TagDomain'
        id:
          type: integer
        name:
          type: string
        protectedData:
          type: boolean
        state:
          type: string
          enum:
          - ACCEPTED
          - REJECTED
          - REMOVED
        tagId:
          type: integer
        tenantId:
          type:
          - string
          - 'null'
        uid:
          type:
          - string
          - 'null'
    AssetTagRequest:
      type: object
      title: io.ad.catalog.api.model.AssetTagRequest
      properties:
        id:
          type: integer
        name:
          type:
          - string
          - 'null'
    AssetTagResponse:
      type: object
      title: io.ad.catalog.api.model.AssetTagResponse
      required:
      - assetTags
      properties:
        assetTags:
          type: array
          items:
            $ref: '#/components/schemas/AssetTag'