Property description

The objectTypes asset defines types of objects, which are the key building block of any application. Here, we define what attributes are assigned to an object and how they are displayed in the UI.

Minimal JSON

{
  "key": "",
  "name": ""
}
{
  "key": "document_set",
  "name": "Document set",
  "description": "A document set is an organized grouping of documentation objects.",
  "iconKey": "core_dataset",
  "tooltipAttributeTypeKey": "core_description",
  "attributeTypes": [
    {
      "key": "core_description"
    }
  ],
  "userRelationTypes": [
    {
      "key": "core_business_owner",
      "isSingleValue": false
    },
    {
      "key": "core_steward",
      "isSingleValue": false
    }
  ],
  "features": [
    {
      "key": "create_without_concept",
      "value": true
    }
  ],
  "graphDisplayLevels": [
    {
      "metamodelKey": "core#knowledge_graph",
      "displayLevelKey": "core#simple_object"
    }
  ],
  "domainTypeKeys": [
    "knowledge_documentation"
  ],
  "templates": {},
  "translations": []
}

Example taken from the core_documentation package.

Nested properties

PropertyDescriptionValuesMandatory
keyUnique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey.stringYes
nameName of the asset, used as the default EN translation.stringYes
attributeTypesArray of attribute types that are assigned to the object type. Attributes store information about the object. All attribute types must also be added in the object type template in order to be displayed and editable in the UI.arrayNo
categoryKeyKey of the object type’s category. Used when the object type doesn’t have its own template, allowing it to inherit the template from the category.stringNo
descriptionDescription of the asset.stringNo
domainTypeKeysKey of the domain type the object type is assigned to. Domain types facilitate object search and simplify search phrasing for better readability.arrayNo
featuresArray of features, which configure object type behavior. E.g., creating an object without the need of a concept.arrayNo
graphDisplayLevelsArray of graph display levels configuring at what level the object type will be displayed by default. Used mostly for data lineage.arrayNo
iconKeyKey of the icon used to visually represent the asset. Use predefined icons from Settings > Configuration > Icons, or define custom ones in the icons asset.stringNo
initialWorkflowStateKeyKey of the default workflow state that is applied when an object is first created. If not specified, then the space app default configuration will be used.stringNo
moduleKeyLegacy configuration.stringNo
notificationsArray of notifications sent to the user when a change is made to the object type.arrayNo
searchArray of search properties configuring if and how the object type appears in search results.arrayNo
stateCurrent status of the asset. Supported options are: active (asset is active and visible in the environment), inactive (asset is inactive and hidden, serves as a soft delete), hidden (asset is active but hidden in the environment).stringNo
templatesTemplatesdefining the appearance of the object type in the UI. Here, you can configure the object type page, object detail, and search facets specific to this object type.jsonNo
tooltipAttributeTypeKeyKey of the attribute type used as a tooltip for this object type. For example, used in search.stringNo
translationsArray of translation keys and their definitions that determine how the text is displayed in the UI for the specific asset. For more information, see Translations.arrayNo
userRelationTypesArray of user relation types assigned to the object type. All user relation types must also be added to the object type template in order to be displayed and selectable in the UI.arrayNo