Relesys API Docs

v1.2

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

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
JSON
{"count":2,"data":[{"id":"682349f6-8b5d-40da-959f-a00e50f4bbfd","url":null,"userId":"1c657f49-7587-418f-940d-8ac8a887d543","userUrl":null,"parentCommentId":"b2a3615e-e55f-418c-ab6b-0c98ad6cf276","parentCommentUrl":null,"creationDateTime":"2024-02-28T13:00:15.6427013+00:00","lastModifiedDateTime":"2024-02-28T17:00:15.6427013+00:00","medias":[{"id":"ede92c34-d9a1-4f03-a491-403cd58c51a7","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"4a3fe5f9-1b27-4d3b-93ab-be80f983a768","downloadUrl":null,"referenceUrl":null,"contentType":"video/mp4","fileName":"mp4"}],"mentions":null,"locales":[{"culture":"en-GB","text":"Example text 1"}]},{"id":"5598d46d-b13b-4dae-acae-a8e539944ea1","url":null,"userId":"72006dec-8a53-454b-82f8-6bf3bbd3ff37","userUrl":null,"parentCommentId":"96bd84a7-bef4-4058-9d21-efa8cf04dc71","parentCommentUrl":null,"creationDateTime":"2024-02-28T12:00:15.6427013+00:00","lastModifiedDateTime":null,"medias":null,"mentions":[{"type":"User","name":null,"id":"7c56d4f7-e426-49c1-a762-a4efb75d00ea","url":null},{"type":"Department","name":null,"id":"d1e5ceb3-4926-4a88-8d38-20f71bac2bb8","url":null},{"type":"User group","name":null,"id":"ac98c6b0-12bc-4785-813d-4f6f76e47009","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