Relesys API Docs

v1.2

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

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.2/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":"94fcf3e4-4a62-40e7-bb10-64b7e67e3b42","url":null,"fillingId":"80a89645-d318-4153-ba02-c4e38f3b970a","fillingUrl":null,"stageId":"7b08ee82-b257-4639-8f89-937d6d0744a6","stageUrl":null,"userId":"c544e6cf-f58e-4f11-adf3-46d0bde68149","userUrl":null,"creationDateTime":"2024-04-27T05:37:41.252755+00:00","lastModifiedDateTime":"2024-04-28T05:37:41.252755+00:00","value":"Stage Comment 1","medias":[{"id":"890c62e8-d5b8-49c7-83bc-6eaa57977329","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"44641159-9806-43df-b5cf-fafafb256fbc","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"01ba8995-3319-4b3d-a086-6be8cb364f8d","url":null,"fillingId":"0629ef76-1773-4537-b8bc-246418848197","fillingUrl":null,"stageId":"ae430b61-49e3-4ccd-b80f-f6750d86e18b","stageUrl":null,"userId":"95929e66-2d80-499b-8291-170bf84cbb89","userUrl":null,"creationDateTime":"2024-04-27T05:37:41.252755+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