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

Forms

List
GET /serviceformModules/{moduleId}/forms 
https://api.relesysapp.net/api/v1.2/serviceformModules/{moduleId}/forms
Get a list of forms for the module with ID moduleId
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
Query String
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
name 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":"e9a1bc4d-6944-4794-b437-270b4c7d9210","url":null,"creationDateTime":"2024-04-22T17:41:10.8260555+00:00","lastModifiedDateTime":"2024-04-27T17:41:10.8260555+00:00","name":"Service form example 1","sortOrder":1,"number":"1","icon":{"id":"7d9e415a-d39c-4fe4-98a0-c2d9e9cd4092","downloadUrl":null,"referenceUrl":null,"contentType":"video/mp4","fileName":"mp4"},"locales":[{"culture":"da-DK","title":"Title example 1","description":"Description example 1"}]},{"id":"f390f315-4e5c-4903-a211-3b4ce7fc8726","url":null,"creationDateTime":"2024-03-26T17:41:10.8260555+00:00","lastModifiedDateTime":null,"name":"Service form example 2","sortOrder":2,"number":"2","icon":null,"locales":[{"culture":"da-DK","title":"Title example 2","description":"Description example 2"},{"culture":"en-GB","title":"Title example 3","description":"Description example 3"}]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   ⯈ icon object      
    contentType string      
    downloadUrl string      
    fileName string      
    id string / guid      
    referenceUrl string      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    description string      
    title string      
   name string      
   number string      
   sortOrder integer      
   url string      
  nextUrl string      
  previousUrl string