HumHub - Content API (1.0.0)

Download OpenAPI specification:Download

Welcome to the HumHub comment module API reference.

Find comments by object

query Parameters

objectModel required	string The object model class name
objectId required	integer The primary key of the object

Responses

Response samples

200

Content type

application/json

{"total": 76,
"page": 1,
"pages": 8,
"links": {"self": "{endpoint_path}?page=1&per-page=10",
"next": "{endpoint_path}?page=2&per-page=10",
"last": "{endpoint_path}?page=8&per-page=10"
},
"results": [{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}
]
}

Find comments by content

path Parameters

id

required

integer

The primary key of the content

Responses

Response samples

200

Content type

application/json

{"total": 76,
"page": 1,
"pages": 8,
"links": {"self": "{endpoint_path}?page=1&per-page=10",
"next": "{endpoint_path}?page=2&per-page=10",
"last": "{endpoint_path}?page=8&per-page=10"
},
"results": [{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}
]
}

Create a comment

Request Body schema: application/json

The comment data

objectModel required	string
objectId required	integer <int64>
required	object (Comment)

Responses

Request samples

Payload

Content type

application/json

{"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"Comment": {"message": "Calvin Klein – Between love and madness lies obsession."
}
}

Response samples

200

Content type

application/json

{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}

Get comment by id

path Parameters

id

required

integer

The id of the comment

Responses

Response samples

200

Content type

application/json

{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}

Update a comment by id

path Parameters

id

required

integer

Id of the updated comment

Request Body schema: application/json

The comment data

required

object (Comment)

Responses

Request samples

Payload

Content type

application/json

{"Comment": {"message": "Calvin Klein – Between love and madness lies obsession."
}
}

Response samples

200

Content type

application/json

{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}

Deletes a comment by id

path Parameters

id

required

integer

The id of comment