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":"f22ebcfb-744a-49f0-9f41-0294a1b8ee03","url":null,"userId":"df9b1f10-7965-4c16-8ad8-c1ac77c7e454","userUrl":null,"parentCommentId":"ed162a66-cda4-414d-a131-26d3a4de10e3","parentCommentUrl":null,"creationDateTime":"2024-07-27T13:29:51.7116558+00:00","lastModifiedDateTime":"2024-07-27T17:29:51.7116558+00:00","medias":[{"id":"8bb63b2f-9451-41ad-a481-f6ee31452b6d","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"c252e580-7c33-440d-83bc-616948e68112","downloadUrl":null,"referenceUrl":null,"contentType":"video/mp4","fileName":"mp4"}],"mentions":null,"locales":[{"culture":"en-GB","text":"Example text 1"}]},{"id":"1b4765a4-c101-430d-9fb4-a80b8aaa6b00","url":null,"userId":"640144c2-93dc-41a4-b1b0-8917533478e0","userUrl":null,"parentCommentId":"c599ba78-2828-491e-b940-c70cda84f4c7","parentCommentUrl":null,"creationDateTime":"2024-07-27T12:29:51.7116558+00:00","lastModifiedDateTime":null,"medias":null,"mentions":[{"type":"User","name":null,"id":"b38f5bba-c3db-48eb-af9d-b033d2be82d5","url":null},{"type":"Department","name":null,"id":"0d9c80d2-c34a-4164-a240-70cd36634290","url":null},{"type":"User group","name":null,"id":"c6924c44-d80d-4eb1-9165-27bd1e44e70c","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