Definition

To update or modify the definition of an Object Type, choose Components > Object Types in the navigational menu, then choose the Object Type. The Object Type detail view will default to the Definition tab, which includes:

• Type Name (ID): required, permanent unique identifier for the Object Type, used throughout the Tenant Workspace UI, throughout your solution, and as the Tenant API endpoint for the Object Type

• Display Name: editable, this required field is used throughout the Tenant Workspace UI

• Description: optional, used in the Tenant Workspace UI and in Swagger documentation of your Tenant API to describe the Object Type

• Display Name (Plural): optional, include a special spelling to use in the Tenant Workspace UI and Swagger documentation of your Tenant API when a plural name is appropriate

• Category: optional, used only in the Tenant Workspace UI, for basic organization and browsing of Records via the left-hand navigational menu

  • Unset or Default (will display the Object Type and its Records in the Data menu item)

  • Data (recommended for frequently changed, or ever-growing sets of data, such as User or Transaction records)

  • Setting (recommended for infrequently changed, more fixed data sets, for instance Zip Codes)

Deleting an Object Type

On the Object Type Definition tab in the Tenant Workspace UI, there is a Danger Zone to delete the Object Type. Once confirmed, the Object Type and all Records of that Object Type will be immediately deleted, an operation which cannot be undone.