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

Performance Ranges

List
GET /serviceformModules/{moduleId}/forms/{formId}/performanceRanges 
https://api.relesysapp.net/api/v1.3/serviceformModules/{moduleId}/forms/{formId}/performanceRanges
Get a list of performance ranges for the form with ID formId
Default sort is by sortOrder in ascending order.

If you want to filter on the color value for this endpoint, you need to replace # with %23 in the hexadecimal code. For example, if you want to filter on blue, you need to use %2300FFFF instead of #00FFFF. This is because # is a special character in URLs and needs to be encoded.
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
color string Filterable optional
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
maxRange integer Filterable Sortable optional
minRange integer Filterable Sortable optional
sortOrder integer Filterable Sortable 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":"c1585755-42de-4ca0-9d78-d63e752c9bf7","url":null,"minRange":0,"maxRange":25,"color":"#111111","creationDateTime":"2024-11-20T06:23:24.9308247+00:00","lastModifiedDateTime":"2024-11-21T06:23:24.9308247+00:00","locales":[{"culture":"en-GB","title":"Performance range title 1"}],"sortOrder":0},{"id":"6d0a7eda-7b53-4caa-83d5-597b9f90b3cd","url":null,"minRange":25,"maxRange":50,"color":"#ffffff","creationDateTime":"2024-11-21T06:23:24.9308247+00:00","lastModifiedDateTime":null,"locales":[{"culture":"en-GB","title":"Performance range title 2"},{"culture":"da-DK","title":"Performance range title 3"}],"sortOrder":0}]}
object
  count integer      
  ⯈ data array[object]      
   color string      
   creationDateTime datetimeoffset      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    title string      
   maxRange integer      
   minRange integer      
   sortOrder integer      
   url string      
  nextUrl string      
  previousUrl string