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

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
creationDateTime datetimeoffset Filterable Sortable optional
dataListId string / guid Filterable optional
externalId string Filterable optional
fieldGroupId string / guid Filterable optional
formId string / guid Filterable optional
id string / guid Filterable optional
isRequired boolean Filterable optional
isVisible boolean Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
name string Filterable Sortable optional
pageId string / guid Filterable optional
scoreCategoryId 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
200
Schema Example
JSON
{"count":2,"data":[{"id":"8bf22ef1-0a98-42ab-ac18-2ad18ba587ac","formId":"487dd4a3-6bba-47f4-8150-793d05c17fcf","pageId":"a0bc8506-11fb-44b5-941d-5d7a08ef9887","dataListId":"41c5c1c9-5a4f-4611-b831-1ffc20093e07","scoreCategoryId":"e274ef20-b184-496e-bfa9-b6d4ae81fc19","fieldGroupId":"4c2472ba-012f-45fa-9846-2ec723acfc9c","externalId":"Field 1","creationDateTime":"2024-10-03T23:39:35.1578323+00:00","lastModifiedDateTime":null,"type":"DataList","name":"Service form field example 1","sortOrder":1,"isRequired":true,"isVisible":true},{"id":"6f71c8bf-c7ea-4c49-b086-5cf8556cd0a1","formId":"095f661b-60ef-4df7-89df-7375a91fe3a9","pageId":"fd73be1f-e590-4b13-b2d9-c0b865f09af8","dataListId":null,"scoreCategoryId":null,"fieldGroupId":null,"externalId":"Field 2","creationDateTime":null,"lastModifiedDateTime":null,"type":"Text","name":"Service form field example 2","sortOrder":1,"isRequired":true,"isVisible":true}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   dataListId string / guid      
   externalId string      
   fieldGroupId string / guid      
   formId string / guid      
   id string / guid      
   isRequired boolean      
   isVisible boolean      
   lastModifiedDateTime datetimeoffset      
   name string      
   pageId string / guid      
   scoreCategoryId string / guid      
   sortOrder integer      
   type string      
  nextUrl string      
  previousUrl string