Sign in
ontology-promotion

Promote Database

Promote a Database into an OntologyEntity (creates the writeable surface).

post/api/v1/ontology/databases/{database_id}/promote

Path parameters

database_idstring uuid required

Request body

namestring required

Entity slug

descriptionstring
display_namestring nullable
key_columnsstring[] nullable

Single-element list naming the column whose values become the entity's row identity. Required for file-backed Databases (CSV uploads) whose key_columns is empty; ignored otherwise.

Response

Successful Response

idstring uuid required
company_idstring uuid required
namestring required
display_namestring required
descriptionstring required
database_idstring uuid required
key_columnstring required
record_countinteger required
statusstring required
created_atstring date-time required
updated_atstring date-time required
is_editableboolean
is_file_backedboolean
last_synced_atstring date-time nullable
source_row_countinteger
iconstring nullable
is_refreshingboolean

Changes

Changed in 2 of the 12 revisions of this API.23

  • ef8b72834a5121See the full diff
    • ●

      removed the optional property row_key_columns from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property row_key_columns_applied_at from the response with the 201 status

      response-optional-property-removed

    • ○

      added the optional property is_refreshing to the response with the 201 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 419963dc27e82See the full diff
    • ○

      added the optional property row_key_columns to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property row_key_columns_applied_at to the response with the 201 status

      response-optional-property-added