yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-23 17:30:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/docs/openmetadata-apis/schemas/entities/thread.md
Suresh Srinivas eae9a5bda2
GitBook: [main] 29 pages and 10 assets modified
2021-08-05 22:54:50 +00:00

382 lines
12 KiB
Markdown
Raw Blame History

# Feed Entity
## thread
```text
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json
```
Entity that represents a feed
| 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) |
### Feed entity Type
`object` \([Feed entity](thread.md)\)
## Feed entity Properties
| 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) |
### id
Unique id used to identify an entity
`id`
* is required
* 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)
### 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)
### threadTs
Timestamp of the when the first post created the thread
`threadTs`
* is optional
* Type: unknown
* cannot be null
* defined in: [Feed entity](thread.md#thread-Properties-Threads)
#### threadTs Type
unknown
#### 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)
### about
Entity or field thread is created for with format <\#E/{enties}/{entityName}/{field}/{fieldValue}
`about`
* is required
* Type: `string`
* cannot be null
* defined in: [Basic type](../types/basic.md#basic-definitions-entitylink)
#### about Type
`string`
#### about Constraints
**pattern**: the string must match the following regular expression:
```text
^<#E/\S+/\S+>$
```
[try pattern](https://regexr.com/?expression=%5E%3C%23E%2F%5CS%2B%2F%5CS%2B%3E%24)
### addressedTo
Entity or field thread is created for with format &lt;\#E/{enties}/{entityName}/{field}/{fieldValue}
`addressedTo`
* is optional
* Type: `string`
* cannot be null
* defined in: [Basic type](../types/basic.md#basic-definitions-entitylink)
#### addressedTo Type
`string`
#### addressedTo Constraints
**pattern**: the string must match the following regular expression:
```text
^<#E/\S+/\S+>$
```
[try pattern](https://regexr.com/?expression=%5E%3C%23E%2F%5CS%2B%2F%5CS%2B%3E%24)
### posts
`posts`
* is required
* Type: `object[]` \([Details](thread.md#thread-definitions-post)\)
* cannot be null
* defined in: [Feed entity](thread.md#thread-Properties-Posts)
#### posts Type
`object[]` \([Details](thread.md#thread-definitions-post)\)
## Feed entity Definitions
### Definitions group post
Reference this group by using
```javascript
{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions/post"}
```
| 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) |
#### message
Message in markdown format. See markdown support for more details.
`message`
* is required
* Type: `string`
* cannot be null
* defined in: [Feed entity](thread.md#thread-definitions-post-properties-message)
**message Type**
`string`
#### postTs
Timestamp of the post
`postTs`
* is optional
* Type: `string`
* cannot be null
* defined in: [Feed entity](thread.md#thread-definitions-post-properties-postts)
**postTs Type**
`string`
**postTs Constraints**
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339)
#### from
Unique id used to identify an entity
`from`
* is required
* Type: `string`
* cannot be null
* defined in: [Basic type](../types/basic.md#basic-definitions-uuid)
**from Type**
`string`
**from Constraints**
**UUID**: the string must be a UUID, according to [RFC 4122](https://tools.ietf.org/html/rfc4122)
## thread-definitions-post-properties-message
```text
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions/post/properties/message
```
Message in markdown format. See markdown support for more details.
| 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) |
### message Type
`string`
## thread-definitions-post-properties-postts
```text
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions/post/properties/postTs
```
Timestamp of the post
| 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) |
### postTs Type
`string`
### postTs Constraints
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339)
## thread-definitions-post
```text
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/properties/posts/items
```
Post within a feed
| 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) |
### items Type
`object` \([Details](thread.md#thread-definitions-post)\)
## items Properties
| 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) |
### message
Message in markdown format. See markdown support for more details.
`message`
* is required
* Type: `string`
* cannot be null
* defined in: [Feed entity](thread.md#thread-definitions-post-properties-message)
#### message Type
`string`
### postTs
Timestamp of the post
`postTs`
* is optional
* Type: `string`
* cannot be null
* defined in: [Feed entity](thread.md#thread-definitions-post-properties-postts)
#### postTs Type
`string`
#### postTs Constraints
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339)
### from
Unique id used to identify an entity
`from`
* is required
* Type: `string`
* cannot be null
* defined in: [Basic type](../types/basic.md#basic-definitions-uuid)
#### from Type
`string`
#### from Constraints
**UUID**: the string must be a UUID, according to [RFC 4122](https://tools.ietf.org/html/rfc4122)
## thread-definitions
```text
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions
```
| 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) |
### definitions Type
unknown
## thread-properties-posts
```text
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/properties/posts
```
| 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) |
### posts Type
`object[]` \([Details](thread.md#thread-definitions-post)\)
## thread-properties-threadts
```text
https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/properties/threadTs
```
Timestamp of the when the first post created the thread
| 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) |
### threadTs Type
unknown
### 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)
Reference in New Issue View Git Blame Copy Permalink