ATataccama
Stewardship

Manage stewardship of an entity

Assign, transfer, or clear the stewardship of a single entity.

Stewardship is a configurable trait, so this endpoint accepts any entity type that carries it: catalog items, terms, sources, and custom entity types alike.

Managing stewardship performs sharing, the same way as transferring stewardship in the web application:

  • 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.

The change is always published: it cannot be applied to a draft.

The response returns the stewardship of the entity after the change was applied. When the assigned stewardship was cleared, effectiveStewardship contains the stewardship inherited from an ancestor, or null when no ancestor assigns one.

A request without groupUrn applies no change and simply returns the entity's current effective stewardship.

post/catalog/v1/stewardship/manage

Request

Request body

entityUrnstring uri required

A URN identifying a resource in any realm of the Public API. URNs follow RFC 8141.

Format: urn:ata:{tenant}:{realm}:{resource-type}:{uuid}

Components:

  • urn — fixed scheme
  • ata — Ataccama namespace
  • {tenant} — tenant identifier from the authentication context
  • {realm} — API realm, for example catalog or reference-data
  • {resource-type} — resource type within the realm, for example catalog-item or table
  • {uuid} — UUID (v4 or v7) of the resource

Example: urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000.

groupUrnstring uri

A URN identifying a group resource in the IAM API.

To find a group's URN, use the Groups endpoints of the IAM API.

Format: urn:ata:{tenant}:iam:group:{uuid}

Example: urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000.

previousStewardAccessLevelstring

Access level at which the entity is shared with the previous stewardship group so that it doesn't lose access, for example, viewMetadata. Must be one of the access levels configured for the entity type in the metadata model. For details, see Access levels.

When omitted, the previous stewardship group loses access.

Example request

{
  "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"
}

Response

Stewardship change applied.

entityUrnstring uri required

A URN identifying a resource in any realm of the Public API. URNs follow RFC 8141.

Format: urn:ata:{tenant}:{realm}:{resource-type}:{uuid}

Components:

  • urn — fixed scheme
  • ata — Ataccama namespace
  • {tenant} — tenant identifier from the authentication context
  • {realm} — API realm, for example catalog or reference-data
  • {resource-type} — resource type within the realm, for example catalog-item or table
  • {uuid} — UUID (v4 or v7) of the resource

Example: urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000.

Example response

{
  "entityUrn": "urn:ata:acme-corp:catalog:catalog-item:fde84300-7a83-4d24-8c88-30ada80b0b54",
  "effectiveStewardship": {
    "groupUrn": "urn:ata:acme-corp:iam:group:b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e",
    "originUrn": "urn:ata:acme-corp:catalog:catalog-item:fde84300-7a83-4d24-8c88-30ada80b0b54"
  }
}

Changes

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