Basic

This schema defines basic common types that are used by other schemas.

Definitions

• integer (integer): An integer type.
• number (number): A numeric type that includes integer or floating point numbers.
• string (string): A String type.
• uuid (string): Unique id used to identify an entity.
• email (string): Email address of a user or other entities.
• timestamp (integer): Timestamp in Unix epoch time milliseconds.
• href (string): URI that points to a resource.
• timeInterval (object): Time interval in unixTimeMillis. Cannot contain additional properties.
  • start (integer): Start time in unixTimeMillis.
  • end (integer): End time in unixTimeMillis.
• duration (string): Duration in ISO 8601 format in UTC. Example - 'P23DT23H'.
• date (string): Date in ISO 8601 format in UTC. Example - '2018-11-13'.
• dateTime (string): Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'.
• time (string): time in ISO 8601 format. Example - '20:20:39+00:00'.
• date-cp (string): Date as defined in custom property.
• dateTime-cp (string): Date and time as defined in custom property.
• time-cp (string): Time as defined in custom property.
• enum (array): List of values in Enum.
  • Items (string)
• timezone (string): Timezone of the user in the format America/Los_Angeles, Brazil/East, etc.
• entityLink (string): Link to an entity or field within an entity using this format <#E::{entities}::{entityType}::{field}::{arrayFieldName}::{arrayFieldValue}.
• entityName (string): Name that identifies an entity.
• testCaseEntityName (string): Name that identifies a test definition and test case.
• fullyQualifiedEntityName (string): A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
• sqlQuery (string): SQL query statement. Example - 'select * from orders'.
• sqlFunction (string): SQL function. Example - 'AVG(), COUNT()`, etc..
• markdown (string): Text in Markdown format.
• expression (string): Expression in SpEL.
• jsonSchema (string): JSON schema encoded as string. This will be used to validate the JSON fields using this schema.
• entityExtension: Entity extension data with custom attributes added to the entity.
• providerType (string): Type of provider of an entity. Some entities are provided by the system. Some are entities created and provided by the user. Typically system provide entities can't be deleted and can only be disabled. Some apps such as AutoPilot create entities with automation provider type. These entities can be deleted by the user. Must be one of: ['system', 'user', 'automation']. Default: user.
• componentConfig (object): key/value pairs to pass to workflow component. Can contain additional properties.
  • Additional Properties
• map (object): A generic map that can be deserialized later. Can contain additional properties.
• status (string): State of an action over API. Must be one of: ['success', 'failure', 'aborted', 'partialSuccess'].
• sourceUrl (string): Source Url of the respective entity.
• style (object): UI Style is used to associate a color code and/or icon to entity to customize the look of that entity in UI. Cannot contain additional properties.
  • color (string): Hex Color Code to mark an entity such as GlossaryTerm, Tag, Domain or Data Product.
  • iconURL (string): An icon to associate with GlossaryTerm, Tag, Domain or Data Product.
• semanticsRule (object): Semantics rule defined in the data contract. Cannot contain additional properties.
  • name (string): Name of the semantics rule.
  • description: Description of the semantics rule. Refer to #/definitions/markdown.
  • rule (string): Definition of the semantics rule.
  • enabled (boolean): Indicates if the semantics rule is enabled. Default: True.
  • entityType (string): Type of the entity to which this semantics rule applies. Default: None.
  • ignoredEntities (array): List of entities to ignore for this semantics rule. Default: [].
    • Items (string)
  • provider: Refer to #/definitions/providerType.

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.