ATataccama
Sources

Create source

Create a source in the catalog.

The server generates the URN for the created source automatically.

Stewardship cannot be set when creating the source. To assign a group responsible for the source, use POST /catalog/v1/stewardship/manage.

post/catalog/v1/sources

Request

Request body

namestring

Name of the source.

descriptionstring

Description of the source.

extraPropertiesExtraProperties

A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays.

In responses, only properties explicitly requested via the extraProperties query parameter are included.

In PATCH requests, only the properties listed in the body are modified; set a property to null (for scalars) or [] (for reference arrays) to clear its value.

To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: catalogItem for catalog items, attribute for catalog attributes, source for sources, folder for folders, and the term's own type (for example, businessTerm) for terms.

Example request

{
  "extraProperties": {
    "isPii": true,
    "community": "Customer Solutions",
    "status": "urn:ata:acme-corp:catalog:completeness-status:10bae762-0000-8010-8000-000001eb0070",
    "domains": [
      "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0065",
      "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0066"
    ]
  }
}

Response

The created source.

urnstring uri required

A URN identifying a source resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:source:{uuid}

Example: urn:ata:acme-corp:catalog:source:123e4567-e89b-12d3-a456-426614174000.

namestring

Name of the source.

descriptionstring

Description of the source.

extraPropertiesExtraProperties

A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays.

In responses, only properties explicitly requested via the extraProperties query parameter are included.

In PATCH requests, only the properties listed in the body are modified; set a property to null (for scalars) or [] (for reference arrays) to clear its value.

To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: catalogItem for catalog items, attribute for catalog attributes, source for sources, folder for folders, and the term's own type (for example, businessTerm) for terms.

Example response

{
  "urn": "urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f",
  "name": "Sales USA",
  "description": "Source system holding US sales records",
  "effectiveStewardship": {
    "groupUrn": "urn:ata:acme-corp:iam:group:b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e",
    "originUrn": "urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f"
  }
}

Changes

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