Comment¶
Create Comment¶
HTTP Request
POST /api/comments
📋 Description: Submits a new comment to the specified resource, enabling users to engage in discussions and provide feedback within the application.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the comment data, including the user’s ID, content, and associated post ID for effective engagement tracking. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "comment": "string",
6 "parentEntityId": 0,
7 "parentEntityName": "string"
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Get All Comments By Entity¶
HTTP Request
GET /api/comments/{entity}/{entityId}
📋 Description: Fetches comments associated with a specified entity and its unique identifier, enabling users to access relevant feedback and insights for enhanced decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entity |
path |
string |
true |
Identifier for the specific entity associated with the comments being retrieved, enabling targeted access to relevant feedback. |
entityId |
path |
integer(int64) |
true |
Unique identifier for the entity |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "comment": "string",
7 "parentEntityId": 0,
8 "parentEntityName": "string"
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a user-generated comment, including relevant metadata such as author information and timestamps, to facilitate engagement and feedback within the platform.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» comment |
string |
true |
none |
Textual feedback or observations related to a specific entity, intended to enhance communication and provide context within the business process. |
» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
» parentEntityName |
string |
true |
none |
Name of the parent entity |