Sign in
ontology-entities

Update Entity

Update entity display_name or description.

patch/api/v1/ontology/entities/{entity_id}

Path parameters

entity_idstring uuid required

Request body

display_namestring nullable
descriptionstring nullable
iconstring nullable

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 200 status

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ○

      added the optional property is_refreshing to the response with the 200 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 200 status

      response-optional-property-added

    • ○

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

      response-optional-property-added