Relesys API Docs

v1.1

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

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

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 with ID stageId.

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
creationDateTime datetimeoffset Filterable Sortable optional
fillingId string / guid Filterable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable 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
200
Schema Example
JSON
{"count":2,"data":[{"id":"2d556b37-c69c-4cb5-bfec-ba2a7176a171","stageId":"a5d66b1e-d22a-4c9b-a8fb-42b48a303bb4","fillingId":"0963d109-e6ba-4853-9e71-55dcb57da064","reviewDateTime":"2024-10-02T23:43:18.9820236+00:00","creationDateTime":"2024-10-02T23:43:18.9820236+00:00","lastModifiedDateTime":"2024-10-04T23:43:18.9820236+00:00","userId":"2014f1d9-60e1-432f-82eb-e2e8925dd1f0","status":"Approved"},{"id":"c039a6be-7922-434f-9ebd-1449c3cc2983","stageId":"69950503-6053-4bcd-bff1-5aa06d57c4b6","fillingId":"2d704ed2-afa6-4686-8d1c-4f3a800586ed","reviewDateTime":"2024-09-26T23:43:18.9820236+00:00","creationDateTime":"2024-10-02T23:43:18.9820236+00:00","lastModifiedDateTime":null,"userId":"eade6b9b-415e-49fb-942a-8c3b5f8c84eb","status":"Rejected"}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   fillingId string / guid      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   reviewDateTime datetimeoffset      
   stageId string / guid      
   status string      
   userId string / guid      
  nextUrl string      
  previousUrl string