ATataccama
Catalog Attributes

Unassign terms from attributes in batch

Unassign terms from catalog item attributes, regardless of whether they were assigned manually or by term detection.

To also add the unassigned terms to the attribute's denylist, so that term detection doesn't assign them again, set addToDenylist to true on the item. When omitted, the terms are only unassigned.

The request accepts a data array of 1 to 100 items, where each item names one attribute in attributeUrn and the terms to unassign from it in termUrns. Each item is processed independently: a failure on one item doesn't affect the other items. Results are returned in the same order as the request items, and each item can carry an optional id of your choice, which is returned in the corresponding result item.

An item fails with the status TERM_NOT_ASSIGNED when a term isn't assigned to the attribute.

post/catalog/v1/attributes/term-assignments/batch/unassign

Request

Request body

Example request

{
  "data": [
    {
      "id": "item-1",
      "attributeUrn": "urn:ata:acme-corp:catalog:catalog-attribute:7764f356-1b8c-43f4-8e15-651feacfca1d",
      "termUrns": [
        "urn:ata:acme-corp:catalog:term:1ede1262-f76b-4d00-9929-e92c15d8a5ba"
      ],
      "addToDenylist": true
    },
    {
      "id": "item-2",
      "attributeUrn": "urn:ata:acme-corp:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000",
      "termUrns": [
        "urn:ata:acme-corp:catalog:term:7c9e6679-7425-40de-944b-e07fc1f90ae7"
      ]
    }
  ]
}

Response

Batch request processed. The meta summary reports the totals (total, success, fail), and results reports the per-item outcomes in the same order as the request items. Each result reports its own status: OK when all terms in the item were processed. Any other value indicates failure and is accompanied by an error whose type matches the status.

The results don't return the attribute's assigned terms. To verify the outcome, retrieve the attribute with GET /catalog/v1/attributes/{urn}.

Example response

{
  "meta": {
    "total": 2,
    "success": 2
  },
  "results": [
    {
      "status": "OK"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.