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 the provided ID.
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":"98ad410f-bb59-41a3-9073-31570f620c3b","formId":"6a5708f9-9477-42f7-bdd0-f934b09de343","pageId":"57e9e7a7-20cd-4792-be37-2e271e92536a","dataListId":"41d078a0-82c2-47a3-86e4-5a52c22f98f9","externalId":"Field 1","type":"DataList","name":"Service form field example 1","sortOrder":1,"isRequired":true,"isVisible":true},{"id":"471ceeda-6666-4787-99e5-66f6221f2d6d","formId":"c21e6ab5-a1af-4f03-aa59-c6034e0df2bc","pageId":"48b41320-43b9-4f32-b6af-17b4f83fc183","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