Table Metadata

Add notes to a table registered as a Rasgo Dataset

Endpoint type

POST

Endpoint name

/public/table-metadata

Parameters

None

Request Body

application/json

{
  "fqtn": "DATABASE.SCHEMA.TABLE",
  "notes": [
    "...note text...",
  ]
}

Responses

200 - Successful Response

application/json

"Sent {n} notes to Table {fqtn}. View these changes in the Rasgo WebApp: app.rasgoml.com/datasets/{dataset}"

Code Sample

curl -X 'POST' \
  'http://api.rasgoml.com/public/table-metadata' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "fqtn": "DATABASE.SCHEMA.TABLE",
  "notes": [
    "This is a note"
  ]
}'

Usage Notes

  • Endpoint accepts a list of 1 or many notes

  • Endpoint will detect and skip existing notes to avoid adding duplicates

  • Endpoint does not handle editing or deleting notes. Handle this through the Rasgo WebApp

Last updated