OpenMetadata/docs/openmetadata-apis/schemas/entities/bot.md

Bot

This schema defines Bot entity. A bot automates tasks, such as adding description, identifying the importance of data. It runs as a special user in the system.

$id:https://open-metadata.org/schema/entity/bots.json

Type: object

This schema does not accept additional properties.

Properties

• id
  • Unique identifier of a bot instance.
  • $ref: ../type/basic.json#/definitions/uuid
• name
  • Name of the bot.
  • Type: string
  • Length: between 1 and 128
• displayName
  • Name used for display purposes. Example 'FirstName LastName'.
  • Type: string
• description
  • Description of the bot.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• href
  • Link to the resource corresponding to this bot.
  • $ref: ../type/basic.json#/definitions/href
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

This document was updated on: Monday, March 7, 2022