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":"6c13c2ed-f8fa-4165-8d20-3e531dcd5ef0","url":null,"fillingId":"48e00d8a-1c98-44cc-b579-42964ff4c3bd","fillingUrl":null,"stageId":"f60444a2-81e3-4ecc-9c28-4ea8f42aab72","stageUrl":null,"userId":"c22fd365-39ca-4e29-9ba0-f6fc49df0541","userUrl":null,"creationDateTime":"2024-07-26T08:50:35.2437287+00:00","lastModifiedDateTime":"2024-07-27T08:50:35.2437287+00:00","value":"Stage Comment 1","medias":[{"id":"fbc692bd-ba7d-45c3-aa5f-255468e26fbd","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"ba3cfde5-46bf-477b-8e9c-62e93db35cdb","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"e9c1635d-d42c-41cb-8661-2a3f0efdb44b","url":null,"fillingId":"7b607950-d8e3-4f31-be67-a6679554d67a","fillingUrl":null,"stageId":"9eb56d68-143d-401d-87dc-097ed4b92394","stageUrl":null,"userId":"52d0a9b5-45e3-4ec5-9e43-5795d8f889b5","userUrl":null,"creationDateTime":"2024-07-26T08:50:35.2437287+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