Relesys API Docs

v1.2

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

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Fields

List
GET /serviceformModules/{moduleId}/forms/{formId}/fields 
https://api.relesysapp.net/api/v1.2/serviceformModules/{moduleId}/forms/{formId}/fields
Get a list of fields for the form with ID formId
Default sort is by sortOrder in ascending order.
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
creationDateTime datetimeoffset Filterable Sortable optional
externalId string Filterable Sortable optional
fieldGroupId string / guid Filterable optional
id string / guid Filterable optional
isFeedbackEnabled boolean Filterable optional
isMultiSelect boolean Filterable optional
isRequired boolean Filterable optional
isVisible boolean Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
maxNumberOfSelected integer Filterable optional
minNumberOfSelected integer Filterable 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":"a2d26a16-98ab-429b-9e6f-fb52391efaf7","url":null,"pageId":"2b3d3657-277b-47b9-a59c-009cf816dda1","pageUrl":null,"dataList":{"type":"Scored","id":"5ef29416-2b8f-4ec9-8400-88e59e30f346","url":null},"scoreCategoryId":"8a6a45ca-be22-4bab-b7fd-3b9514762fcf","scoreCategoryUrl":null,"fieldGroupId":"faa90456-6655-44ec-b21d-063ef121a8ef","fieldGroupUrl":null,"externalId":"External id example 1","creationDateTime":"2024-04-27T11:23:11.4636516+00:00","lastModifiedDateTime":"2024-04-28T11:23:11.4636516+00:00","type":"DataList","name":"Service form field name example 1","sortOrder":1,"isRequired":true,"isVisible":true,"isMultiSelect":true,"minNumberOfSelected":1,"maxNumberOfSelected":5,"isFeedbackEnabled":true,"locales":[{"culture":"da-DK","title":"Title example 1","helpText":"Help text example 1","bodyHtml":"Body html example 1","numberSuffix":"Number suffix example 1","filterLabel":"Filter label example 1"},{"culture":"en-GB","title":"Title example 2","helpText":"Help text example 2","bodyHtml":"Body html example 2","numberSuffix":"Number suffix example 2","filterLabel":"Filter label example 2"}]},{"id":"4440901d-4f6c-4a6e-8b05-f11082ab0705","url":null,"pageId":null,"pageUrl":null,"dataList":null,"scoreCategoryId":null,"scoreCategoryUrl":null,"fieldGroupId":null,"fieldGroupUrl":null,"externalId":"External id example 2","creationDateTime":null,"lastModifiedDateTime":null,"type":"Text","name":"Service form field name example 2","sortOrder":2,"isRequired":false,"isVisible":false,"isMultiSelect":false,"minNumberOfSelected":null,"maxNumberOfSelected":null,"isFeedbackEnabled":false,"locales":[{"culture":"da-DK","title":"Title example 3","helpText":"Help text example 3","bodyHtml":"Body html example 3","numberSuffix":"Number suffix example 3","filterLabel":"Filter label example 3"}]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   ⯈ dataList object      
    id string / guid      
    type string      
    url string      
   externalId string      
   fieldGroupId string / guid      
   fieldGroupUrl string      
   id string / guid      
   isFeedbackEnabled boolean      
   isMultiSelect boolean      
   isRequired boolean      
   isVisible boolean      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    bodyHtml string      
    culture string      
    filterLabel string      
    helpText string      
    numberSuffix string      
    title string      
   maxNumberOfSelected integer      
   minNumberOfSelected integer      
   name string      
   pageId string / guid      
   pageUrl string      
   scoreCategoryId string / guid      
   scoreCategoryUrl string      
   sortOrder integer      
   type string      
   url string      
  nextUrl string      
  previousUrl string