Relesys API Docs

v1.3

https://api.relesysapp.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Comments

Get Comments
GET /contentmodules/{moduleId}/content/{contentId}/comments 
https://api.relesysapp.net/api/v1.3/contentmodules/{moduleId}/content/{contentId}/comments
Get a list of content comments.
Default sort is by creationDateTime in descending order.

Please note: Comments must be enabled on the module for this endpoint to be called. Otherwise status code 400 - Bad Request will be returned.
Scopes: relesys.api, relesys.api:read, relesys.api.content, relesys.api.content:read
URL Path
moduleId string / guid required
contentId string / guid required
Query String
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
parentCommentId string / guid Filterable optional
userId string / guid Filterable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200 400 401
Schema Example
JSON
{"count":2,"data":[{"id":"50eed55f-b98e-4493-9d63-aeb4601a8e79","url":null,"userId":"bcf92cc5-8f26-4e07-a950-afe999ad73bc","userUrl":null,"parentCommentId":"3a147c68-a29b-46e6-aa53-7c523d01efe0","parentCommentUrl":null,"creationDateTime":"2024-11-21T06:27:15.2670692+00:00","lastModifiedDateTime":"2024-11-21T10:27:15.2670692+00:00","medias":[{"id":"e29abaf6-aae9-4ae8-8d3b-65e54a9d0016","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"a97f27d6-b8bd-4c9e-89e3-5a5169cbcbd6","downloadUrl":null,"referenceUrl":null,"contentType":"video/mp4","fileName":"mp4"}],"mentions":null,"locales":[{"culture":"en-GB","text":"Example text 1"}]},{"id":"ea0b9b77-5c80-4def-9080-a7fad31b4144","url":null,"userId":"5babe8fb-1aa2-45ea-85b7-f9b4be05e03e","userUrl":null,"parentCommentId":"439205a5-847f-4b43-ac85-243073d7e688","parentCommentUrl":null,"creationDateTime":"2024-11-21T05:27:15.2670692+00:00","lastModifiedDateTime":null,"medias":null,"mentions":[{"type":"User","name":null,"id":"12071612-da2c-4dcc-b798-76e6f3750c9e","url":null},{"type":"Department","name":null,"id":"e2899d4c-25f7-436e-8d36-9ba3adce96cd","url":null},{"type":"User group","name":null,"id":"04fa95ec-b5fb-49c7-b9dd-f60d93ebecae","url":null}],"locales":[{"culture":"en-GB","text":"Example text 2"}]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    text string      
   ⯈ medias array[object]      
    contentType string      
    downloadUrl string      
    fileName string      
    id string / guid      
    referenceUrl string      
   ⯈ mentions array[object]      
    id string / guid      
    name string      
    type string      
    url string      
   parentCommentId string / guid      
   parentCommentUrl string      
   url string      
   userId string / guid      
   userUrl string      
  nextUrl string      
  previousUrl string