Relesys API Docs

v1.3

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

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
JSON
{"count":2,"data":[{"id":"b0bb01b3-b0c5-42c1-8d69-e48f48560869","url":null,"userId":"760a986a-610a-450d-94ae-5006c5955ecf","userUrl":null,"parentCommentId":"2063d61f-f3f8-450c-b0f8-a185959b1a9d","parentCommentUrl":null,"creationDateTime":"2024-11-15T00:43:56.3375997+00:00","lastModifiedDateTime":"2024-11-15T04:43:56.3375997+00:00","medias":[{"id":"7b056ce2-5f17-468a-9c1d-fcaf269d7054","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"ef9f4e87-8eb9-41ad-bb9c-75fe4143595c","downloadUrl":null,"referenceUrl":null,"contentType":"video/mp4","fileName":"mp4"}],"mentions":null,"locales":[{"culture":"en-GB","text":"Example text 1"}]},{"id":"ca336435-b52a-49af-965e-b7893f092a52","url":null,"userId":"4d002533-b4e5-4502-8e44-c4be155577ef","userUrl":null,"parentCommentId":"1c9ae8b8-6171-4002-a087-158c9191bbe7","parentCommentUrl":null,"creationDateTime":"2024-11-14T23:43:56.3375997+00:00","lastModifiedDateTime":null,"medias":null,"mentions":[{"type":"User","name":null,"id":"e915c4d2-48e7-4ead-9fe7-369b44d5ed02","url":null},{"type":"Department","name":null,"id":"ca807461-06d5-4b72-a820-e7f18ae36664","url":null},{"type":"User group","name":null,"id":"6f3c7a02-62d2-4221-b750-95173b6da787","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