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

DataListItems

Get Data List Items
GET /dataLists/{dataListId}/items 
https://api.relesysapp.net/api/v1.2/dataLists/{dataListId}/items
Get a list of data list items.
Default sort is by sortOrder in ascending order.

customFieldValues - This field differ based on the custom fields the data list has and what type the fields are, and only includes values from custom fields not currently hidden.
Either value, locales, medias or dataListItems is set depending on the type value:

  • Barcode, Color, Date or Number
    • The field value will be set.
  • Text or Multiline Text
    • The field value will be set.
    If the custom field is multilingual, then locales will be used instead.
  • Media
    • The field medias will be set.
    referenceUrl will be set if the media is third-party reference, otherwise downloadUrl will be set.
  • Data List
    • The field dataListItems will be set.

This endpoint will return a 400 Bad Request response in case the data list with dataListId is of type Department, User, or User Group as their items are dynamically based on the available users, departments, or user groups respectively.
Scopes: relesys.api, relesys.api:read, relesys.api.datalists, relesys.api.datalists:read
URL Path
dataListId string / guid required
Query String
creationDateTime datetimeoffset Filterable Sortable optional
customId string Filterable Sortable optional
id string / guid Filterable optional
isEnabled boolean Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
sortOrder integer 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":4,"data":[{"id":"3a4f9677-cf58-4d62-802b-e66179497f41","url":null,"customId":"Data list item custom id example 1","sortOrder":0,"isEnabled":true,"creationDateTime":"2024-04-15T11:26:53.9271346+00:00","lastModifiedDateTime":"2024-04-16T11:26:53.9271346+00:00","locales":[{"culture":"da-DK","title":"Data list item locale title example 1"}],"customFieldValues":[{"dataListCustomFieldId":"132300eb-6b8d-4aee-9442-a44d70cc059f","url":null,"type":"Text","value":"Data list item custom field value example 1","locales":null,"medias":null,"dataListItems":null}]},{"id":"da0262fc-ed23-497e-9bc7-e1acbe6cfb05","url":null,"customId":"Data list item custom id example 2","sortOrder":1,"isEnabled":true,"creationDateTime":"2024-04-15T11:26:53.9271346+00:00","lastModifiedDateTime":"2024-04-16T11:26:53.9271346+00:00","locales":[{"culture":"da-DK","title":"Data list item locale title example 2"}],"customFieldValues":[{"dataListCustomFieldId":"10943f7c-2bb4-4fe2-86fe-89cd839bcd5b","url":null,"type":"Text","value":null,"locales":[{"culture":"da-DK","value":"Data list custom field value locale value example 1"}],"medias":null,"dataListItems":null}]},{"id":"be5d4e08-a64b-4584-818f-c88bc90dc11e","url":null,"customId":"Data list item custom id example 3","sortOrder":2,"isEnabled":false,"creationDateTime":"2024-04-15T11:26:53.9271346+00:00","lastModifiedDateTime":null,"locales":[{"culture":"da-DK","title":"Data list item locale title example 3"},{"culture":"en-GB","title":"Data list item locale title example 4"}],"customFieldValues":[{"dataListCustomFieldId":"dae3539a-4212-4e7d-9949-5b45b34e9cc5","url":null,"type":"Media","value":null,"locales":null,"medias":[{"id":"fe29e3fd-9623-4997-b29a-b1fa933d73b1","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"FileName.png"}],"dataListItems":null}]},{"id":"649eb6dd-f83a-45fe-b6a4-a7258df3c451","url":null,"customId":"Data list item custom id example 4","sortOrder":3,"isEnabled":false,"creationDateTime":"2024-04-15T11:26:53.9271346+00:00","lastModifiedDateTime":null,"locales":[{"culture":"da-DK","title":"Data list item locale title example 5"},{"culture":"en-GB","title":"Data list item locale title example 6"}],"customFieldValues":[{"dataListCustomFieldId":"fddea4b0-45f1-40f1-be14-03d5e37a8a92","url":null,"type":"DataList","value":null,"locales":null,"medias":null,"dataListItems":[{"type":"User","id":"3fb499c5-62e5-44fc-84c2-fbb5045414ff","url":null},{"type":"User","id":"c24a804c-8c50-4958-8c53-46fc2f6278f2","url":null}]}]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   ⯈ customFieldValues array[object]      
    dataListCustomFieldId string / guid      
    ⯈ dataListItems array[object]      
     id string / guid      
     type string      
     url string      
    ⯈ locales array[object]      
     culture string      
     value string      
    ⯈ medias array[object]      
     contentType string      
     downloadUrl string      
     fileName string      
     id string / guid      
     referenceUrl string      
    type string      
    url string      
    value string      
   customId string      
   id string / guid      
   isEnabled boolean      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    title string      
   sortOrder integer      
   url string      
  nextUrl string      
  previousUrl string