2021-08-05 22:54:50 +00:00
# Feed Entity
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
## thread
```text
2021-08-04 13:18:14 +05:30
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json
2021-08-01 14:27:44 -07:00
```
Entity that represents a feed
2021-08-05 22:54:50 +00:00
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| Can be instantiated | Yes | Unknown status | No | Forbidden | Allowed | none | [thread.json ](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### Feed entity Type
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
`object` \([Feed entity ](thread.md )\)
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
## Feed entity Properties
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
| Property | Type | Required | Nullable | Defined by |
| :--- | :--- | :--- | :--- | :--- |
| [id ](thread.md#id ) | `string` | Required | cannot be null | [Basic type ](../types/basic.md#basic-definitions-uuid ) |
| [href ](thread.md#href ) | `string` | Optional | cannot be null | [Basic type ](../types/basic.md#basic-definitions-href ) |
| [threadTs ](thread.md#threadts ) | Not specified | Optional | cannot be null | [Feed entity ](thread.md#thread-Properties-Threads ) |
| [about ](thread.md#about ) | `string` | Required | cannot be null | [Basic type ](../types/basic.md#basic-definitions-entitylink ) |
| [addressedTo ](thread.md#addressedto ) | `string` | Optional | cannot be null | [Basic type ](../types/basic.md#basic-definitions-entitylink ) |
| [posts ](thread.md#posts ) | `array` | Required | cannot be null | [Feed entity ](thread.md#thread-Properties-Posts ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### id
2021-08-01 14:27:44 -07:00
Unique id used to identify an entity
`id`
2021-08-05 22:54:50 +00:00
* is required
* Type: `string`
* cannot be null
* defined in: [Basic type ](../types/basic.md#basic-definitions-uuid )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
#### id Type
2021-08-01 14:27:44 -07:00
`string`
2021-08-05 22:54:50 +00:00
#### id Constraints
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
**UUID**: the string must be a UUID, according to [RFC 4122 ](https://tools.ietf.org/html/rfc4122 )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### href
2021-08-01 14:27:44 -07:00
Link to the resource corresponding to this entity
> Link to the resource
`href`
2021-08-05 22:54:50 +00:00
* is optional
* Type: `string`
* cannot be null
* defined in: [Basic type ](../types/basic.md#basic-definitions-href )
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
#### href Type
2021-08-01 14:27:44 -07:00
`string`
2021-08-05 22:54:50 +00:00
#### href Constraints
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
**URI**: the string must be a URI, according to [RFC 3986 ](https://tools.ietf.org/html/rfc3986 )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### threadTs
2021-08-01 14:27:44 -07:00
Timestamp of the when the first post created the thread
`threadTs`
2021-08-05 22:54:50 +00:00
* is optional
* Type: unknown
* cannot be null
* defined in: [Feed entity ](thread.md#thread-Properties-Threads )
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
#### threadTs Type
2021-08-01 14:27:44 -07:00
unknown
2021-08-05 22:54:50 +00:00
#### threadTs Constraints
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6 ](https://tools.ietf.org/html/rfc3339 )
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
### about
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
Entity or field thread is created for with format < \#E/{enties}/{entityName}/{field}/{fieldValue}
2021-08-04 06:53:40 +00:00
`about`
2021-08-05 22:54:50 +00:00
* is required
* Type: `string`
* cannot be null
* defined in: [Basic type ](../types/basic.md#basic-definitions-entitylink )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
#### about Type
2021-08-04 06:53:40 +00:00
`string`
2021-08-05 22:54:50 +00:00
#### about Constraints
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
**pattern**: the string must match the following regular expression:
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
```text
2021-08-04 06:53:40 +00:00
^< #E/ \S+/\S+>$
```
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
[try pattern ](https://regexr.com/?expression=%5E%3C%23E%2F%5CS%2B%2F%5CS%2B%3E%24 )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### addressedTo
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
Entity or field thread is created for with format < \#E/{enties}/{entityName}/{field}/{fieldValue}
2021-08-01 14:27:44 -07:00
2021-08-04 06:53:40 +00:00
`addressedTo`
2021-08-05 22:54:50 +00:00
* is optional
* Type: `string`
* cannot be null
* defined in: [Basic type ](../types/basic.md#basic-definitions-entitylink )
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
#### addressedTo Type
2021-08-04 06:53:40 +00:00
`string`
2021-08-05 22:54:50 +00:00
#### addressedTo Constraints
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
**pattern**: the string must match the following regular expression:
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
```text
2021-08-04 06:53:40 +00:00
^< #E/ \S+/\S+>$
```
2021-08-05 22:54:50 +00:00
[try pattern ](https://regexr.com/?expression=%5E%3C%23E%2F%5CS%2B%2F%5CS%2B%3E%24 )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### posts
2021-08-01 14:27:44 -07:00
`posts`
2021-08-05 22:54:50 +00:00
* is required
* Type: `object[]` \([Details ](thread.md#thread-definitions-post )\)
* cannot be null
* defined in: [Feed entity ](thread.md#thread-Properties-Posts )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
#### posts Type
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
`object[]` \([Details ](thread.md#thread-definitions-post )\)
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
## Feed entity Definitions
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### Definitions group post
2021-08-01 14:27:44 -07:00
Reference this group by using
2021-08-05 22:54:50 +00:00
```javascript
2021-08-04 13:18:14 +05:30
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions/post "}
2021-08-01 14:27:44 -07:00
```
2021-08-05 22:54:50 +00:00
| Property | Type | Required | Nullable | Defined by |
| :--- | :--- | :--- | :--- | :--- |
| [message ](thread.md#message ) | `string` | Required | cannot be null | [Feed entity ](thread.md#thread-definitions-post-properties-message ) |
| [postTs ](thread.md#postts ) | `string` | Optional | cannot be null | [Feed entity ](thread.md#thread-definitions-post-properties-postts ) |
| [from ](thread.md#from ) | `string` | Required | cannot be null | [Basic type ](../types/basic.md#basic-definitions-uuid ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
#### message
2021-08-01 14:27:44 -07:00
2021-08-04 06:53:40 +00:00
Message in markdown format. See markdown support for more details.
2021-08-01 14:27:44 -07:00
`message`
2021-08-05 22:54:50 +00:00
* is required
* Type: `string`
* cannot be null
* defined in: [Feed entity ](thread.md#thread-definitions-post-properties-message )
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
**message Type**
2021-08-01 14:27:44 -07:00
`string`
2021-08-05 22:54:50 +00:00
#### postTs
2021-08-01 14:27:44 -07:00
Timestamp of the post
`postTs`
2021-08-05 22:54:50 +00:00
* is optional
* Type: `string`
* cannot be null
* defined in: [Feed entity ](thread.md#thread-definitions-post-properties-postts )
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
**postTs Type**
2021-08-01 14:27:44 -07:00
`string`
2021-08-05 22:54:50 +00:00
**postTs Constraints**
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6 ](https://tools.ietf.org/html/rfc3339 )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
#### from
2021-08-01 14:27:44 -07:00
Unique id used to identify an entity
`from`
2021-08-05 22:54:50 +00:00
* is required
* Type: `string`
* cannot be null
* defined in: [Basic type ](../types/basic.md#basic-definitions-uuid )
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
**from Type**
2021-08-01 14:27:44 -07:00
2021-08-04 06:53:40 +00:00
`string`
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
**from Constraints**
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
**UUID**: the string must be a UUID, according to [RFC 4122 ](https://tools.ietf.org/html/rfc4122 )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
## thread-definitions-post-properties-message
```text
2021-08-04 13:18:14 +05:30
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions/post/properties/message
2021-08-01 14:27:44 -07:00
```
2021-08-04 06:53:40 +00:00
Message in markdown format. See markdown support for more details.
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [thread.json\* ](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### message Type
2021-08-01 14:27:44 -07:00
`string`
2021-08-05 22:54:50 +00:00
## thread-definitions-post-properties-postts
```text
2021-08-04 13:18:14 +05:30
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions/post/properties/postTs
2021-08-01 14:27:44 -07:00
```
Timestamp of the post
2021-08-05 22:54:50 +00:00
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [thread.json\* ](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### postTs Type
2021-08-01 14:27:44 -07:00
`string`
2021-08-05 22:54:50 +00:00
### postTs Constraints
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6 ](https://tools.ietf.org/html/rfc3339 )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
## thread-definitions-post
```text
2021-08-04 13:18:14 +05:30
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/properties/posts/items
2021-08-01 14:27:44 -07:00
```
Post within a feed
2021-08-05 22:54:50 +00:00
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [thread.json\* ](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### items Type
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
`object` \([Details ](thread.md#thread-definitions-post )\)
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
## items Properties
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
| Property | Type | Required | Nullable | Defined by |
| :--- | :--- | :--- | :--- | :--- |
| [message ](thread.md#message ) | `string` | Required | cannot be null | [Feed entity ](thread.md#thread-definitions-post-properties-message ) |
| [postTs ](thread.md#postts ) | `string` | Optional | cannot be null | [Feed entity ](thread.md#thread-definitions-post-properties-postts ) |
| [from ](thread.md#from ) | `string` | Required | cannot be null | [Basic type ](../types/basic.md#basic-definitions-uuid ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### message
2021-08-01 14:27:44 -07:00
2021-08-04 06:53:40 +00:00
Message in markdown format. See markdown support for more details.
2021-08-01 14:27:44 -07:00
`message`
2021-08-05 22:54:50 +00:00
* is required
* Type: `string`
* cannot be null
* defined in: [Feed entity ](thread.md#thread-definitions-post-properties-message )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
#### message Type
2021-08-01 14:27:44 -07:00
`string`
2021-08-05 22:54:50 +00:00
### postTs
2021-08-01 14:27:44 -07:00
Timestamp of the post
`postTs`
2021-08-05 22:54:50 +00:00
* is optional
* Type: `string`
* cannot be null
* defined in: [Feed entity ](thread.md#thread-definitions-post-properties-postts )
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
#### postTs Type
2021-08-01 14:27:44 -07:00
`string`
2021-08-05 22:54:50 +00:00
#### postTs Constraints
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6 ](https://tools.ietf.org/html/rfc3339 )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### from
2021-08-01 14:27:44 -07:00
Unique id used to identify an entity
`from`
2021-08-05 22:54:50 +00:00
* is required
* Type: `string`
* cannot be null
* defined in: [Basic type ](../types/basic.md#basic-definitions-uuid )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
#### from Type
2021-08-01 14:27:44 -07:00
2021-08-04 06:53:40 +00:00
`string`
2021-08-05 22:54:50 +00:00
#### from Constraints
2021-08-04 06:53:40 +00:00
2021-08-05 22:54:50 +00:00
**UUID**: the string must be a UUID, according to [RFC 4122 ](https://tools.ietf.org/html/rfc4122 )
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
## thread-definitions
```text
2021-08-04 13:18:14 +05:30
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions
2021-08-01 14:27:44 -07:00
```
2021-08-05 22:54:50 +00:00
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [thread.json\* ](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### definitions Type
2021-08-01 14:27:44 -07:00
2021-08-04 06:53:40 +00:00
unknown
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
## thread-properties-posts
```text
2021-08-04 13:18:14 +05:30
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/properties/posts
2021-08-01 14:27:44 -07:00
```
2021-08-05 22:54:50 +00:00
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [thread.json\* ](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### posts Type
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
`object[]` \([Details ](thread.md#thread-definitions-post )\)
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
## thread-properties-threadts
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
```text
2021-08-04 13:18:14 +05:30
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/properties/threadTs
2021-08-01 14:27:44 -07:00
```
Timestamp of the when the first post created the thread
2021-08-05 22:54:50 +00:00
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [thread.json\* ](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/https:/github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json ) |
2021-08-01 14:27:44 -07:00
2021-08-05 22:54:50 +00:00
### threadTs Type
2021-08-01 14:27:44 -07:00
unknown
2021-08-05 22:54:50 +00:00
### threadTs Constraints
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6 ](https://tools.ietf.org/html/rfc3339 )
2021-08-01 14:27:44 -07:00