Relesys API Docs

v1.2

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

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.2/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":"4bf3491a-46fd-42ce-8ee5-59eee9ae61c5","url":null,"userId":"1b4f463b-2110-457e-83f7-a40e4f5ecda1","userUrl":null,"parentCommentId":"7658e1b6-315e-4137-a6f4-f1ffc1b58a07","parentCommentUrl":null,"creationDateTime":"2024-04-25T11:10:53.6305457+00:00","lastModifiedDateTime":"2024-04-25T15:10:53.6305457+00:00","medias":[{"id":"85bcf8e1-dd00-4c91-b3ba-a94bd9724751","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"5d4d3df9-6aaf-4d82-8ef5-4a9e6bef3934","downloadUrl":null,"referenceUrl":null,"contentType":"video/mp4","fileName":"mp4"}],"mentions":null,"locales":[{"culture":"en-GB","text":"Example text 1"}]},{"id":"fbae7088-322d-46a2-a166-d64a4c9fa00d","url":null,"userId":"306c8d25-aa0a-4772-bb17-90b1f16dd22c","userUrl":null,"parentCommentId":"da6af7b8-d1f4-4f40-8bb0-e78bb73f1d32","parentCommentUrl":null,"creationDateTime":"2024-04-25T10:10:53.6305457+00:00","lastModifiedDateTime":null,"medias":null,"mentions":[{"type":"User","name":null,"id":"d621c029-dab5-40b9-93a3-a32026c247d5","url":null},{"type":"Department","name":null,"id":"d71c49d1-2036-4330-a55c-e0460c648323","url":null},{"type":"User group","name":null,"id":"a61cefc0-00bf-4650-9b69-e6dc1ab74dc1","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