---
title: app
slug: /main-concepts/metadata-standard/schemas/entity/applications/app
---

# App

*This schema defines the applications for Open-Metadata.*

## Properties

- **`id`**: Unique identifier of this application. Refer to *[../../type/basic.json#/definitions/uuid](#/../type/basic.json#/definitions/uuid)*.
- **`name`**: Name of the Application. Refer to *[../../type/basic.json#/definitions/entityName](#/../type/basic.json#/definitions/entityName)*.
- **`displayName`** *(string)*: Display Name for the application.
- **`description`**: Description of the Application. Refer to *[../../type/basic.json#/definitions/markdown](#/../type/basic.json#/definitions/markdown)*.
- **`features`**: Features of the Application. Refer to *[../../type/basic.json#/definitions/markdown](#/../type/basic.json#/definitions/markdown)*.
- **`fullyQualifiedName`**: FullyQualifiedName same as `name`. Refer to *[../../type/basic.json#/definitions/fullyQualifiedEntityName](#/../type/basic.json#/definitions/fullyQualifiedEntityName)*.
- **`owners`**: Owners of this workflow. Refer to *[../../type/entityReferenceList.json](#/../type/entityReferenceList.json)*. Default: `null`.
- **`version`**: Metadata version of the entity. Refer to *[../../type/entityHistory.json#/definitions/entityVersion](#/../type/entityHistory.json#/definitions/entityVersion)*.
- **`updatedAt`**: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to *[../../type/basic.json#/definitions/timestamp](#/../type/basic.json#/definitions/timestamp)*.
- **`updatedBy`** *(string)*: User who made the update.
- **`href`**: Link to the resource corresponding to this entity. Refer to *[../../type/basic.json#/definitions/href](#/../type/basic.json#/definitions/href)*.
- **`changeDescription`**: Change that lead to this version of the entity. Refer to *[../../type/entityHistory.json#/definitions/changeDescription](#/../type/entityHistory.json#/definitions/changeDescription)*.
- **`deleted`** *(boolean)*: When `true` indicates the entity has been soft deleted. Default: `false`.
- **`provider`**: Refer to *[../../type/basic.json#/definitions/providerType](#/../type/basic.json#/definitions/providerType)*.
- **`developer`** *(string)*: Developer For the Application.
- **`developerUrl`** *(string)*: Url for the developer.
- **`privacyPolicyUrl`** *(string)*: Privacy Policy for the developer.
- **`supportEmail`** *(string)*: Support Email for the application.
- **`className`** *(string)*: Fully Qualified ClassName for the Schedule.
- **`sourcePythonClass`** *(string)*: Fully Qualified class name for the Python source that will execute the external application.
- **`appType`**: This schema defines the type of application. Refer to *[#/definitions/appType](#definitions/appType)*.
- **`scheduleType`**: This schema defines the Schedule Type of Application. Refer to *[#/definitions/scheduleType](#definitions/scheduleType)*.
- **`permission`**: Permission used by Native Applications. Refer to *[#/definitions/permissions](#definitions/permissions)*.
- **`bot`**: Bot User Associated with this application. Refer to *[../../type/entityReference.json](#/../type/entityReference.json)*. Default: `null`.
- **`runtime`**: Execution Configuration. Refer to *[#/definitions/executionContext](#definitions/executionContext)*.
- **`allowConfiguration`** *(boolean)*: Allow users to configure the app from the UI. If `false`, the `configure` step will be hidden. Default: `true`.
- **`system`** *(boolean)*: A system app cannot be uninstalled or modified. Default: `false`.
- **`appConfiguration`**: Application Configuration object. Refer to *[./configuration/applicationConfig.json#/definitions/appConfig](#configuration/applicationConfig.json#/definitions/appConfig)*.
- **`privateConfiguration`**: Application Private configuration loaded at runtime. Refer to *[./configuration/applicationConfig.json#/definitions/privateConfig](#configuration/applicationConfig.json#/definitions/privateConfig)*.
- **`preview`** *(boolean)*: Flag to enable/disable preview for the application. If the app is in preview mode, it can't be installed. Default: `false`.
- **`pipelines`**: References to pipelines deployed for this database service to extract metadata, usage, lineage etc.. Refer to *[../../type/entityReferenceList.json](#/../type/entityReferenceList.json)*.
- **`appSchedule`**: In case the app supports scheduling, list of different app schedules. Refer to *[#/definitions/appSchedule](#definitions/appSchedule)*.
- **`openMetadataServerConnection`**: Refer to *[../services/connections/metadata/openMetadataConnection.json](#/services/connections/metadata/openMetadataConnection.json)*.
- **`appLogoUrl`** *(string, format: uri)*: Application Logo Url.
- **`appScreenshots`** *(array)*: Application Screenshots.
  - **Items** *(string)*
- **`domain`**: Domain the asset belongs to. When not set, the asset inherits the domain from the parent it belongs to. Refer to *[../../type/entityReference.json](#/../type/entityReference.json)*.
- **`supportsInterrupt`** *(boolean)*: If the app run can be interrupted as part of the execution. Default: `false`.
## Definitions

- **`scheduleType`** *(string)*: This schema defines the type of application. Must be one of: `["Live", "Scheduled", "ScheduledOrManual", "NoSchedule"]`.
- **`scheduleTimeline`** *(string)*: This schema defines the Application ScheduleTimeline Options. Must be one of: `["Hourly", " Daily", "Weekly", "Monthly", "Custom", "None"]`. Default: `"Weekly"`.
- **`appSchedule`**: This schema defines the type of application. Cannot contain additional properties.
  - **`scheduleTimeline`**: Refer to *[#/definitions/scheduleTimeline](#definitions/scheduleTimeline)*.
  - **`cronExpression`** *(string)*: Cron Expression in case of Custom scheduled Trigger.
- **`appType`** *(string)*: This schema defines the type of application. Must be one of: `["internal", "external"]`.
- **`permissions`** *(string)*: This schema defines the Permission used by Native Application. Must be one of: `["All"]`.
- **`executionContext`**: Execution Configuration. Cannot contain additional properties.
  - **One of**
    - : Refer to *[./liveExecutionContext.json](#liveExecutionContext.json)*.
    - : Refer to *[./scheduledExecutionContext.json](#scheduledExecutionContext.json)*.


Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.