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":"e19cc4b2-e3ee-4db7-8c3d-9b6e65f8432c","url":null,"fillingId":"7b3f69b5-8734-4f5b-94a7-dcf528b3c210","fillingUrl":null,"stageId":"36a95f0b-b4db-4760-84b4-b90516e49b39","stageUrl":null,"userId":"3295e8f9-dec8-445c-a2b1-f93eb8d1ff5a","userUrl":null,"creationDateTime":"2024-11-20T06:47:05.43657+00:00","lastModifiedDateTime":"2024-11-21T06:47:05.43657+00:00","value":"Stage Comment 1","medias":[{"id":"82bf4f03-508c-4131-bb9d-e644709c80a7","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"52aa0c69-70e5-4b90-abe1-2b69f8e71809","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"aceb59cd-046f-4a06-b85a-480601647f9c","url":null,"fillingId":"f1c6dc46-7f63-4d16-a44f-8eff4d24cf96","fillingUrl":null,"stageId":"7bf61a6d-ac18-4305-b87a-f0b01677e1b9","stageUrl":null,"userId":"d043b29e-ed87-4ed5-92fa-c5929707af87","userUrl":null,"creationDateTime":"2024-11-20T06:47:05.43657+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