Relesys API Docs

v1.1

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

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.1/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":"af4f012a-427d-49a9-9fdb-1943b860068f","url":null,"userId":"f1856ffa-bc95-4db6-a33e-e0c37ac7a31c","userUrl":null,"parentCommentId":"5e661f29-69f6-438c-a62b-ef0257a0509a","parentCommentUrl":null,"creationDateTime":"2024-10-04T23:31:29.0669892+00:00","lastModifiedDateTime":"2024-10-05T03:31:29.0669892+00:00","medias":[{"id":"59b47a49-5edf-49d5-ad18-7574ffd65a53","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"80e8281b-bc42-4f7b-8279-202561031a2f","downloadUrl":null,"referenceUrl":null,"contentType":"video/mp4","fileName":"mp4"}],"mentions":null,"locales":[{"culture":"en-GB","text":"Example text 1"}]},{"id":"2ceefeb2-c7ef-474d-8b58-45808b8f4f06","url":null,"userId":"85107e14-7b61-4dab-95b6-05530c2d6c7c","userUrl":null,"parentCommentId":"44cc3ba9-6d99-4be8-9839-daa87df48ce3","parentCommentUrl":null,"creationDateTime":"2024-10-04T22:31:29.0669892+00:00","lastModifiedDateTime":null,"medias":null,"mentions":[{"type":"User","name":null,"id":"4c962cfe-9749-4444-a1c2-01fc4b0fa248","url":null},{"type":"Department","name":null,"id":"94154f64-ef79-4594-ac80-dd07946035cd","url":null},{"type":"User group","name":null,"id":"a685efc7-7e12-4769-83db-e2a00212df5d","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