Relesys API Docs

v1.3

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

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

DataLists

Get Data Lists
GET /dataLists 
https://api.relesysapp.net/api/v1.3/dataLists
Get a list of data lists.
Default sort is by sortOrder in ascending order.

type - This field displays the type of the data list. Currently, the available types are:
  • Catalog
  • Customer
  • DateInterval
  • Default
  • Department
  • Scored
  • User
  • User Group
media - This field can only be set when the type is catalog.
Scopes: relesys.api, relesys.api:read, relesys.api.datalists, relesys.api.datalists:read
Query String
creationDateTime datetimeoffset Filterable Sortable optional
externalId string Filterable Sortable optional
id string / guid Filterable optional
isEnabled boolean Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
sortOrder integer Filterable Sortable 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":"70a12639-a913-47c9-9e67-76c65e53082a","url":null,"type":"Default","sortOrder":0,"media":null,"isEnabled":true,"externalId":"Data list external Id example 1","creationDateTime":"2024-11-20T07:07:57.2051992+00:00","lastModifiedDateTime":"2024-11-21T07:07:57.2051992+00:00","locales":[{"culture":"da-DK","title":"Data list locale title example 1"}]},{"id":"856a2d53-e25f-436b-80a6-fe913c6fe9e1","url":null,"type":"Default","sortOrder":1,"media":null,"isEnabled":true,"externalId":"Data list external Id example 2","creationDateTime":"2024-11-20T07:07:57.2051992+00:00","lastModifiedDateTime":null,"locales":[{"culture":"da-DK","title":"Data list locale title example 2"},{"culture":"en-GB","title":"Data list locale title example 3"}]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   externalId string      
   id string / guid      
   isEnabled boolean      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    title string      
   ⯈ media object      
    contentType string      
    downloadUrl string      
    fileName string      
    id string / guid      
    referenceUrl string      
   sortOrder integer      
   type string      
   url string      
  nextUrl string      
  previousUrl string