12 KiB
Feed Entity
thread
https://github.com/StreamlineData/catalog/blob/master/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 |
Feed entity Type
object
[Feed entity](thread.md)
Feed entity Properties
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
id | string |
Required | cannot be null | Common type |
href | string |
Optional | cannot be null | Common type |
threadTs | Not specified | Optional | cannot be null | Feed entity |
toEntity | object |
Required | cannot be null | Common type |
posts | array |
Required | cannot be null | Feed entity |
id
Unique id used to identify an entity
id
- is required
- Type:
string
- cannot be null
- defined in: Common type
id Type
string
id Constraints
UUID: the string must be a UUID, according to RFC 4122
href
Link to the resource corresponding to this entity
Link to the resource
href
- is optional
- Type:
string
- cannot be null
- defined in: Common type
href Type
string
href Constraints
URI: the string must be a URI, according to RFC 3986
threadTs
Timestamp of the when the first post created the thread
threadTs
- is optional
- Type: unknown
- cannot be null
- defined in: Feed entity
threadTs Type
unknown
threadTs Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
toEntity
Entity for which this thread is created
Entity reference that includes entity ID and entity type
toEntity
- is required
- Type:
object
[Details](../types/common.md#common-definitions-entityreference)
- cannot be null
- defined in: Common type
toEntity Type
object
[Details](../types/common.md#common-definitions-entityreference)
posts
posts
- is required
- Type:
object[]
[Details](thread.md#thread-definitions-post)
- cannot be null
- defined in: Feed entity
posts Type
object[]
[Details](thread.md#thread-definitions-post)
Feed entity Definitions
Definitions group post
Reference this group by using
{"$ref":"https://github.com/StreamlineData/catalog/blob/master/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions/post"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
message | string |
Required | cannot be null | Feed entity |
postTs | string |
Optional | cannot be null | Feed entity |
from | string |
Required | cannot be null | Feed entity |
message
Message in the post
message
- is required
- Type:
string
- cannot be null
- defined in: Feed entity
message Type
string
postTs
Timestamp of the post
postTs
- is optional
- Type:
string
- cannot be null
- defined in: Feed entity
postTs Type
string
postTs Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
from
Unique id used to identify an entity
from
- is required
- Type:
string
- cannot be null
- defined in: Feed entity
from Type
string
from Constraints
UUID: the string must be a UUID, according to RFC 4122
thread-definitions-post-properties-message
https://github.com/StreamlineData/catalog/blob/master/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json#/definitions/post/properties/message
Message in 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* |
message Type
string
thread-definitions-post-properties-postts
https://github.com/StreamlineData/catalog/blob/master/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* |
postTs Type
string
postTs Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
thread-definitions-post
https://github.com/StreamlineData/catalog/blob/master/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* |
items Type
object
[Details](thread.md#thread-definitions-post)
items Properties
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
message | string |
Required | cannot be null | Feed entity |
postTs | string |
Optional | cannot be null | Feed entity |
from | string |
Required | cannot be null | Feed entity |
message
Message in the post
message
- is required
- Type:
string
- cannot be null
- defined in: Feed entity
message Type
string
postTs
Timestamp of the post
postTs
- is optional
- Type:
string
- cannot be null
- defined in: Feed entity
postTs Type
string
postTs Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
from
Unique id used to identify an entity
from
- is required
- Type:
string
- cannot be null
- defined in: Feed entity
from Type
string
from Constraints
UUID: the string must be a UUID, according to RFC 4122
thread-definitions
https://github.com/StreamlineData/catalog/blob/master/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* |
definitions Type
unknown
thread-properties-posts
https://github.com/StreamlineData/catalog/blob/master/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* |
posts Type
object[]
[Details](thread.md#thread-definitions-post)
thread-properties-threadts
https://github.com/StreamlineData/catalog/blob/master/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* |
threadTs Type
unknown
threadTs Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6