/api/ee/dependencies

POST /api/ee/dependencies/check-card

Check a proposed edit to a card, and return the card IDs for those cards this edit will break.

post/api/ee/dependencies/check-card

Request body

collection_idinteger

Valid Collection ID

dashboard_idinteger

Valid Dashboard ID

database_idinteger

Valid Database ID

{"stackTrail":"components:schemas:metabase.queries.schema.empty-map","oasType":"schema","type":"unknown","description":"An empty map, allowed for Card.dataset_query for historic purposes."}
descriptionstring nullable
document_idinteger

Valid Document ID

idinteger

Valid Card ID

namestring nullable
result_metadataMetabaseQueryProcessorSchemaResultMetadataColumn[] nullable— unresolved $ref

value must be an array of valid results column metadata maps.

type'question' | 'metric' | 'model'

All acceptable card types.

Previously (< 49), we only had 2 card types: question and model, which were differentiated using the boolean dataset column. Soon we'll have more card types (e.g: metric) and we will longer be able to use a boolean column to differentiate between all types. So we've added a new type column for this purpose.

Migrating all the code to use report_card.type will be quite an effort, we decided that we'll migrate it gradually.

Response

Successful response

successboolean required

Changes