Get Comment Children
Returns all children for a given comment.
Resource Information
This service uses the tomcat application on port 8080 by default.
The context for this API is /crafter-social, please prefix the API URLs with this context.
HTTP Verb
|
GET
|
URL
|
/api/3/threads/:id/comments/:commentId/children |
Response Formats
|
JSON |
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
context
|
String
|
✓
|
The ID of the Social Context
|
id
|
String
|
✓
|
The ID of the thread
|
commentId
|
String
|
✓
|
The ID of the comment
|
recursive
|
Integer
|
Levels of comments to return
|
|
pageNumber
|
Integer
|
Page number to return
|
|
pageSize
|
Integer
|
Comments per page
|
|
childrenCount
|
Integer
|
Amount of children to return
|
|
sortBy
|
List
|
List of fields to order by
|
|
sortOrder
|
List
|
List of sort orders for each field
|
Example
Request
GET .../api/3/threads/Welcome/comments/59678d3f300426156e21df50/children?context=f5b143c2-f1c0-4a10-b56e-f485f00d3fe9
Response
Status 200 OK
1{
2 "total": 1,
3 "pageSize": 666,
4 "pageNumber": 0,
5 "watched": false,
6 "comments": [
7 {
8 "ancestors": [
9 "59678d3f300426156e21df50"
10 ],
11 "targetId": "Welcome",
12 "subject": "",
13 "body": "This is a response.",
14 "createdBy": "59667e8abd4787992596ba6b",
15 "lastModifiedBy": "59667e8abd4787992596ba6b",
16 "createdDate": "2017-07-13T14:15Z",
17 "lastModifiedDate": "2017-07-13T14:15Z",
18 "anonymousFlag": false,
19 "attributes": {},
20 "children": [],
21 "attachments": [],
22 "moderationStatus": "UNMODERATED",
23 "votesUp": [],
24 "votesDown": [],
25 "flags": [],
26 "_id": "5967d4c6300426156e21df57"
27 }
28 ]
29}
Responses
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
See example above.
|
|
401
|
{ "message" : "User must be logged in" } |
|
403
|
{ "message" : "Current subject does not have
permission to execute global action ..." }
|
|
404
|
{ "message" : "Unable to find ugc with
id ..." }
|
|
500
|
{ "message" : "Internal server error" } |