mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-24 01:40:00 +00:00
183 lines
7.7 KiB
Markdown
183 lines
7.7 KiB
Markdown
# bots
|
|
|
|
```txt
|
|
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](../../https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json "open original schema") |
|
|
|
|
## Bot entity Type
|
|
|
|
`object` ([Bot entity](bots.md))
|
|
|
|
# Bot entity Properties
|
|
|
|
| Property | Type | Required | Nullable | Defined by |
|
|
| :-------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| [id](#id) | `string` | Optional | cannot be null | [Basic type](../types/basic.md#basic-definitions-uuid) |
|
|
| [name](#name) | `string` | Optional | cannot be null | [Bot entity](#bots-properties-name "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json#/properties/name") |
|
|
| [displayName](#displayname) | `string` | Optional | cannot be null | [Bot entity](#bots-properties-displayname "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json#/properties/displayName") |
|
|
| [description](#description) | `string` | Optional | cannot be null | [Bot entity](#bots-properties-description "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json#/properties/description") |
|
|
| [href](#href) | `string` | Optional | cannot be null | [Basic type](../types/basic.md#basic-definitions-href) |
|
|
|
|
## id
|
|
|
|
Unique id used to identify an entity
|
|
|
|
`id`
|
|
|
|
* is optional
|
|
|
|
* Type: `string`
|
|
|
|
* cannot be null
|
|
|
|
* defined in: [Basic type](../types/basic.md#basic-definitions-uuid)
|
|
|
|
### id Type
|
|
|
|
`string`
|
|
|
|
### id Constraints
|
|
|
|
**UUID**: the string must be a UUID, according to [RFC 4122](https://tools.ietf.org/html/rfc4122 "check the specification")
|
|
|
|
## 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](#bots-properties-name "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json#/properties/name")
|
|
|
|
### 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](#bots-properties-displayname "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json#/properties/displayName")
|
|
|
|
### displayName Type
|
|
|
|
`string`
|
|
|
|
## description
|
|
|
|
Description of entity instance.
|
|
|
|
`description`
|
|
|
|
* is optional
|
|
|
|
* Type: `string`
|
|
|
|
* cannot be null
|
|
|
|
* defined in: [Bot entity](#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 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](../types/basic.md#basic-definitions-href)
|
|
|
|
### href Type
|
|
|
|
`string`
|
|
|
|
### href Constraints
|
|
|
|
**URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986 "check the specification")
|
|
# bots-properties-description
|
|
|
|
```txt
|
|
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*](../../https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json "open original schema") |
|
|
|
|
## description Type
|
|
|
|
`string`
|
|
# bots-properties-displayname
|
|
|
|
```txt
|
|
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*](../../https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json "open original schema") |
|
|
|
|
## displayName Type
|
|
|
|
`string`
|
|
# bots-properties-name
|
|
|
|
```txt
|
|
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*](../../https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json "open original schema") |
|
|
|
|
## 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`
|