ATataccama
Stewardship

Manage stewardship of entities in batch

Change the stewardship of up to 100 entities in one call.

Each item carries its own entity, group, and access level, so a single request can transfer different entities to different groups.

Each item accepts the same fields and behaves the same way as a single-entity request: the entity is shared with the new stewardship group, the previous stewardship group keeps access only at the access level given in previousStewardAccessLevel, stewardship overrides are removed where needed, and the change is published immediately. Omitting groupUrn leaves that entity's assigned stewardship unchanged.

Each item is processed independently: a failure on one item, for example, because the entity doesn't exist or you don't have access to it, doesn't affect the other items.

Results are returned in the same order as the request items. Each item can also include an optional id, which is returned in the corresponding result so that you can match results to request items.

At least one entity is required, and at most 100 entities can be changed per request.

post/catalog/v1/stewardship/batch/manage

Request

Request body

Example request

{
  "data": [
    {
      "id": "item-1",
      "entityUrn": "urn:ata:acme-corp:catalog:catalog-item:fde84300-7a83-4d24-8c88-30ada80b0b54",
      "groupUrn": "urn:ata:acme-corp:iam:group:b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e",
      "previousStewardAccessLevel": "viewMetadata"
    },
    {
      "id": "item-2",
      "entityUrn": "urn:ata:acme-corp:catalog:term:1ede1262-f76b-4d00-9929-e92c15d8a5ba",
      "groupUrn": "urn:ata:acme-corp:iam:group:b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e"
    }
  ]
}

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 the stewardship change was applied. Any other value indicates failure and is accompanied by an error whose type matches the status, for example, RESOURCE_NOT_FOUND, STEWARDSHIP_NOT_SUPPORTED, or INVALID_ACCESS_LEVEL.

Unlike the single-entity endpoint, the batch results don't return the resulting effective stewardship. To verify the outcome, retrieve the entities with include=effectiveStewardship.

Example response

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

Changes

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