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

Bot Entity

bots

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json

Bot entity to capture the details of a bot

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	bots.json

Bot entity Type

object [Bot entity](bots.md)

Bot entity Properties

Property	Type	Required	Nullable	Defined by
id	string	Optional	cannot be null	Basic type
name	string	Optional	cannot be null	Bot entity
displayName	string	Optional	cannot be null	Bot entity
description	string	Optional	cannot be null	Bot entity
href	string	Optional	cannot be null	Basic type

id

Unique id used to identify an entity

id

• is optional
• Type: string
• cannot be null
• defined in: Basic type

id Type

string

id Constraints

UUID: the string must be a UUID, according to RFC 4122

name

Optional name that identifies this entity. Same as id if name is not available

name

• is optional
• Type: string
• cannot be null
• defined in: Bot entity

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

displayName

Name used for display purposes. Example 'FirstName LastName'

displayName

• is optional
• Type: string
• cannot be null
• defined in: Bot entity

displayName Type

string

description

Description of entity instance.

description

• is optional
• Type: string
• cannot be null
• defined in: Bot entity

description Type

string

href

Link to the resource corresponding to this entity

Link to the resource

href

• is optional
• Type: string
• cannot be null
• defined in: Basic type

href Type

string

href Constraints

URI: the string must be a URI, according to RFC 3986

bots-properties-description

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json#/properties/description

Description of entity instance.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	bots.json*

description Type

string

bots-properties-displayname

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json#/properties/displayName

Name used for display purposes. Example 'FirstName LastName'

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	bots.json*

displayName Type

string

bots-properties-name

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json#/properties/name

Optional name that identifies this entity. Same as id if name is not available

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	bots.json*

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1