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":"b614895a-3270-4cf7-9952-5c6dcd85d1c8","url":null,"fillingId":"c336515d-1f19-4d89-a163-67ab20feb74e","fillingUrl":null,"stageId":"1c799878-162e-4cd2-8338-a0103acbf9cf","stageUrl":null,"userId":"6d6b4a0a-9d75-4bb3-ae50-4d704a4f39e3","userUrl":null,"creationDateTime":"2024-12-01T10:49:40.2299239+00:00","lastModifiedDateTime":"2024-12-02T10:49:40.2299239+00:00","value":"Stage Comment 1","medias":[{"id":"102884c7-c119-494e-a13d-e92d9209b7b8","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"aee48968-ae7a-4fbb-bd8b-b30f7f467ba6","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"5d480572-f858-4d93-8044-abffbf82a13b","url":null,"fillingId":"5cebe40f-98cd-4dc2-a062-973159040a03","fillingUrl":null,"stageId":"5f43bd9e-490c-46c5-bd2a-581c01f04013","stageUrl":null,"userId":"36f7de94-d0da-4a6c-97e3-5800020d102f","userUrl":null,"creationDateTime":"2024-12-01T10:49:40.2299239+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