Relesys API Docs

v1.1

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

Fields

Get Fields
GET /serviceforms/{serviceFormId}/forms/{formId}/pages/{pageId}/fields
https://api.relesysapp.net/api/v1.1/serviceforms/{serviceFormId}/forms/{formId}/pages/{pageId}/fields
Get all fields related to a page with ID pageId.
Scopes: relesys.api, relesys.api:read, relesys.api.serviceform, relesys.api.serviceform:read
URL Path
serviceFormId string / guid required
formId string / guid required
pageId string / guid required
Query String
dataListId string / guid Filterable optional
externalId string Filterable optional
formId string / guid Filterable optional
id string / guid Filterable optional
isRequired boolean Filterable optional
isVisible boolean Filterable optional
name string Filterable Sortable optional
pageId string / guid Filterable optional
type string 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
JSON
{"count":2,"data":[{"id":"d9cc58f8-953a-47f2-a5c6-1962c831f522","formId":"81e92c47-f26f-4a8d-9ce2-6d334d3d680d","pageId":"2c3571e7-5bb1-46b6-b980-9e94238fb7e4","dataListId":"c9ca7f8c-2dba-48d9-98b0-60a1ded1dc2d","externalId":"Field 1","type":"DataList","name":"Service form field example 1","sortOrder":1,"isRequired":true,"isVisible":true},{"id":"790740d5-a509-4cfe-b9ba-3d5aa89dca3c","formId":"04ecc1ec-ada9-4453-a7fe-b953718c8c70","pageId":"a5aaba38-227d-44ba-b85c-6cc03685b5af","dataListId":null,"externalId":"Field 2","type":"Text","name":"Service form field example 2","sortOrder":1,"isRequired":true,"isVisible":true}]}
object
  count integer      
  data array[object]      
   dataListId string / guid      
   externalId string      
   formId string / guid      
   id string / guid      
   isRequired boolean      
   isVisible boolean      
   name string      
   pageId string / guid      
   sortOrder integer      
   type string      
  nextUrl string      
  previousUrl string