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

Stage Comments

List
GET /serviceformModules/{moduleId}/forms/{formId}/stageComments 
https://api.relesysapp.net/api/v1.3/serviceformModules/{moduleId}/forms/{formId}/stageComments
Get a list of stage comments for the form with ID formId.

Please note: This endpoint is only available if stages are enabled on the service form module.
Scopes: relesys.api, relesys.api:read, relesys.api.serviceform, relesys.api.serviceform:read
URL Path
moduleId string / guid required
formId string / guid required
Query String
creationDateTime datetimeoffset Filterable Sortable optional
fillingId string / guid Filterable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
stageId 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
Schema Example
JSON
{"count":2,"data":[{"id":"be031935-150f-47c4-968e-a32179052e2a","url":null,"fillingId":"6cae5a1d-1346-43ac-85be-e468987a9238","fillingUrl":null,"stageId":"c30361e5-1d9c-46d3-aa94-b397decbfaa6","stageUrl":null,"userId":"d591ce28-71d0-4e17-b966-890f68a35319","userUrl":null,"creationDateTime":"2024-10-21T13:59:41.6248212+00:00","lastModifiedDateTime":"2024-10-22T13:59:41.6248212+00:00","value":"Stage Comment 1","medias":[{"id":"bffad038-9660-4485-a525-953553e34929","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"086e8239-e549-4015-8156-130d33d7e23e","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"a7476770-baa3-4145-b5f4-47d2e4123d8d","url":null,"fillingId":"7b542f48-db12-40dc-b094-1901b9067854","fillingUrl":null,"stageId":"1f2bc616-5cb4-4759-aa98-d2b02ed459c6","stageUrl":null,"userId":"95239b57-3f25-456e-ae99-3f114cfa7e2e","userUrl":null,"creationDateTime":"2024-10-21T13:59:41.6248212+00:00","lastModifiedDateTime":null,"value":"Stage Comment 2","medias":[]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   fillingId string / guid      
   fillingUrl string      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   ⯈ medias array[object]      
    contentType string      
    downloadUrl string      
    fileName string      
    id string / guid      
    referenceUrl string      
   stageId string / guid      
   stageUrl string      
   url string      
   userId string / guid      
   userUrl string      
   value string      
  nextUrl string      
  previousUrl string