Relesys API Docs

v1.1

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

Stages

Get Stage Reviews
GET /serviceforms/{serviceFormId}/forms/{formId}/stages/{stageId}/reviews
https://api.relesysapp.net/api/v1.1/serviceforms/{serviceFormId}/forms/{formId}/stages/{stageId}/reviews
Get a all reviews for the specified stage.

Please note: This endpoint is only available if stages are enabled on the service form module as well as stage approvals on the specific form.

status - This field displays the status of the review. Currently, the available statuses to filter on are:
  • Pending
  • Approved
  • Rejected
Scopes: relesys.api, relesys.api:read, relesys.api.serviceform, relesys.api.serviceform:read
URL Path
serviceFormId string / guid required
formId string / guid required
stageId string / guid required
Query String
fillingId string / guid Filterable optional
id string / guid Filterable optional
reviewDateTime datetimeoffset Filterable Sortable optional
stageId string / guid Filterable optional
status string 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
JSON
{"count":2,"data":[{"id":"10fa4935-2261-46a6-9e3e-9b21bbda3500","stageId":"05c663fa-2d3e-46d0-82c5-71926478cb6b","fillingId":"79b4b417-45d1-48c5-8803-00a2e1de53ea","reviewDateTime":"2022-08-09T01:25:53.8953049+00:00","userId":"8806955b-ad31-4049-863f-92eec8f5049e","status":"Approved"},{"id":"d6c38966-2fbf-41da-99fe-1dfc8f7b0fa1","stageId":"64b9a3fc-fd2b-415f-8a89-720d02eb77db","fillingId":"fdbeb991-aa6a-463a-8f44-268337b0fa49","reviewDateTime":"2022-08-03T01:25:53.8953049+00:00","userId":"6393a7d3-0162-4061-ab23-c1db28c5bbba","status":"Rejected"}]}
object
  count integer      
  data array[object]      
   fillingId string / guid      
   id string / guid      
   reviewDateTime datetimeoffset      
   stageId string / guid      
   status string      
   userId string / guid      
  nextUrl string      
  previousUrl string